arduino-audio-tools
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | Protected Member Functions | Static Protected Member Functions | Protected Attributes | List of all members
OggContainerDecoder Class Reference

Decoder for Ogg Container. Decodes a packet from an Ogg container. The Ogg begin segment contains the AudioInfo structure. You can subclass and overwrite the beginOfSegment() method to implement your own headers Dependency: https://github.com/pschatzmann/arduino-libopus. More...

#include <ContainerOgg.h>

Inheritance diagram for OggContainerDecoder:
ContainerDecoder AudioDecoder AudioWriter AudioInfoSource AudioInfoSupport OpusOggDecoder

Public Member Functions

 OggContainerDecoder ()
 Construct a new OggContainerDecoder object.
 
 OggContainerDecoder (AudioDecoder &decoder)
 
 OggContainerDecoder (AudioDecoder *decoder)
 
void addNotifyAudioChange (AudioInfoSupport &bi) override
 Adds target to be notified about audio changes.
 
AudioInfo audioInfo () override
 provides the actual input AudioInfo
 
virtual AudioInfo audioInfoOut ()
 provides the actual output AudioInfo: this is usually the same as audioInfo() unless we use a transforming stream
 
bool begin () override
 
bool begin (AudioInfo info) override
 
virtual void clearNotifyAudioChange ()
 Deletes all change notify subscriptions.
 
void end () override
 
void flush ()
 
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.
 
virtual void setAudioInfo (AudioInfo from) override
 for most decoders this is not needed
 
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)
 
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_tbuffer { ( (1024) ) }
 
CopyDecoder dec_copy
 
AudioInfo info
 
bool is_notify_active = true
 
bool is_open = false
 
Vector< AudioInfoSupport * > notify_vector
 
EncodedAudioOutput out
 
AudioDecoderp_codec = nullptr
 
OGGZp_oggz = nullptr
 
Printp_print = nullptr
 
long pos = 0
 

Detailed Description

Decoder for Ogg Container. Decodes a packet from an Ogg container. The Ogg begin segment contains the AudioInfo structure. You can subclass and overwrite the beginOfSegment() method to implement your own headers Dependency: https://github.com/pschatzmann/arduino-libopus.

Author
Phil Schatzmann

Member Function Documentation

◆ addNotifyAudioChange()

void addNotifyAudioChange ( AudioInfoSupport bi)
inlineoverridevirtual

Adds target to be notified about audio changes.

Reimplemented from AudioInfoSource.

◆ audioInfo()

AudioInfo audioInfo ( )
inlineoverridevirtual

provides the actual input AudioInfo

Reimplemented from AudioDecoder.

◆ audioInfoOut()

virtual AudioInfo audioInfoOut ( )
inlinevirtualinherited

◆ begin() [1/2]

bool begin ( )
inlineoverridevirtual

Reimplemented from AudioDecoder.

◆ begin() [2/2]

bool begin ( AudioInfo  info)
inlineoverridevirtual

Reimplemented from AudioDecoder.

◆ end()

void end ( )
inlineoverridevirtual

Reimplemented from AudioDecoder.

◆ operator bool()

virtual operator bool ( )
inlineoverridevirtual

Implements AudioWriter.

◆ setAudioInfo()

virtual void setAudioInfo ( AudioInfo  from)
inlineoverridevirtualinherited

for most decoders this is not needed

Implements AudioWriter.

Reimplemented in GGWaveDecoder, DecoderL8, OpusAudioDecoder, CodecNOP, AACDecoderHelix, and G7xxDecoder.

◆ setOutput() [1/3]

virtual void setOutput ( AudioOutput out_stream)
inlinevirtualinherited

Defines where the decoded result is written to.

Reimplemented in MetaDataFilterDecoder.

◆ setOutput() [2/3]

virtual void setOutput ( AudioStream out_stream)
inlinevirtualinherited

Defines where the decoded result is written to.

Reimplemented in MetaDataFilterDecoder.

◆ setOutput() [3/3]

void setOutput ( Print print)
inlineoverridevirtual

Defines the output Stream.

Reimplemented from AudioDecoder.

◆ write()

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

Implements AudioWriter.


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