OpusOggEncoder Class Reference

Opus Encoder which uses the Ogg Container: see https://datatracker.ietf.org/doc/html/rfc7845 Dependency: https://github.com/pschatzmann/arduino-libopus. More...

#include <CodecOpusOgg.h>

Inheritance diagram for OpusOggEncoder:

Public Member Functions
	OpusOggEncoder ()
AudioInfo	audioInfo () override
	provides the actual input AudioInfo
virtual AudioInfo	audioInfoOut ()
bool	begin () override
	starts the processing using the actual AudioInfo
bool	begin (AudioInfo from) override
OpusEncoderSettings &	config ()
	Provides access to the Opus config.
void	end () override
	stops the processing
uint32_t	frameDurationUs () override
	provides the frame duration in us (e.g. for RTSP)
virtual int	frameSize ()
bool	isOpen ()
const char *	mime () override
	Provides "audio/opus".
	operator bool () override
virtual uint16_t	samplesPerFrame ()
	Optional rtsp function: provide samples per the frame.
virtual void	setAudioInfo (AudioInfo info) override
	We actually do nothing with this.
void	setOutput (Print &print) override
	Defines the output Stream.
virtual size_t	write (const uint8_t *data, size_t len) override
	Writes raw data to be encoded and packaged.

Protected Member Functions
void	setEncoder (AudioEncoder *enc)
void	setOggOutput (OggContainerOutput *out)
	Replace the ogg output class.
void	writeBlocking (Print *out, uint8_t *data, size_t len)

Protected Attributes
OpusAudioEncoder	enc
AudioInfo	info
OggContainerOutput	ogg
OpusOggWriter	ogg_writer
AudioEncoder *	p_codec = nullptr
OggContainerOutput *	p_ogg = &ogg

Detailed Description

Opus Encoder which uses the Ogg Container: see https://datatracker.ietf.org/doc/html/rfc7845 Dependency: https://github.com/pschatzmann/arduino-libopus.

Author

Phil Schatzmann

Copyright

GPLv3

Constructor & Destructor Documentation

OpusOggEncoder()

OpusOggEncoder ( )

inline

Member Function Documentation

audioInfo()

AudioInfo audioInfo ( )

inlineoverridevirtualinherited

provides the actual input AudioInfo

Implements AudioInfoSupport.

Reimplemented in CodecNOP, MP3EncoderShine, BinaryContainerEncoder, and MP3ParserEncoder.

audioInfoOut()

virtual AudioInfo audioInfoOut ( )

inlinevirtualinherited

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

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

begin() [1/2]

bool begin ( )

inlineoverridevirtual

starts the processing using the actual AudioInfo

Reimplemented from OggContainerEncoder.

begin() [2/2]

bool begin ( AudioInfo  from )

inlineoverridevirtual

Reimplemented from OggContainerEncoder.

config()

OpusEncoderSettings & config ( )

inline

Provides access to the Opus config.

end()

void end ( )

inlineoverridevirtual

stops the processing

Reimplemented from OggContainerEncoder.

frameDurationUs()

uint32_t frameDurationUs ( )

inlineoverridevirtual

provides the frame duration in us (e.g. for RTSP)

Reimplemented from AudioEncoder.

frameSize()

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, EncoderALAC, AMRNBEncoder, AMRWBEncoder, and MP3ParserEncoder.

isOpen()

bool isOpen ( )

inlineinherited

mime()

const char * mime ( )

inlineoverridevirtual

Provides "audio/opus".

Reimplemented from OggContainerEncoder.

operator bool()

operator bool ( )

inlineoverridevirtualinherited

Implements AudioWriter.

samplesPerFrame()

virtual uint16_t samplesPerFrame ( )

inlinevirtualinherited

Optional rtsp function: provide samples per the frame.

Reimplemented in OpusAudioEncoder, OpusMultiStreamAudioEncoder, MP3EncoderShine, MP3ParserEncoder, and MetaDataFilterEncoder.

setAudioInfo()

virtual void setAudioInfo ( AudioInfo  info )

inlineoverridevirtualinherited

We actually do nothing with this.

Reimplemented from AudioEncoder.

setEncoder()

void setEncoder ( AudioEncoder *  enc )

inlineprotectedinherited

setOggOutput()

void setOggOutput ( OggContainerOutput *  out )

inlineprotectedinherited

Replace the ogg output class.

setOutput()

void setOutput ( Print &  print )

inlineoverridevirtualinherited

Defines the output Stream.

Reimplemented from AudioEncoder.

write()

virtual size_t write ( const uint8_t *  data, size_t  len  )

inlineoverridevirtualinherited

Writes raw data to be encoded and packaged.

Implements AudioWriter.

writeBlocking()

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

inlineprotectedinherited

Member Data Documentation

enc

OpusAudioEncoder enc

protected

info

AudioInfo info

protectedinherited

ogg

OggContainerOutput ogg

protectedinherited

ogg_writer

OpusOggWriter ogg_writer

protected

p_codec

AudioEncoder* p_codec = nullptr

protectedinherited

p_ogg

OggContainerOutput* p_ogg = &ogg

protectedinherited

---

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

• src/AudioTools/AudioCodecs/CodecOpusOgg.h