Decoder for the Opus audio format. Each Opus frame must be provided with one write() call. Therefore, Opus is usually encapsulated in a container format (e.g., Ogg) that splits the stream into frames. More...

#include <CodecOpus.h>

Inheritance diagram for OpusAudioDecoder:

Public Member Functions
	OpusAudioDecoder (bool releaseOnEnd=false)
	Construct a new OpusDecoder object.

	OpusAudioDecoder (Print &out_stream)
	Construct a new OpusDecoder object.

virtual void	addNotifyAudioChange (AudioInfoSupport &bi)
	Adds target to be notified about audio changes.

AudioInfo	audioInfo () override
	provides the actual input AudioInfo

virtual AudioInfo	audioInfoOut ()

bool	begin () override

virtual bool	begin (AudioInfo info) override

bool	begin (OpusSettings settings)

virtual void	clearNotifyAudioChange ()
	Deletes all change notify subscriptions.

OpusSettings &	config ()
	Provides access to the configuration.

OpusSettings &	defaultConfig ()

void	end () override

Print *	getOutput ()

bool	isNotifyActive ()
	Checks if the automatic AudioInfo update is active.

virtual bool	isResultPCM ()
	Returns true to indicate that the decoding result is PCM data.

	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	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 &out_stream) override
	Defines the output Stream.

void	setReleaseOnEnd (bool flag)

size_t	write (const uint8_t *data, size_t len) override
	write one full opus frame

Public Attributes
int	id
	custom id to be used by application

Protected Member Functions
bool	isValidRate (int rate)

void	notifyAudioChange (AudioInfo info)

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

Protected Attributes
bool	active = false

OpusSettings	cfg

OpusDecoder *	dec = nullptr

Vector< uint8_t >	decbuf {0}

AudioInfo	info

bool	is_notify_active = true

Vector< AudioInfoSupport * >	notify_vector

Vector< uint8_t >	outbuf {0}

Print *	p_print = nullptr

bool	release_on_end = false

const uint32_t	valid_rates [5] = {8000, 12000, 16000, 24000, 48000}

Detailed Description

Decoder for the Opus audio format. Each Opus frame must be provided with one write() call. Therefore, Opus is usually encapsulated in a container format (e.g., Ogg) that splits the stream into frames.

Depends on https://github.com/pschatzmann/arduino-libopus.git

Author: Phil Schatzmann

Copyright: GPLv3

Constructor & Destructor Documentation

◆ OpusAudioDecoder() [1/2]

OpusAudioDecoder ( bool releaseOnEnd = false )

inline

Construct a new OpusDecoder object.

◆ OpusAudioDecoder() [2/2]

OpusAudioDecoder ( Print & out_stream )

inline

Construct a new OpusDecoder object.

Parameters

out_stream Output Stream to which we write the decoded result

Member Function Documentation

◆ addNotifyAudioChange()

virtual void addNotifyAudioChange ( AudioInfoSupport & bi )

inlinevirtualinherited

Adds target to be notified about audio changes.

Reimplemented in CodecNOP, EncodedAudioOutput, EncodedAudioStream, AACDecoderFDK, DecoderBasic, CodecChain, MP3DecoderHelix, MP3DecoderMAD, OggContainerDecoder, RTSPClient< TcpClient, UdpSocket >, Pipeline, and Pipeline::ModifyingStreamAdapter.

◆ audioInfo()

AudioInfo audioInfo ( )

inlineoverridevirtual

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 PureDataStream, PWMAudioOutput, ChannelFormatConverterStreamT< T >, ChannelFormatConverterStream, NumberFormatConverterStreamT< TFrom, TTo >, NumberFormatConverterStream, FormatConverterStream, Pipeline, ResampleStream, and ResampleStreamT< TInterpolator >.

◆ begin() [1/3]

bool begin ( )

inlineoverridevirtual

Reimplemented from AudioDecoder.

◆ begin() [2/3]

virtual bool begin ( AudioInfo info )

inlineoverridevirtualinherited

Reimplemented from AudioWriter.

Reimplemented in DecoderBasic, and OggContainerDecoder.

◆ begin() [3/3]

bool begin ( OpusSettings settings )

inline

◆ clearNotifyAudioChange()

virtual void clearNotifyAudioChange ( )

inlinevirtualinherited

Deletes all change notify subscriptions.

Reimplemented in RTSPClient< TcpClient, UdpSocket >.

◆ config()

OpusSettings & config ( )

inline

Provides access to the configuration.

◆ defaultConfig()

OpusSettings & defaultConfig ( )

inline

◆ end()

void end ( )

inlineoverridevirtual

Reimplemented from AudioDecoder.

◆ getOutput()

Print * getOutput ( )

inlineinherited

◆ isNotifyActive()

bool isNotifyActive ( )

inlineinherited

Checks if the automatic AudioInfo update is active.

◆ isResultPCM()

virtual bool isResultPCM ( )

inlinevirtualinherited

Returns true to indicate that the decoding result is PCM data.

Reimplemented in CopyDecoder, DecoderNetworkFormat, and ContainerM4A.

◆ isValidRate()

bool isValidRate ( int rate )

inlineprotected

◆ notifyAudioChange()

void notifyAudioChange ( AudioInfo info )

inlineprotectedinherited

◆ operator bool()

operator bool ( )

inlineoverridevirtual

Implements AudioWriter.

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

inlineoverridevirtual

for most decoders this is not needed

Reimplemented from AudioDecoder.

◆ 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.

◆ 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 & out_stream )

inlineoverridevirtual

Defines the output Stream.

Reimplemented from AudioDecoder.

◆ setReleaseOnEnd()

void setReleaseOnEnd ( bool flag )

inline

Defines if the resources should be released when the stream is closed (default: false)

◆ write()

size_t write	(	const uint8_t *	data,
		size_t	len
	)

inlineoverridevirtual

write one full opus frame

Implements AudioWriter.

◆ writeBlocking()

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

inlineprotectedinherited

Member Data Documentation

◆ active

bool active = false

protected

◆ cfg

OpusSettings cfg

protected

◆ dec

OpusDecoder* dec = nullptr

protected

◆ decbuf

Vector<uint8_t> decbuf {0}

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

◆ notify_vector

Vector<AudioInfoSupport*> notify_vector

protectedinherited

◆ outbuf

Vector<uint8_t> outbuf {0}

protected

◆ p_print

Print* p_print = nullptr

protected

◆ release_on_end

bool release_on_end = false

protected

◆ valid_rates

const uint32_t valid_rates[5] = {8000, 12000, 16000, 24000, 48000}

protected

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

src/AudioTools/AudioCodecs/CodecOpus.h

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ OpusAudioDecoder() [1/2]

◆ OpusAudioDecoder() [2/2]

Member Function Documentation

◆ addNotifyAudioChange()

◆ audioInfo()

◆ audioInfoOut()

◆ begin() [1/3]

◆ begin() [2/3]

◆ begin() [3/3]

◆ clearNotifyAudioChange()

◆ config()

◆ defaultConfig()

◆ end()

◆ getOutput()

◆ isNotifyActive()

◆ isResultPCM()

◆ isValidRate()

◆ notifyAudioChange()

◆ operator bool()

◆ removeNotifyAudioChange()

◆ setAudioInfo()

◆ setCodecConfig()

◆ setNotifyActive()

◆ setOutput() [1/3]

◆ setOutput() [2/3]

◆ setOutput() [3/3]

◆ setReleaseOnEnd()

◆ write()

◆ writeBlocking()

Member Data Documentation

◆ active

◆ cfg

◆ dec

◆ decbuf

◆ id

◆ info

◆ is_notify_active

◆ notify_vector

◆ outbuf

◆ p_print

◆ release_on_end

◆ valid_rates