SimpleAudioPacket Struct Reference

Simple Audio Packet. More...

#include <simpleaudiopacket.h>

List of all members.

Public Types
enum	SimpleAudioFlags { SAF_Data = 0, SAF_MediaInfo = 1 }
Public Member Functions
	SimpleAudioPacket ()
void	translate ()
void	reset ()
Static Public Member Functions
static AudioQuality	calculateQualityForLimits (const AudioQualityInterface &userSetting, const AudioQualityInterface &inputQuality, const card64 totalByteRateLimit, const cardinal networkQualityDecrement, const cardinal headerSize, const cardinal maxPacketSize)
static cardinal	calculateFrameSize (const cardinal inputBytesPerSecond, const cardinal inputFrameSize)
Public Attributes
card32	FormatID
card16	SamplingRate
card8	Channels
card8	Bits
card64	Position
card64	MaxPosition
card8	ErrorCode
card8	Flags
enum SimpleAudioPacket::SimpleAudioFlags	__attribute__
char	Data []
Static Public Attributes
static const card16	SimpleAudioTypeID = 0x2960
static const char	SimpleAudioTypeName [] = "Simple Audio Encoding"
static const card32	SimpleAudioFormatID = 0x74660000 | SimpleAudioTypeID
static const cardinal	SimpleAudioMediaInfoPacketsPerSecond = 1
static const cardinal	SimpleAudioFramesPerSecond = 15
static const cardinal	SimpleAudioFrameSize = 2352 * 5
static const cardinal	SimpleAudioMaxTransferDelay = 1500 * 16
static const cardinal	SimpleAudioQualityLevels = AudioQuality::QualityLevels

---

Detailed Description

Simple Audio Packet.

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

Author:

Thomas Dreibholz

Version:

1.0

See also:

SimpleAudioEncoder

SimpleAudioDecoder

---

Member Enumeration Documentation

enum SimpleAudioPacket::SimpleAudioFlags

Emumeration of Flags.

Enumerator:

SAF_Data
SAF_MediaInfo

---

Constructor & Destructor Documentation

SimpleAudioPacket::SimpleAudioPacket

(

)

Constructor.

---

Member Function Documentation

cardinal SimpleAudioPacket::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.

AudioQuality SimpleAudioPacket::calculateQualityForLimits	(	const AudioQualityInterface &	userSetting,
		const AudioQualityInterface &	inputQuality,
		const card64	totalByteRateLimit,
		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.
networkQualityDecrement	Number of steps for decrement of user's quality.
headerSize	Header size (eg. IP + UDP + RTP). SimpleAudioPacket size is added automatically.
maxPacketSize	Maximum packet size.

Returns:

The calculated quality.

void SimpleAudioPacket::reset

(

)

Reset report.

void SimpleAudioPacket::translate

(

)

Translate byte order.

---

Member Data Documentation

enum SimpleAudioPacket::SimpleAudioFlags SimpleAudioPacket::__attribute__

card8 SimpleAudioPacket::Bits

Number of audio bits.

card8 SimpleAudioPacket::Channels

Number of audio channels.

char SimpleAudioPacket::Data[]

Packet data.

card8 SimpleAudioPacket::ErrorCode

Error code.

card8 SimpleAudioPacket::Flags

Flags.

card32 SimpleAudioPacket::FormatID

Packet format ID.

card64 SimpleAudioPacket::MaxPosition

Maximum position in nanoseconds.

card64 SimpleAudioPacket::Position

Current position in nanoseconds.

card16 SimpleAudioPacket::SamplingRate

Audio sampling rate.

const card32 SimpleAudioPacket::SimpleAudioFormatID = 0x74660000 | SimpleAudioTypeID [static]

Simple Audio Encoding package format ID.

const cardinal SimpleAudioPacket::SimpleAudioFrameSize = 2352 * 5 [static]

Simple Audio frame size.

const cardinal SimpleAudioPacket::SimpleAudioFramesPerSecond = 15 [static]

Simple Audio frames per second.

const cardinal SimpleAudioPacket::SimpleAudioMaxTransferDelay = 1500 * 16 [static]

Simple Audio maximum transfer delay.

const cardinal SimpleAudioPacket::SimpleAudioMediaInfoPacketsPerSecond = 1 [static]

Simple Audio MediaInfo packets per second.

const cardinal SimpleAudioPacket::SimpleAudioQualityLevels = AudioQuality::QualityLevels [static]

Simple Audio number of quality levels.

const card16 SimpleAudioPacket::SimpleAudioTypeID = 0x2960 [static]

Type ID for Simple Audio Encoding.

const char SimpleAudioPacket::SimpleAudioTypeName = "Simple Audio Encoding" [static]

Name for Simple Audio Encoding.

---

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

• simpleaudiopacket.h
• simpleaudiopacket.cc