Tristan Matthews | 0a329cc | 2013-07-17 13:20:14 -0400 | [diff] [blame] | 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 | /** @defgroup SpeexStereoState SpeexStereoState: Handling Speex stereo files |
| 38 | * This describes the Speex intensity stereo encoding/decoding |
| 39 | * @{ |
| 40 | */ |
| 41 | |
| 42 | #include "speex/speex_types.h" |
| 43 | #include "speex/speex_bits.h" |
| 44 | |
| 45 | #ifdef __cplusplus |
| 46 | extern "C" { |
| 47 | #endif |
| 48 | |
| 49 | /** If you access any of these fields directly, I'll personally come and bite you */ |
| 50 | typedef struct SpeexStereoState { |
| 51 | float balance; /**< Left/right balance info */ |
| 52 | float e_ratio; /**< Ratio of energies: E(left+right)/[E(left)+E(right)] */ |
| 53 | float smooth_left; /**< Smoothed left channel gain */ |
| 54 | float smooth_right; /**< Smoothed right channel gain */ |
| 55 | float reserved1; /**< Reserved for future use */ |
| 56 | float reserved2; /**< Reserved for future use */ |
| 57 | } SpeexStereoState; |
| 58 | |
| 59 | /** Deprecated. Use speex_stereo_state_init() instead. */ |
| 60 | #define SPEEX_STEREO_STATE_INIT {1,.5,1,1,0,0} |
| 61 | |
| 62 | /** Initialise/create a stereo stereo state */ |
| 63 | SpeexStereoState *speex_stereo_state_init(); |
| 64 | |
| 65 | /** Reset/re-initialise an already allocated stereo state */ |
| 66 | void speex_stereo_state_reset(SpeexStereoState *stereo); |
| 67 | |
| 68 | /** Destroy a stereo stereo state */ |
| 69 | void speex_stereo_state_destroy(SpeexStereoState *stereo); |
| 70 | |
| 71 | /** Transforms a stereo frame into a mono frame and stores intensity stereo info in 'bits' */ |
| 72 | void speex_encode_stereo(float *data, int frame_size, SpeexBits *bits); |
| 73 | |
| 74 | /** Transforms a stereo frame into a mono frame and stores intensity stereo info in 'bits' */ |
| 75 | void speex_encode_stereo_int(spx_int16_t *data, int frame_size, SpeexBits *bits); |
| 76 | |
| 77 | /** Transforms a mono frame into a stereo frame using intensity stereo info */ |
| 78 | void speex_decode_stereo(float *data, int frame_size, SpeexStereoState *stereo); |
| 79 | |
| 80 | /** Transforms a mono frame into a stereo frame using intensity stereo info */ |
| 81 | void speex_decode_stereo_int(spx_int16_t *data, int frame_size, SpeexStereoState *stereo); |
| 82 | |
| 83 | /** Callback handler for intensity stereo info */ |
| 84 | int speex_std_stereo_request_handler(SpeexBits *bits, void *state, void *data); |
| 85 | |
| 86 | #ifdef __cplusplus |
| 87 | } |
| 88 | #endif |
| 89 | |
| 90 | /** @} */ |
| 91 | #endif |