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

#include <CodecOpusOgg.h>

Inheritance diagram for OpusOggWriter:
Inheritance graph
[legend]
Collaboration diagram for OpusOggWriter:
Collaboration graph
[legend]

Public Member Functions

virtual void addNotifyAudioChange (AudioInfoSupport &bi)
 Adds target to be notified about audio changes.
 
virtual AudioInfo audioInfo () override
 provides the actual input AudioInfo
 
virtual AudioInfo audioInfoOut ()
 
virtual int availableForWrite () override
 
virtual bool begin () override
 starts the processing using the actual AudioInfo
 
virtual bool begin (AudioInfo info)
 
virtual void clearNotifyAudioChange ()
 Deletes all change notify subscriptions.
 
void end () override
 stops the processing
 
virtual void flush ()
 
virtual bool isDeletable ()
 If true we need to release the related memory in the destructor.
 
bool isNotifyActive ()
 Checks if the automatic AudioInfo update is active.
 
bool isOpen ()
 
virtual operator bool ()
 
virtual bool removeNotifyAudioChange (AudioInfoSupport &bi)
 Removes a target in order not to be notified about audio changes.
 
virtual void setAudioInfo (AudioInfo newInfo) override
 Defines the input AudioInfo.
 
void setFinalPacketSamples (ogg_int64_t samples)
 
void setFrameDurationUs (uint32_t frameDurationUs)
 
void setNotifyActive (bool flag)
 Deactivate/Reactivate automatic AudioInfo updates: (default is active)
 
void setOutput (Print &print)
 Defines the output Stream.
 
void setPreSkipSamples (uint16_t preSkipSamples)
 
size_t write (const uint8_t *data, size_t len) override
 Writes raw data to be encoded and packaged.
 
virtual size_t write (uint8_t ch) override
 
virtual void writeSilence (size_t len)
 

Protected Member Functions

bool emitBufferedPacket (ogg_int64_t granulePosition, bool endOfStream)
 
void notifyAudioChange (AudioInfo info)
 
virtual bool writeFooter ()
 
bool writeHeader () override
 
virtual bool writePacket (ogg_packet &op, int flag=0)
 

Static Protected Member Functions

static size_t ogg_io_write (void *user_handle, void *buf, size_t n)
 

Protected Attributes

int _timeout = 10
 
AudioInfo cfg
 
OpusOggCommentHeader comment
 
ogg_int64_t finalPacketSamples = 0
 
size_t granulepos = 0
 
bool hasPendingPacket = false
 
OpusOggHeader header
 
bool is_active = false
 
bool is_audio = false
 
bool is_notify_active = true
 
bool is_open = false
 
Vector< AudioInfoSupport * > notify_vector
 
ogg_packet oh
 
ogg_packet oh1
 
ogg_packet op
 
OGGZ * p_oggz = nullptr
 
Print * p_out = nullptr
 
size_t packetno = 0
 
Vector< uint8_t > pendingPacket {0}
 
ogg_int64_t samplesPerPacket = 960
 
long serialno = -1
 
SingleBuffer< uint8_t > tmp {MAX_SINGLE_CHARS}
 
int tmpPos = 0
 
ogg_int64_t totalGranulepos = 0
 

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

virtual AudioInfo audioInfo ( )
inlineoverridevirtualinherited

provides the actual input AudioInfo

Implements AudioInfoSupport.

Reimplemented in AdapterPrintToAudioOutput, EncodedAudioOutput, and AdapterAudioStreamToAudioOutput.

◆ 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 MP3EncoderShine, PureDataStream, PWMAudioOutput< PWMDriverT >, ChannelFormatConverterStreamT< T >, ChannelFormatConverterStream, NumberFormatConverterStreamT< TFrom, TTo >, NumberFormatConverterStream, FormatConverterStream, Pipeline, ResampleStream, ResampleStreamT< TInterpolator >, and SupportedRatesStream.

◆ availableForWrite()

virtual int availableForWrite ( )
inlineoverridevirtualinherited

Reimplemented from Print.

Reimplemented in AudioESP32ULP, RTSPOutput< Platform >, SPIAudioMaster, EncodedAudioOutput, AudioServerEx, AudioSyncWriter, SPIRegAudioMaster, AdapterAudioStreamToAudioOutput, CsvOutput< T >, MemoryOutput, and PWMAudioOutput< PWMDriverT >.

◆ begin() [1/2]

virtual bool begin ( )
inlineoverridevirtualinherited

starts the processing using the actual AudioInfo

Reimplemented from AudioOutput.

◆ begin() [2/2]

virtual bool begin ( AudioInfo  info)
inlinevirtualinherited

Reimplemented in AudioESP32ULP, RTSPOutput< Platform >, RTTTLOutput< T >, ChannelsSelectOutput, CsvOutput< T >, and EncodedAudioOutput.

◆ clearNotifyAudioChange()

virtual void clearNotifyAudioChange ( )
inlinevirtualinherited

Deletes all change notify subscriptions.

Reimplemented in RTSPClient< TcpClient, UdpSocket >.

◆ emitBufferedPacket()

bool emitBufferedPacket ( ogg_int64_t  granulePosition,
bool  endOfStream 
)
inlineprotected

◆ end()

void end ( )
inlineoverridevirtual

stops the processing

Reimplemented from OggContainerOutput.

◆ flush()

virtual void flush ( )
inlinevirtualinherited

Reimplemented from Print.

Reimplemented in MultiOutput, and HexDumpOutput.

◆ isDeletable()

virtual bool isDeletable ( )
inlinevirtualinherited

If true we need to release the related memory in the destructor.

Reimplemented in AdapterPrintToAudioOutput, and AdapterAudioStreamToAudioOutput.

◆ isNotifyActive()

bool isNotifyActive ( )
inlineinherited

Checks if the automatic AudioInfo update is active.

◆ isOpen()

bool isOpen ( )
inlineinherited

◆ notifyAudioChange()

void notifyAudioChange ( AudioInfo  info)
inlineprotectedinherited

◆ ogg_io_write()

static size_t ogg_io_write ( void *  user_handle,
void *  buf,
size_t  n 
)
inlinestaticprotectedinherited

◆ operator bool()

virtual operator bool ( )
inlinevirtualinherited

Reimplemented in RTSPOutput< Platform >, EncodedAudioOutput, and AdapterAudioStreamToAudioOutput.

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

virtual void setAudioInfo ( AudioInfo  info)
inlineoverridevirtualinherited

Defines the input AudioInfo.

Implements AudioInfoSupport.

Reimplemented in ChannelsSelectOutput, AdapterPrintToAudioOutput, MultiOutput, SPIAudioMaster, SPIRegAudioMaster, AdapterAudioStreamToAudioOutput, CsvOutput< T >, PWMAudioOutput< PWMDriverT >, and EncodedAudioOutput.

◆ setFinalPacketSamples()

void setFinalPacketSamples ( ogg_int64_t  samples)
inline

◆ setFrameDurationUs()

void setFrameDurationUs ( uint32_t  frameDurationUs)
inline

◆ setNotifyActive()

void setNotifyActive ( bool  flag)
inlineinherited

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

◆ setOutput()

void setOutput ( Print &  print)
inlineinherited

Defines the output Stream.

◆ setPreSkipSamples()

void setPreSkipSamples ( uint16_t  preSkipSamples)
inline

◆ write() [1/2]

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

Writes raw data to be encoded and packaged.

Reimplemented from OggContainerOutput.

◆ write() [2/2]

virtual size_t write ( uint8_t  ch)
inlineoverridevirtualinherited

Reimplemented in MetaDataOutput, and MultiOutput.

◆ writeFooter()

virtual bool writeFooter ( )
inlineprotectedvirtualinherited

◆ writeHeader()

bool writeHeader ( )
inlineoverrideprotectedvirtual

Reimplemented from OggContainerOutput.

◆ writePacket()

virtual bool writePacket ( ogg_packet &  op,
int  flag = 0 
)
inlineprotectedvirtualinherited

◆ writeSilence()

virtual void writeSilence ( size_t  len)
inlinevirtualinherited

Writes n 0 values (= silence)

Parameters
len

Member Data Documentation

◆ _timeout

int _timeout = 10
protectedinherited

◆ cfg

AudioInfo cfg
protectedinherited

◆ comment

OpusOggCommentHeader comment
protected

◆ finalPacketSamples

ogg_int64_t finalPacketSamples = 0
protected

◆ granulepos

size_t granulepos = 0
protectedinherited

◆ hasPendingPacket

bool hasPendingPacket = false
protected

◆ header

OpusOggHeader header
protected

◆ is_active

bool is_active = false
protectedinherited

◆ is_audio

bool is_audio = false
protectedinherited

◆ is_notify_active

bool is_notify_active = true
protectedinherited

◆ is_open

bool is_open = false
protectedinherited

◆ notify_vector

Vector<AudioInfoSupport*> notify_vector
protectedinherited

◆ oh

ogg_packet oh
protectedinherited

◆ oh1

ogg_packet oh1
protected

◆ op

ogg_packet op
protectedinherited

◆ p_oggz

OGGZ* p_oggz = nullptr
protectedinherited

◆ p_out

Print* p_out = nullptr
protectedinherited

◆ packetno

size_t packetno = 0
protectedinherited

◆ pendingPacket

Vector<uint8_t> pendingPacket {0}
protected

◆ samplesPerPacket

ogg_int64_t samplesPerPacket = 960
protected

◆ serialno

long serialno = -1
protectedinherited

◆ tmp

SingleBuffer<uint8_t> tmp {MAX_SINGLE_CHARS}
protectedinherited

◆ tmpPos

int tmpPos = 0
protectedinherited

◆ totalGranulepos

ogg_int64_t totalGranulepos = 0
protected
The documentation for this class was generated from the following file:
Generated by doxygen 1.9.8