canonical_pcm.hpp

Go to the documentation of this file.

#pragma once

 
#include <pulp/authoring_capsule/status.hpp>
#include <pulp/runtime/result.hpp>
 
#include <cstddef>
#include <cstdint>
#include <span>
#include <string>
#include <vector>
 
namespace pulp::authoring_capsule {
 
inline constexpr std::uint32_t kMinCanonicalSampleRate = 8000;
inline constexpr std::uint32_t kMaxCanonicalSampleRate = 192000;
inline constexpr std::uint32_t kMaxCanonicalChannels = 2;

inline constexpr std::uint32_t kCanonicalPcmDecoderVersion = 1;

inline constexpr char kCanonicalPcmMagic[8] = {'p', 'u', 'l', 'p', '.', 'p', 'c', 'm'};

inline constexpr std::size_t kCanonicalPcmHeaderBytes = 28;
 
struct CanonicalPcm {
    std::uint32_t channels = 0;
    std::uint32_t sample_rate = 0;
    std::uint64_t frame_count = 0;
    std::vector<float> samples;
};

runtime::Result<CanonicalPcm, CapsuleError> decode_to_canonical(std::span<const std::uint8_t> source);

std::vector<std::uint8_t> to_canonical_bytes(const CanonicalPcm& pcm);

runtime::Result<CanonicalPcm, CapsuleError> from_canonical_bytes(std::span<const std::uint8_t> bytes);

std::string canonical_pcm_digest(const CanonicalPcm& pcm);

runtime::Result<void, CapsuleError> validate_canonical(const CanonicalPcm& pcm);
 
}  // namespace pulp::authoring_capsule