/home/humfrn01/Projects/twolame/trunk/libtwolame/twolame.h

Go to the documentation of this file.

/*
 *      TwoLAME: an optimized MPEG Audio Layer Two encoder
 *
 *      Copyright (C) 2001-2004 Michael Cheng
 *      Copyright (C) 2004-2006 The TwoLAME Project
 *
 *      This library is free software; you can redistribute it and/or
 *      modify it under the terms of the GNU Lesser General Public
 *      License as published by the Free Software Foundation; either
 *      version 2.1 of the License, or (at your option) any later version.
 *
 *      This library is distributed in the hope that it will be useful,
 *      but WITHOUT ANY WARRANTY; without even the implied warranty of
 *      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *      Lesser General Public License for more details.
 *
 *      You should have received a copy of the GNU Lesser General Public
 *      License along with this library; if not, write to the Free Software
 *      Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 *  $Id: twolame_8h-source.html,v 1.3 2008-02-01 19:44:25 richardash1981 Exp $
 *
 */

#ifndef __TWOLAME_H__
#define __TWOLAME_H__

#ifdef __cplusplus
extern "C" {
#endif

/*
 * ATTENTION WIN32 USERS!
 * 
 * By default, when you use this header file, it is configured to use
 * symbols from the "twolame.dll" file. If you use the static version of
 * the library, define LIBTWOLAME_STATIC prior to including this header.
 */

#ifdef _WIN32
#ifdef LIBTWOLAME_STATIC
#define DLL_EXPORT
#else
#ifdef LIBTWOLAME_DLL_EXPORTS
#define DLL_EXPORT __declspec(dllexport)
#else
#define DLL_EXPORT __declspec(dllimport)
#endif
#endif
#else
#define DLL_EXPORT
#endif


#ifndef TRUE
#define TRUE    (1)
#endif

#ifndef FALSE
#define FALSE   (0)
#endif


typedef enum {
        TWOLAME_AUTO_MODE = -1, 
        TWOLAME_STEREO = 0,             
        TWOLAME_JOINT_STEREO,   
        TWOLAME_DUAL_CHANNEL,   
        TWOLAME_MONO,                   
        TWOLAME_NOT_SET
} TWOLAME_MPEG_mode;


typedef enum {
        TWOLAME_MPEG2 = 0,      
        TWOLAME_MPEG1           
} TWOLAME_MPEG_version;


typedef enum {
        TWOLAME_PAD_NO = 0,             
        TWOLAME_PAD_ALL                 
//      TWOLAME_PAD_ADJUST              // unsupported by twolame
} TWOLAME_Padding;

typedef enum {
        TWOLAME_EMPHASIS_N = 0, 
        TWOLAME_EMPHASIS_5 = 1, 
                                                        // reserved
        TWOLAME_EMPHASIS_C = 3  
} TWOLAME_Emphasis;


#define TWOLAME_SAMPLES_PER_FRAME               (1152)


struct twolame_options_struct;

typedef struct twolame_options_struct twolame_options;





DLL_EXPORT const char* get_twolame_version( void );


DLL_EXPORT const char* get_twolame_url( void );


DLL_EXPORT void twolame_print_config(twolame_options *glopts);


DLL_EXPORT twolame_options *twolame_init(void);


DLL_EXPORT int twolame_init_params(twolame_options *glopts);


DLL_EXPORT int twolame_encode_buffer(
                twolame_options *glopts,
                const short int leftpcm[],
                const short int rightpcm[],
                int num_samples,
                unsigned char *mp2buffer,
                int mp2buffer_size );


DLL_EXPORT int twolame_encode_buffer_interleaved(
                twolame_options *glopts,
                const short int pcm[],
                int num_samples,
                unsigned char *mp2buffer,
                int mp2buffer_size );


DLL_EXPORT int twolame_encode_buffer_float32(
                twolame_options *glopts,
                const float             leftpcm [],
                const float             rightpcm [],
                int num_samples,
                unsigned char *mp2buffer,
                int mp2buffer_size );


int twolame_encode_buffer_float32_interleaved(
                twolame_options *glopts,
                const float pcm[],
                int num_samples,
                unsigned char *mp2buffer,
                int mp2buffer_size );


DLL_EXPORT int twolame_encode_flush(
                twolame_options *glopts,
                unsigned char *mp2buffer,
                int mp2buffer_size);


DLL_EXPORT void twolame_close(twolame_options **glopts);



DLL_EXPORT int twolame_set_verbosity(twolame_options *glopts, int verbosity);


DLL_EXPORT int twolame_get_verbosity(twolame_options *glopts);


DLL_EXPORT int twolame_set_mode(twolame_options *glopts, TWOLAME_MPEG_mode mode);


DLL_EXPORT TWOLAME_MPEG_mode twolame_get_mode(twolame_options *glopts);


DLL_EXPORT const char *twolame_get_mode_name(twolame_options *glopts);


DLL_EXPORT int twolame_set_version(twolame_options *glopts, TWOLAME_MPEG_version version);


DLL_EXPORT TWOLAME_MPEG_version twolame_get_version(twolame_options *glopts);


DLL_EXPORT const char *twolame_get_version_name( twolame_options *glopts );


DLL_EXPORT int twolame_get_framelength( twolame_options *glopts );


DLL_EXPORT int twolame_set_psymodel(twolame_options *glopts, int psymodel);


DLL_EXPORT int twolame_get_psymodel(twolame_options *glopts);


DLL_EXPORT int twolame_set_num_channels(twolame_options* glopts, int num_channels);


DLL_EXPORT int twolame_get_num_channels(twolame_options* glopts);


DLL_EXPORT int twolame_set_scale(twolame_options* glopts, float scale);


DLL_EXPORT float twolame_get_scale(twolame_options* glopts);
        
DLL_EXPORT int twolame_set_scale_left(twolame_options* glopts, float scale);


DLL_EXPORT float twolame_get_scale_left(twolame_options* glopts);


DLL_EXPORT int twolame_set_scale_right(twolame_options* glopts, float scale);


DLL_EXPORT float twolame_get_scale_right(twolame_options* glopts);


DLL_EXPORT int twolame_set_in_samplerate(twolame_options *glopts, int samplerate);


DLL_EXPORT int twolame_get_in_samplerate(twolame_options *glopts);


DLL_EXPORT int twolame_set_out_samplerate(twolame_options *glopts, int samplerate);


DLL_EXPORT int twolame_get_out_samplerate(twolame_options *glopts);


DLL_EXPORT int twolame_set_bitrate(twolame_options *glopts, int bitrate);


DLL_EXPORT int twolame_get_bitrate(twolame_options *glopts);


DLL_EXPORT int twolame_set_brate(twolame_options *glopts, int bitrate);


DLL_EXPORT int twolame_get_brate(twolame_options *glopts);


DLL_EXPORT int twolame_set_padding(twolame_options *glopts, TWOLAME_Padding padding);

DLL_EXPORT TWOLAME_Padding twolame_get_padding(twolame_options *glopts);


DLL_EXPORT int twolame_set_energy_levels(twolame_options *glopts, int energylevels );


DLL_EXPORT int twolame_get_energy_levels(twolame_options *glopts);


DLL_EXPORT int twolame_set_num_ancillary_bits(twolame_options *glopts, int num);


DLL_EXPORT int twolame_get_num_ancillary_bits(twolame_options *glopts);



DLL_EXPORT int twolame_set_emphasis(twolame_options *glopts, TWOLAME_Emphasis emphasis);


DLL_EXPORT TWOLAME_Emphasis twolame_get_emphasis(twolame_options *glopts);


DLL_EXPORT int twolame_set_error_protection(twolame_options *glopts, int err_protection);


DLL_EXPORT int twolame_get_error_protection(twolame_options *glopts);


DLL_EXPORT int twolame_set_copyright(twolame_options *glopts, int copyright);


DLL_EXPORT int twolame_get_copyright(twolame_options *glopts);


DLL_EXPORT int twolame_set_original(twolame_options *glopts, int original);


DLL_EXPORT int twolame_get_original(twolame_options *glopts);


DLL_EXPORT int twolame_set_VBR(twolame_options *glopts, int vbr);


DLL_EXPORT int twolame_get_VBR(twolame_options *glopts);


DLL_EXPORT int twolame_set_VBR_level(twolame_options *glopts, float level);


DLL_EXPORT float twolame_get_VBR_level(twolame_options *glopts);



/* 
   Using the twolame_set_VBR_q()/twolame_get_VBR_q functions 
   are deprecated, please use twolame_set_VBR_level() instead.
*/
DLL_EXPORT int twolame_set_VBR_q(twolame_options *glopts, float level);
DLL_EXPORT float twolame_get_VBR_q(twolame_options *glopts);



DLL_EXPORT int twolame_set_ATH_level(twolame_options *glopts, float level);


DLL_EXPORT float twolame_get_ATH_level(twolame_options *glopts);


DLL_EXPORT int twolame_set_VBR_max_bitrate_kbps(twolame_options *glopts, int bitrate);

DLL_EXPORT int twolame_get_VBR_max_bitrate_kbps(twolame_options *glopts);


DLL_EXPORT int twolame_set_quick_mode(twolame_options *glopts, int quickmode);

DLL_EXPORT int twolame_get_quick_mode(twolame_options *glopts);


DLL_EXPORT int twolame_set_quick_count(twolame_options *glopts, int quickcount );

DLL_EXPORT int twolame_get_quick_count(twolame_options *glopts);







/* WARNING: DAB support is currently broken */





DLL_EXPORT int twolame_set_DAB(twolame_options *glopts, int dab);

DLL_EXPORT int twolame_get_DAB(twolame_options *glopts);


DLL_EXPORT int twolame_set_DAB_xpad_length(twolame_options *glopts, int length);


DLL_EXPORT int twolame_get_DAB_xpad_length(twolame_options *glopts);


DLL_EXPORT int twolame_set_DAB_crc_length(twolame_options *glopts, int length);


DLL_EXPORT int twolame_get_DAB_crc_length(twolame_options *glopts);



#ifdef __cplusplus
}
#endif

#endif /* _TWOLAME_H_ */


// vim:ts=4:sw=4:nowrap:

---