live
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | Private Member Functions | Private Attributes
AudioInputDevice Class Referenceabstract

#include <AudioInputDevice.hh>

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

Public Types

typedef void() afterGettingFunc(void *clientData, unsigned frameSize, unsigned numTruncatedBytes, struct timeval presentationTime, unsigned durationInMicroseconds)
 
typedef void() onCloseFunc(void *clientData)
 

Public Member Functions

unsigned char bitsPerSample () const
 
unsigned char numChannels () const
 
unsigned samplingFrequency () const
 
virtual Boolean setInputPort (int portIndex)=0
 
virtual double getAverageLevel () const =0
 
void getNextFrame (unsigned char *to, unsigned maxSize, afterGettingFunc *afterGettingFunc, void *afterGettingClientData, onCloseFunc *onCloseFunc, void *onCloseClientData)
 
void handleClosure ()
 
void stopGettingFrames ()
 
virtual unsigned maxFrameSize () const
 
virtual void doGetNextFrame ()=0
 
Boolean isCurrentlyAwaitingData () const
 
virtual void getAttributes () const
 
virtual char const * MIMEtype () const
 
virtual Boolean isRTPSource () const
 
virtual Boolean isMPEG1or2VideoStreamFramer () const
 
virtual Boolean isMPEG4VideoStreamFramer () const
 
virtual Boolean isH264VideoStreamFramer () const
 
virtual Boolean isH265VideoStreamFramer () const
 
virtual Boolean isDVVideoStreamFramer () const
 
virtual Boolean isJPEGVideoSource () const
 
virtual Boolean isAMRAudioSource () const
 
virtual Boolean isMPEG2TransportStreamMultiplexor () const
 
UsageEnvironment & envir () const
 
char const * name () const
 
virtual Boolean isSink () const
 
virtual Boolean isRTCPInstance () const
 
virtual Boolean isRTSPClient () const
 
virtual Boolean isRTSPServer () const
 
virtual Boolean isMediaSession () const
 
virtual Boolean isServerMediaSession () const
 

Static Public Member Functions

static AudioInputDevice * createNew (UsageEnvironment &env, int inputPortNumber, unsigned char bitsPerSample, unsigned char numChannels, unsigned samplingFrequency, unsigned granularityInMS=20)
 
static AudioPortNames * getPortNames ()
 
static Boolean lookupByName (UsageEnvironment &env, char const *sourceName, FramedSource *&resultSource)
 
static Boolean lookupByName (UsageEnvironment &env, char const *sourceName, MediaSource *&resultSource)
 
static Boolean lookupByName (UsageEnvironment &env, char const *mediumName, Medium *&resultMedium)
 
static void handleClosure (void *clientData)
 
static void afterGetting (FramedSource *source)
 
static void close (UsageEnvironment &env, char const *mediumName)
 
static void close (Medium *medium)
 

Static Public Attributes

static char ** allowedDeviceNames
 

Protected Member Functions

 AudioInputDevice (UsageEnvironment &env, unsigned char bitsPerSample, unsigned char numChannels, unsigned samplingFrequency, unsigned granularityInMS)
 
virtual ~AudioInputDevice ()
 
virtual void doStopGettingFrames ()
 
TaskToken & nextTask ()
 

Protected Attributes

unsigned char fBitsPerSample
 
unsigned char fNumChannels
 
unsigned fSamplingFrequency
 
unsigned fGranularityInMS
 
unsigned char * fTo
 
unsigned fMaxSize
 
unsigned fFrameSize
 
unsigned fNumTruncatedBytes
 
struct timeval fPresentationTime
 
unsigned fDurationInMicroseconds
 

Private Member Functions

virtual Boolean isFramedSource () const
 
virtual Boolean isSource () const
 

Private Attributes

afterGettingFunc * fAfterGettingFunc
 
void * fAfterGettingClientData
 
onCloseFunc * fOnCloseFunc
 
void * fOnCloseClientData
 
Boolean fIsCurrentlyAwaitingData
 
UsageEnvironment & fEnviron
 
char fMediumName [mediumNameMaxLen]
 
TaskToken fNextTask
 

Detailed Description

Definition at line 36 of file AudioInputDevice.hh.

Member Typedef Documentation

◆ afterGettingFunc

typedef void() FramedSource::afterGettingFunc(void *clientData, unsigned frameSize, unsigned numTruncatedBytes, struct timeval presentationTime, unsigned durationInMicroseconds)
inherited

Definition at line 36 of file FramedSource.hh.

◆ onCloseFunc

typedef void() FramedSource::onCloseFunc(void *clientData)
inherited

Definition at line 40 of file FramedSource.hh.

Constructor & Destructor Documentation

◆ AudioInputDevice()

AudioInputDevice::AudioInputDevice ( UsageEnvironment &  env,
unsigned char  bitsPerSample,
unsigned char  numChannels,
unsigned  samplingFrequency,
unsigned  granularityInMS 
)
protected

◆ ~AudioInputDevice()

virtual AudioInputDevice::~AudioInputDevice ( )
protectedvirtual

Member Function Documentation

◆ afterGetting()

static void FramedSource::afterGetting ( FramedSource *  source)
staticinherited

◆ bitsPerSample()

unsigned char AudioInputDevice::bitsPerSample ( ) const
inline

Definition at line 38 of file AudioInputDevice.hh.

38{ return fBitsPerSample; }
AudioInputDevice::fBitsPerSample
unsigned char fBitsPerSample
Definition: AudioInputDevice.hh:66

References fBitsPerSample.

◆ close() [1/2]

static void Medium::close ( Medium *  medium)
staticinherited

◆ close() [2/2]

static void Medium::close ( UsageEnvironment &  env,
char const *  mediumName 
)
staticinherited

◆ createNew()

static AudioInputDevice * AudioInputDevice::createNew ( UsageEnvironment &  env,
int  inputPortNumber,
unsigned char  bitsPerSample,
unsigned char  numChannels,
unsigned  samplingFrequency,
unsigned  granularityInMS = 20 
)
static

◆ doGetNextFrame()

virtual void FramedSource::doGetNextFrame ( )
pure virtualinherited

Implemented in AC3AudioStreamFramer, ADTSAudioFileSource, ADTSAudioStreamDiscreteFramer, AMRAudioFileSource, BasicUDPSource, ByteStreamFileSource, ByteStreamMemoryBufferSource, ByteStreamMultiFileSource, DeviceSource, DVVideoStreamFramer, H263plusVideoStreamFramer, H264or5VideoStreamDiscreteFramer, H264or5VideoStreamFramer, ADUFromMP3Source, MP3FromADUSource, MP3ADUinterleaver, MP3ADUdeinterleaver, MP3ADUTranscoder, MP3FileSource, MPEG1or2AudioStreamFramer, MPEG1or2DemuxedElementaryStream, MPEG1or2VideoStreamDiscreteFramer, MPEG2IFrameIndexFromTransportStream, MPEG2TransportStreamAccumulator, MPEG2TransportStreamFramer, MPEG2TransportStreamMultiplexor, MPEG2TransportStreamTrickModeFilter, MPEG4VideoStreamDiscreteFramer, MPEGVideoStreamFramer, MultiFramedRTPSource, PresentationTimeSubsessionNormalizer, T140IdleFilter, uLawFromPCMAudioSource, PCMFromuLawAudioSource, NetworkFromHostOrder16, HostFromNetworkOrder16, EndianSwap16, EndianSwap24, WAVAudioFileSource, MatroskaDemuxedTrack, MPEG2TransportStreamDemuxedTrack, and OggDemuxedTrack.

◆ doStopGettingFrames()

virtual void FramedSource::doStopGettingFrames ( )
protectedvirtualinherited

Reimplemented in BasicUDPSource, ByteStreamFileSource, FramedFilter, MPEG1or2DemuxedElementaryStream, MPEG2TransportStreamFramer, MPEG2TransportStreamFromESSource, MPEG2TransportStreamFromPESSource, MPEG2TransportStreamTrickModeFilter, MPEGVideoStreamFramer, MultiFramedRTPSource, T140IdleFilter, WAVAudioFileSource, and MatroskaDemuxedTrack.

◆ envir()

UsageEnvironment & Medium::envir ( ) const
inlineinherited

Definition at line 59 of file Media.hh.

59{return fEnviron;}
Medium::fEnviron
UsageEnvironment & fEnviron
Definition: Media.hh:82

References Medium::fEnviron.

Referenced by MediaSubsession::env(), GenericMediaServer::ClientConnection::envir(), GenericMediaServer::ClientSession::envir(), and RTPInterface::envir().

◆ getAttributes()

virtual void MediaSource::getAttributes ( ) const
virtualinherited

Reimplemented in FramedFilter, MP3ADUTranscoder, MP3FileSource, and RTPSource.

◆ getAverageLevel()

virtual double AudioInputDevice::getAverageLevel ( ) const
pure virtual

Implemented in WAVAudioFileSource.

◆ getNextFrame()

void FramedSource::getNextFrame ( unsigned char *  to,
unsigned  maxSize,
afterGettingFunc *  afterGettingFunc,
void *  afterGettingClientData,
onCloseFunc *  onCloseFunc,
void *  onCloseClientData 
)
inherited

◆ getPortNames()

static AudioPortNames * AudioInputDevice::getPortNames ( )
static

◆ handleClosure() [1/2]

void FramedSource::handleClosure ( )
inherited

◆ handleClosure() [2/2]

static void FramedSource::handleClosure ( void *  clientData)
staticinherited

◆ isAMRAudioSource()

virtual Boolean MediaSource::isAMRAudioSource ( ) const
virtualinherited

Reimplemented in AMRAudioSource.

◆ isCurrentlyAwaitingData()

Boolean FramedSource::isCurrentlyAwaitingData ( ) const
inlineinherited

Definition at line 61 of file FramedSource.hh.

61{return fIsCurrentlyAwaitingData;}
FramedSource::fIsCurrentlyAwaitingData
Boolean fIsCurrentlyAwaitingData
Definition: FramedSource.hh:92

References FramedSource::fIsCurrentlyAwaitingData.

◆ isDVVideoStreamFramer()

virtual Boolean MediaSource::isDVVideoStreamFramer ( ) const
virtualinherited

Reimplemented in DVVideoStreamFramer.

◆ isFramedSource()

virtual Boolean FramedSource::isFramedSource ( ) const
privatevirtualinherited

Reimplemented from MediaSource.

◆ isH264VideoStreamFramer()

virtual Boolean MediaSource::isH264VideoStreamFramer ( ) const
virtualinherited

Reimplemented in H264VideoStreamDiscreteFramer, and H264VideoStreamFramer.

◆ isH265VideoStreamFramer()

virtual Boolean MediaSource::isH265VideoStreamFramer ( ) const
virtualinherited

Reimplemented in H265VideoStreamDiscreteFramer, and H265VideoStreamFramer.

◆ isJPEGVideoSource()

virtual Boolean MediaSource::isJPEGVideoSource ( ) const
virtualinherited

Reimplemented in JPEGVideoSource.

◆ isMediaSession()

virtual Boolean Medium::isMediaSession ( ) const
virtualinherited

Reimplemented in MediaSession.

◆ isMPEG1or2VideoStreamFramer()

virtual Boolean MediaSource::isMPEG1or2VideoStreamFramer ( ) const
virtualinherited

Reimplemented in MPEG1or2VideoStreamFramer.

◆ isMPEG2TransportStreamMultiplexor()

virtual Boolean MediaSource::isMPEG2TransportStreamMultiplexor ( ) const
virtualinherited

Reimplemented in MPEG2TransportStreamMultiplexor.

◆ isMPEG4VideoStreamFramer()

virtual Boolean MediaSource::isMPEG4VideoStreamFramer ( ) const
virtualinherited

Reimplemented in MPEG4VideoStreamFramer.

◆ isRTCPInstance()

virtual Boolean Medium::isRTCPInstance ( ) const
virtualinherited

Reimplemented in RTCPInstance.

◆ isRTPSource()

virtual Boolean MediaSource::isRTPSource ( ) const
virtualinherited

Reimplemented in RTPSource.

◆ isRTSPClient()

virtual Boolean Medium::isRTSPClient ( ) const
virtualinherited

Reimplemented in RTSPClient.

◆ isRTSPServer()

virtual Boolean Medium::isRTSPServer ( ) const
virtualinherited

Reimplemented in RTSPServer.

◆ isServerMediaSession()

virtual Boolean Medium::isServerMediaSession ( ) const
virtualinherited

Reimplemented in ServerMediaSession.

◆ isSink()

virtual Boolean Medium::isSink ( ) const
virtualinherited

Reimplemented in MediaSink.

◆ isSource()

virtual Boolean MediaSource::isSource ( ) const
privatevirtualinherited

Reimplemented from Medium.

◆ lookupByName() [1/3]

static Boolean Medium::lookupByName ( UsageEnvironment &  env,
char const *  mediumName,
Medium *&  resultMedium 
)
staticinherited

◆ lookupByName() [2/3]

static Boolean FramedSource::lookupByName ( UsageEnvironment &  env,
char const *  sourceName,
FramedSource *&  resultSource 
)
staticinherited

◆ lookupByName() [3/3]

static Boolean MediaSource::lookupByName ( UsageEnvironment &  env,
char const *  sourceName,
MediaSource *&  resultSource 
)
staticinherited

◆ maxFrameSize()

virtual unsigned FramedSource::maxFrameSize ( ) const
virtualinherited

Reimplemented in BasicUDPSource, and MPEG1or2DemuxedElementaryStream.

◆ MIMEtype()

virtual char const * MediaSource::MIMEtype ( ) const
virtualinherited

Reimplemented in AC3AudioRTPSource, AMRAudioSource, DVVideoRTPSource, FramedFilter, H261VideoRTPSource, H263plusVideoRTPSource, H264VideoRTPSource, H265VideoRTPSource, JPEG2000VideoRTPSource, JPEGVideoRTPSource, ADUFromMP3Source, MP3FromADUSource, MP3ADURTPSource, MP3FileSource, MPEG1or2AudioRTPSource, MPEG1or2DemuxedElementaryStream, MPEG1or2VideoRTPSource, MPEG4ESVideoRTPSource, MPEG4GenericRTPSource, MPEG4LATMAudioRTPSource, QuickTimeGenericRTPSource, RawVideoRTPSource, SimpleRTPSource, TheoraVideoRTPSource, VorbisAudioRTPSource, VP8VideoRTPSource, VP9VideoRTPSource, MatroskaDemuxedTrack, and OggDemuxedTrack.

◆ name()

char const * Medium::name ( ) const
inlineinherited

Definition at line 61 of file Media.hh.

61{return fMediumName;}
Medium::fMediumName
char fMediumName[mediumNameMaxLen]
Definition: Media.hh:83

References Medium::fMediumName.

◆ nextTask()

TaskToken & Medium::nextTask ( )
inlineprotectedinherited

Definition at line 77 of file Media.hh.

77 {
78 return fNextTask;
79 }
Medium::fNextTask
TaskToken fNextTask
Definition: Media.hh:84

References Medium::fNextTask.

◆ numChannels()

unsigned char AudioInputDevice::numChannels ( ) const
inline

Definition at line 39 of file AudioInputDevice.hh.

39{ return fNumChannels; }
AudioInputDevice::fNumChannels
unsigned char fNumChannels
Definition: AudioInputDevice.hh:66

References fNumChannels.

◆ samplingFrequency()

unsigned AudioInputDevice::samplingFrequency ( ) const
inline

Definition at line 40 of file AudioInputDevice.hh.

40{ return fSamplingFrequency; }
AudioInputDevice::fSamplingFrequency
unsigned fSamplingFrequency
Definition: AudioInputDevice.hh:67

References fSamplingFrequency.

◆ setInputPort()

virtual Boolean AudioInputDevice::setInputPort ( int  portIndex)
pure virtual

Implemented in WAVAudioFileSource.

◆ stopGettingFrames()

void FramedSource::stopGettingFrames ( )
inherited

Field Documentation

◆ allowedDeviceNames

char** AudioInputDevice::allowedDeviceNames
static

Definition at line 51 of file AudioInputDevice.hh.

◆ fAfterGettingClientData

void* FramedSource::fAfterGettingClientData
privateinherited

Definition at line 88 of file FramedSource.hh.

◆ fAfterGettingFunc

afterGettingFunc* FramedSource::fAfterGettingFunc
privateinherited

Definition at line 87 of file FramedSource.hh.

◆ fBitsPerSample

unsigned char AudioInputDevice::fBitsPerSample
protected

Definition at line 66 of file AudioInputDevice.hh.

Referenced by bitsPerSample().

◆ fDurationInMicroseconds

unsigned FramedSource::fDurationInMicroseconds
protectedinherited

Definition at line 80 of file FramedSource.hh.

Referenced by MatroskaDemuxedTrack::durationInMicroseconds(), and OggDemuxedTrack::durationInMicroseconds().

◆ fEnviron

UsageEnvironment& Medium::fEnviron
privateinherited

Definition at line 82 of file Media.hh.

Referenced by Medium::envir().

◆ fFrameSize

unsigned FramedSource::fFrameSize
protectedinherited

Definition at line 77 of file FramedSource.hh.

Referenced by MatroskaDemuxedTrack::frameSize(), MPEG2TransportStreamDemuxedTrack::frameSize(), and OggDemuxedTrack::frameSize().

◆ fGranularityInMS

unsigned AudioInputDevice::fGranularityInMS
protected

Definition at line 68 of file AudioInputDevice.hh.

◆ fIsCurrentlyAwaitingData

Boolean FramedSource::fIsCurrentlyAwaitingData
privateinherited

Definition at line 92 of file FramedSource.hh.

Referenced by FramedSource::isCurrentlyAwaitingData().

◆ fMaxSize

unsigned FramedSource::fMaxSize
protectedinherited

Definition at line 76 of file FramedSource.hh.

Referenced by MatroskaDemuxedTrack::maxSize(), MPEG2TransportStreamDemuxedTrack::maxSize(), and OggDemuxedTrack::maxSize().

◆ fMediumName

char Medium::fMediumName[mediumNameMaxLen]
privateinherited

Definition at line 83 of file Media.hh.

Referenced by Medium::name().

◆ fNextTask

TaskToken Medium::fNextTask
privateinherited

Definition at line 84 of file Media.hh.

Referenced by Medium::nextTask().

◆ fNumChannels

unsigned char AudioInputDevice::fNumChannels
protected

Definition at line 66 of file AudioInputDevice.hh.

Referenced by numChannels().

◆ fNumTruncatedBytes

unsigned FramedSource::fNumTruncatedBytes
protectedinherited

Definition at line 78 of file FramedSource.hh.

Referenced by MatroskaDemuxedTrack::numTruncatedBytes(), MPEG2TransportStreamDemuxedTrack::numTruncatedBytes(), and OggDemuxedTrack::numTruncatedBytes().

◆ fOnCloseClientData

void* FramedSource::fOnCloseClientData
privateinherited

Definition at line 90 of file FramedSource.hh.

◆ fOnCloseFunc

onCloseFunc* FramedSource::fOnCloseFunc
privateinherited

Definition at line 89 of file FramedSource.hh.

◆ fPresentationTime

struct timeval FramedSource::fPresentationTime
protectedinherited

Definition at line 79 of file FramedSource.hh.

Referenced by MatroskaDemuxedTrack::presentationTime(), MPEG2TransportStreamDemuxedTrack::presentationTime(), and OggDemuxedTrack::presentationTime().

◆ fSamplingFrequency

unsigned AudioInputDevice::fSamplingFrequency
protected

Definition at line 67 of file AudioInputDevice.hh.

Referenced by samplingFrequency().

◆ fTo

unsigned char* FramedSource::fTo
protectedinherited

Definition at line 75 of file FramedSource.hh.

Referenced by MatroskaDemuxedTrack::to(), MPEG2TransportStreamDemuxedTrack::to(), and OggDemuxedTrack::to().

The documentation for this class was generated from the following file:
Generated on Wed Jul 9 2025 21:27:05 for live by doxygen 1.9.6