OpusMultiStreamAudioEncoder Class Reference

Encoder for Opus multistream audio. Supports up to 255 channels by combining multiple Opus streams into a single packet. Each fully encoded frame is written to the output stream. More...

#include <CodecOpusMultiStream.h>

Inheritance diagram for OpusMultiStreamAudioEncoder:

Public Member Functions
	OpusMultiStreamAudioEncoder ()=default
	OpusMultiStreamAudioEncoder (Print &out)
AudioInfo	audioInfo () override
	provides the actual input AudioInfo
AudioInfo	audioInfo () override
	provides the actual input AudioInfo
virtual AudioInfo	audioInfoOut ()
virtual AudioInfo	audioInfoOut ()
virtual bool	begin (AudioInfo info)
bool	begin () override
bool	begin (OpusMultiStreamEncoderSettings settings)
OpusMultiStreamEncoderSettings &	config ()
OpusMultiStreamEncoderSettings &	defaultConfig ()
void	end () override
virtual uint32_t	frameDurationUs ()
	Optional rtsp function: provide the frame duration in microseconds.
virtual uint32_t	frameDurationUs ()
	Optional rtsp function: provide the frame duration in microseconds.
virtual int	frameSize ()
virtual int	frameSize ()
int	frameSizeSamples ()
bool	isOpen ()
int	lookaheadSamples ()
const char *	mime () override
	Provides the mime type of the encoded result.
	operator bool () override
int	pendingSamples ()
uint16_t	samplesPerFrame ()
	Optional rtsp function: provide samples per the frame.
void	setAudioInfo (AudioInfo from) override
	Defines the sample rate, number of channels and bits per sample.
void	setAudioInfo (AudioInfo from) override
void	setOutput (Print &out_stream) override
	Default output assignment (encoders may override to store Print reference).
size_t	write (const uint8_t *data, size_t len) override

Protected Member Functions
void	encodeByte (uint8_t data)
void	encodeFrame ()
int	getFrameSizeSamples (int sampling_rate)
bool	settings ()
void	writeBlocking (Print *out, uint8_t *data, size_t len)
void	writeBlocking (Print *out, uint8_t *data, size_t len)

Protected Attributes
OpusMultiStreamEncoderSettings	cfg
OpusMSEncoder *	enc = nullptr
Vector< uint8_t >	frame {0}
int	frame_pos = 0
AudioInfo	info
bool	is_open = false
Print *	p_print = nullptr
Vector< uint8_t >	packet {0}

Detailed Description

Encoder for Opus multistream audio. Supports up to 255 channels by combining multiple Opus streams into a single packet. Each fully encoded frame is written to the output stream.

Warning

The decoder needs a lot of stack space: SET_LOOP_TASK_STACK_SIZE(16 * 1024);

Depends on https://github.com/pschatzmann/codec-opus.git

Author

Phil Schatzmann

Copyright

GPLv3

Constructor & Destructor Documentation

OpusMultiStreamAudioEncoder() [1/2]

OpusMultiStreamAudioEncoder ( )

default

OpusMultiStreamAudioEncoder() [2/2]

OpusMultiStreamAudioEncoder ( Print & out )

inline

Member Function Documentation

audioInfo() [1/2]

AudioInfo audioInfo ( )

inlineoverridevirtualinherited

provides the actual input AudioInfo

Implements AudioInfoSupport.

Reimplemented in CodecNOP, CodecNOP, BinaryContainerEncoder, CodecNOP, MP3EncoderShine, and MP3ParserEncoder.

audioInfo() [2/2]

AudioInfo audioInfo ( )

inlineoverridevirtualinherited

provides the actual input AudioInfo

Implements AudioInfoSupport.

Reimplemented in CodecNOP, CodecNOP, BinaryContainerEncoder, CodecNOP, MP3EncoderShine, and MP3ParserEncoder.

audioInfoOut() [1/2]

virtual AudioInfo audioInfoOut ( )

inlinevirtualinherited

provides the actual output AudioInfo: this is usually the same as audioInfo() unless we use a transforming stream

Reimplemented in ChannelFormatConverterStream, ChannelFormatConverterStreamT< T >, FormatConverterStream, MP3EncoderShine, NumberFormatConverterStream, NumberFormatConverterStreamT< TFrom, TTo >, Pipeline, PureDataStream, PWMAudioOutput< PWMDriverT >, ResampleStream, ResampleStreamT< TInterpolator >, and SupportedRatesStream.

audioInfoOut() [2/2]

virtual AudioInfo audioInfoOut ( )

inlinevirtualinherited

provides the actual output AudioInfo: this is usually the same as audioInfo() unless we use a transforming stream

Reimplemented in ChannelFormatConverterStream, ChannelFormatConverterStreamT< T >, FormatConverterStream, MP3EncoderShine, NumberFormatConverterStream, NumberFormatConverterStreamT< TFrom, TTo >, Pipeline, PureDataStream, PWMAudioOutput< PWMDriverT >, ResampleStream, ResampleStreamT< TInterpolator >, and SupportedRatesStream.

begin() [1/3]

virtual bool begin ( AudioInfo info )

inlinevirtualinherited

Reimplemented in AudioDecoder, and AudioDecoder.

begin() [2/3]

bool begin ( )

inlineoverridevirtual

Implements AudioWriter.

begin() [3/3]

bool begin ( OpusMultiStreamEncoderSettings settings )

inline

config()

OpusMultiStreamEncoderSettings & config ( )

inline

defaultConfig()

OpusMultiStreamEncoderSettings & defaultConfig ( )

inline

encodeByte()

void encodeByte ( uint8_t data )

inlineprotected

encodeFrame()

void encodeFrame ( )

inlineprotected

end()

void end ( )

inlineoverridevirtual

Implements AudioWriter.

frameDurationUs() [1/2]

virtual uint32_t frameDurationUs ( )

inlinevirtualinherited

Optional rtsp function: provide the frame duration in microseconds.

Reimplemented in ADPCMEncoder, MetaDataFilterEncoder, MP3EncoderShine, MP3ParserEncoder, and OpusOggEncoder.

frameDurationUs() [2/2]

virtual uint32_t frameDurationUs ( )

inlinevirtualinherited

Optional rtsp function: provide the frame duration in microseconds.

Reimplemented in ADPCMEncoder, MetaDataFilterEncoder, MP3EncoderShine, MP3ParserEncoder, and OpusOggEncoder.

frameSize() [1/2]

virtual int frameSize ( )

inlinevirtualinherited

Optional rtsp function: provide the encoded size (in bytes) of one frame, once known (e.g. after the encoder has seen real data). Lets an RTSPFormat size its RTP fragments to match one frame instead of a fixed guess, so throughput actually tracks frameDurationUs() - a fragment size covering several frames' worth of bytes sent at one-frame timing overruns real-time bandwidth and, over UDP (no flow control), causes packet loss. Returns 0 if not yet known/not applicable (fixed-frame-size codecs have no need to override this).

Reimplemented in ADPCMEncoder, AMRNBEncoder, AMRWBEncoder, EncoderALAC, and MP3ParserEncoder.

frameSize() [2/2]

virtual int frameSize ( )

inlinevirtualinherited

Optional rtsp function: provide the encoded size (in bytes) of one frame, once known (e.g. after the encoder has seen real data). Lets an RTSPFormat size its RTP fragments to match one frame instead of a fixed guess, so throughput actually tracks frameDurationUs() - a fragment size covering several frames' worth of bytes sent at one-frame timing overruns real-time bandwidth and, over UDP (no flow control), causes packet loss. Returns 0 if not yet known/not applicable (fixed-frame-size codecs have no need to override this).

Reimplemented in ADPCMEncoder, AMRNBEncoder, AMRWBEncoder, EncoderALAC, and MP3ParserEncoder.

frameSizeSamples()

int frameSizeSamples ( )

inline

getFrameSizeSamples()

int getFrameSizeSamples ( int sampling_rate )

inlineprotected

isOpen()

bool isOpen ( )

inline

lookaheadSamples()

int lookaheadSamples ( )

inline

mime()

const char * mime ( )

inlineoverridevirtual

Provides the mime type of the encoded result.

Implements AudioEncoder.

operator bool()

operator bool ( )

inlineoverridevirtual

Implements AudioWriter.

pendingSamples()

int pendingSamples ( )

inline

samplesPerFrame()

uint16_t samplesPerFrame ( )

inlinevirtual

Optional rtsp function: provide samples per the frame.

Reimplemented from AudioEncoder.

setAudioInfo() [1/2]

void setAudioInfo ( AudioInfo from )

inlineoverridevirtualinherited

Defines the sample rate, number of channels and bits per sample.

Implements AudioWriter.

Reimplemented in CodecNOP, and CodecNOP.

setAudioInfo() [2/2]

void setAudioInfo ( AudioInfo from )

inlineoverride

setOutput()

void setOutput ( Print & out_stream )

inlineoverridevirtual

Default output assignment (encoders may override to store Print reference).

Reimplemented from AudioEncoder.

settings()

bool settings ( )

inlineprotected

write()

size_t write ( const uint8_t * data, size_t len )

inlineoverridevirtual

Implements AudioWriter.

writeBlocking() [1/2]

void writeBlocking ( Print * out, uint8_t * data, size_t len )

inlineprotectedinherited

writeBlocking() [2/2]

void writeBlocking ( Print * out, uint8_t * data, size_t len )

inlineprotectedinherited

Member Data Documentation

cfg

OpusMultiStreamEncoderSettings cfg

protected

enc

OpusMSEncoder* enc = nullptr

protected

frame

Vector<uint8_t> frame {0}

protected

frame_pos

int frame_pos = 0

protected

info

AudioInfo info

protectedinherited

is_open

bool is_open = false

protected

p_print

Print* p_print = nullptr

protected

packet

Vector<uint8_t> packet {0}

protected

---

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

• src/AudioTools/AudioCodecs/CodecOpusMultiStream.h