roc::audio::SampleSpec Class Reference

Sample specification. Describes sample rate and channels. More...

#include <sample_spec.h>

Public Member Functions
	SampleSpec ()
	Construct empty specification. More...
	SampleSpec (size_t sample_rate, const ChannelSet &channel_set)
	Construct specification with parameters. More...
	SampleSpec (size_t sample_rate, ChannelLayout channel_layout, ChannelOrder channel_order, ChannelMask channel_mask)
	Construct specification with parameters. More...
Equality
bool	operator== (const SampleSpec &other) const
	Check two specifications for equality. More...
bool	operator!= (const SampleSpec &other) const
	Check two specifications for equality. More...
Getters and setters
bool	is_valid () const
	Check if sample spec has non-zero rate and valid channel set. More...
size_t	sample_rate () const
	Get sample rate. More...
void	set_sample_rate (size_t sample_rate)
	Set sample rate. More...
const ChannelSet &	channel_set () const
	Get channel set. More...
ChannelSet &	channel_set ()
	Get mutable channel set. More...
void	set_channel_set (const ChannelSet &channel_set)
	Set channel set. More...
size_t	num_channels () const
	Get number enabled channels in channel set. More...
Nanosecond duration converters
size_t	ns_2_samples_per_chan (core::nanoseconds_t ns_duration) const
	Convert nanoseconds duration to number of samples per channel. More...
core::nanoseconds_t	samples_per_chan_2_ns (size_t n_samples) const
	Convert number of samples per channel to nanoseconds duration. More...
core::nanoseconds_t	fract_samples_per_chan_2_ns (float n_samples) const
	Convert (possibly fractional) number samples per channel to nanoseconds duration. More...
size_t	ns_2_samples_overall (core::nanoseconds_t ns_duration) const
	Convert nanoseconds duration to number of samples for all channels. More...
core::nanoseconds_t	samples_overall_2_ns (size_t n_samples) const
	Convert number of samples for all channels to nanoseconds duration. More...
core::nanoseconds_t	fract_samples_overall_2_ns (float n_samples) const
	Convert number of samples (possibly non-integer) to nanoseconds. More...

RTP timestamp converters
packet::stream_timestamp_diff_t	ns_2_stream_timestamp_delta (core::nanoseconds_t ns_delta) const
	Convert nanoseconds delta to stream timestamp delta. More...
core::nanoseconds_t	stream_timestamp_delta_2_ns (packet::stream_timestamp_diff_t sts_delta) const
	Convert stream timestamp delta to nanoseconds delta. More...

Detailed Description

Sample specification. Describes sample rate and channels.

Definition at line 26 of file sample_spec.h.

Constructor & Destructor Documentation

SampleSpec() [1/3]

roc::audio::SampleSpec::SampleSpec

(

)

Construct empty specification.

SampleSpec() [2/3]

roc::audio::SampleSpec::SampleSpec	(	size_t	sample_rate,
		const ChannelSet &	channel_set
	)

Construct specification with parameters.

SampleSpec() [3/3]

roc::audio::SampleSpec::SampleSpec	(	size_t	sample_rate,
		ChannelLayout	channel_layout,
		ChannelOrder	channel_order,
		ChannelMask	channel_mask
	)

Construct specification with parameters.

Remarks

This is a convenient overload for the case when 32-bit mask is enough to describe channels. Otherwise, use overload that accepts ChannelSet.

Member Function Documentation

channel_set() [1/2]

ChannelSet& roc::audio::SampleSpec::channel_set

(

)

Get mutable channel set.

channel_set() [2/2]

const ChannelSet& roc::audio::SampleSpec::channel_set

(

)

const

Get channel set.

Remarks

Defines sample channels (layout and numbers).

fract_samples_overall_2_ns()

core::nanoseconds_t roc::audio::SampleSpec::fract_samples_overall_2_ns

(

float

n_samples

)

const

Convert number of samples (possibly non-integer) to nanoseconds.

Note

In case of overflow, result is saturated.

fract_samples_per_chan_2_ns()

core::nanoseconds_t roc::audio::SampleSpec::fract_samples_per_chan_2_ns

(

float

n_samples

)

const

Convert (possibly fractional) number samples per channel to nanoseconds duration.

Note

In case of overflow, result is saturated.

is_valid()

bool roc::audio::SampleSpec::is_valid

(

)

const

Check if sample spec has non-zero rate and valid channel set.

ns_2_samples_overall()

size_t roc::audio::SampleSpec::ns_2_samples_overall

(

core::nanoseconds_t

ns_duration

)

const

Convert nanoseconds duration to number of samples for all channels.

Precondition

ns_duration should not be negative.

Postcondition

result is always multiple of number of channels.

Note

In case of overflow, result is saturated.

ns_2_samples_per_chan()

size_t roc::audio::SampleSpec::ns_2_samples_per_chan

(

core::nanoseconds_t

ns_duration

)

const

Convert nanoseconds duration to number of samples per channel.

Precondition

ns_duration should not be negative.

Note

In case of overflow, result is saturated.

ns_2_stream_timestamp_delta()

packet::stream_timestamp_diff_t roc::audio::SampleSpec::ns_2_stream_timestamp_delta

(

core::nanoseconds_t

ns_delta

)

const

Convert nanoseconds delta to stream timestamp delta.

Remarks

Same as ns_2_samples_per_chan(), but supports negative deltas.

num_channels()

size_t roc::audio::SampleSpec::num_channels

(

)

const

Get number enabled channels in channel set.

Remarks

Shorthand for channel_set().num_channels().

operator!=()

bool roc::audio::SampleSpec::operator!=

(

const SampleSpec &

other

)

const

Check two specifications for equality.

operator==()

bool roc::audio::SampleSpec::operator==

(

const SampleSpec &

other

)

const

Check two specifications for equality.

sample_rate()

size_t roc::audio::SampleSpec::sample_rate

(

)

const

Get sample rate.

Remarks

Defines sample frequency (number of samples per second).

samples_overall_2_ns()

core::nanoseconds_t roc::audio::SampleSpec::samples_overall_2_ns

(

size_t

n_samples

)

const

Convert number of samples for all channels to nanoseconds duration.

Precondition

n_samples should be multiple of number of channels.

Note

In case of overflow, result is saturated.

samples_per_chan_2_ns()

core::nanoseconds_t roc::audio::SampleSpec::samples_per_chan_2_ns

(

size_t

n_samples

)

const

Convert number of samples per channel to nanoseconds duration.

Note

In case of overflow, result is saturated.

set_channel_set()

void roc::audio::SampleSpec::set_channel_set

(

const ChannelSet &

channel_set

)

Set channel set.

set_sample_rate()

void roc::audio::SampleSpec::set_sample_rate

(

size_t

sample_rate

)

Set sample rate.

stream_timestamp_delta_2_ns()

core::nanoseconds_t roc::audio::SampleSpec::stream_timestamp_delta_2_ns

(

packet::stream_timestamp_diff_t

sts_delta

)

const

Convert stream timestamp delta to nanoseconds delta.

Remarks

Same as samples_per_chan_2_ns(), but supports negative deltas.

---

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

• roc_audio/sample_spec.h