OpusOggDecoder Class Reference

Opus Decoder which uses the Ogg Container. See https://datatracker.ietf.org/doc/html/rfc7845. The audio data is transmitted in frames and the header information contains the sampler rate, channels and other critical info. Dependency: https://github.com/pschatzmann/arduino-libopus. More...

#include <CodecOpusOgg.h>

Inheritance diagram for OpusOggDecoder:

Public Member Functions
	OpusOggDecoder ()
void	addNotifyAudioChange (AudioInfoSupport &bi) override
	Adds target to be notified about audio changes.
AudioInfo	audioInfo () override
	provides the actual input AudioInfo
virtual AudioInfo	audioInfoOut ()
bool	begin () override
bool	begin (AudioInfo info) override
bool	begin (OpusSettings settings)
virtual void	clearNotifyAudioChange ()
	Deletes all change notify subscriptions.
OpusSettings &	config ()
	Provides access to the Opus configuration.
void	end () override
void	flush ()
Print *	getOutput ()
bool	isNotifyActive ()
	Checks if the automatic AudioInfo update is active.
virtual	operator bool () override
virtual bool	removeNotifyAudioChange (AudioInfoSupport &bi)
	Removes a target in order not to be notified about audio changes.
void	setAudioInfo (AudioInfo from) override
	for most decoders this is not needed
virtual bool	setCodecConfig (const uint8_t *data, size_t len)
	Some decoders need e.g. a magic cookie to provide the relevant info for decoding.
void	setDecoder (AudioDecoder *decoder)
void	setNotifyActive (bool flag)
	Deactivate/Reactivate automatic AudioInfo updates: (default is active)
virtual void	setOutput (AudioOutput &out_stream)
	Defines where the decoded result is written to.
virtual void	setOutput (AudioStream &out_stream)
	Defines where the decoded result is written to.
void	setOutput (Print &print) override
	Defines the output Stream.
virtual size_t	write (const uint8_t *data, size_t len) override

Public Attributes
int	id
	custom id to be used by application

Protected Member Functions
virtual void	beginOfSegment (ogg_packet *op) override
virtual void	endOfSegment (ogg_packet *op)
void	notifyAudioChange (AudioInfo info)
void	writeBlocking (Print *out, uint8_t *data, size_t len)

Static Protected Member Functions
static size_t	ogg_io_read (void *user_handle, void *buf, size_t n)
static int	read_packet (OGGZ *oggz, oggz_packet *zp, long serialno, void *user_data)
static int	read_page (OGGZ *oggz, const ogg_page *og, long serialno, void *user_data)

Protected Attributes
RingBuffer< uint8_t >	buffer { ( (1024) ) }
OpusAudioDecoder	dec
CopyDecoder	dec_copy
OpusOggHeader	header
AudioInfo	info
bool	is_notify_active = true
bool	is_open = false
Vector< AudioInfoSupport * >	notify_vector
EncodedAudioOutput	out
AudioDecoder *	p_codec = nullptr
OGGZ *	p_oggz = nullptr
Print *	p_print = nullptr
long	pos = 0

Detailed Description

Opus Decoder which uses the Ogg Container. See https://datatracker.ietf.org/doc/html/rfc7845. The audio data is transmitted in frames and the header information contains the sampler rate, channels and other critical info. Dependency: https://github.com/pschatzmann/arduino-libopus.

Author

Phil Schatzmann

Copyright

GPLv3

Constructor & Destructor Documentation

OpusOggDecoder()

OpusOggDecoder ( )

inline

Member Function Documentation

addNotifyAudioChange()

void addNotifyAudioChange ( AudioInfoSupport &  bi )

inlineoverridevirtualinherited

Adds target to be notified about audio changes.

Reimplemented from AudioInfoSource.

audioInfo()

AudioInfo audioInfo ( )

inlineoverridevirtualinherited

provides the actual input AudioInfo

Reimplemented from AudioDecoder.

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, and ResampleStreamT< TInterpolator >.

begin() [1/3]

bool begin ( )

inlineoverridevirtual

Reimplemented from OggContainerDecoder.

begin() [2/3]

bool begin ( AudioInfo  info )

inlineoverridevirtualinherited

Reimplemented from AudioDecoder.

begin() [3/3]

bool begin ( OpusSettings  settings )

inline

beginOfSegment()

virtual void beginOfSegment ( ogg_packet *  op )

inlineoverrideprotectedvirtual

Reimplemented from OggContainerDecoder.

clearNotifyAudioChange()

virtual void clearNotifyAudioChange ( )

inlinevirtualinherited

Deletes all change notify subscriptions.

Reimplemented in RTSPClient< TcpClient, UdpSocket >.

config()

OpusSettings & config ( )

inline

Provides access to the Opus configuration.

end()

void end ( )

inlineoverridevirtual

Reimplemented from OggContainerDecoder.

endOfSegment()

virtual void endOfSegment ( ogg_packet *  op )

inlineprotectedvirtualinherited

flush()

void flush ( )

inlineinherited

getOutput()

Print * getOutput ( )

inlineinherited

isNotifyActive()

bool isNotifyActive ( )

inlineinherited

Checks if the automatic AudioInfo update is active.

notifyAudioChange()

void notifyAudioChange ( AudioInfo  info )

inlineprotectedinherited

ogg_io_read()

static size_t ogg_io_read ( void *  user_handle, void *  buf, size_t  n  )

inlinestaticprotectedinherited

operator bool()

virtual operator bool ( )

inlineoverridevirtualinherited

Implements AudioWriter.

read_packet()

static int read_packet ( OGGZ *  oggz, oggz_packet *  zp, long  serialno, void *  user_data  )

inlinestaticprotectedinherited

read_page()

static int read_page ( OGGZ *  oggz, const ogg_page *  og, long  serialno, void *  user_data  )

inlinestaticprotectedinherited

removeNotifyAudioChange()

virtual bool removeNotifyAudioChange ( AudioInfoSupport &  bi )

inlinevirtualinherited

Removes a target in order not to be notified about audio changes.

Reimplemented in RTSPClient< TcpClient, UdpSocket >.

setAudioInfo()

void setAudioInfo ( AudioInfo  from )

inlineoverridevirtualinherited

for most decoders this is not needed

Implements AudioWriter.

Reimplemented in DecoderALAC, CodecChain, DSFDecoder, DecoderL8, OpusAudioDecoder, OpusMultiStreamAudioDecoder, CodecNOP, G729Decoder, and G7xxDecoder.

setCodecConfig()

virtual bool setCodecConfig ( const uint8_t *  data, size_t  len  )

inlinevirtualinherited

Some decoders need e.g. a magic cookie to provide the relevant info for decoding.

Reimplemented in DecoderALAC, and MultiDecoder.

setDecoder()

void setDecoder ( AudioDecoder *  decoder )

inlineinherited

setNotifyActive()

void setNotifyActive ( bool  flag )

inlineinherited

Deactivate/Reactivate automatic AudioInfo updates: (default is active)

setOutput() [1/3]

virtual void setOutput ( AudioOutput &  out_stream )

inlinevirtualinherited

Defines where the decoded result is written to.

Reimplemented in ADTSDecoder, CodecChain, MTSDecoder, MTSDecoderTSDemux, and MetaDataFilterDecoder.

setOutput() [2/3]

virtual void setOutput ( AudioStream &  out_stream )

inlinevirtualinherited

Defines where the decoded result is written to.

Reimplemented in ADTSDecoder, CodecChain, MTSDecoder, MTSDecoderTSDemux, and MetaDataFilterDecoder.

setOutput() [3/3]

void setOutput ( Print &  print )

inlineoverridevirtualinherited

Defines the output Stream.

Reimplemented from AudioDecoder.

write()

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

inlineoverridevirtualinherited

Implements AudioWriter.

writeBlocking()

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

inlineprotectedinherited

Member Data Documentation

buffer

RingBuffer<uint8_t> buffer { ( (1024) ) }

protectedinherited

dec

OpusAudioDecoder dec

protected

dec_copy

CopyDecoder dec_copy

protectedinherited

header

OpusOggHeader header

protected

id

int id

inherited

custom id to be used by application

info

AudioInfo info

protectedinherited

is_notify_active

bool is_notify_active = true

protectedinherited

is_open

bool is_open = false

protectedinherited

notify_vector

Vector<AudioInfoSupport*> notify_vector

protectedinherited

out

EncodedAudioOutput out

protectedinherited

p_codec

AudioDecoder* p_codec = nullptr

protectedinherited

p_oggz

OGGZ* p_oggz = nullptr

protectedinherited

p_print

Print* p_print = nullptr

protectedinherited

pos

long pos = 0

protectedinherited

---

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

• src/AudioTools/AudioCodecs/CodecOpusOgg.h