Fixing some typos in the manual (thanks to Peter Grayson for the patch)
[speexdsp.git] / libspeex / speex_callbacks.c
1 /* Copyright (C) 2002 Jean-Marc Valin
2    File speex_callbacks.c
3    Callback handling and in-band signalling
4
5
6    Redistribution and use in source and binary forms, with or without
7    modification, are permitted provided that the following conditions
8    are met:
9    
10    - Redistributions of source code must retain the above copyright
11    notice, this list of conditions and the following disclaimer.
12    
13    - Redistributions in binary form must reproduce the above copyright
14    notice, this list of conditions and the following disclaimer in the
15    documentation and/or other materials provided with the distribution.
16    
17    - Neither the name of the Xiph.org Foundation nor the names of its
18    contributors may be used to endorse or promote products derived from
19    this software without specific prior written permission.
20    
21    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22    ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
24    A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR
25    CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
26    EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
27    PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
28    PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
29    LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
30    NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
31    SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32
33 */
34
35 #ifdef HAVE_CONFIG_H
36 #include "config.h"
37 #endif
38
39 #include <speex/speex_callbacks.h>
40 #include "arch.h"
41 #include "os_support.h"
42
43 int speex_inband_handler(SpeexBits *bits, SpeexCallback *callback_list, void *state)
44 {
45    int id;
46    SpeexCallback *callback;
47    /*speex_bits_advance(bits, 5);*/
48    id=speex_bits_unpack_unsigned(bits, 4);
49    callback = callback_list+id;
50
51    if (callback->func)
52    {
53       return callback->func(bits, state, callback->data);
54    } else
55       /*If callback is not registered, skip the right number of bits*/
56    {
57       int adv;
58       if (id<2)
59          adv = 1;
60       else if (id<8)
61          adv = 4;
62       else if (id<10)
63          adv = 8;
64       else if (id<12)
65          adv = 16;
66       else if (id<14)
67          adv = 32;
68       else 
69          adv = 64;
70       speex_bits_advance(bits, adv);
71    }
72    return 0;
73 }
74
75 int speex_std_mode_request_handler(SpeexBits *bits, void *state, void *data)
76 {
77    spx_int32_t m;
78    m = speex_bits_unpack_unsigned(bits, 4);
79    speex_encoder_ctl(data, SPEEX_SET_MODE, &m);
80    return 0;
81 }
82
83 int speex_std_low_mode_request_handler(SpeexBits *bits, void *state, void *data)
84 {
85    spx_int32_t m;
86    m = speex_bits_unpack_unsigned(bits, 4);
87    speex_encoder_ctl(data, SPEEX_SET_LOW_MODE, &m);
88    return 0;
89 }
90
91 int speex_std_high_mode_request_handler(SpeexBits *bits, void *state, void *data)
92 {
93    spx_int32_t m;
94    m = speex_bits_unpack_unsigned(bits, 4);
95    speex_encoder_ctl(data, SPEEX_SET_HIGH_MODE, &m);
96    return 0;
97 }
98
99 #ifndef DISABLE_VBR
100 int speex_std_vbr_request_handler(SpeexBits *bits, void *state, void *data)
101 {
102    spx_int32_t vbr;
103    vbr = speex_bits_unpack_unsigned(bits, 1);
104    speex_encoder_ctl(data, SPEEX_SET_VBR, &vbr);
105    return 0;
106 }
107 #endif /* #ifndef DISABLE_VBR */
108
109 int speex_std_enh_request_handler(SpeexBits *bits, void *state, void *data)
110 {
111    spx_int32_t enh;
112    enh = speex_bits_unpack_unsigned(bits, 1);
113    speex_decoder_ctl(data, SPEEX_SET_ENH, &enh);
114    return 0;
115 }
116
117 #ifndef DISABLE_VBR
118 int speex_std_vbr_quality_request_handler(SpeexBits *bits, void *state, void *data)
119 {
120    float qual;
121    qual = speex_bits_unpack_unsigned(bits, 4);
122    speex_encoder_ctl(data, SPEEX_SET_VBR_QUALITY, &qual);
123    return 0;
124 }
125 #endif /* #ifndef DISABLE_VBR */
126
127 int speex_std_char_handler(SpeexBits *bits, void *state, void *data)
128 {
129    unsigned char ch;
130    ch = speex_bits_unpack_unsigned(bits, 8);
131    _speex_putc(ch, data);
132    /*printf("speex_std_char_handler ch=%x\n", ch);*/
133    return 0;
134 }
135
136
137
138 /* Default handler for user callbacks: skip it */
139 int speex_default_user_handler(SpeexBits *bits, void *state, void *data)
140 {
141    int req_size = speex_bits_unpack_unsigned(bits, 4);
142    speex_bits_advance(bits, 5+8*req_size);
143    return 0;
144 }