MiniAudioStream Class Reference

MiniAudio: https://miniaud.io/. More...

#include <MiniAudioStream.h>

Inheritance diagram for MiniAudioStream:

Public Member Functions
	MiniAudioStream ()=default
	~MiniAudioStream ()
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 ()
int	available () override
int	availableForWrite () override
bool	begin () override
bool	begin (MiniAudioConfig info)
virtual void	clearNotifyAudioChange ()
	Deletes all change notify subscriptions.
MiniAudioConfig	defaultConfig (RxTxMode mode=RXTX_MODE)
void	end () override
virtual void	flush () override
bool	isNotifyActive ()
	Checks if the automatic AudioInfo update is active.
bool	isPlaying () const
	Check if playback is currently active.
virtual	operator bool ()
size_t	readBytes (uint8_t *data, size_t len) override
virtual size_t	readSilence (uint8_t *buffer, size_t length)
	Source to generate silence: just sets the buffer to 0.
virtual bool	removeNotifyAudioChange (AudioInfoSupport &bi)
	Removes a target in order not to be notified about audio changes.
void	restartPlayback ()
	Manually restart playback (useful after long delays)
void	setAudioInfo (AudioInfo in) override
	Defines the input AudioInfo.
void	setNotifyActive (bool flag)
	Deactivate/Reactivate automatic AudioInfo updates: (default is active)
void	setWriteBufferSize (int size)
size_t	write (const uint8_t *data, size_t len) override
virtual size_t	write (uint8_t ch) override
virtual void	writeSilence (size_t len)
	Writes len bytes of silence (=0).

Protected Member Functions
void	doWait ()
virtual int	not_supported (int out, const char *msg="")
void	notifyAudioChange (AudioInfo info)
void	refillReadBuffer ()
	Refill small read buffer (e.g. 8 bytes) to avoid single byte reads when calling read()
void	setupBuffers (int size=1200)

Static Protected Member Functions
static void	data_callback (ma_device *pDevice, void *pOutput, const void *pInput, ma_uint32 frameCount)

Protected Attributes
int	_timeout = 10
RingBuffer< uint8_t >	buffer_in {0}
RingBuffer< uint8_t >	buffer_out {0}
std::atomic< int >	buffer_size {0}
MiniAudioConfig	config
ma_device_config	config_ma
ma_device	device_ma
AudioInfo	info
std::atomic< bool >	is_active {false}
std::atomic< bool >	is_buffers_setup {false}
bool	is_notify_active = true
std::atomic< bool >	is_playing {false}
Vector< AudioInfoSupport * >	notify_vector
std::mutex	read_mtx
RingBuffer< uint8_t >	tmp_in {0}
RingBuffer< uint8_t >	tmp_out {0}
int	write_buffer_size = MAX_SINGLE_CHARS
std::mutex	write_mtx

Detailed Description

MiniAudio: https://miniaud.io/.

Author

Phil Schatzmann

Copyright

GPLv3

Constructor & Destructor Documentation

MiniAudioStream()

MiniAudioStream ( )

default

~MiniAudioStream()

~MiniAudioStream ( )

inline

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 JupyterAudioT< T >, MozziStream, TimerCallbackAudioStream, EncodedAudioStream, PureDataStream, AdapterAudioOutputToAudioStream, GeneratedSoundStream< T >, GeneratedSoundStream< int16_t >, and InputMerge< T >.

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

available()

int available ( )

inlineoverridevirtual

Reimplemented from BaseStream.

availableForWrite()

int availableForWrite ( )

inlineoverridevirtual

Reimplemented from BaseStream.

begin() [1/2]

bool begin ( )

inlineoverridevirtual

Reimplemented from BaseStream.

begin() [2/2]

bool begin ( MiniAudioConfig  info )

inline

clearNotifyAudioChange()

virtual void clearNotifyAudioChange ( )

inlinevirtualinherited

Deletes all change notify subscriptions.

Reimplemented in RTSPClient< TcpClient, UdpSocket >.

data_callback()

static void data_callback ( ma_device *  pDevice, void *  pOutput, const void *  pInput, ma_uint32  frameCount  )

inlinestaticprotected

defaultConfig()

MiniAudioConfig defaultConfig ( RxTxMode  mode = RXTX_MODE )

inline

doWait()

void doWait ( )

inlineprotected

end()

void end ( )

inlineoverridevirtual

Reimplemented from BaseStream.

flush()

virtual void flush ( )

inlineoverridevirtualinherited

Reimplemented from Print.

Reimplemented in PureDataStream, URLStreamBufferedT< T >, URLStreamBufferedT< ICYStream >, AudioStreamWrapper, ResampleStream, URLStream, BufferedTaskStream, I2SStream, MemoryStream, RingBufferStream, GeneratedSoundStream< T >, GeneratedSoundStream< int16_t >, and BufferedStream.

isNotifyActive()

bool isNotifyActive ( )

inlineinherited

Checks if the automatic AudioInfo update is active.

isPlaying()

bool isPlaying ( ) const

inline

Check if playback is currently active.

not_supported()

virtual int not_supported ( int  out, const char *  msg = ""  )

inlineprotectedvirtualinherited

notifyAudioChange()

void notifyAudioChange ( AudioInfo  info )

inlineprotectedinherited

operator bool()

virtual operator bool ( )

inlinevirtualinherited

Reimplemented in A2DPStream, ICYStreamT< T >, AudioBLEStream, AudioFFTBase, PortAudioStream, URLStream, I2SStream, AdapterAudioOutputToAudioStream, TimedStream, MemoryStream, GeneratedSoundStream< T >, GeneratedSoundStream< int16_t >, and Pipeline.

readBytes()

size_t readBytes ( uint8_t *  data, size_t  len  )

inlineoverridevirtual

Reimplemented from AudioStream.

readSilence()

virtual size_t readSilence ( uint8_t *  buffer, size_t  length  )

inlinevirtualinherited

Source to generate silence: just sets the buffer to 0.

refillReadBuffer()

void refillReadBuffer ( )

inlineprotectedinherited

Refill small read buffer (e.g. 8 bytes) to avoid single byte reads when calling read()

removeNotifyAudioChange()

virtual bool removeNotifyAudioChange ( AudioInfoSupport &  bi )

inlinevirtualinherited

Removes a target in order not to be notified about audio changes.

Reimplemented in RTSPClient< TcpClient, UdpSocket >.

restartPlayback()

void restartPlayback ( )

inline

Manually restart playback (useful after long delays)

setAudioInfo()

void setAudioInfo ( AudioInfo  info )

inlineoverridevirtual

Defines the input AudioInfo.

Reimplemented from AudioStream.

setNotifyActive()

void setNotifyActive ( bool  flag )

inlineinherited

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

setupBuffers()

void setupBuffers ( int  size = 1200 )

inlineprotected

setWriteBufferSize()

void setWriteBufferSize ( int  size )

inlineinherited

write() [1/2]

size_t write ( const uint8_t *  data, size_t  len  )

inlineoverridevirtual

Reimplemented from AudioStream.

write() [2/2]

virtual size_t write ( uint8_t  ch )

inlineoverridevirtualinherited

Reimplemented in MemoryStream, AudioStreamWrapper, BufferedTaskStream, RingBufferStream, BufferedStream, and URLStream.

writeSilence()

virtual void writeSilence ( size_t  len )

inlinevirtualinherited

Writes len bytes of silence (=0).

Member Data Documentation

_timeout

int _timeout = 10

protectedinherited

buffer_in

RingBuffer<uint8_t> buffer_in {0}

protected

buffer_out

RingBuffer<uint8_t> buffer_out {0}

protected

buffer_size

std::atomic<int> buffer_size {0}

protected

config

MiniAudioConfig config

protected

config_ma

ma_device_config config_ma

protected

device_ma

ma_device device_ma

protected

info

AudioInfo info

protectedinherited

is_active

std::atomic<bool> is_active {false}

protected

is_buffers_setup

std::atomic<bool> is_buffers_setup {false}

protected

is_notify_active

bool is_notify_active = true

protectedinherited

is_playing

std::atomic<bool> is_playing {false}

protected

notify_vector

Vector<AudioInfoSupport*> notify_vector

protectedinherited

read_mtx

std::mutex read_mtx

protected

tmp_in

RingBuffer<uint8_t> tmp_in {0}

protectedinherited

tmp_out

RingBuffer<uint8_t> tmp_out {0}

protectedinherited

write_buffer_size

int write_buffer_size = MAX_SINGLE_CHARS

protectedinherited

write_mtx

std::mutex write_mtx

protected

---

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

• src/AudioTools/AudioLibs/MiniAudioStream.h