primal-barracuda 0.4.0

barraCuda — BARrier-free Rust Abstracted Cross-platform Unified Dimensional Algebra. Vendor-agnostic GPU compute via WGSL.
Documentation
// SPDX-License-Identifier: AGPL-3.0-or-later
//! ISTFT - Inverse Short-Time Fourier Transform
//!
//! Reconstructs time-domain signal from STFT.
//! Uses overlap-add method.
//!
//! Deep Debt Principles:
//! - Self-knowledge: Operation knows its computation
//! - Zero hardcoding: Hardware-agnostic implementation
//! - Modern idiomatic Rust: Safe, zero unsafe code
//! - Complete implementation: Production-ready, no mocks
//! - Hardware-agnostic: Pure WGSL for universal compute

use crate::device::{DeviceCapabilities, WorkloadType};
use crate::error::{BarracudaError, Result};
use crate::tensor::Tensor;

/// f64 is the canonical source — math is universal, precision is silicon.
static SHADER_F64: &str = include_str!("../shaders/audio/istft_f64.wgsl");
static SHADER_F32: std::sync::LazyLock<String> =
    std::sync::LazyLock::new(|| SHADER_F64.to_string());

/// ISTFT operation
pub struct ISTFT {
    stft_data: Tensor, // Complex STFT [real, imag, real, imag, ...]
    window: Tensor,
    n_fft: usize,
    hop_length: usize,
    num_frames: usize,
}

impl ISTFT {
    /// Create a new ISTFT operation
    ///
    /// # Errors
    ///
    /// Returns [`Err`] if buffer allocation, GPU dispatch, or buffer
    /// readback fails (e.g. device lost or out of memory).
    pub fn new(
        stft_data: Tensor,
        window: Tensor,
        n_fft: usize,
        hop_length: usize,
        num_frames: usize,
    ) -> Result<Self> {
        // Validate window length
        let window_size: usize = window.shape().iter().product();
        if window_size != n_fft {
            return Err(BarracudaError::InvalidInput {
                message: format!("Window length ({window_size}) must match n_fft ({n_fft})"),
            });
        }

        // Validate STFT data size
        let stft_size: usize = stft_data.shape().iter().product();
        let bins_per_frame = n_fft / 2 + 1;
        let expected_size = num_frames * bins_per_frame * 2; // Complex pairs
        if stft_size != expected_size {
            return Err(BarracudaError::InvalidInput {
                message: format!(
                    "STFT data size ({stft_size}) must equal num_frames * bins_per_frame * 2 ({expected_size})"
                ),
            });
        }

        // Ensure same device
        if !std::ptr::eq(stft_data.device().as_ref(), window.device().as_ref()) {
            return Err(BarracudaError::InvalidInput {
                message: "STFT data and window must be on the same device".to_string(),
            });
        }

        Ok(Self {
            stft_data,
            window,
            n_fft,
            hop_length,
            num_frames,
        })
    }

    /// Get the WGSL shader source
    fn wgsl_shader() -> &'static str {
        &SHADER_F32
    }

    /// Execute the ISTFT operation
    ///
    /// # Errors
    ///
    /// Returns [`Err`] if buffer allocation, GPU dispatch, or buffer
    /// readback fails (e.g. device lost or out of memory).
    pub fn execute(self) -> Result<Tensor> {
        let device = self.stft_data.device();
        let bins_per_frame = self.n_fft / 2 + 1;
        let output_length = (self.num_frames - 1) * self.hop_length + self.n_fft;

        // Access input buffers directly (zero-copy)
        let stft_buffer = self.stft_data.buffer();
        let window_buffer = self.window.buffer();

        // Create output buffer
        let output_buffer = device.create_buffer_f32(output_length)?;

        // Create window_sum buffer for normalization
        let window_sum_buffer = device.create_buffer_f32(output_length)?;

        // Create uniform buffer for parameters
        #[repr(C)]
        #[derive(Copy, Clone, bytemuck::Pod, bytemuck::Zeroable)]
        struct Params {
            num_frames: u32,
            n_fft: u32,
            hop_length: u32,
            bins_per_frame: u32,
            output_length: u32,
        }

        let params = Params {
            num_frames: self.num_frames as u32,
            n_fft: self.n_fft as u32,
            hop_length: self.hop_length as u32,
            bins_per_frame: bins_per_frame as u32,
            output_length: output_length as u32,
        };

        let params_buffer = device
            .device
            .create_buffer_init(&wgpu::util::BufferInitDescriptor {
                label: Some("ISTFT Params"),
                contents: bytemuck::cast_slice(&[params]),
                usage: wgpu::BufferUsages::UNIFORM | wgpu::BufferUsages::COPY_DST,
            });

        // Compile shader
        let shader_module = device.compile_shader(Self::wgsl_shader(), Some("ISTFT Shader"));

        // Create bind group layout
        let bind_group_layout =
            device
                .device
                .create_bind_group_layout(&wgpu::BindGroupLayoutDescriptor {
                    label: Some("ISTFT Bind Group Layout"),
                    entries: &[
                        wgpu::BindGroupLayoutEntry {
                            binding: 0,
                            visibility: wgpu::ShaderStages::COMPUTE,
                            ty: wgpu::BindingType::Buffer {
                                ty: wgpu::BufferBindingType::Storage { read_only: true },
                                has_dynamic_offset: false,
                                min_binding_size: None,
                            },
                            count: None,
                        },
                        wgpu::BindGroupLayoutEntry {
                            binding: 1,
                            visibility: wgpu::ShaderStages::COMPUTE,
                            ty: wgpu::BindingType::Buffer {
                                ty: wgpu::BufferBindingType::Storage { read_only: true },
                                has_dynamic_offset: false,
                                min_binding_size: None,
                            },
                            count: None,
                        },
                        wgpu::BindGroupLayoutEntry {
                            binding: 2,
                            visibility: wgpu::ShaderStages::COMPUTE,
                            ty: wgpu::BindingType::Buffer {
                                ty: wgpu::BufferBindingType::Storage { read_only: false },
                                has_dynamic_offset: false,
                                min_binding_size: None,
                            },
                            count: None,
                        },
                        wgpu::BindGroupLayoutEntry {
                            binding: 3,
                            visibility: wgpu::ShaderStages::COMPUTE,
                            ty: wgpu::BindingType::Buffer {
                                ty: wgpu::BufferBindingType::Storage { read_only: false },
                                has_dynamic_offset: false,
                                min_binding_size: None,
                            },
                            count: None,
                        },
                        wgpu::BindGroupLayoutEntry {
                            binding: 4,
                            visibility: wgpu::ShaderStages::COMPUTE,
                            ty: wgpu::BindingType::Buffer {
                                ty: wgpu::BufferBindingType::Uniform,
                                has_dynamic_offset: false,
                                min_binding_size: None,
                            },
                            count: None,
                        },
                    ],
                });

        // Create bind group
        let bind_group = device.device.create_bind_group(&wgpu::BindGroupDescriptor {
            label: Some("ISTFT Bind Group"),
            layout: &bind_group_layout,
            entries: &[
                wgpu::BindGroupEntry {
                    binding: 0,
                    resource: stft_buffer.as_entire_binding(),
                },
                wgpu::BindGroupEntry {
                    binding: 1,
                    resource: window_buffer.as_entire_binding(),
                },
                wgpu::BindGroupEntry {
                    binding: 2,
                    resource: output_buffer.as_entire_binding(),
                },
                wgpu::BindGroupEntry {
                    binding: 3,
                    resource: window_sum_buffer.as_entire_binding(),
                },
                wgpu::BindGroupEntry {
                    binding: 4,
                    resource: params_buffer.as_entire_binding(),
                },
            ],
        });

        // Create compute pipeline
        let pipeline_layout =
            device
                .device
                .create_pipeline_layout(&wgpu::PipelineLayoutDescriptor {
                    label: Some("ISTFT Pipeline Layout"),
                    bind_group_layouts: &[&bind_group_layout],
                    immediate_size: 0,
                });

        let compute_pipeline =
            device
                .device
                .create_compute_pipeline(&wgpu::ComputePipelineDescriptor {
                    label: Some("ISTFT Pipeline"),
                    layout: Some(&pipeline_layout),
                    module: &shader_module,
                    entry_point: Some("main"),
                    cache: None,
                    compilation_options: Default::default(),
                });

        // Note: ISTFT requires atomic operations for overlap-add which WGSL doesn't support for f32
        // This is a simplified version. For full implementation, we'd need to use a different approach
        // such as processing frames sequentially or using a reduction pass.

        // Execute compute shader
        let mut encoder = device.create_encoder_guarded(&wgpu::CommandEncoderDescriptor {
            label: Some("ISTFT Encoder"),
        });

        {
            let mut compute_pass = encoder.begin_compute_pass(&wgpu::ComputePassDescriptor {
                label: Some("ISTFT Pass"),
                timestamp_writes: None,
            });
            compute_pass.set_pipeline(&compute_pipeline);
            compute_pass.set_bind_group(0, Some(&bind_group), &[]);
            // Deep Debt Evolution: Capability-based dispatch
            let caps = DeviceCapabilities::from_device(device);
            let optimal_wg_size = caps.optimal_workgroup_size(WorkloadType::MatMul);
            let workgroups = (self.num_frames as u32).div_ceil(optimal_wg_size);
            compute_pass.dispatch_workgroups(workgroups, 1, 1);
        }

        device.submit_commands(Some(encoder.finish()));

        // Output shape: [output_length]
        let output_shape = vec![output_length];

        // Return tensor without reading back (zero-copy)
        // Note: This implementation is simplified. Full ISTFT would require
        // additional normalization pass or atomic operations.
        Ok(Tensor::from_buffer(
            output_buffer,
            output_shape,
            device.clone(),
        ))
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    use crate::ops::window_function::{WindowFunction, WindowType};
    #[expect(unused_imports, reason = "conditional imports")]
    use std::sync::Arc;

    #[tokio::test]
    async fn test_istft_basic() {
        let device = crate::device::test_pool::get_test_device().await;
        // Create complex STFT data: [real, imag, real, imag, ...]
        let bins_per_frame = 257;
        let num_frames = 5;
        let stft_data = Tensor::from_vec_on(
            vec![1.0; num_frames * bins_per_frame * 2],
            vec![num_frames, bins_per_frame, 2],
            device.clone(),
        )
        .await
        .unwrap();
        let window = WindowFunction::new(512, WindowType::Rectangular, device.clone())
            .unwrap()
            .execute()
            .unwrap();

        let output = ISTFT::new(stft_data, window, 512, 256, num_frames)
            .unwrap()
            .execute()
            .unwrap();
        assert!(output.shape()[0] > 0);
    }
}