VorbisDecoder Class Reference

Vorbis Streaming Decoder using https://github.com/pschatzmann/arduino-libvorbis-tremor. More...

#include <CodecVorbis.h>

Inheritance diagram for VorbisDecoder:

Public Member Functions
	~VorbisDecoder ()
	Destroy the VorbisDecoder object.
virtual void	addNotifyAudioChange (AudioInfoSupport &bi)
	Adds target to be notified about audio changes.
AudioInfo	audioInfo () override
	Provides the last available MP3FrameInfo.
bool	begin () override
	Starts the processing.
virtual void	clearNotifyAudioChange ()
	Deletes all change notify subscriptions.
virtual bool	copy () override
	Process a single read operation - to be called in the loop.
void	end () override
	Releases the reserved memory.
bool	isNotifyActive ()
	Checks if the automatic AudioInfo update is active.
virtual	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	setInput (Stream &inStream)
void	setNotifyActive (bool flag)
	Deactivate/Reactivate automatic AudioInfo updates: (default is active)
virtual void	setOutput (AudioOutput &out_stream)
	Defines the output streams and register to be notified.
virtual void	setOutput (AudioStream &out_stream)
	Defines the output streams and register to be notified.
virtual void	setOutput (Print &out_stream)
	Defines the output Stream.

Protected Member Functions
AudioInfo	currentInfo ()
void	notifyAudioChange (AudioInfo info)
bool	ovOpen ()
virtual size_t	readBytes (uint8_t *data, size_t len) override
const char *	readError (long error)

Static Protected Member Functions
static int	close_func (void *datasource)
static size_t	read_func (void *ptr, size_t size, size_t nmemb, void *datasource)
static int	seek_func (void *datasource, ogg_int64_t offset, int whence)
static long	tell_func (void *datasource)

Protected Attributes
bool	active
int	bitstream
ov_callbacks	callbacks
AudioInfo	cfg
OggVorbis_File	file
bool	is_first = true
bool	is_notify_active = true
bool	is_ov_open = false
Vector< AudioInfoSupport * >	notify_vector
Stream *	p_input = nullptr
Print *	p_print = nullptr
Vector< uint8_t >	pcm

Detailed Description

Vorbis Streaming Decoder using https://github.com/pschatzmann/arduino-libvorbis-tremor.

Author

Phil Schatzmann

Copyright

GPLv3

Member Function Documentation

addNotifyAudioChange()

virtual void addNotifyAudioChange ( AudioInfoSupport &  bi )

inlinevirtualinherited

Adds target to be notified about audio changes.

Reimplemented in CodecNOP, MP3DecoderMAD, EncodedAudioOutput, EncodedAudioStream, AACDecoderFDK, DecoderBasic, MP3DecoderHelix, OggContainerDecoder, Pipeline, and Pipeline::ModifyingStreamAdapter.

audioInfo()

AudioInfo audioInfo ( )

inlineoverridevirtual

Provides the last available MP3FrameInfo.

Implements StreamingDecoder.

begin()

bool begin ( )

inlineoverridevirtual

Starts the processing.

Implements StreamingDecoder.

copy()

virtual bool copy ( )

inlineoverridevirtual

Process a single read operation - to be called in the loop.

Implements StreamingDecoder.

end()

void end ( )

inlineoverridevirtual

Releases the reserved memory.

Implements StreamingDecoder.

operator bool()

virtual operator bool ( )

inlineoverridevirtual

checks if the class is active

Implements StreamingDecoder.

readBytes()

virtual size_t readBytes ( uint8_t *  data, size_t  len  )

inlineoverrideprotectedvirtual

Implements StreamingDecoder.

setInput()

void setInput ( Stream &  inStream )

inlineinherited

Stream Interface: Decode directly by taking data from the stream. This is more efficient then feeding the decoder with write: just call copy() in the loop

setOutput()

virtual void setOutput ( Print &  out_stream )

inlinevirtualinherited

Defines the output Stream.

Reimplemented in StreamingDecoderAdapter.

---

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

• src/AudioTools/AudioCodecs/CodecVorbis.h