MP3 - LAME
[Audio Codecs]

---

Detailed Description

The LAME codec is used to produce MP3 audio streams.

Example Usage:

  sc = Flix2_AddCodec(&codec, flix, FE2_CODEC_LAME);
  // Use 128kbit
  if(sc == ON2_OK)
      sc = Flix2_CodecSetParam(codec, FE2_LAME_BITRATE, Bitrate128kbps);

Additional References:

LAME project homepage

Defines
#define	FE2_CODEC_LAME
	Codec name for use with Flix2_AddCodec().
#define	FE2_LAME_BITRATE
	Alias for FE2_CODECPARAM_BITRATE.
#define	FE2_LAME_QUALITY
	Codec parameter for controlling LAME library's algorithm selection.
#define	FE2_LAME_RC_MODE
	Codec parameter for controlling LAME library's rate control method.
#define	FE2_LAME_CHANNELS
	Codec parameter for number of output channels.
Typedefs
typedef enum lame_rcmode	lame_rcmode_t
Enumerations
enum	lame_rcmode {   LAME_CBR,   LAME_ABR,   LAME_VBR_rh,   LAME_VBR_mtrh }
	Rate control modes analogous to those found in <lame/lame.h>. More...

---

Define Documentation

#define FE2_CODEC_LAME

Codec name for use with Flix2_AddCodec().

Definition at line 41 of file lame.h.

#define FE2_LAME_BITRATE

Alias for FE2_CODECPARAM_BITRATE.

Codec parameter for stream bitrate.

Compressed stream bitrate in kbits/sec. Valid bitrates are defined by FE2_AudioBitrates

Note:

Default: Bitrate64kbps

Attention:

Some combinations of bitrate and samplerate are invalid based on the MP3 specification. Setting an invalid pair will cause the codec setup to fail.
For further details please see: http://www.mpgedit.org/mpgedit/mpeg_format/mpeghdr.htm
Validity can be determined by inspecting the bitrate and samplerate indices.

Definition at line 55 of file lame.h.

#define FE2_LAME_CHANNELS

Codec parameter for number of output channels.

Note:

Default: input number of channels as described by audio_options_SetStereo()
This parameter is temporary and will be removed when a proper filter is added in a future release

Deprecated:

Use the Filter Interface along with FE2_FILTER_RESAMPLE and the FE2_RESAMPLE_RATE parameter.

Definition at line 97 of file lame.h.

#define FE2_LAME_QUALITY

Codec parameter for controlling LAME library's algorithm selection.

From <lame/lame.h>:

   internal algorithm selection.  True quality is determined by the bitrate
   but this variable will effect quality by selecting expensive or cheap
   algorithms.
   quality=0..9.  0=best (very slow).  9=worst.
   recommended:  2     near-best quality, not too slow
                 5     good quality, fast
                 7     ok quality, really fast
   

Note:

Valid range: [0,9]
Default: 5

Definition at line 72 of file lame.h.

#define FE2_LAME_RC_MODE

Codec parameter for controlling LAME library's rate control method.

Note:

Valid values are defined by lame_rcmode_t
Default: LAME_CBR

Definition at line 77 of file lame.h.

---

Typedef Documentation

typedef enum lame_rcmode lame_rcmode_t

---

Enumeration Type Documentation

enum lame_rcmode

Rate control modes analogous to those found in <lame/lame.h>.

Enumerator:

LAME_CBR	constant bitrate
LAME_ABR	average bitrate, produces predictable size output w/improved quality over CBR
LAME_VBR_rh	variable bitrate, also referred to as vbr-old/standard
LAME_VBR_mtrh	variable bitrate, also referred to as vbr-new/fast (over twice as fast as vbr-old)

Definition at line 80 of file lame.h.