arduino-audio-tools
Public Member Functions | 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:
AudioDecoder AudioWriter AudioInfoSource OpusOggDecoder

Public Member Functions

 OggContainerDecoder ()
 Construct a new OggContainerDecoder object.
 
 OggContainerDecoder (AudioDecoder &decoder)
 
 OggContainerDecoder (AudioDecoder *decoder)
 
AudioInfo audioInfo () override
 
void begin () override
 
void begin (AudioInfo info) override
 
void end () override
 
void flush ()
 
virtual bool isResultPCM ()
 If true, the decoding result is PCM data.
 
virtual operator bool () override
 
virtual void setAudioInfo (AudioInfo from) override
 for most decoders this is not needed
 
void setDecoder (AudioDecoder *decoder)
 
void setNotifyAudioChange (AudioInfoSupport &bi) override
 Registers an object that is notified if the audio format is changing.
 
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 void *in_ptr, size_t in_size) override
 

Protected Member Functions

virtual void beginOfSegment (ogg_packet *op)
 
virtual void endOfSegment (ogg_packet *op)
 
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) ) }
 
CopyDecoder dec_copy
 
AudioInfo info
 
bool is_open = false
 
EncodedAudioOutput out
 
AudioDecoderp_codec = nullptr
 
AudioInfoSupportp_notify = nullptr
 
OGGZ * p_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

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