Pulp 1.88.0
Cross-platform audio plugin framework
Loading...
Searching...
No Matches
pulp::gpu_audio::GpuSpectralMaskSession Class Reference

#include <gpu_spectral_mask.hpp>

Classes

struct  Config
struct  CreateResult
struct  Result
struct  Diagnostics

Public Types

enum class  Error { None , InvalidConfig , ProviderUnavailable , PreparationFailed }

Public Member Functions

Diagnostics diagnostics () const
 ~GpuSpectralMaskSession ()
bool prepared () const noexcept
std::uint32_t latency_samples () const noexcept
std::uint64_t epoch () const noexcept
bool submit_hop (std::span< const float > planar, std::uint64_t sequence, std::uint64_t deadline_ns=0) noexcept
bool submit_hop_with_gains (std::span< const float > planar, std::uint64_t sequence, std::span< const float > gains, std::uint64_t deadline_ns=0) noexcept
std::size_t service (std::uint64_t now_ns) noexcept
std::optional< Result > receive (std::span< float > planar) noexcept
bool release () noexcept

Static Public Member Functions

static CreateResult create (const Config &) noexcept
static CreateResult create_with_per_hop_gains (const Config &) noexcept

Member Enumeration Documentation

◆ Error

Enumerator
None 
InvalidConfig 
ProviderUnavailable 
PreparationFailed 

Constructor & Destructor Documentation

◆ ~GpuSpectralMaskSession()

pulp::gpu_audio::GpuSpectralMaskSession::~GpuSpectralMaskSession ( )

Member Function Documentation

◆ create()

CreateResult pulp::gpu_audio::GpuSpectralMaskSession::create ( const Config & )
staticnoexcept

◆ create_with_per_hop_gains()

CreateResult pulp::gpu_audio::GpuSpectralMaskSession::create_with_per_hop_gains ( const Config & )
staticnoexcept

◆ diagnostics()

Diagnostics pulp::gpu_audio::GpuSpectralMaskSession::diagnostics ( ) const

◆ epoch()

std::uint64_t pulp::gpu_audio::GpuSpectralMaskSession::epoch ( ) const
noexcept

◆ latency_samples()

std::uint32_t pulp::gpu_audio::GpuSpectralMaskSession::latency_samples ( ) const
noexcept

◆ prepared()

bool pulp::gpu_audio::GpuSpectralMaskSession::prepared ( ) const
noexcept

◆ receive()

std::optional< Result > pulp::gpu_audio::GpuSpectralMaskSession::receive ( std::span< float > planar)
noexcept

◆ release()

bool pulp::gpu_audio::GpuSpectralMaskSession::release ( )
noexcept

◆ service()

std::size_t pulp::gpu_audio::GpuSpectralMaskSession::service ( std::uint64_t now_ns)
noexcept

◆ submit_hop()

bool pulp::gpu_audio::GpuSpectralMaskSession::submit_hop ( std::span< const float > planar,
std::uint64_t sequence,
std::uint64_t deadline_ns = 0 )
noexcept

◆ submit_hop_with_gains()

bool pulp::gpu_audio::GpuSpectralMaskSession::submit_hop_with_gains ( std::span< const float > planar,
std::uint64_t sequence,
std::span< const float > gains,
std::uint64_t deadline_ns = 0 )
noexcept

The documentation for this class was generated from the following file: