arduino-audio-tools
Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | List of all members
OpusAudioDecoder Class Reference

OpusAudioDecoder: Depends on https://github.com/pschatzmann/arduino-libopus.git. More...

#include <CodecOpus.h>

Inheritance diagram for OpusAudioDecoder:
AudioDecoder AudioWriter AudioInfoSource AudioInfoSupport

Public Member Functions

 OpusAudioDecoder ()=default
 Construct a new OpusDecoder object.
 
 OpusAudioDecoder (Print &out_stream)
 Construct a new OpusDecoder object. More...
 
virtual void addNotifyAudioChange (AudioInfoSupport &bi)
 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
 
virtual bool begin (AudioInfo info) override
 
bool begin (OpusSettings settings)
 
virtual void clearNotifyAudioChange ()
 Deletes all change notify subscriptions.
 
OpusSettingsconfig ()
 Provides access to the configuration.
 
OpusSettingsdefaultConfig ()
 
void end () override
 
bool isNotifyActive ()
 Checks if the automatic AudioInfo update is active.
 
virtual bool isResultPCM ()
 If true, the decoding result is PCM data.
 
 operator bool () override
 
virtual bool removeNotifyAudioChange (AudioInfoSupport &bi)
 Removes a target in order not to be notified about audio changes.
 
void setAudioInfo (AudioInfo from) override
 for most decoders this is not needed
 
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 &out_stream) override
 Defines the output Stream.
 
size_t write (const void *in_ptr, size_t in_size) override
 

Public Attributes

int id
 custom id to be used by application
 

Protected Member Functions

bool isValidRate (int rate)
 
void notifyAudioChange (AudioInfo info)
 
void writeBlocking (Print *out, uint8_t *data, size_t len)
 

Protected Attributes

bool active = false
 
OpusSettings cfg
 
OpusDecoder * dec
 
Vector< uint8_t > decbuf {0}
 
AudioInfo info
 
bool is_notify_active = true
 
Vector< AudioInfoSupport * > notify_vector
 
Vector< uint8_t > outbuf {0}
 
Printp_print = nullptr
 
const uint32_t valid_rates [5] = {8000, 12000, 16000, 24000, 48000}
 

Detailed Description

OpusAudioDecoder: Depends on https://github.com/pschatzmann/arduino-libopus.git.

Author
Phil Schatzmann

Constructor & Destructor Documentation

◆ OpusAudioDecoder()

OpusAudioDecoder ( Print out_stream)
inline

Construct a new OpusDecoder object.

Parameters
out_streamOutput Stream to which we write the decoded result

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