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:

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_t >	buffer { ( (1024) ) }

CopyDecoder	dec_copy

AudioInfo	info

bool	is_notify_active = true

bool	is_open = false

Vector< AudioInfoSupport * >	notify_vector

EncodedAudioOutput	out

AudioDecoder *	p_codec = nullptr

OGGZ *	p_oggz = nullptr

Print *	p_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

Copyright: GPLv3

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

src/AudioTools/AudioCodecs/ContainerOgg.h

Public Member Functions

Public Attributes

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Detailed Description