hikogui/main/a00590_source.html

// Copyright Take Vos 2020-2021.

// Distributed under the Boost Software License, Version 1.0.

// (See accompanying file LICENSE_1_0.txt or copy at https://www.boost.org/LICENSE_1_0.txt)


#pragma once


#include "../time/time.hpp"

#include "../utility/utility.hpp"

#include "../macros.hpp"

#include <hikocpu/hikocpu.hpp>

#include <span>


hi_export_module(hikogui.audio.audio_block);


hi_export namespace hi { inline namespace v1 {


hi_export enum class audio_block_state { normal, silent, corrupt };


hi_export class audio_block {

public:

    float **samples;


    std::size_t num_samples;


    std::size_t num_channels;


    int sample_rate;


    int64_t sample_count;


    utc_nanoseconds time_stamp;


    audio_block_state state;

};


}} // namespace hi::inline v1

hi
The HikoGUI namespace.
Definition array_generic.hpp:20

v1
DOXYGEN BUG.
Definition algorithm_misc.hpp:20

hi::audio_block
A block of audio data.
Definition audio_block.hpp:27

hi::v1::audio_block::sample_count
int64_t sample_count
The sample count value for the first sample in the sample buffers.
Definition audio_block.hpp:55

hi::v1::audio_block::sample_rate
int sample_rate
The sample rate this block was taken at.
Definition audio_block.hpp:51

hi::v1::audio_block::num_samples
std::size_t num_samples
Number of samples for each channel in samples.
Definition audio_block.hpp:42

hi::v1::audio_block::num_channels
std::size_t num_channels
Number of channels in samples.
Definition audio_block.hpp:46

hi::v1::audio_block::state
audio_block_state state
The state of the audio block.
Definition audio_block.hpp:73

hi::v1::audio_block::time_stamp
utc_nanoseconds time_stamp
Time point when the sample was at the input or will be at the output of the audio interface.
Definition audio_block.hpp:59

hi::v1::audio_block::samples
float ** samples
A list of pointers to non-interleaved sample buffers.
Definition audio_block.hpp:38

std::size_t