ADTSDecoder Class Reference

Audio Data Transport Stream (ADTS) is a format similar to Audio Data Interchange Format (ADIF), used by MPEG TS or Shoutcast to stream audio defined in MPEG-2 Part 7, usually AAC. This parser extracts all valid ADTS frames from the data stream ignoring other data. More...

#include <CodecADTS.h>

Inheritance diagram for ADTSDecoder:

Public Member Functions
	ADTSDecoder ()=default
	ADTSDecoder (AudioDecoder &dec)
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
virtual void	clearNotifyAudioChange ()
	Deletes all change notify subscriptions.
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
	checks if the class is active
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)
void	setOutput (AudioOutput &out_stream) override
	Defines where the decoded result is written to.
void	setOutput (AudioStream &out_stream) override
	Defines where the decoded result is written to.
void	setOutput (Print &out_stream) override
	Defines where the decoded result is written to.
void	setOutputBufferSize (int size)
void	setParseBufferSize (int size)
	Defines the parse buffer size: default is 1024.
size_t	write (const uint8_t *data, size_t len) override
	Write AAC data to decoder.

Public Attributes
int	id
	custom id to be used by application

Protected Member Functions
void	notifyAudioChange (AudioInfo info)
void	parseBuffer ()
void	writeBlocking (Print *out, uint8_t *data, size_t len)
size_t	writeData (uint8_t *data, size_t size)
size_t	writeDataBuffered (uint8_t *data, size_t size)

Protected Attributes
SingleBuffer< uint8_t >	buffer {DEFAULT_BUFFER_SIZE}
AudioInfo	info
bool	is_notify_active = true
Vector< AudioInfoSupport * >	notify_vector
SingleBuffer< uint8_t >	out_buffer
AudioDecoder *	p_dec = nullptr
Print *	p_print = nullptr
ADTSParser	parser

Detailed Description

Audio Data Transport Stream (ADTS) is a format similar to Audio Data Interchange Format (ADIF), used by MPEG TS or Shoutcast to stream audio defined in MPEG-2 Part 7, usually AAC. This parser extracts all valid ADTS frames from the data stream ignoring other data.

Author

Phil Schatzmann

Copyright

GPLv3

Constructor & Destructor Documentation

ADTSDecoder() [1/2]

ADTSDecoder ( )

default

ADTSDecoder() [2/2]

ADTSDecoder ( AudioDecoder &  dec )

inline

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

inlineoverridevirtualinherited

provides the actual input AudioInfo

Implements AudioInfoSupport.

Reimplemented in CodecNOP, DecoderBasic, DSFDecoder, MP3DecoderHelix, MP3DecoderMAD, OpusAudioDecoder, VorbisDecoder, WAVDecoder, WavIMADecoder, OggContainerDecoder, and VorbisDecoder.

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/2]

bool begin ( )

inlineoverridevirtual

Implements AudioWriter.

begin() [2/2]

virtual bool begin ( AudioInfo  info )

inlineoverridevirtualinherited

Reimplemented from AudioWriter.

Reimplemented in DecoderBasic, and OggContainerDecoder.

clearNotifyAudioChange()

virtual void clearNotifyAudioChange ( )

inlinevirtualinherited

Deletes all change notify subscriptions.

Reimplemented in RTSPClient< TcpClient, UdpSocket >.

end()

void end ( )

inlineoverridevirtual

Implements AudioWriter.

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.

notifyAudioChange()

void notifyAudioChange ( AudioInfo  info )

inlineprotectedinherited

operator bool()

operator bool ( )

inlineoverridevirtual

checks if the class is active

Implements AudioWriter.

parseBuffer()

void parseBuffer ( )

inlineprotected

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

setNotifyActive()

void setNotifyActive ( bool  flag )

inlineinherited

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

setOutput() [1/3]

void setOutput ( AudioOutput &  out_stream )

inlineoverridevirtual

Defines where the decoded result is written to.

Reimplemented from AudioDecoder.

setOutput() [2/3]

void setOutput ( AudioStream &  out_stream )

inlineoverridevirtual

Defines where the decoded result is written to.

Reimplemented from AudioDecoder.

setOutput() [3/3]

void setOutput ( Print &  out_stream )

inlineoverridevirtual

Defines where the decoded result is written to.

Reimplemented from AudioDecoder.

setOutputBufferSize()

void setOutputBufferSize ( int  size )

inline

By default we write the parsed frames directly to the output: alternatively you can activate a buffer here

setParseBufferSize()

void setParseBufferSize ( int  size )

inline

Defines the parse buffer size: default is 1024.

write()

size_t write ( const uint8_t *  data, size_t  len  )

inlineoverridevirtual

Write AAC data to decoder.

Implements AudioWriter.

writeBlocking()

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

inlineprotectedinherited

writeData()

size_t writeData ( uint8_t *  data, size_t  size  )

inlineprotected

writeDataBuffered()

size_t writeDataBuffered ( uint8_t *  data, size_t  size  )

inlineprotected

Member Data Documentation

buffer

SingleBuffer<uint8_t> buffer {DEFAULT_BUFFER_SIZE}

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

out_buffer

SingleBuffer<uint8_t> out_buffer

protected

p_dec

AudioDecoder* p_dec = nullptr

protected

p_print

Print* p_print = nullptr

protectedinherited

parser

ADTSParser parser

protected

---

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

• src/AudioTools/AudioCodecs/CodecADTS.h