Main Page | Compound List | File List | Compound Members | File Members

speex_callbacks.h

Go to the documentation of this file.
00001 /* Copyright (C) 2002 Jean-Marc Valin*/
00006 /*
00007    Redistribution and use in source and binary forms, with or without
00008    modification, are permitted provided that the following conditions
00009    are met:
00010    
00011    - Redistributions of source code must retain the above copyright
00012    notice, this list of conditions and the following disclaimer.
00013    
00014    - Redistributions in binary form must reproduce the above copyright
00015    notice, this list of conditions and the following disclaimer in the
00016    documentation and/or other materials provided with the distribution.
00017    
00018    - Neither the name of the Xiph.org Foundation nor the names of its
00019    contributors may be used to endorse or promote products derived from
00020    this software without specific prior written permission.
00021    
00022    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
00023    ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
00024    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
00025    A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR
00026    CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
00027    EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
00028    PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00029    PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00030    LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00031    NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00032    SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00033 
00034 */
00035 
00036 #ifndef SPEEX_CALLBACKS_H
00037 #define SPEEX_CALLBACKS_H
00038 
00039 #include "speex.h"
00040 
00041 #ifdef __cplusplus
00042 extern "C" {
00043 #endif
00044 
00046 #define SPEEX_MAX_CALLBACKS 16
00047 
00048 /* Describes all the in-band requests */
00049 
00050 /*These are 1-bit requests*/
00052 #define SPEEX_INBAND_ENH_REQUEST         0
00053 
00054 #define SPEEX_INBAND_RESERVED1           1
00055 
00056 /*These are 4-bit requests*/
00058 #define SPEEX_INBAND_MODE_REQUEST        2
00059 
00060 #define SPEEX_INBAND_LOW_MODE_REQUEST    3
00061 
00062 #define SPEEX_INBAND_HIGH_MODE_REQUEST   4
00063 
00064 #define SPEEX_INBAND_VBR_QUALITY_REQUEST 5
00065 
00066 #define SPEEX_INBAND_ACKNOWLEDGE_REQUEST 6
00067 
00068 #define SPEEX_INBAND_VBR_REQUEST         7
00069 
00070 /*These are 8-bit requests*/
00072 #define SPEEX_INBAND_CHAR                8
00073 
00074 #define SPEEX_INBAND_STEREO              9
00075 
00076 /*These are 16-bit requests*/
00078 #define SPEEX_INBAND_MAX_BITRATE         10
00079 
00080 /*These are 32-bit requests*/
00082 #define SPEEX_INBAND_ACKNOWLEDGE         12
00083 
00085 typedef int (*speex_callback_func)(SpeexBits *bits, void *state, void *data);
00086 
00088 typedef struct SpeexCallback {
00089    int callback_id;             
00090    speex_callback_func func;    
00091    void *data;                  
00092    void *reserved1;             
00093    int   reserved2;             
00094 } SpeexCallback;
00095 
00097 int speex_inband_handler(SpeexBits *bits, SpeexCallback *callback_list, void *state);
00098 
00100 int speex_std_mode_request_handler(SpeexBits *bits, void *state, void *data);
00101 
00103 int speex_std_high_mode_request_handler(SpeexBits *bits, void *state, void *data);
00104 
00106 int speex_std_char_handler(SpeexBits *bits, void *state, void *data);
00107 
00109 int speex_default_user_handler(SpeexBits *bits, void *state, void *data);
00110 
00111 
00112 
00113 
00114 int speex_std_low_mode_request_handler(SpeexBits *bits, void *state, void *data);
00115 
00116 int speex_std_vbr_request_handler(SpeexBits *bits, void *state, void *data);
00117 
00118 int speex_std_enh_request_handler(SpeexBits *bits, void *state, void *data);
00119 
00120 int speex_std_vbr_quality_request_handler(SpeexBits *bits, void *state, void *data);
00121 
00122 
00123 #ifdef __cplusplus
00124 }
00125 #endif
00126 
00127 
00128 #endif

Generated on Sun Sep 21 16:07:08 2003 for speex by doxygen 1.3.2