OggContainerEncoder Class Reference

Encoder for Ogg Container. Encodes a packet for an Ogg container. The Ogg begin segment contains the AudioInfo structure. You can subclass ond overwrite the writeHeader() method to implement your own header logic. When an optional encoder is specified in the constructor we package the encoded data. Dependency: https://github.com/pschatzmann/codec-opus. More...

#include <ContainerOgg.h>

Inheritance diagram for OggContainerEncoder:

Collaboration diagram for OggContainerEncoder:

Public Member Functions
	OggContainerEncoder ()=default
	OggContainerEncoder (AudioEncoder &encoder)
	OggContainerEncoder (AudioEncoder *encoder)
AudioInfo	audioInfo () override
	provides the actual input AudioInfo
virtual AudioInfo	audioInfoOut ()
virtual bool	begin () override
	starts the processing using the actual AudioInfo
virtual bool	begin (AudioInfo from) override
void	end () override
	stops the processing
virtual uint32_t	frameDurationUs ()
	Optional rtsp function: provide the frame duration in microseconds.
virtual int	frameSize ()
bool	isOpen ()
const char *	mime () override
	Provides "audio/pcm".
	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
AudioInfo	info
OggContainerOutput	ogg
AudioEncoder *	p_codec = nullptr
OggContainerOutput *	p_ogg = &ogg

Detailed Description

Encoder for Ogg Container. Encodes a packet for an Ogg container. The Ogg begin segment contains the AudioInfo structure. You can subclass ond overwrite the writeHeader() method to implement your own header logic. When an optional encoder is specified in the constructor we package the encoded data. Dependency: https://github.com/pschatzmann/codec-opus.

Author

Phil Schatzmann

Copyright

GPLv3

Constructor & Destructor Documentation

OggContainerEncoder() [1/3]

OggContainerEncoder ( )

default

OggContainerEncoder() [2/3]

OggContainerEncoder ( AudioEncoder *  encoder )

inline

OggContainerEncoder() [3/3]

OggContainerEncoder ( AudioEncoder &  encoder )

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]

virtual bool begin ( )

inlineoverridevirtual

starts the processing using the actual AudioInfo

Implements AudioWriter.

Reimplemented in OpusOggEncoder.

begin() [2/2]

virtual bool begin ( AudioInfo  from )

inlineoverridevirtual

Reimplemented from AudioWriter.

Reimplemented in OpusOggEncoder.

end()

void end ( )

inlineoverridevirtual

stops the processing

Implements AudioWriter.

Reimplemented in OpusOggEncoder.

frameDurationUs()

virtual uint32_t frameDurationUs ( )

inlinevirtualinherited

Optional rtsp function: provide the frame duration in microseconds.

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

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 ( )

inline

mime()

const char * mime ( )

inlineoverridevirtual

Provides "audio/pcm".

Implements AudioEncoder.

Reimplemented in OpusOggEncoder.

operator bool()

operator bool ( )

inlineoverridevirtual

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 )

inlineoverridevirtual

We actually do nothing with this.

Reimplemented from AudioEncoder.

setEncoder()

void setEncoder ( AudioEncoder *  enc )

inlineprotected

setOggOutput()

void setOggOutput ( OggContainerOutput *  out )

inlineprotected

Replace the ogg output class.

setOutput()

void setOutput ( Print &  print )

inlineoverridevirtual

Defines the output Stream.

Reimplemented from AudioEncoder.

write()

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

inlineoverridevirtual

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

info

AudioInfo info

protectedinherited

ogg

OggContainerOutput ogg

protected

p_codec

AudioEncoder* p_codec = nullptr

protected

p_ogg

OggContainerOutput* p_ogg = &ogg

protected

---

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

• src/AudioTools/AudioCodecs/ContainerOgg.h