build fix for FreeBSD (gnugetopt), allow VBR without DTX
[speexdsp.git] / libspeex / speex_stereo.h
1 /* Copyright (C) 2002 Jean-Marc Valin*/
2 /**
3    @file speex_stereo.h
4    @brief Describes the handling for intensity stereo
5 */
6 /*
7    Redistribution and use in source and binary forms, with or without
8    modification, are permitted provided that the following conditions
9    are met:
10    
11    - Redistributions of source code must retain the above copyright
12    notice, this list of conditions and the following disclaimer.
13    
14    - Redistributions in binary form must reproduce the above copyright
15    notice, this list of conditions and the following disclaimer in the
16    documentation and/or other materials provided with the distribution.
17    
18    - Neither the name of the Xiph.org Foundation nor the names of its
19    contributors may be used to endorse or promote products derived from
20    this software without specific prior written permission.
21    
22    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
23    ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
24    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
25    A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR
26    CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
27    EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
28    PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
29    PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
30    LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
31    NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
32    SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33 */
34
35 #ifndef STEREO_H
36 #define STEREO_H
37
38 #include "speex_bits.h"
39
40 /** State used for decoding (intensity) stereo information */
41 typedef struct SpeexStereoState {
42    float balance;      /**< Left/right balance info */
43    float e_ratio;      /**< Ratio of energies: E(left+right)/[E(left)+E(right)]  */
44    float smooth_left;  /**< Smoothed left channel gain */
45    float smooth_right; /**< Smoothed right channel gain */
46    float reserved1;    /**< Reserved for future use */
47    float reserved2;    /**< Reserved for future use */
48 } SpeexStereoState;
49
50 /** Initialization value for a stereo state */
51 #define SPEEX_STEREO_STATE_INIT {1,.5,1,1}
52
53 /** Transforms a stereo frame into a mono frame and stores intensity stereo info in 'bits' */
54 void speex_encode_stereo(float *data, int frame_size, SpeexBits *bits);
55
56 /** Transforms a mono frame into a stereo frame using intensity stereo info */
57 void speex_decode_stereo(float *data, int frame_size, SpeexStereoState *stereo);
58
59 /** Callback handler for intensity stereo info */
60 int speex_std_stereo_request_handler(SpeexBits *bits, void *state, void *data);
61
62 #endif