pxdct 0.3.2

/*
 * // Copyright (c) Radzivon Bartoshyk 1/2026. All rights reserved.
 * //
 * // Redistribution and use in source and binary forms, with or without modification,
 * // are permitted provided that the following conditions are met:
 * //
 * // 1.  Redistributions of source code must retain the above copyright notice, this
 * // list of conditions and the following disclaimer.
 * //
 * // 2.  Redistributions in binary form must reproduce the above copyright notice,
 * // this list of conditions and the following disclaimer in the documentation
 * // and/or other materials provided with the distribution.
 * //
 * // 3.  Neither the name of the copyright holder nor the names of its
 * // contributors may be used to endorse or promote products derived from
 * // this software without specific prior written permission.
 * //
 * // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * // AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * // DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
 * // FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * // DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 * // SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 * // CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * // OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
use crate::avx::dct2::mixed_radix3f::{
    dct2_radix_n_cos_twiddles_avx_f, dct2_radix_n_rotation_twiddles_avx_f,
};
use crate::avx::storef::AvxStoreF;
use crate::avx::util::{boring_avx_mixed_radix, fma};
use crate::bidirectional::BidirectionalStore;
use crate::butterflies::MixedRadix9Sample;
use crate::util::{DctConstants, DctSample, try_vec, validate_scratch};
use crate::{PxdctError, PxdctExecutor};
use num_traits::One;
use std::sync::Arc;

pub(crate) struct AvxDct2MixedRadix9f {
    rotation_layer: Vec<AvxStoreF>,
    cos_twiddles: Vec<AvxStoreF>,
    inner_dct: Arc<dyn PxdctExecutor<f32> + Send + Sync>,
    inner_dct_scratch_size: usize,
    execution_length: usize,
    q_modules: usize,
}

impl AvxDct2MixedRadix9f {
    pub(crate) fn new(
        len: usize,
        inner_dct: Arc<dyn PxdctExecutor<f32> + Send + Sync>,
    ) -> Result<AvxDct2MixedRadix9f, PxdctError> {
        assert!(
            len.is_multiple_of(9),
            "Mixed radix 9 should not be called on sizes no divisible by 9"
        );

        let q_modules = len / 9;

        let inner_dct_scratch_size = inner_dct.scratch_size();

        // always 4 inner groups in Radix-9
        Ok(AvxDct2MixedRadix9f {
            rotation_layer: unsafe { dct2_radix_n_rotation_twiddles_avx_f(9, q_modules, len) },
            cos_twiddles: unsafe { dct2_radix_n_cos_twiddles_avx_f(9, q_modules, len) },
            inner_dct,
            inner_dct_scratch_size,
            execution_length: len,
            q_modules: len / 9,
        })
    }
}

boring_avx_mixed_radix!(AvxDct2MixedRadix9f, f32);

impl AvxDct2MixedRadix9f {
    #[inline]
    #[target_feature(enable = "avx2", enable = "fma")]
    fn exec_block<S: BidirectionalStore<f32>, const N: usize>(
        &self,
        data: &mut S,
        a_buffer: &[f32],
        s_buffer: &[f32],
        c_buffer: &[f32],
        uk: usize,
        k: usize,
    ) {
        // Apply rotation twiddles to combine forward and inverted components
        let rotation_twiddle_re = unsafe { *self.rotation_layer.get_unchecked(uk) };
        let rotation_twiddle_im = unsafe { *self.rotation_layer.get_unchecked(uk + 1) };

        let c_forward = AvxStoreF::load_n::<N>(unsafe { c_buffer.get_unchecked(k..) });
        let s_forward = AvxStoreF::load_n::<N>(unsafe {
            s_buffer.get_unchecked(self.q_modules - k - (N - 1)..)
        })
        .reverse_n::<N>();

        let rotated_dc = fma(s_forward, rotation_twiddle_re, c_forward);

        let twiddle_re = unsafe { *self.cos_twiddles.get_unchecked(uk) };
        let twiddle_im = unsafe { *self.cos_twiddles.get_unchecked(uk + 1) };

        let twiddled_dc = rotated_dc * twiddle_re;

        let mut dc0 = twiddled_dc;
        let mut dc2 = twiddled_dc * f32::R9_EVEN_TWIDDLE_0;
        let mut dc4 = twiddled_dc * f32::R9_EVEN_TWIDDLE_2;
        let mut dc6 = twiddled_dc * -f32::HALF;
        let mut dc8 = twiddled_dc * f32::R9_EVEN_TWIDDLE_1;

        let rotated_ds = fma(c_forward, rotation_twiddle_im, s_forward);

        let twiddled_ds = rotated_ds * twiddle_im;

        let mut ds1 = twiddled_ds * f32::R9_ODD_TWIDDLE_0;
        let mut ds3 = twiddled_ds * -f32::R9_ODD_TWIDDLE_1;
        let mut ds5 = twiddled_ds * f32::R9_ODD_TWIDDLE_2;
        let mut ds7 = twiddled_ds * -f32::R9_ODD_TWIDDLE_3;

        {
            let c_forward =
                AvxStoreF::load_n::<N>(unsafe { c_buffer.get_unchecked(self.q_modules + k..) });
            let s_forward = AvxStoreF::load_n::<N>(unsafe {
                s_buffer.get_unchecked(self.q_modules * 2 - k - (N - 1)..)
            })
            .reverse_n::<N>();

            let rotation_twiddle_re = unsafe { *self.rotation_layer.get_unchecked(uk + 2) };
            let rotation_twiddle_im = unsafe { *self.rotation_layer.get_unchecked(uk + 3) };

            let twiddle_re = unsafe { *self.cos_twiddles.get_unchecked(uk + 2) };
            let twiddle_im = unsafe { *self.cos_twiddles.get_unchecked(uk + 3) };

            let rotated_dc1 = fma(s_forward, rotation_twiddle_re, c_forward);
            let rotated_ds2 = fma(c_forward, rotation_twiddle_im, s_forward);

            let twiddled_dc = twiddle_re * rotated_dc1;
            let twiddled_ds = twiddle_im * rotated_ds2;

            dc0 = twiddled_dc + dc0;
            dc2 = AvxStoreF::f32_mul_add(-f32::HALF, twiddled_dc, dc2);
            dc4 = AvxStoreF::f32_mul_add(-f32::HALF, twiddled_dc, dc4);
            dc6 = twiddled_dc + dc6;
            dc8 = AvxStoreF::f32_mul_add(-f32::HALF, twiddled_dc, dc8);

            ds1 = AvxStoreF::f32_mul_add(f32::R9_ODD_TWIDDLE_1, twiddled_ds, ds1);
            ds5 = AvxStoreF::f32_mul_add(-f32::R9_ODD_TWIDDLE_1, twiddled_ds, ds5);
            ds7 = AvxStoreF::f32_mul_add(f32::R9_ODD_TWIDDLE_1, twiddled_ds, ds7);
        }

        {
            let c_forward =
                AvxStoreF::load_n::<N>(unsafe { c_buffer.get_unchecked(self.q_modules * 2 + k..) });
            let s_forward = AvxStoreF::load_n::<N>(unsafe {
                s_buffer.get_unchecked(self.q_modules * 3 - k - (N - 1)..)
            })
            .reverse_n::<N>();

            let rotation_twiddle_re = unsafe { *self.rotation_layer.get_unchecked(uk + 4) };
            let rotation_twiddle_im = unsafe { *self.rotation_layer.get_unchecked(uk + 5) };

            let twiddle_re = unsafe { *self.cos_twiddles.get_unchecked(uk + 4) };
            let twiddle_im = unsafe { *self.cos_twiddles.get_unchecked(uk + 5) };

            let rotated_dc1 = fma(s_forward, rotation_twiddle_re, c_forward);
            let rotated_ds2 = fma(c_forward, rotation_twiddle_im, s_forward);

            let twiddled_dc = twiddle_re * rotated_dc1;
            let twiddled_ds = twiddle_im * rotated_ds2;

            dc0 = twiddled_dc + dc0;
            dc2 = AvxStoreF::f32_mul_add(f32::R9_EVEN_TWIDDLE_1, twiddled_dc, dc2);
            dc4 = AvxStoreF::f32_mul_add(f32::R9_EVEN_TWIDDLE_0, twiddled_dc, dc4);
            dc6 = AvxStoreF::f32_mul_add(-f32::HALF, twiddled_dc, dc6);
            dc8 = AvxStoreF::f32_mul_add(f32::R9_EVEN_TWIDDLE_2, twiddled_dc, dc8);

            ds1 = AvxStoreF::f32_mul_add(f32::R9_ODD_TWIDDLE_2, twiddled_ds, ds1);
            ds3 = AvxStoreF::f32_mul_add(f32::R9_ODD_TWIDDLE_1, twiddled_ds, ds3);
            ds5 = AvxStoreF::f32_mul_add(-f32::R9_ODD_TWIDDLE_3, twiddled_ds, ds5);
            ds7 = AvxStoreF::f32_mul_add(-f32::R9_ODD_TWIDDLE_0, twiddled_ds, ds7);
        }

        {
            let c_forward =
                AvxStoreF::load_n::<N>(unsafe { c_buffer.get_unchecked(self.q_modules * 3 + k..) });
            let s_forward = AvxStoreF::load_n::<N>(unsafe {
                s_buffer.get_unchecked(self.q_modules * 4 - k - (N - 1)..)
            })
            .reverse_n::<N>();

            let rotation_twiddle_re = unsafe { *self.rotation_layer.get_unchecked(uk + 6) };
            let rotation_twiddle_im = unsafe { *self.rotation_layer.get_unchecked(uk + 7) };

            let twiddle_re = unsafe { *self.cos_twiddles.get_unchecked(uk + 6) };
            let twiddle_im = unsafe { *self.cos_twiddles.get_unchecked(uk + 7) };

            let rotated_dc1 = fma(s_forward, rotation_twiddle_re, c_forward);
            let rotated_ds2 = fma(c_forward, rotation_twiddle_im, s_forward);

            let twiddled_dc = twiddle_re * rotated_dc1;
            let twiddled_ds = twiddle_im * rotated_ds2;

            dc0 = twiddled_dc + dc0;
            dc2 = AvxStoreF::f32_mul_add(f32::R9_EVEN_TWIDDLE_2, twiddled_dc, dc2);
            dc4 = AvxStoreF::f32_mul_add(f32::R9_EVEN_TWIDDLE_1, twiddled_dc, dc4);
            dc6 = AvxStoreF::f32_mul_add(-f32::HALF, twiddled_dc, dc6);
            dc8 = AvxStoreF::f32_mul_add(f32::R9_EVEN_TWIDDLE_0, twiddled_dc, dc8);

            ds1 = AvxStoreF::f32_mul_add(f32::R9_ODD_TWIDDLE_3, twiddled_ds, ds1);
            ds3 = AvxStoreF::f32_mul_add(f32::R9_ODD_TWIDDLE_1, twiddled_ds, ds3);
            ds5 = AvxStoreF::f32_mul_add(f32::R9_ODD_TWIDDLE_0, twiddled_ds, ds5);
            ds7 = AvxStoreF::f32_mul_add(f32::R9_ODD_TWIDDLE_2, twiddled_ds, ds7);
        }

        let a0 = AvxStoreF::load_n::<N>(unsafe { a_buffer.get_unchecked(k..) });
        let dc = dc0 + a0;

        dc2 = -(dc2 + a0);
        dc4 += a0;
        dc6 += a0;
        dc8 += a0;

        dc.write_n::<N>(data.slice_from_mut(k..));

        let dss1 = AvxStoreF::f32_mul_add(2., ds1, -dc);
        dss1.reverse_n::<N>()
            .write_n::<N>(data.slice_from_mut(self.q_modules * 2 - k - (N - 1)..));

        dc2 = AvxStoreF::f32_mul_add(2., dc2, -dss1);
        dc2.write_n::<N>(data.slice_from_mut(self.q_modules * 2 + k..));

        let dss3 = AvxStoreF::f32_mul_add(2., -ds3, -dc2);
        dss3.reverse_n::<N>()
            .write_n::<N>(data.slice_from_mut(self.q_modules * 4 - k - (N - 1)..));

        let mdc4 = AvxStoreF::f32_mul_add(2., dc4, -dss3);
        mdc4.write_n::<N>(data.slice_from_mut(self.q_modules * 4 + k..));

        let dss5 = AvxStoreF::f32_mul_add(2., ds5, -mdc4);
        dss5.reverse_n::<N>()
            .write_n::<N>(data.slice_from_mut(self.q_modules * 6 - k - (N - 1)..));

        dc6 = AvxStoreF::f32_mul_add(2., -dc6, -dss5);
        dc6.write_n::<N>(data.slice_from_mut(self.q_modules * 6 + k..));

        let dss6 = AvxStoreF::f32_mul_add(2., -ds7, -dc6);
        dss6.reverse_n::<N>()
            .write_n::<N>(data.slice_from_mut(self.q_modules * 8 - k - (N - 1)..));

        dc8 = AvxStoreF::f32_mul_add(2., dc8, -dss6);
        dc8.write_n::<N>(data.slice_from_mut(self.q_modules * 8 + k..));
    }

    #[inline]
    #[target_feature(enable = "avx2", enable = "fma")]
    fn execute_store<S: BidirectionalStore<f32>>(
        &self,
        data: &mut S,
        scratch: &mut [f32],
    ) -> Result<(), PxdctError> {
        let (scratch, inner_scratch) = scratch.split_at_mut(self.execution_length);

        let q_modules = self.execution_length / 9;
        let (a_buffer, c_s_buffer) = scratch.split_at_mut(q_modules);
        let (c_buffer, s_buffer) = c_s_buffer.split_at_mut(q_modules * 4);

        // Step 1: Decompose input into A (center), C (even-symmetric), S (odd-symmetric) buffers
        for (n, dst) in a_buffer.iter_mut().enumerate() {
            *dst = data[n * 9 + 4];
        }

        // Extract and combine symmetric pairs with sign alternation for S buffer
        for (m, (c_buffer, s_buffer)) in c_buffer
            .chunks_exact_mut(q_modules)
            .zip(s_buffer.chunks_exact_mut(q_modules))
            .enumerate()
        {
            let mut sign = f32::one();
            for (n, (c_dst, s_dst)) in c_buffer.iter_mut().zip(s_buffer.iter_mut()).enumerate() {
                let u0 = data[9 * n + m];
                let u1 = data[9 * n + 9 - m - 1];

                *c_dst = u0 + u1;
                *s_dst = (u0 - u1).mulsign(sign);

                sign = -sign;
            }
        }

        // Step 2: Apply DCT-II to all buffers (A, C₀, C₁, S₀, S₁)
        self.inner_dct
            .execute_with_scratch(scratch, inner_scratch)?;

        let (a_buffer, c_s_buffer) = scratch.split_at_mut(q_modules);
        let (c_buffer, s_buffer) = c_s_buffer.split_at_mut(q_modules * 4);

        {
            // Step 3: Recombine transformed buffers with twiddle factors

            // Handle k=0 case (DC and low frequencies)
            let qc = c_buffer[0];
            let mut c0 = qc; // Component C₀ (position 0)
            let mut c1 = qc * f32::R9_EVEN_TWIDDLE_0; // Component C₂ (position 2, uses j=2)
            let mut c2 = qc * f32::R9_EVEN_TWIDDLE_2; // Component C₄ (position 4, uses j=4)
            let mut c3 = qc * -f32::HALF; // Component C6 (position 6, uses j=6)
            let mut c4 = qc * f32::R9_EVEN_TWIDDLE_1; // Component C8 (position 8, uses j=8)

            let s0_twiddled = s_buffer[0];

            let mut s0 = s0_twiddled * f32::R9_ODD_TWIDDLE_0;
            let mut s1 = s0_twiddled * -f32::R9_ODD_TWIDDLE_1;
            let mut s2 = s0_twiddled * f32::R9_ODD_TWIDDLE_2;
            let mut s3 = s0_twiddled * -f32::R9_ODD_TWIDDLE_3;

            let ci = unsafe { *c_buffer.get_unchecked(q_modules) };
            let si = unsafe { *s_buffer.get_unchecked(q_modules) };

            let ci2 = unsafe { *c_buffer.get_unchecked(q_modules * 2) };
            let si2 = unsafe { *s_buffer.get_unchecked(q_modules * 2) };

            let ci3 = unsafe { *c_buffer.get_unchecked(q_modules * 3) };
            let si3 = unsafe { *s_buffer.get_unchecked(q_modules * 3) };

            c0 = ci + c0 + ci2 + ci3;

            let a0 = a_buffer[0];

            let dc = c0 + a0;
            data[0] = dc;

            c1 = fma(ci, -f32::HALF, c1);
            c1 = fma(ci2, f32::R9_EVEN_TWIDDLE_1, c1);
            c1 = fma(ci3, f32::R9_EVEN_TWIDDLE_2, c1);

            c2 = fma(ci, -f32::HALF, c2);
            c2 = fma(ci2, f32::R9_EVEN_TWIDDLE_0, c2);
            c2 = fma(ci3, f32::R9_EVEN_TWIDDLE_1, c2);

            let dc2 = c2 + a0;
            data[q_modules * 4] = dc2;

            c3 += ci;
            c3 = fma(ci2, -f32::HALF, c3);
            c3 = fma(ci3, -f32::HALF, c3);

            let dc3 = c3 + a0;
            data[q_modules * 6] = -dc3;

            c4 = fma(ci, -f32::HALF, c4);
            c4 = fma(ci2, f32::R9_EVEN_TWIDDLE_2, c4);
            c4 = fma(ci3, f32::R9_EVEN_TWIDDLE_0, c4);

            let dc4 = c4 + a0;
            data[q_modules * 8] = dc4;

            s0 = fma(si, f32::R9_ODD_TWIDDLE_1, s0);
            s0 = fma(si2, f32::R9_ODD_TWIDDLE_2, s0);
            s0 = fma(si3, f32::R9_ODD_TWIDDLE_3, s0);

            s1 = fma(si2, f32::R9_ODD_TWIDDLE_1, s1);
            s1 = fma(si3, f32::R9_ODD_TWIDDLE_1, s1);

            s2 = fma(si, -f32::R9_ODD_TWIDDLE_1, s2);
            s2 = fma(si2, -f32::R9_ODD_TWIDDLE_3, s2);
            s2 = fma(si3, f32::R9_ODD_TWIDDLE_0, s2);

            s3 = fma(si, f32::R9_ODD_TWIDDLE_1, s3);
            s3 = fma(si2, -f32::R9_ODD_TWIDDLE_0, s3);
            s3 = fma(si3, f32::R9_ODD_TWIDDLE_2, s3);

            data[q_modules * 3] = -s1;
            data[q_modules] = s0;

            let qid2 = -(c1 + a0); // negated 2j
            data[q_modules * 2] = qid2;
            data[q_modules * 5] = s2;
            data[q_modules * 7] = -s3;

            let mut k = 1usize;
            let mut uk = 0usize;
            while k + 8 <= q_modules {
                self.exec_block::<S, 8>(data, a_buffer, s_buffer, c_buffer, uk, k);

                k += 8;
                uk += 8;
            }

            let rem = q_modules - k;
            if rem == 7 {
                self.exec_block::<S, 7>(data, a_buffer, s_buffer, c_buffer, uk, k);
            } else if rem == 6 {
                self.exec_block::<S, 6>(data, a_buffer, s_buffer, c_buffer, uk, k);
            } else if rem == 5 {
                self.exec_block::<S, 5>(data, a_buffer, s_buffer, c_buffer, uk, k);
            } else if rem == 4 {
                self.exec_block::<S, 4>(data, a_buffer, s_buffer, c_buffer, uk, k);
            } else if rem == 3 {
                self.exec_block::<S, 3>(data, a_buffer, s_buffer, c_buffer, uk, k);
            } else if rem == 2 {
                self.exec_block::<S, 2>(data, a_buffer, s_buffer, c_buffer, uk, k);
            } else if rem == 1 {
                self.exec_block::<S, 1>(data, a_buffer, s_buffer, c_buffer, uk, k);
            }
        }
        Ok(())
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::Pxdct;
    use crate::tests::naive_dct2_f32;
    use crate::util::has_valid_avx;

    #[test]
    fn test_radix9_dct() {
        if !has_valid_avx() {
            return;
        }
        let mut input = vec![0.; 9 * 11];
        for (i, z) in input.iter_mut().enumerate() {
            *z = i as f32 + rand::random::<f32>() * 10.0;
        }
        // let mut input = vec![
        //     7.6871257, 1.2637726, 11.096954, 4.113755, 6.3156953, 12.343984, 9.859292, 15.516256,
        //     12.010594, 7.6871257, 1.2637726, 11.096954, 4.113755, 6.3156953, 12.343984, 9.859292,
        //     15.516256, 12.010594, 7.6871257, 1.2637726, 11.096954, 4.113755, 6.3156953, 12.343984,
        //     9.859292, 15.516256, 12.010594,
        // ];
        let mut reference_input = input.clone();
        // let rr = Pxdcf32::make_dct2_f32(25).unwrap();
        // rr.execute(&mut reference_input).unwrap();
        reference_input = naive_dct2_f32(&reference_input);
        let bf =
            AvxDct2MixedRadix9f::new(input.len(), Pxdct::make_dct2_f32(input.len() / 9).unwrap())
                .unwrap();
        bf.execute(&mut input).unwrap();
        println!(
            "{:?}",
            input
                .iter()
                .enumerate()
                .map(|(i, x)| format!("({i}) {}", x))
                .collect::<Vec<_>>()
        );
        println!(
            "{:?}",
            reference_input
                .iter()
                .enumerate()
                .map(|(i, x)| format!("({i}) {}", x))
                .collect::<Vec<_>>()
        );
        input
            .iter()
            .zip(reference_input.iter())
            .enumerate()
            .for_each(|(i, (&src, &r0))| {
                if (src - r0).abs() > 1e-1 {
                    println!(
                        "Difference must be < {}, but it was {}, at position {i}",
                        1e-1,
                        (src - r0).abs()
                    )
                }
            });
    }
}