namespace Coral

Flags More...

List of all Methods
Annotated List
Files
Globals
Hierarchy
Index

Public Types

Public Methods

Public Members


Detailed Description

Flags

AdvancedAudioDecoder (class)

This class is an advanced audio decoder. It does error correction by using nearly redundant data of left and right channel to "reconstruct" the full data.

AdvancedAudioEncoder (class)

This class is an advanced audio encoder. It does error correction by using nearly redundant data of left and right channel to "reconstruct" the full data.

AdvancedAudioPacket (class)

This class defines the packet format for the advanced audio encoder.

See also: AdvancedAudioEncoder, AdvancedAudioDecoder

AudioClient (class)

This class is an audio client.

const card8 AudioServerDefaultTrafficClass

Default traffic class/TOS for RTP data connection from server to client.

const card8 AudioClientDefaultTrafficClass

Default traffic class/TOS for RTCP control connection from client to server.

AudioClientAppPacket (class)

This class defines the packet format for the audio client's RTCP APP-PRIV messages.

See also: AudioClient, AudioServer

cardinal  AudioConverter (const AudioQualityInterface& from, const AudioQualityInterface& to, const card8* inputBuffer, card8* outputBuffer, const cardinal inputLength, const cardinal outputLength)

Audio quality converter. Convert quality from a given value to a given value. Note: The "from" value must be greater than or equal to the "to" value, that is from-sampling rate >= to-sampling rate, from-bits >= to-bits, from-channels >= to-channels.

Parameters:
fromQuality to convert from.
toQuality to convert to.
inputBufferInput buffer.
outputBufferOutput buffer.
inputLengthLength of the audio data in input buffer.
outputLengthLength of the output buffer.

Returns: Length after conversion.

cardinal  getAlignedLength (const AudioQualityInterface& inputQuality, const AudioQualityInterface& outputQuality, const cardinal inputLength)

Get aligned output length for a conversion from given input quality and input length to output quality. Example: 12 Bit/Stereo has a 6-byte alignment: L1L1R1R2 = 48 bits = 6 Bytes.

Parameters:
inputQualityInput quality.
outputQualityOutput quality.
inputLengthInput length.

Returns: Aligned length.

bool  getConvParams (const cardinal in, const cardinal out, cardinal& a, cardinal& b, float& c)

Get parameters for audio conversion. New sampling rate = (a * OldSamplingRate) / b;

Parameters:
inOld sampling rate.
outNew sampling rate.
aReference to store a.
bReference to store b.
cReference to store float in / out.

Returns: true, if a and b have been found; false, if there are no such numbers for b out of the set {1,2,...,20}

AudioDebug (class)

This class implements AudioWriterInterface for the audio debugger.

AudioDecoderInterface (class)

This class is the interface for an audio decoder.

AudioDecoderRepository (class)

This class is a repository for audio decoders.

AudioDevice (class)

This class implements AudioWriterInterface for the audio device.

AudioEncoderInterface (class)

This class is the interface for an audio encoder.

AudioEncoderRepository (class)

This class is a repository for audio encoders.

AudioMixer (class)

This class is an interface to an audio mixer.

AudioNull (class)

This class implements a dummy AudioWriterInterface.

AudioQuality (class)

This class manages audio quality.

ostream&  operator<< (ostream& out, const AudioQualityInterface& quality)

Implementation of << operator.

AudioQuality  operator+ (const AudioQualityInterface& q1, const AudioQualityInterface& q2)

Implementation of + operator.

AudioQuality  operator- (const AudioQualityInterface& q1, const AudioQualityInterface& q2)

Implementation of - operator.

AudioQuality  operator- (const AudioQualityInterface& q1, const cardinal bytesPerSecond)

Implementation of - operator. Limits resulting audio quality by a given byte rate.

AudioQualityInterface (class)

This class is an interface for getting audio quality.

AdjustableAudioQualityInterface (class)

This class is an interface for getting and setting audio quality. It extends AudioQualityInterface with setting functions.

AudioReaderInterface (class)

This class is the interface for an audio reader.

AudioServer (class)

This class is an audio server based on RTCPAbstractServer

AudioWriterInterface (class)

This class is the interface for an audio writer.

void  installBreakDetector ()

Install break handler.

void  uninstallBreakDetector ()

Uninstall break handler.

bool  breakDetected ()

Check, if break has been detected.

CongestionManager (class)

This class implements a the congestion manager.

CongestionManagerClient (class)

This class implements a client for the congestion manager. Multiple streams can be managed over one connection to the manager.

CongestionManagerPacket (class)

This is a packet which is received and sent by CongestionManager.

CongestionManagerRequest (class)

This is a packet which is received and sent by CongestionManager.

CongestionManagerSuggestion (class)

This is a packet which is received and sent by CongestionManager.

CongestionMonitor (class)

This class implements a congestion monitor. It monitors a network using a NetworkMonitorInterface.

CongestionMonitorReport (class)

This is a congestion monitor report, which can be read from the CongestionMonitor.

ostream&  operator<< (ostream& os, const CongestionMonitorReport& report)

Implementation of << operator.

DecoderPacket (struct)

This structure contains packet information for handleNextPacket() call.

DecoderInterface (class)

This class is the interface for a decoder.

DecoderRepositoryInterface (class)

This class is a repository for decoders.

EncoderPacket (struct)

This structure contains packet information for getNextPacket() call.

EncoderInterface (class)

This class is the interface for an encoder.

EncoderRepositoryInterface (class)

This class is a repository for encoders.

ExtendedTransportInfo (class)

This class is an extension to TransportInfo and contains additional information on source and destination.

ostream&  operator<< (ostream& os, const ExtendedTransportInfo& eti)

<< operator.

FastFourierTransformation (class)

This class does fast fourier transformation.

InternetAddress (class)

This class manages an internet address.

InternetFlow (class)

This class inherits InternetAddress and contains an additional flow label for IPv6 support.

enum MediaError {ME_NoError = 0, ME_NoMedia = 1, ME_EOF = 2, ME_UnrecoverableError = 20, ME_BadMedia = ME_UnrecoverableError + 0, ME_ReadError = ME_UnrecoverableError + 1, ME_OutOfMemory = ME_UnrecoverableError + 2, }

Definition of encoder errors.

const card64 PositionStepsPerSecond

Constant for position steps per second: 1 step = 1 nanosecond;

MediaInfo (class)

This class contains information on a media.

ostream&  operator<< (ostream& os, const MediaInfo& mi)

Output operator.

MP3AudioReader (class)

This class is a reader for MP3 audio files.

MultiAudioReader (class)

This class is a reader for multiple audio files from a list.

MultiAudioWriter (class)

This class implements AudioWriterInterface for a set of AudioWriterInterfaces. Example: AudioDevice + AudioDebug + SpectrumAnalyzer.

NetLogFileHeader (struct)

This is the Header of a netlog file.

NetLogReader (class)

This class implements a reader for NetworkMonitorReports. The reports will be read from a file written by NetLogWriter.

NetLogWriter (class)

This class implements a writer for NetworkMonitorReports. The reports will be written to a file in given intervals.

NetworkMonitor (class)

This class implements a network monitor, which sums bytes and packets transmitted over a given network interface (eth0, lo, ...). The interface will be set to promiscuous mode. Note: root permissions are required for monitoring a network interface!

NetworkMonitorInterface (class)

This class is an interface for a network monitor, which sums bytes and packets transmitted.

NetworkMonitorReport (class)

This is a network report, which can be read from a NetworkMonitor.

ostream&  operator<< (ostream& os, const NetworkMonitorReport& report)

Implementation of << operator.

NetworkMonitorSimulator (class)

This class implements a network monitor simulator.

PingerHost (struct)

This structure contains internal information for RoundTripTimePinger.

inline int  operator== (const PingerHost& ph1, const PingerHost& ph2)

Operator "==".

inline int  operator== (const PingerHost& ph1, const PingerHost& ph2)

Operator "!=".

inline int  operator< (const PingerHost& ph1, const PingerHost& ph2)

Operator "<".

inline int  operator> (const PingerHost& ph1, const PingerHost& ph2)

Operator ">".

PortableAddress (class)

Binary representation for a socket address for sending the address over a network. The difference between InternetAddress is that PortableAddress does not contain hidden information on virtual function management, which make network transfer of InternetAddress objects problematic.

QAudioMixer (class)

This class is a Qt GUI for the audio mixer.

InfoEntry (struct)

This structure describes a single info string for QInfoWidget and QInfoTabWidget.

InfoTable (struct)

This structure is a table of InfoEntries for QInfoWidget and QInfoTabWidget.

QInfoWidget (class)

This class is a widget for displaying sets of info strings.

QInfoTabWidget (class)

This class is a widget for displaying groups of sets of info strings.

const card16 [] QSpectrumAnalyzerTimings

Constants for the timing radio buttons.

QSpectrumAnalyzer (class)

This class is the Qt-Toolkit GUI for the spectrum analyzer.

Randomizer (class)

This class is an randomizer. The randomizer algorithm will calculate random numbers with seed given by system timer (microseconds since January 01, 1970) or given by a number.

RoundTripTimePinger (class)

This class implements a round trip time pinger.

RTCPAbstractServer (class)

This class is an abstract RTCP server.

enum RTCP_Type {RTCP_SR = 200, RTCP_RR = 201, RTCP_SDES = 202, RTCP_BYE = 203, RTCP_APP = 204 }

Definition of RTCP message types.

enum RTCP_SDES_Type {RTCP_SDES_END = 0, RTCP_SDES_CNAME = 1, RTCP_SDES_NAME = 2, RTCP_SDES_EMAIL = 3, RTCP_SDES_PHONE = 4, RTCP_SDES_LOC = 5, RTCP_SDES_TOOL = 6, RTCP_SDES_NOTE = 7, RTCP_SDES_PRIV = 8 }

Definition of RTCP SDES message types.

RTCPCommonHeader (class)

This class manages a common RTCP header.

See also: RTCPSender, RTCPReceiver, RTCPAbstractServer

RTCPSenderInfoBlock (class)

This class manages a sender info block

See also: RTCPSender, RTCPReceiver, RTCPAbstractServer

RTCPReceptionReportBlock (class)

This class manages a reception report block

See also: RTCPSender, RTCPReceiver, RTCPAbstractServer

RTCPReport (class)

This class manages an RTCP report.

See also: RTCPSender, RTCPReceiver, RTCPAbstractServer

RTCPSenderReport (class)

This class manages an RTCP sender report

See also: RTCPSender, RTCPReceiver, RTCPAbstractServer

RTCPReceiverReport (class)

This class manages an RTCP receiver report

See also: RTCPSender, RTCPReceiver, RTCPAbstractServer

RTCPSourceDescriptionItem (class)

This class manages an RTCP source description item

See also: RTCPSender, RTCPReceiver, RTCPAbstractServer

RTCPSourceDescriptionChunk (class)

This class manages an RTCP source description chunk

See also: RTCPSender, RTCPReceiver, RTCPAbstractServer

RTCPSourceDescription (class)

This class manages an RTCP source description (SDES)

See also: RTCPSender, RTCPReceiver, RTCPAbstractServer

RTCPBye (class)

This class manages an RTCP BYE message

See also: RTCPSender, RTCPReceiver, RTCPAbstractServer

RTCPApp (class)

This class manages an RTCP APP message

See also: RTCPSender, RTCPReceiver, RTCPAbstractServer

RTCPReceiver (class)

This class implements an RTCP receiver based on Thread.

RTCPSender (class)

This class implements an RTCP sender based on TimedThread.

RTPConstants (namespace)

RTPPacket (class)

This class manages an RTP packet

See also: RTPSender, RTPReceiver

RTPReceiver (class)

This class implements an RTP receiver based on Thread.

RTPSender (class)

This class implements an RTP sender based on TimedThread.

SeqNumValidator (class)

This class is a validator for sequence numbers. It is based on the algorithm described in RFC 1889. It can use sequence numbers up to a size of 64 bits. Jitter and fraction loss calculation is also done by this class.

SimpleAudioDecoder (class)

This class is an simple audio decoder. It does no error correction or redundant transmission.

SimpleAudioEncoder (class)

This class is an simple audio encoder. It does no error correction or redundant transmission.

SimpleAudioPacket (class)

This class defines the packet format for the simple audio encoder.

See also: SimpleAudioEncoder, SimpleAudioDecoder

const cardinal UDPHeaderSize

UDP header size.

const cardinal IPv4HeaderSize

IPv4 header size.

const cardinal IPv6HeaderSize

IPv6 header size.

Socket (class)

This class manages a socket. IPv6 support is automatically available, when supported by the system.

SocketAddress (class)

This class is an interface for a socket address.

inline ostream&  operator<< (ostream& os, const SocketAddress& sa)

Output operator.

SourceStateInfo (class)

This class manages the source state information of an RTP receiver to be transmitted by a RTCPSender. See also RFC 1889 for more information on RTP.

See also: RTPReceiver, RTCPSender

SpectrumAnalyzer (class)

This class implements a spectrum analyzer device implementing AudioWriterInterface.

StreamMonitorReport (class)

This class contains a report for a set of streams. Note: No synchronization is done by StreamMonitorReport. The user has to take care for correct thread synchronization!

ostream&  operator<< (ostream& os, StreamMonitorReport& report)

Implementation of << operator.

StreamReport (struct)

This class contains a report for a single stream.

ostream&  operator<< (ostream& os, const StreamReport& report)

Implementation of << operator.

StreamSrcDest (class)

This class is contains source and destination of a stream.

ostream&  operator<< (ostream& os, const StreamSrcDest& ssd)

<< operator.

Synchronizable (class)

This class realizes synchronized access to a thread's data by other threads. Synchronization is done by using a global pthread mutex and obtaining access to this mutex by synchronized() for synchronized access and releasing this mutex for unsynchronized access. IMPORTANT: Do *not* use synchronized()/unsynchronized() within async signal handlers. This may cause deadlocks. See PThread's pthread_mutex_lock man-page, section "Async Signal Safety" for more information!

Thread (class)

This abstract class realizes threads based on Linux's pthreads. The user of this class has to implement run(). Synchronization is implemented by inheriting Synchronizable. IMPORTANT: Do *not* use Thread methods within async signal handlers. This may cause deadlocks. See PThread's pthread_mutex_lock man-page, section "Async Signal Safety" for more information!

TimedThread (class)

This abstract class realizes a timed thread based on Thread. The user of this class has to implement timerEvent(). Inaccurate system timers are corrected by calling user's timerEvent() implementation multiple times if necessary. This feature can be modified by setTimerCorrection (Default is on at a maximum of 10 calls). IMPORTANT: Do *not* use Thread methods within async signal handlers. This may cause deadlocks. See PThread's pthread_mutex_lock man-page, section "Async Signal Safety" for more information!

inline void  debug (const char* string)

Debug output.

Parameters:
stringDebug string to be written to cerr.

card64  getMicroTime ()

Get microseconds since January 01, 1970.

Returns: Microseconds since January 01, 1970.

inline card16  translate16 (const card16 x)

Translate 16-bit value to network byte order.

Parameters:
xValue to be translated.

Returns: Translated value.

inline card32  translate32 (const card32 x)

Translate 32-bit value to network byte order.

Parameters:
xValue to be translated.

Returns: Translated value.

inline card64  translate64 (const card64 x)

Translate 64-bit value to network byte order.

Parameters:
xValue to be translated.

Returns: Translated value.

inline card64  translateToBinary (const double x)

Translate double to 64-bit binary.

Parameters:
xValue to be translated.

Returns: Translated value.

inline double  translateToDouble (const card64 x)

Translate 64-bit binary to double.

Parameters:
xValue to be translated.

Returns: Translated value.

cardinal  calculatePacketsPerSecond (const cardinal payloadBytesPerSecond, const cardinal framesPerSecond, const cardinal maxPacketSize, const cardinal headerLength)

Calculate packets per second.

Asumption: Every frame has it's own packets.

Parameters:
payloadBytesPerSecondByte rate of payload data.
framesPerSecondFrame rate.
maxPacketSizeMaximum size of a packet.
headerLengthLength of header for each frame.

Returns: Total bytes per second.

cardinal  calculateBytesPerSecond (const cardinal payloadBytesPerSecond, const cardinal framesPerSecond, const cardinal maxPacketSize, const cardinal headerLength)

Calculate frames per second.

Asumption: Every frame has it's own packets.

Parameters:
payloadBytesPerSecondByte rate of payload data.
framesPerSecondFrame rate.
maxPacketSizeMaximum size of a packet.
headerLengthLength of header for each frame.

Returns: Total frames per second.

bool  scanURL (const String& location, String& protocol, String& host, String& path)

Scan protocol, host and path from an URL string. The protocol my be missing, if the String "protocol" is initialized with a default.

Parameters:
locationString with URL.
protocolPlace to store the protocol name.
hostPlace to store the host name.
pathPlace to store the path.

Returns: true on success; false otherwise.

template<class T> void  quickSort (T* array, const integer start, const integer end)

Sort array using QuickSort algorithm.

Parameters:
arrayArray to be sorted.
startStart offset in array.
endEnd offset in array.

template<class T> cardinal  removeDuplicates (T* array, const cardinal length)

Remove duplicates from *sorted* array.

Parameters:
arrayArray to be sorted.
lengthLength of array.

void  printTimeStamp (ostream& os = cout)

Print time stamp (date and time) to given output stream.

Parameters:
osOutput stream.

void*  operator new (size_t size) throw (std::bad_alloc)

operator new() replacement for usage with libefence.

void  operator delete (void* ptr) throw ()

operator delete() replacement for usage with libefence.

TrafficClassValues (class)

This class contains a set of values for the traffic class/TOS byte of IP packets. This class contains only static methods and attributes.

TrafficShaper (class)

This class is a traffic shaper.

TrafficShaperSingleton (class)

This class is a singleton for the traffic shaper.

TransportInfoLayer (class)

This class keeps information on a quality level's layers.

ostream&  operator<< (ostream& os, const TransportInfoLayer& ti)

<< operator.

TransportInfoLevel (class)

This class keeps information on a quality level.

ostream&  operator<< (ostream& os, const TransportInfoLevel& ti)

<< operator.

TransportInfo (class)

This class keeps information on an encoding's transport of data: Quality levels and layers, required bandwidth, etc.

See also: EncoderInterface, DecoderInterface

ostream&  operator<< (ostream& os, const TransportInfo& ti)

<< operator.

UnixAddress (class)

This class manages an unix socket address.

WavAudioReader (class)

This class is a reader for WAV audio files.


Generated by: viper@odin on Fri Feb 23 12:41:26 2001, using kdoc 2.0a36.