arduino-audio-tools
Loading...
Searching...
No Matches

Common interface for demuxers (DemuxerAVI, DemuxerMP4) that split a container's video and (optional) audio tracks apart. Write code against this interface instead of a concrete class if it should work with either container format. More...

#include <ContainerCommon.h>

Inheritance diagram for Demuxer:
ContainerDecoder MimeSource VideoInfoSource AudioDecoder AudioDecoder AudioInfoSource AudioWriter AudioInfoSource AudioWriter AudioInfoSource AudioWriter AudioInfoSource AudioWriter DemuxerAVI DemuxerMP4 DemuxerMPG DemuxerMTS MultiVideoDemuxer MultiVideoDemuxerFull

Public Member Functions

virtual void addNotifyAudioChange (AudioInfoSupport &bi)
 Adds target to be notified about audio changes.
virtual void addNotifyAudioChange (AudioInfoSupport &bi)
 Adds target to be notified about audio changes.
AudioInfo audioInfo () override
 provides the actual input AudioInfo
AudioInfo audioInfo () override
 provides the actual input AudioInfo
virtual AudioInfo audioInfoOut ()
virtual AudioInfo audioInfoOut ()
bool begin () override
bool begin () override
virtual bool begin (AudioInfo info) override
virtual bool begin (AudioInfo info) override
virtual void clearNotifyAudioChange ()
 Deletes all change notify subscriptions.
virtual void clearNotifyAudioChange ()
 Deletes all change notify subscriptions.
void end () override
void end () override
virtual AudioInfoFormat getAudioInfo ()=0
Print * getOutput ()
Print * getOutput ()
virtual VideoInfo getVideoInfo ()=0
 Common video info (width/height/format/frame_size/total_file_size).
bool isNotifyActive ()
 Checks if the automatic AudioInfo update is active.
bool isNotifyActive ()
 Checks if the automatic AudioInfo update is active.
virtual bool isValid (const uint8_t *data, size_t len)
const char * mime () override=0
virtual const char * mimeVideo ()=0
 The container's MIME type (e.g. "video/avi", "video/mp4").
virtual operator bool ()=0
virtual operator bool ()=0
virtual bool removeNotifyAudioChange (AudioInfoSupport &bi)
 Removes a target in order not to be notified about audio changes.
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 setAudioInfo (AudioInfo from) override
 for most decoders this is not needed
virtual bool setCodecConfig (const uint8_t *data, size_t len)
 Some decoders need e.g. a magic cookie to provide the relevant info for decoding.
virtual bool setCodecConfig (const uint8_t *data, size_t len)
 Some decoders need e.g. a magic cookie to provide the relevant info for decoding.
void setNotifyActive (bool flag)
 Deactivate/Reactivate automatic AudioInfo updates: (default is active).
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 (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.
virtual void setOutput (AudioStream &out_stream)
 Defines where the decoded result is written to.
virtual void setOutput (Print &out_stream) override
 Defines where the decoded result is written to.
virtual void setOutput (Print &out_stream) override
 Defines where the decoded result is written to.
virtual void setOutputAudio (Print &out)=0
virtual void setOutputVideo (Print &out)=0
virtual void setOutputVideo (VideoOutput &out)=0
virtual void setSendWavHeader (bool flag)=0
VideoInfo videoInfo () override
virtual size_t write (const uint8_t *data, size_t len)=0
virtual size_t write (const uint8_t *data, size_t len)=0

Public Attributes

int id
 custom id to be used by application

Protected Member Functions

void notifyAudioChange (AudioInfo info)
void notifyAudioChange (AudioInfo info)
void writeBlocking (Print *out, uint8_t *data, size_t len)
void writeBlocking (Print *out, uint8_t *data, size_t len)

Protected Attributes

AudioInfo info
bool is_notify_active = true
Vector< AudioInfoSupport * > notify_vector
Print * p_print = nullptr

Detailed Description

Common interface for demuxers (DemuxerAVI, DemuxerMP4) that split a container's video and (optional) audio tracks apart. Write code against this interface instead of a concrete class if it should work with either container format.

Author
Phil Schatzmann

Member Function Documentation

◆ addNotifyAudioChange() [1/2]

virtual void addNotifyAudioChange ( AudioInfoSupport & bi)
inlinevirtualinherited

Adds target to be notified about audio changes.

Reimplemented in CodecNOP, CodecNOP, EncodedAudioOutput, and EncodedAudioStream.

◆ addNotifyAudioChange() [2/2]

virtual void addNotifyAudioChange ( AudioInfoSupport & bi)
inlinevirtualinherited

Adds target to be notified about audio changes.

Reimplemented in CodecNOP, CodecNOP, EncodedAudioOutput, and EncodedAudioStream.

◆ audioInfo() [1/2]

◆ audioInfo() [2/2]

◆ audioInfoOut() [1/2]

◆ audioInfoOut() [2/2]

◆ begin() [1/4]

◆ begin() [2/4]

◆ begin() [3/4]

virtual bool begin ( AudioInfo info)
inlineoverridevirtualinherited

Reimplemented from AudioWriter.

◆ begin() [4/4]

virtual bool begin ( AudioInfo info)
inlineoverridevirtualinherited

Reimplemented from AudioWriter.

◆ clearNotifyAudioChange() [1/2]

virtual void clearNotifyAudioChange ( )
inlinevirtualinherited

◆ clearNotifyAudioChange() [2/2]

virtual void clearNotifyAudioChange ( )
inlinevirtualinherited

◆ end() [1/2]

◆ end() [2/2]

◆ getAudioInfo()

virtual AudioInfoFormat getAudioInfo ( )
pure virtual

Common audio info (sample_rate/channels/bits_per_sample), extended with the parsed codec format tag.

Implemented in DemuxerAVI, DemuxerMP4, DemuxerMPG, DemuxerMTS, and MultiVideoDemuxer.

◆ getOutput() [1/2]

Print * getOutput ( )
inlineinherited

◆ getOutput() [2/2]

Print * getOutput ( )
inlineinherited

◆ getVideoInfo()

virtual VideoInfo getVideoInfo ( )
pure virtual

Common video info (width/height/format/frame_size/total_file_size).

Implemented in DemuxerAVI, DemuxerMP4, DemuxerMPG, DemuxerMTS, and MultiVideoDemuxer.

◆ isNotifyActive() [1/2]

bool isNotifyActive ( )
inlineinherited

Checks if the automatic AudioInfo update is active.

◆ isNotifyActive() [2/2]

bool isNotifyActive ( )
inlineinherited

Checks if the automatic AudioInfo update is active.

◆ isValid()

virtual bool isValid ( const uint8_t * data,
size_t len )
inlinevirtual

True if data (the start of the stream, as handed to the first write()) looks like this demuxer's own container format - content-sniffing, not a guarantee (see the concrete class for exactly what's checked). Used by MultiVideoDemuxer to auto-select a registered demuxer (MultiVideoDemuxer.h); not otherwise part of the write()/parse path. Default false, matching VideoDecoder::isValid()'s own default - a demuxer not meant to be auto-detected this way simply never overrides it.

Reimplemented in DemuxerAVI, DemuxerMP4, DemuxerMPG, and DemuxerMTS.

◆ mime()

const char * mime ( )
overridepure virtual

Provides the MIME type of the audio track (e.g. "audio/wav", "audio/aac") - fulfills MimeSource::mime(), so any Demuxer can be passed directly to e.g. MultiDecoder::setMimeSource() to hint the audio codec instead of relying on sniffing the raw byte stream.

Implements AudioDecoder.

Implemented in DemuxerAVI, DemuxerMP4, DemuxerMPG, DemuxerMTS, and MultiVideoDemuxer.

◆ mimeVideo()

virtual const char * mimeVideo ( )
pure virtual

The container's MIME type (e.g. "video/avi", "video/mp4").

Implemented in DemuxerAVI, DemuxerMP4, DemuxerMPG, DemuxerMTS, and MultiVideoDemuxer.

◆ notifyAudioChange() [1/2]

void notifyAudioChange ( AudioInfo info)
inlineprotectedinherited

◆ notifyAudioChange() [2/2]

void notifyAudioChange ( AudioInfo info)
inlineprotectedinherited

◆ operator bool() [1/2]

◆ operator bool() [2/2]

◆ removeNotifyAudioChange() [1/2]

virtual bool removeNotifyAudioChange ( AudioInfoSupport & bi)
inlinevirtualinherited

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

◆ removeNotifyAudioChange() [2/2]

virtual bool removeNotifyAudioChange ( AudioInfoSupport & bi)
inlinevirtualinherited

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

◆ setAudioInfo() [1/2]

void setAudioInfo ( AudioInfo from)
inlineoverridevirtualinherited

for most decoders this is not needed

Implements AudioWriter.

Reimplemented in CodecNOP, and CodecNOP.

◆ setAudioInfo() [2/2]

void setAudioInfo ( AudioInfo from)
inlineoverridevirtualinherited

for most decoders this is not needed

Implements AudioWriter.

Reimplemented in CodecNOP, and CodecNOP.

◆ setCodecConfig() [1/2]

virtual bool setCodecConfig ( const uint8_t * data,
size_t len )
inlinevirtualinherited

Some decoders need e.g. a magic cookie to provide the relevant info for decoding.

Reimplemented in DecoderALAC, and MultiDecoder.

◆ setCodecConfig() [2/2]

virtual bool setCodecConfig ( const uint8_t * data,
size_t len )
inlinevirtualinherited

Some decoders need e.g. a magic cookie to provide the relevant info for decoding.

Reimplemented in DecoderALAC, and MultiDecoder.

◆ setNotifyActive() [1/2]

void setNotifyActive ( bool flag)
inlineinherited

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

◆ setNotifyActive() [2/2]

void setNotifyActive ( bool flag)
inlineinherited

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

◆ setOutput() [1/6]

virtual void setOutput ( AudioOutput & out_stream)
inlinevirtualinherited

Defines where the decoded result is written to.

◆ setOutput() [2/6]

virtual void setOutput ( AudioOutput & out_stream)
inlinevirtualinherited

Defines where the decoded result is written to.

◆ setOutput() [3/6]

virtual void setOutput ( AudioStream & out_stream)
inlinevirtualinherited

Defines where the decoded result is written to.

◆ setOutput() [4/6]

virtual void setOutput ( AudioStream & out_stream)
inlinevirtualinherited

Defines where the decoded result is written to.

◆ setOutput() [5/6]

◆ setOutput() [6/6]

◆ setOutputAudio()

virtual void setOutputAudio ( Print & out)
pure virtual

Defines the audio output stream - e.g. an EncodedAudioStream wrapping an AudioDecoder that matches the track's codec, or any other Print if you want the raw payload as-is.

Implemented in DemuxerAVI, DemuxerMP4, DemuxerMPG, DemuxerMTS, and MultiVideoDemuxer.

◆ setOutputVideo() [1/2]

virtual void setOutputVideo ( Print & out)
pure virtual

Defines the video output - e.g. a VideoOutput implementation, or any other Print if you want the raw payload as-is.

Implemented in DemuxerAVI, DemuxerMP4, DemuxerMPG, DemuxerMTS, and MultiVideoDemuxer.

◆ setOutputVideo() [2/2]

virtual void setOutputVideo ( VideoOutput & out)
pure virtual

Defines the video output - the VideoOutput-specific counterpart of setOutputVideo(Print&), for a target like PacedVideoOutput/ OutputTinyGPU/OutputOpenCV that implements VideoOutput but not Print (the two are unrelated types - see VideoFrameMeter's own comment). Part of the base interface (unlike other concrete-class-specific extras) so code holding only a Demuxer& (e.g. VideoPlayer) can wire it to an arbitrary VideoOutput& without knowing the concrete container format - every current demuxer already implemented this identically before it was pulled up into the interface.

Implemented in DemuxerAVI, DemuxerMP4, DemuxerMPG, DemuxerMTS, and MultiVideoDemuxer.

◆ setSendWavHeader()

virtual void setSendWavHeader ( bool flag)
pure virtual

Overrides the automatic decision of whether a synthetic WAV header is sent to the audio output before any audio payload - see the concrete class for the default heuristic.

Implemented in DemuxerAVI, DemuxerMP4, DemuxerMPG, DemuxerMTS, and MultiVideoDemuxer.

◆ videoInfo()

VideoInfo videoInfo ( )
inlineoverridevirtual

Fulfills VideoInfoSource::videoInfo(), so any Demuxer can be passed directly to e.g. OutputOpenCV::setVideoInfoSource() - note the reported 'format' is the container's codec (e.g. H264), not necessarily what ends up written to a raw-picture VideoOutput/Print (that depends on whatever decoder sits between the demuxer and the output); consumers that care about the decoded format should still set it explicitly and rely on this only for width/height.

Implements VideoInfoSource.

◆ write() [1/2]

virtual size_t write ( const uint8_t * data,
size_t len )
pure virtualinherited

◆ write() [2/2]

virtual size_t write ( const uint8_t * data,
size_t len )
pure virtualinherited

◆ writeBlocking() [1/2]

void writeBlocking ( Print * out,
uint8_t * data,
size_t len )
inlineprotectedinherited

◆ writeBlocking() [2/2]

void writeBlocking ( Print * out,
uint8_t * data,
size_t len )
inlineprotectedinherited

Member Data Documentation

◆ id

int id
inherited

custom id to be used by application

◆ info

AudioInfo info
protectedinherited

◆ is_notify_active

bool is_notify_active = true
protectedinherited

◆ notify_vector

Vector< AudioInfoSupport * > notify_vector
protectedinherited

◆ p_print

Print * p_print = nullptr
protectedinherited

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