AdvancedAudioPacket Struct Reference

Advanced Audio Packet. More...

#include <advancedaudiopacket.h>

List of all members.

Public Types
enum	AdvancedAudioFlags {   AAF_ChannelLeft = (1 << 0), AAF_ChannelRight = (1 << 1), AAF_ByteUpper = (1 << 2), AAF_ByteLower = (1 << 3),   AAF_MediaInfo = (1 << 4) }
Public Member Functions
	AdvancedAudioPacket ()
void	translate ()
void	reset ()
Static Public Member Functions
static AudioQuality	calculateQualityForLimits (const AudioQualityInterface &userSetting, const AudioQualityInterface &inputQuality, const card64 totalByteRateLimit, const card64 byteRateLimitL1, const card64 byteRateLimitL2, const card64 byteRateLimitL3, const cardinal networkQualityDecrement, const cardinal headerSize, const cardinal maxPacketSize)
static cardinal	calculateFrameSize (const cardinal inputBytesPerSecond, const cardinal inputFrameSize)
static cardinal	calculateLayers (const AudioQualityInterface &quality)
Public Attributes
card32	FormatID
card16	SamplingRate
card8	Channels
card8	Bits
card64	Position
card64	MaxPosition
card8	ErrorCode
card8	Flags
enum AdvancedAudioPacket::AdvancedAudioFlags	__attribute__
card16	Fragment
char	Data [0]
Static Public Attributes
static const card16	AdvancedAudioTypeID = 0x2961
static const char	AdvancedAudioTypeName [] = "Advanced Audio Encoding"
static const card32	AdvancedAudioFormatID = 0x74660000 | AdvancedAudioTypeID
static const cardinal	AdvancedAudioMediaInfoPacketsPerSecond = 2
static const cardinal	AdvancedAudioFramesPerSecond = 35
static const cardinal	AdvancedAudioFrameSize
static const cardinal	AdvancedAudioMaxTransferDelay = 100 * 16
static const cardinal	AdvancedAudioMaxQualityLayers = 3
static const cardinal	AdvancedAudioQualityLevels = AudioQuality::QualityLevels

---

Detailed Description

Advanced Audio Packet.

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

Author:

Thomas Dreibholz

Version:

1.0

See also:

AdvancedAudioEncoder

AdvancedAudioDecoder

---

Member Enumeration Documentation

enum AdvancedAudioPacket::AdvancedAudioFlags

Emumeration of Flags.

Enumerator:

AAF_ChannelLeft
AAF_ChannelRight
AAF_ByteUpper
AAF_ByteLower
AAF_MediaInfo

---

Constructor & Destructor Documentation

AdvancedAudioPacket::AdvancedAudioPacket

(

)

Constructor.

---

Member Function Documentation

cardinal AdvancedAudioPacket::calculateFrameSize	(	const cardinal	inputBytesPerSecond,
		const cardinal	inputFrameSize
	)		[static]

Calculate output frame size from given input bytes per second and input frame size.

Parameters:

inputBytesPerSecond	Input source's bytes per second.
inputFrameSize	Input source's frame size.

Returns:

The calculated frame size.

cardinal AdvancedAudioPacket::calculateLayers

(

const AudioQualityInterface &

quality

)

[static]

Calculate number of layers for given quality.

Parameters:

quality

Quality.

Returns:

Number of layers.

AudioQuality AdvancedAudioPacket::calculateQualityForLimits	(	const AudioQualityInterface &	userSetting,
		const AudioQualityInterface &	inputQuality,
		const card64	totalByteRateLimit,
		const card64	byteRateLimitL1,
		const card64	byteRateLimitL2,
		const card64	byteRateLimitL3,
		const cardinal	networkQualityDecrement,
		const cardinal	headerSize,
		const cardinal	maxPacketSize
	)		[static]

Quality calculation for given user quality limited by input quality, byte rate and network quality decrement with given header size (eg. IP + UDP + RTP) and maximum packet size.

Parameters:

userSetting	User's quality setting.
inputQuality	Input source's quality.
byteRateLimit	Byte rate limit.
byteRateLimitL1	Layer #0 byte rate limit.
byteRateLimitL2	Layer #1 byte rate limit.
byteRateLimitL3	Layer #2 byte rate limit.
networkQualityDecrement	Number of steps for decrement of user's quality.
headerSize	Header size (eg. IP + UDP + RTP). AdvancedAudioPacket size is added automatically.
maxPacketSize	Maximum packet size.

Returns:

The calculated quality.

void AdvancedAudioPacket::reset

(

)

Reset report.

void AdvancedAudioPacket::translate

(

)

Translate byte order.

---

Member Data Documentation

enum AdvancedAudioPacket::AdvancedAudioFlags AdvancedAudioPacket::__attribute__

const card32 AdvancedAudioPacket::AdvancedAudioFormatID = 0x74660000 | AdvancedAudioTypeID [static]

Advanced Audio Encoding package format ID.

const cardinal AdvancedAudioPacket::AdvancedAudioFrameSize [static]

Initial value:

      44100 * 2 * 2 / AdvancedAudioFramesPerSecond

Advanced Audio frame size.

const cardinal AdvancedAudioPacket::AdvancedAudioFramesPerSecond = 35 [static]

Advanced Audio frames per second.

const cardinal AdvancedAudioPacket::AdvancedAudioMaxQualityLayers = 3 [static]

Advanced Audio maximum quality layers.

const cardinal AdvancedAudioPacket::AdvancedAudioMaxTransferDelay = 100 * 16 [static]

Advanced Audio maximum transfer delay.

const cardinal AdvancedAudioPacket::AdvancedAudioMediaInfoPacketsPerSecond = 2 [static]

Advanced Audio MediaInfo packets per second.

const cardinal AdvancedAudioPacket::AdvancedAudioQualityLevels = AudioQuality::QualityLevels [static]

Advanced Audio quality levels.

const card16 AdvancedAudioPacket::AdvancedAudioTypeID = 0x2961 [static]

Type ID for Advanced Audio Encoding.

const char AdvancedAudioPacket::AdvancedAudioTypeName = "Advanced Audio Encoding" [static]

Name for Advanced Audio Encoding.

card8 AdvancedAudioPacket::Bits

Number of audio bits.

card8 AdvancedAudioPacket::Channels

Number of audio channels.

char AdvancedAudioPacket::Data[0]

Packet data.

card8 AdvancedAudioPacket::ErrorCode

Error code.

card8 AdvancedAudioPacket::Flags

Advanced Audio Encoding Flags.

card32 AdvancedAudioPacket::FormatID

Packet format ID.

card16 AdvancedAudioPacket::Fragment

Fragment number.

card64 AdvancedAudioPacket::MaxPosition

Maximum position in nanoseconds.

card64 AdvancedAudioPacket::Position

Current position in nanoseconds.

card16 AdvancedAudioPacket::SamplingRate

Audio sampling rate.

---

The documentation for this struct was generated from the following files:

• advancedaudiopacket.h
• advancedaudiopacket.cc