audio_frame2 Class Reference

#include <types.h>

Collaboration diagram for audio_frame2:

Classes
struct	channel

Public Member Functions
	audio_frame2 ()=default
	audio_frame2 (audio_frame2 &&)=default
	audio_frame2 (audio_frame2 const &)=delete
	audio_frame2 (const struct audio_frame *)
	creates audio_frame2 from POD audio_frame
	~audio_frame2 ()=default
void	append (audio_frame2 const &frame)
void	append (int channel, const char *data, size_t length)
void	change_bps (int new_bps)
int	get_bps () const
int	get_channel_count () const
audio_codec_t	get_codec () const
char *	get_data (int channel)
const char *	get_data (int channel) const
size_t	get_data_len () const
size_t	get_data_len (int channel) const
struct audio_desc	get_desc () const
double	get_duration () const
fec_desc const &	get_fec_params (int channel) const
int	get_sample_count () const
int	get_sample_rate () const
int64_t	get_timestamp () const
bool	has_same_prop_as (audio_frame2 const &frame) const
void	init (int nr_channels, audio_codec_t codec, int bps, int sample_rate)
	Initializes audio_frame2 for use. If already initialized, data are dropped.
	operator bool () const
audio_frame2 &	operator= (audio_frame2 &&)=default
audio_frame2 &	operator= (audio_frame2 const &)=delete
void	replace (int channel, size_t offset, const char *data, size_t length)
	replaces portion of data of specified channel. If the size of the channel is not sufficient, it is extended and old data are copied.
bool	resample (audio_frame2_resampler &resampler_state, int new_sample_rate)
std::tuple< bool, audio_frame2 >	resample_fake (audio_frame2_resampler &resampler_state, int new_sample_rate_num, int new_sample_rate_den)
	@ resamples to new sample rate while keeping nominal sample rate intact
void	reserve (size_t len)
void	reset ()
void	resize (int channel, size_t len)
void	set_duration (double duration)
void	set_fec_params (int channel, fec_desc const &)
void	set_timestamp (int64_t ts)

Static Public Member Functions
static audio_frame2	copy_with_bps_change (audio_frame2 const &frame, int new_bps)

Private Member Functions
void	reserve (int channel, size_t len)

Private Attributes
std::vector< channel >	channels
struct audio_desc	desc = {}
	desc.ch_count not set, use channels.size() instead
double	duration = 0.0
	for compressed formats where this cannot be directly determined from samples/sample_rate
int64_t	timestamp = -1

Friends
class	audio_frame2_resampler
class	soxr_resampler
class	speex_resampler

Detailed Description

More versatile than audio_frame

Can hold also compressed audio data. Audio channels are non-interleaved.

Definition at line 144 of file types.h.

Constructor & Destructor Documentation

audio_frame2() [1/4]

audio_frame2::audio_frame2 ( )

default

~audio_frame2()

audio_frame2::~audio_frame2 ( )

default

audio_frame2() [2/4]

audio_frame2::audio_frame2 ( audio_frame2 const & )

delete

audio_frame2() [3/4]

audio_frame2::audio_frame2 ( audio_frame2 && )

default

audio_frame2() [4/4]

audio_frame2::audio_frame2 ( const struct audio_frame * old )

explicit

creates audio_frame2 from POD audio_frame

Definition at line 87 of file types.cpp.

                                                        :
                channels(old ? old->ch_count : 0)
{
        if (old == nullptr) {
                return;
        }
        desc.bps = old->bps;
        desc.sample_rate = old->sample_rate;
        desc.codec = AC_PCM;
        for (int i = 0; i < old->ch_count; i++) {
                resize(i, old->data_len / old->ch_count);
                char *data = channels[i].data.get();
                demux_channel(data, old->data, old->bps, old->data_len,
                              old->ch_count, i);
        }
        if ((old->flags & TIMESTAMP_VALID) != 0) {
                timestamp = old->timestamp;
        }
}

References AC_PCM, audio_desc::bps, audio_frame::bps, audio_frame::ch_count, channels, audio_desc::codec, audio_frame::data, audio_frame::data_len, demux_channel(), desc, audio_frame::flags, resize(), audio_desc::sample_rate, audio_frame::sample_rate, and TIMESTAMP_VALID.

Here is the call graph for this function:

Member Function Documentation

append() [1/2]

void audio_frame2::append

(

audio_frame2 const &

frame

)

Definition at line 125 of file types.cpp.

{
        if (desc.bps != src.desc.bps || desc.sample_rate != src.desc.sample_rate ||
            channels.size() != src.channels.size()) {
                throw std::logic_error(
                    "Trying to append frame with different parameters!");
        }
 
        for (size_t i = 0; i < channels.size(); i++) {
                append(i, src.get_data(i), src.get_data_len(i));
        }
}

References append(), audio_desc::bps, channels, desc, get_data(), get_data_len(), and audio_desc::sample_rate.

Referenced by append(), audio_codec_compress(), audio_codec_decompress(), decode_audio_frame(), decode_audio_frame_mulaw(), rs::encode(), and process_statistics().

Here is the call graph for this function:

append() [2/2]

void audio_frame2::append	(	int	channel,
		const char *	data,
		size_t	length )

Definition at line 138 of file types.cpp.

{
        // allocate twice as much as we need to avoid frequent reallocations
        // when append is called repeatedly
        reserve(channel, 2 * (channels[channel].len + length));
        copy(data, data + length, channels[channel].data.get() + channels[channel].len);
        channels[channel].len += length;
}

References channels, len, and reserve().

Here is the call graph for this function:

change_bps()

void audio_frame2::change_bps

(

int

new_bps

)

Definition at line 313 of file types.cpp.

{
        if (new_bps == desc.bps) {
                return;
        }
 
        vector<channel> new_channels(channels.size());
 
        for (size_t i = 0; i < channels.size(); i++) {
                size_t new_size = channels[i].len / desc.bps * new_bps;
                new_channels[i] = {unique_ptr<char []>(new char[new_size]), new_size, new_size, {}};
        }
 
        for (size_t i = 0; i < channels.size(); i++) {
                ::change_bps(new_channels[i].data.get(), new_bps, get_data(i), get_bps(),
                                get_data_len(i));
        }
 
        desc.bps = new_bps;
        channels = std::move(new_channels);
}

References audio_desc::bps, change_bps(), channels, desc, get_bps(), get_data(), and get_data_len().

Referenced by audio_sender_thread(), change_bps(), copy_with_bps_change(), and decode_audio_frame().

Here is the call graph for this function:

copy_with_bps_change()

audio_frame2 audio_frame2::copy_with_bps_change ( audio_frame2 const & frame, int new_bps )

staticnodiscard

Definition at line 298 of file types.cpp.

{
        audio_frame2 ret;
        ret.init(frame.get_channel_count(), frame.get_codec(), new_bps, frame.get_sample_rate());
 
        for (size_t i = 0; i < ret.channels.size(); i++) {
                ret.channels[i].len = frame.get_data_len(i) / frame.get_bps() * new_bps;
                ret.channels[i].data = unique_ptr<char []>(new char[ret.channels[i].len]);
                ::change_bps(ret.channels[i].data.get(), new_bps, frame.get_data(i), frame.get_bps(),
                                frame.get_data_len(i));
        }
 
        return ret;
}

References change_bps(), channels, frame, and init().

Here is the call graph for this function:

get_bps()

int audio_frame2::get_bps ( ) const

nodiscard

Definition at line 200 of file types.cpp.

{
        return desc.bps;
}

References audio_desc::bps, and desc.

Referenced by audio_codec_compress(), audio_codec_decompress(), audio_sender_thread(), change_bps(), decode_audio_frame(), decode_audio_frame_mulaw(), rs::encode(), get_sample_count(), and process_statistics().

get_channel_count()

int audio_frame2::get_channel_count ( ) const

nodiscard

Definition at line 260 of file types.cpp.

{
        return channels.size();
}

References channels.

Referenced by audio_tx_send(), audio_tx_send_standard(), decode_audio_frame(), decode_audio_frame_mulaw(), rs::encode(), get_data_len(), process_statistics(), and validate_std_audio().

get_codec()

audio_codec_t audio_frame2::get_codec ( ) const

nodiscard

Definition at line 213 of file types.cpp.

{
        return desc.codec;
}

References audio_desc::codec, and desc.

Referenced by audio_tx_send_standard(), decode_audio_frame(), rs::encode(), process_statistics(), and validate_std_audio().

get_data() [1/2]

char * audio_frame2::get_data ( int channel )

nodiscard

Definition at line 218 of file types.cpp.

{
        return channels[channel].data.get();
}

References channels.

Referenced by append(), audio_codec_decompress(), audio_tx_send_chan(), audio_tx_send_standard(), change_bps(), decode_audio_frame(), and rs::encode().

get_data() [2/2]

const char * audio_frame2::get_data ( int channel ) const

nodiscard

Definition at line 223 of file types.cpp.

{
        return channels[channel].data.get();
}

References channels.

get_data_len() [1/2]

size_t audio_frame2::get_data_len ( ) const

nodiscard

Returns length of all channels in bytes

Definition at line 236 of file types.cpp.

{
        size_t len = 0;
        for (int i = 0; i < get_channel_count(); ++i) {
                len += get_data_len(i);
        }
 
        return len;
}

References get_channel_count(), get_data_len(), and len.

Referenced by change_bps(), and get_data_len().

Here is the call graph for this function:

get_data_len() [2/2]

size_t audio_frame2::get_data_len ( int channel ) const

nodiscard

Definition at line 228 of file types.cpp.

{
        return channels[channel].len;
}

References channels.

Referenced by append(), audio_codec_decompress(), audio_tx_send_chan(), audio_tx_send_standard(), decode_audio_frame(), rs::encode(), and validate_std_audio().

get_desc()

struct audio_desc audio_frame2::get_desc

(

)

const

Definition at line 205 of file types.cpp.

{
        struct audio_desc ret = desc;
        ret.ch_count =
            get_channel_count(); // ch_count is not set in audio_frame2::desc
        return ret;
}

References audio_desc::ch_count, and desc.

Referenced by set_audio_spec_to_vrxtx().

get_duration()

double audio_frame2::get_duration ( ) const

nodiscard

Definition at line 246 of file types.cpp.

{
        if (desc.codec == AC_PCM) {
                int samples = get_sample_count();
                return (double) samples / get_sample_rate();
        }
        return duration;
}

References AC_PCM, audio_desc::codec, desc, duration, get_sample_count(), and get_sample_rate().

Referenced by audio_tx_send_standard().

Here is the call graph for this function:

get_fec_params()

fec_desc const & audio_frame2::get_fec_params ( int channel ) const

nodiscard

Definition at line 255 of file types.cpp.

{
        return channels[channel].fec_params;
}

References channels.

Referenced by audio_tx_send_chan().

get_sample_count()

int audio_frame2::get_sample_count ( ) const

nodiscard

Definition at line 265 of file types.cpp.

{
        // for PCM, we can deduce samples count from length of the data
        if (desc.codec == AC_PCM) {
                return channels[0].len / get_bps();
        } else {
                throw logic_error("Unknown sample count for compressed audio!");
        }
}

References AC_PCM, channels, audio_desc::codec, desc, and get_bps().

Referenced by get_duration().

Here is the call graph for this function:

get_sample_rate()

int audio_frame2::get_sample_rate ( ) const

nodiscard

Definition at line 275 of file types.cpp.

{
        return desc.sample_rate;
}

References desc, and audio_desc::sample_rate.

Referenced by audio_codec_compress(), audio_codec_decompress(), audio_sender_thread(), audio_tx_send_standard(), decode_audio_frame(), rs::encode(), get_duration(), and process_statistics().

get_timestamp()

int64_t audio_frame2::get_timestamp ( ) const

nodiscard

Definition at line 340 of file types.cpp.

{ return timestamp; }

References timestamp.

Referenced by audio_tx_send(), and decode_audio_frame().

has_same_prop_as()

bool audio_frame2::has_same_prop_as ( audio_frame2 const & frame ) const

nodiscard

Definition at line 280 of file types.cpp.

{
        return desc.bps == frame.desc.bps &&
                desc.sample_rate == frame.desc.sample_rate &&
                desc.codec == frame.desc.codec &&
                channels.size() == frame.channels.size();
}

References audio_desc::bps, channels, audio_desc::codec, desc, frame, and audio_desc::sample_rate.

Referenced by process_statistics().

init()

void audio_frame2::init	(	int	nr_channels,
		audio_codec_t	codec,
		int	bps,
		int	sample_rate )

Initializes audio_frame2 for use. If already initialized, data are dropped.

Definition at line 115 of file types.cpp.

{
        channels.clear();
        channels.resize(nr_channels);
        desc.bps = b;
        desc.codec = c;
        desc.sample_rate = sr;
        duration = 0.0;
}

References audio_desc::bps, channels, audio_desc::codec, desc, and audio_desc::sample_rate.

Referenced by audio_codec_compress(), audio_codec_decompress(), audio_decoder_reconfigure(), copy_with_bps_change(), decode_audio_frame(), decode_audio_frame_mulaw(), rs::encode(), and process_statistics().

operator bool()

audio_frame2::operator bool ( ) const

explicit

Definition at line 107 of file types.cpp.

{
        return desc.codec != AC_NONE;
}

References AC_NONE, and desc.

operator=() [1/2]

audio_frame2 & audio_frame2::operator= ( audio_frame2 && )

default

operator=() [2/2]

audio_frame2 & audio_frame2::operator= ( audio_frame2 const & )

delete

replace()

void audio_frame2::replace	(	int	channel,
		size_t	offset,
		const char *	data,
		size_t	length )

replaces portion of data of specified channel. If the size of the channel is not sufficient, it is extended and old data are copied.

Definition at line 152 of file types.cpp.

{
        resize(channel, offset + length);
        copy(data, data + length, channels[channel].data.get() + offset);
}

References channels, offset, and resize().

Referenced by audio_fec_decode(), and decode_audio_frame().

Here is the call graph for this function:

resample()

bool audio_frame2::resample	(	audio_frame2_resampler &	resampler_state,
		int	new_sample_rate )

Note

bps of the frame needs to be 16 bits!

Parameters

resampler_state

opaque state that can holds resampler that dosn't need to be reinitalized during calls on various audio frames. It reinitializes itself when needed (when source or new sample rate changes). Therefore, it is very recommended to use it only in a stream that may change sometimes but do not eg. share it between two streams that has different properties.

Return values

false

if SpeexDSP was not compiled in

Definition at line 361 of file types.cpp.

{
        auto [ret, remainder] = resample_fake(resampler_state, new_sample_rate, 1);
        if (!ret) {
                return false;
        }
        if (remainder.get_data_len() > 0) {
                LOG(LOG_LEVEL_WARNING) << "Audio frame resampler: not all samples resampled!\n";
        }
        desc.sample_rate = new_sample_rate;
 
        return true;
}

References desc, LOG, LOG_LEVEL_WARNING, resample_fake(), and audio_desc::sample_rate.

Referenced by audio_sender_thread(), and decode_audio_frame().

Here is the call graph for this function:

resample_fake()

tuple< bool, audio_frame2 > audio_frame2::resample_fake	(	audio_frame2_resampler &	resampler_state,
		int	new_sample_rate_num,
		int	new_sample_rate_den )

@ resamples to new sample rate while keeping nominal sample rate intact

Definition at line 342 of file types.cpp.

{
        vector<channel> new_channels(channels.size());
        for (size_t i = 0; i < channels.size(); i++) {
                // allocate new storage + 10 ms headroom
                size_t new_size = (long long) channels[i].len * new_sample_rate_num / desc.sample_rate / new_sample_rate_den
                        + new_sample_rate_num * desc.bps / 100 / new_sample_rate_den;
                new_channels[i] = {unique_ptr<char []>(new char[new_size]), new_size, new_size, {}};
        }
 
        auto [ret, remainder] = resampler_state.resample(*this, new_channels, new_sample_rate_num, new_sample_rate_den);
        if (!ret) {
                return {false, audio_frame2{}};
        }
 
        channels = std::move(new_channels);
        return {ret, std::move(remainder)};
}

References audio_desc::bps, channels, desc, len, audio_frame2_resampler::resample(), and audio_desc::sample_rate.

Referenced by decode_audio_frame(), and resample().

Here is the call graph for this function:

reserve() [1/2]

void audio_frame2::reserve ( int channel, size_t len )

private

Definition at line 168 of file types.cpp.

{
        if (channels[channel].max_len < length) {
                unique_ptr<char []> new_data(new char[length]);
                copy(channels[channel].data.get(), channels[channel].data.get() +
                                channels[channel].len, new_data.get());
 
                channels[channel].max_len = length;
                channels[channel].data = std::move(new_data);
        }
}

References channels.

reserve() [2/2]

void audio_frame2::reserve

(

size_t

length

)

Reserves data for every channel with the specified length.

Definition at line 161 of file types.cpp.

{
        for (size_t channel = 0; channel < channels.size(); ++channel) {
                reserve(channel, length);
        }
}

References channels, and reserve().

Referenced by append(), audio_decoder_reconfigure(), rs::encode(), reserve(), and resize().

Here is the call graph for this function:

reset()

void audio_frame2::reset

(

)

Removes all data from audio_frame2.

Definition at line 192 of file types.cpp.

{
        for (size_t i = 0; i < channels.size(); i++) {
                channels[i].len = 0;
        }
        duration = 0.0;
}

References channels.

resize()

void audio_frame2::resize	(	int	channel,
		size_t	length )

Changes actual size of channel.

Definition at line 183 of file types.cpp.

{
        reserve(channel, length);
        channels[channel].len = length;
}

References channels, and reserve().

Referenced by audio_frame2(), audio_codec_decompress(), decode_audio_frame(), rs::encode(), and replace().

Here is the call graph for this function:

set_duration()

void audio_frame2::set_duration

(

double

duration

)

Definition at line 288 of file types.cpp.

{
        duration = new_duration;
}

Referenced by audio_codec_compress().

set_fec_params()

void audio_frame2::set_fec_params	(	int	channel,
		fec_desc const &	fec_params )

Definition at line 293 of file types.cpp.

{
        channels[channel].fec_params = fec_params;
}

References channels, and video_frame::fec_params.

Referenced by rs::encode().

set_timestamp()

void audio_frame2::set_timestamp

(

int64_t

ts

)

Definition at line 335 of file types.cpp.

{
        assert(ts >= -1);
        timestamp = ts;
}

References timestamp, and ts.

Referenced by audio_codec_compress(), audio_codec_decompress(), and decode_audio_frame().

Friends And Related Symbol Documentation

audio_frame2_resampler

friend class audio_frame2_resampler

friend

Definition at line 212 of file types.h.

soxr_resampler

friend class soxr_resampler

friend

Definition at line 213 of file types.h.

speex_resampler

friend class speex_resampler

friend

Definition at line 214 of file types.h.

Member Data Documentation

channels

std::vector<channel> audio_frame2::channels

private

Definition at line 208 of file types.h.

Referenced by audio_frame2(), append(), append(), change_bps(), copy_with_bps_change(), get_channel_count(), get_data(), get_data(), get_data_len(), get_fec_params(), get_sample_count(), has_same_prop_as(), init(), replace(), resample_fake(), reserve(), reserve(), reset(), resize(), and set_fec_params().

desc

struct audio_desc audio_frame2::desc = {}

private

desc.ch_count not set, use channels.size() instead

Definition at line 207 of file types.h.

{}; 

Referenced by audio_frame2(), append(), change_bps(), get_bps(), get_codec(), get_duration(), get_sample_count(), get_sample_rate(), has_same_prop_as(), init(), resample(), and resample_fake().

duration

double audio_frame2::duration = 0.0

private

for compressed formats where this cannot be directly determined from samples/sample_rate

Definition at line 209 of file types.h.

Referenced by get_duration().

timestamp

int64_t audio_frame2::timestamp = -1

private

Definition at line 210 of file types.h.

Referenced by get_timestamp(), and set_timestamp().

---

The documentation for this class was generated from the following files:

• src/audio/types.h
• src/audio/types.cpp