gpu_neural_model.hpp

Go to the documentation of this file.

#pragma once
 
#include <cstdint>
#include <span>
#include <string_view>
 
#include <pulp/gpu_audio/gpu_neural_realtime_node.hpp>
#include <pulp/gpu_audio/gpu_wavenet.hpp>
 
namespace pulp::gpu_audio {

struct GpuNeuralCpuKernel {
    void* state = nullptr;
    bool (*prepare)(void* state) noexcept = nullptr;
    void (*process)(void* state, const float* input, float* output,
                    std::uint32_t frames) noexcept = nullptr;
    void (*reset)(void* state) noexcept = nullptr;
};

struct GpuNeuralModelManifest {
    std::string_view model_id{};
    std::string_view architecture{};
    std::string_view model_version{};
    std::string_view artifact_id{};
    std::string_view artifact_sha256{};
    std::string_view license{};
    std::string_view runtime{};
    std::uint64_t artifact_size_bytes = 0;
    std::uint32_t sample_rate_hz = 0;
    bool redistributable = false;
    bool local_research = false;
};

struct GpuNeuralModelShape {
    std::uint32_t tcn_kernel_size = 0;
    std::uint32_t tcn_dilation = 0;
    std::uint32_t recurrent_hidden_size = 0;
    std::uint32_t ssm_state_size = 0;
};
 
struct GpuNeuralModelRequest {
    NeuralFamily family = NeuralFamily::Unknown;
    GpuNeuralModelManifest manifest{};
    GpuNeuralModelShape shape{};
    std::uint32_t block_size = 0;
    std::span<const GpuNeuralCpuKernel> channel_kernels{};
    const GpuWaveNetSession::Config* wavenet_gpu = nullptr;
    std::uint32_t gpu_max_inflight = 0;
};
 
enum class GpuNeuralModelError : std::uint8_t {
    None,
    UnsupportedFamily,
    InvalidManifest,
    InvalidBlockSize,
    MissingKernels,
    ShapeMismatch,
    UnsupportedBackend,
    AllocationFailed,
};
 
struct GpuNeuralModelResult {
    GpuNeuralModelHandle model;
    GpuNeuralModelError error = GpuNeuralModelError::None;
    explicit operator bool() const noexcept {
        return model != nullptr && error == GpuNeuralModelError::None;
    }
};

GpuNeuralModelResult make_gpu_neural_model(const GpuNeuralModelRequest& request) noexcept;
 
} // namespace pulp::gpu_audio