db/dce/saudio_8hpp_source.html

#pragma once


#include <filesystem>


#include "NNL/common/fixed_type.hpp"

#include "NNL/common/io.hpp"


namespace nnl {


struct SAudio {

  std::string name;


  u32 sample_rate = 0;


  u16 num_channels = 1;


  std::vector<i16> pcm;


  [[nodiscard]] static SAudio Import(const std::filesystem::path& path);


  [[nodiscard]] static SAudio Import(BufferView buffer);


  void ExportWAV(const std::filesystem::path& path) const;


  [[nodiscard]] Buffer ExportWAV() const;


  void ToMono();

};


}  // namespace nnl

fixed_type.hpp
Contains macros and definitions for fixed-width types.

nnl::u16
std::uint16_t u16
16-bit unsigned integer
Definition fixed_type.hpp:62

nnl::u32
std::uint32_t u32
32-bit unsigned integer
Definition fixed_type.hpp:60

nnl::BufferView
Reader implementation for read-only memory buffers.
Definition io.hpp:598

nnl::Buffer
std::vector< u8 > Buffer
A type alias for std::vector<u8> that denotes a raw, contiguous memory region that may be interpreted...
Definition io.hpp:40

nnl::SAudio::Import
static SAudio Import(BufferView buffer)
Constructs an audio asset from a WAV file in the buffer.

nnl::SAudio::ToMono
void ToMono()
Converts stereo audio to mono.

nnl::SAudio::pcm
std::vector< i16 > pcm
The PCM audio data stored as 16-bit samples.
Definition saudio.hpp:45

nnl::SAudio::Import
static SAudio Import(const std::filesystem::path &path)
Constructs an audio asset from a WAV file located at the specified file path.

nnl::SAudio::ExportWAV
Buffer ExportWAV() const
Exports the audio data to a WAV file.

nnl::SAudio::sample_rate
u32 sample_rate
The sample rate of the audio (per second)
Definition saudio.hpp:41

nnl::SAudio::num_channels
u16 num_channels
The number of audio channels (1 for mono, 2 for stereo).
Definition saudio.hpp:43

nnl::SAudio::ExportWAV
void ExportWAV(const std::filesystem::path &path) const
Exports the audio data to a WAV file.

nnl::SAudio::name
std::string name
An optional name of the audio asset.
Definition saudio.hpp:39

nnl::SAudio
Represents a simple audio asset.
Definition saudio.hpp:38

io.hpp
Provides classes for reading and writing binary data to and from various sources.

nnl
Definition exception.hpp:56