VidoG729 ACM Codec API

low level API to use vidog729 acm codec More...

Data Structures

struct  ACM_HANDLE
 Handle to created vidog729 object. More...

Defines

#define COMPRESSED_FRAME   10
 a compressed frame size Compressed frame audio buffer is in unsigned char compressed frame standard value is 10
#define SAMPLE_FRAME   80
 a uncompressed frame size Uncompressed frame audio buffer is in short Uncompressed frame standard value is 80

Functions

BOOL acm_create_codec (ACM_HANDLE *handle, BOOL encode)
 Create vidog729 codec.
void acm_destroy_codec (ACM_HANDLE *handle)
 Destroy vidog729 codec.
BOOL acm_decode (ACM_HANDLE *handle, unsigned char *src, unsigned srcLength, short *dest, unsigned *destLength)
 Create vidog729 codec.
BOOL acm_encode (ACM_HANDLE *handle, short *src, unsigned srcLength, unsigned char *dest, unsigned *destLength)
 Create vidog729 codec.
void acm_format_pcm (LPWAVEFORMATEX lpwf)
 format pcm tag to standard format This is a helper functions used to format the pcm waveformatex tag to default value

Detailed Description

low level API to use vidog729 acm codec

vidog729 acm codec has been widely used by microsoft RTC as g729 plugin codec Microsoft RTC can detect automaticly the present of vidog729 codec. However other application can still use the vidog729 codec to encode PCM wav file to g729 audio file and vice versa.


Function Documentation

BOOL acm_create_codec ( ACM_HANDLE handle,
BOOL  encode 
)

Create vidog729 codec.

Parameters:
handle [out]: This is the handle that will be used through out other functions
encode [in]: Set TRUE if you want to create encoder, set FALSE if you want to create decoder
Returns:
True if codec creation success, otherwise return FALSE.

BOOL acm_decode ( ACM_HANDLE handle,
unsigned char *  src,
unsigned  srcLength,
short *  dest,
unsigned *  destLength 
)

Create vidog729 codec.

Parameters:
handle [in]: This is the handle that is derrived from codec creation
src [in]: Buffer of source of compressedaudio
srcLength [in]: Source buffer length
dest [in]: Buffer of destination uncompressed audio
srcLength [in/out]: Destination buffer length
Returns:
True if codec decoding success, otherwise return FALSE.

void acm_destroy_codec ( ACM_HANDLE handle  ) 

Destroy vidog729 codec.

Parameters:
handle [in]: This is the handle that is derrived from codec creation
Returns:
NONE

BOOL acm_encode ( ACM_HANDLE handle,
short *  src,
unsigned  srcLength,
unsigned char *  dest,
unsigned *  destLength 
)

Create vidog729 codec.

Parameters:
handle [in]: This is the handle that is derrived from codec creation
src [in]: Buffer of source uncompressed audio
srcLength [in]: Source buffer length
dest [in]: Buffer of destination compressed audio
srcLength [in/out]: Destination buffer length
Returns:
True if encoding success, otherwise return FALSE.

void acm_format_pcm ( LPWAVEFORMATEX  lpwf  ) 

format pcm tag to standard format This is a helper functions used to format the pcm waveformatex tag to default value

Parameters:
lpwf [out]: A WAVEFORMATEX struct tag
Returns:
NONE


Generated on Thu Feb 22 17:13:01 2007 for Vido g729 ACM Codec API by  doxygen 1.5.1-p1