|
MayaFlux 1.0.0
Digital-First Multimedia Processing Framework
|
Runs a compute shader over one audio block on the GPU. More...
#include <AudioComputeProcessor.hpp>
Public Member Functions | |
| AudioComputeProcessor (const Portal::Graphics::ShaderSpec &spec, bool native_f64) | |
| AudioComputeProcessor (const std::string &shader_path, bool native_f64, uint32_t workgroup_x=256) | |
| bool | is_compatible_with (const std::shared_ptr< Buffer > &buffer) const override |
| Checks if this processor can handle the specified buffer type. | |
| bool | is_native_f64 () const |
| void | on_attach (const std::shared_ptr< Buffer > &buffer) override |
| Called when this processor is attached to a buffer. | |
| void | on_detach (const std::shared_ptr< Buffer > &buffer) override |
| Called when this processor is detached from a buffer. | |
| void | processing_function (const std::shared_ptr< Buffer > &buffer) override |
| The core processing function that must be implemented by derived classes. | |
| Public Member Functions inherited from MayaFlux::Buffers::ComputeProcessor | |
| ComputeProcessor (const Portal::Graphics::ShaderSpec &spec) | |
| Construct processor from a generated ShaderSpec. | |
| ComputeProcessor (const std::string &shader_path, uint32_t workgroup_x=256) | |
| Construct processor with shader path. | |
| const ShaderDispatchConfig & | get_dispatch_config () const |
| Get current dispatch configuration. | |
| uint32_t | get_iteration_count () const |
| Dispatches recorded per execute cycle. | |
| bool | is_pipeline_ready () const |
| Check if pipeline is created. | |
| void | set_custom_dispatch (std::function< std::array< uint32_t, 3 >(const std::shared_ptr< VKBuffer > &)> calculator) |
| Set custom dispatch calculator. | |
| void | set_dispatch_mode (ShaderDispatchConfig::DispatchMode mode) |
| Set dispatch mode. | |
| void | set_iteration_count (uint32_t count) |
| Set how many dispatches are recorded per execute cycle. | |
| void | set_manual_dispatch (uint32_t x, uint32_t y=1, uint32_t z=1) |
| Set manual dispatch group counts. | |
| void | set_workgroup_size (uint32_t x, uint32_t y=1, uint32_t z=1) |
| Set workgroup size (should match shader local_size). | |
| ~ComputeProcessor () override | |
| Public Member Functions inherited from MayaFlux::Buffers::ShaderProcessor | |
| void | add_binding (const std::string &descriptor_name, const ShaderBinding &binding) |
| Add descriptor binding configuration. | |
| bool | are_bindings_complete () const |
| Check if all required bindings are satisfied. | |
| bool | are_descriptors_ready () const |
| Check if descriptors are initialized. | |
| void | auto_bind_buffer (const std::shared_ptr< VKBuffer > &buffer) |
| Auto-bind buffer based on attachment order. | |
| void | bind_buffer (const std::string &descriptor_name, const std::shared_ptr< VKBuffer > &buffer) |
| Bind a VKBuffer to a named shader descriptor. | |
| void | clear_specialization_constants () |
| Clear all specialization constants. | |
| template<typename T> | |
| bool | download_bound (const std::string &descriptor_name, std::vector< T > &data) const |
| bool | download_bound (const std::string &descriptor_name, void *data, size_t size, const std::shared_ptr< VKBuffer > &staging=nullptr) const |
| Download the buffer currently bound to a named descriptor. | |
| void | feed (const std::string &name, FeedSource source) |
| Supply a shader input from a callable, resolved by name. | |
| void | feed (const std::string &name, FeedSource source, uint32_t offset, size_t size=sizeof(float), bool early=true) |
| Supply a push constant from a callable at an explicit offset. | |
| std::vector< std::string > | get_binding_names () const |
| Get all configured descriptor names. | |
| std::shared_ptr< VKBuffer > | get_bound_buffer (const std::string &descriptor_name) const |
| Get bound buffer for a descriptor name. | |
| size_t | get_bound_buffer_count () const |
| Get number of bound buffers. | |
| virtual BufferUsageHint | get_buffer_usage_hint (const std::string &descriptor_name) const |
| Get buffer usage hint for a descriptor. | |
| const ShaderConfig & | get_config () const |
| Get current configuration. | |
| std::vector< std::string > | get_feed_names () const |
| Names of every registered feed. | |
| virtual std::shared_ptr< VKBuffer > | get_output_buffer () const |
| Get the output buffer after compute dispatch. | |
| std::vector< uint8_t > & | get_push_constant_data () |
| const std::vector< uint8_t > & | get_push_constant_data () const |
| Get current push constant data. | |
| const std::string & | get_shader_path () const |
| Get current shader path. | |
| bool | has_binding (const std::string &descriptor_name) const |
| Check if a descriptor binding exists. | |
| virtual bool | has_executed () const |
| Check if compute has been executed at least once. | |
| bool | has_feed (const std::string &name) const |
| Whether a feed of this name is registered. | |
| bool | hot_reload_shader () |
| Hot-reload shader from ShaderFoundry. | |
| bool | is_compatible_with (const std::shared_ptr< Buffer > &buffer) const override |
| Checks if this processor can handle the specified buffer type. | |
| bool | is_deferred_submission () const |
| Whether this processor submits asynchronously. | |
| bool | is_dispatch_pending () const |
| True while an asynchronous submission is outstanding. | |
| virtual bool | is_in_place_operation (const std::string &descriptor_name) const |
| Check if shader modifies a specific buffer in-place. | |
| bool | is_shader_loaded () const |
| Check if shader is loaded. | |
| void | on_attach (const std::shared_ptr< Buffer > &buffer) override |
| Called when this processor is attached to a buffer. | |
| void | on_detach (const std::shared_ptr< Buffer > &buffer) override |
| Called when this processor is detached from a buffer. | |
| void | processing_function (const std::shared_ptr< Buffer > &buffer) override |
| The core processing function that must be implemented by derived classes. | |
| void | remove_feed (const std::string &name) |
| Remove a feed. | |
| bool | resolve_pending_dispatch (bool block) |
| Resolve an outstanding asynchronous submission. | |
| void | set_config (const ShaderConfig &config) |
| Update entire configuration. | |
| void | set_deferred_submission (bool deferred) |
| Submit asynchronously and resolve at the top of a later cycle. | |
| template<typename T> | |
| void | set_push_constant_data (const T &data) |
| Update push constant data (type-safe). | |
| virtual void | set_push_constant_data_raw (const void *data, size_t size) |
| Update push constant data (raw bytes). | |
| template<typename T> | |
| void | set_push_constant_size () |
| Set push constant size from type. | |
| void | set_push_constant_size (size_t size) |
| Set push constant size. | |
| void | set_shader (const std::string &shader_path) |
| Update shader path and reload. | |
| void | set_specialization_constant (uint32_t constant_id, uint32_t value) |
| Set specialization constant. | |
| ShaderProcessor (const std::string &shader_path) | |
| Construct processor with shader path. | |
| ShaderProcessor (ShaderConfig config) | |
| Construct processor with full configuration. | |
| void | unbind_buffer (const std::string &descriptor_name) |
| Unbind a buffer from a descriptor. | |
| ~ShaderProcessor () override | |
| Public Member Functions inherited from MayaFlux::Buffers::BufferProcessor | |
| virtual ProcessingToken | get_processing_token () const |
| Gets the current processing token for this buffer. | |
| void | process (const std::shared_ptr< Buffer > &buffer) |
| Applies a computational transformation to the data in the provided buffer. | |
| virtual void | set_processing_token (ProcessingToken token) |
| Gets the preferred processing backend for this processor. | |
| virtual | ~BufferProcessor ()=default |
| Virtual destructor for proper cleanup of derived classes. | |
Protected Member Functions | |
| std::array< uint32_t, 3 > | calculate_dispatch_size (const std::shared_ptr< VKBuffer > &buffer) override |
| Dispatch size from the block's frame count, not its byte size. | |
| Protected Member Functions inherited from MayaFlux::Buffers::ComputeProcessor | |
| void | cleanup () override |
| virtual void | collect_push_writes (const std::shared_ptr< VKBuffer > &buffer, std::vector< Portal::Graphics::PushDescriptorWrite > &writes) |
| Collect the writes for the push descriptor set, set 0. | |
| void | initialize_descriptors (const std::shared_ptr< VKBuffer > &buffer) override |
| void | initialize_pipeline (const std::shared_ptr< VKBuffer > &buffer) override |
| virtual bool | on_iteration (Portal::Graphics::CommandBufferID cmd_id, const std::shared_ptr< VKBuffer > &buffer, uint32_t index) |
| Called before each iteration's push constants and dispatch. | |
| virtual void | on_iteration_barrier (Portal::Graphics::CommandBufferID cmd_id, const std::shared_ptr< VKBuffer > &buffer, uint32_t index) |
| Called after each iteration except the last. | |
| bool | tracks_pipeline_layout () const override |
| Whether the owner builds its pipeline layout from this processor's bindings, staged descriptors and push range. | |
| Protected Member Functions inherited from MayaFlux::Buffers::ShaderProcessor | |
| virtual void | on_after_execute (Portal::Graphics::CommandBufferID cmd_id, const std::shared_ptr< VKBuffer > &buffer) |
| Called after each process callback. | |
| virtual void | on_before_compile (const std::string &shader_path) |
| Called before shader compilation. | |
| virtual void | on_before_descriptors_create () |
| Called before descriptor sets are created. | |
| virtual bool | on_before_execute (Portal::Graphics::CommandBufferID cmd_id, const std::shared_ptr< VKBuffer > &buffer) |
| Called before each process callback. | |
| virtual void | on_before_pipeline_create (Portal::Graphics::ComputePipelineID pipeline_id) |
| Called before pipeline creation. | |
| virtual void | on_descriptors_created () |
| Called after descriptor sets are created. | |
| virtual void | on_dispatch_complete (const std::shared_ptr< VKBuffer > &buffer) |
| Called once when an asynchronous submission is observed complete. | |
| virtual void | on_pipeline_created (Portal::Graphics::ComputePipelineID pipeline_id) |
| Called after pipeline is created. | |
| virtual void | on_shader_loaded (Portal::Graphics::ShaderID shader_id) |
| Called after shader is loaded. | |
| void | prepare_for (const std::shared_ptr< VKBuffer > &vk_buffer) |
| Creates or rebuilds the shader, pipeline and descriptors that the next dispatch needs. | |
| void | pump_feeds (bool early=true) |
| Pull every feed and write its result. | |
| std::optional< uint32_t > | resolve_ds_index (uint32_t set) const |
| Resolve logical descriptor set index to actual index. | |
| size_t | resolve_push_constant_size (const std::shared_ptr< VKBuffer > &buffer) const |
| Byte width of this processor's push constant block, extended to cover any fragment staged on the buffer. | |
| std::vector< uint8_t > | resolve_push_constants (const std::shared_ptr< VKBuffer > &buffer) const |
| This processor's push constant data with buffer-staged fragments overlaid at their declared offsets. | |
| void | resolve_push_constants_into (std::vector< uint8_t > &out, const std::shared_ptr< VKBuffer > &buffer) const |
resolve_push_constants() written into out, reusing its storage. | |
| void | submit_recorded (Portal::Graphics::CommandBufferID cmd_id, const std::shared_ptr< VKBuffer > &buffer) |
| Submit a recorded command buffer honoring the submission mode. | |
| virtual void | update_descriptors (const std::shared_ptr< VKBuffer > &buffer) |
| virtual bool | waits_on_submit () const |
| Whether a dispatch blocks the host until it has completed. | |
| Protected Member Functions inherited from MayaFlux::Buffers::VKBufferProcessor | |
| void | ensure_initialized (const std::shared_ptr< VKBuffer > &buffer) |
| void | initialize_buffer_service () |
| void | initialize_compute_service () |
Private Member Functions | |
| void | configure () |
| void | process_block (const std::shared_ptr< Buffer > &buffer) |
| void | release (const std::shared_ptr< Buffer > &buffer) |
| void | resize_block (uint32_t frames) |
| void | validate_shader () |
Private Attributes | |
| std::atomic< bool > | m_attached { false } |
| Set on attach, cleared on detach. | |
| std::shared_ptr< VKBuffer > | m_block |
| uint32_t | m_frames {} |
| std::atomic< bool > | m_holds_block { false } |
| True while m_block is allocated and bound. | |
| std::atomic< bool > | m_in_flight { false } |
| Set while processing_function runs on the processing thread. | |
| bool | m_native_f64 {} |
Runs a compute shader over one audio block on the GPU.
Install as the default processor of a child AudioBuffer under AUDIO_PARALLEL. Each cycle the child's samples are written to an owned host-visible storage buffer, bound as "block" at set 0, binding 0. The shader is dispatched synchronously and the result is read back into the child.
A dispatch that does not run leaves the child cleared.
Usage: auto proc = std::make_shared<AudioComputeProcessor>("shaders/gain.comp"); child->set_default_processor(proc);
Definition at line 24 of file AudioComputeProcessor.hpp.