speex_stereo.h revision 98913fed6520d8849fb2e246be943e04474aefa4
1dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines/* Copyright (C) 2002 Jean-Marc Valin*/ 2dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines/** 3dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines @file speex_stereo.h 4dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines @brief Describes the handling for intensity stereo 5dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines*/ 6dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines/* 7dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines Redistribution and use in source and binary forms, with or without 8dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines modification, are permitted provided that the following conditions 9dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines are met: 10dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines 11dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines - Redistributions of source code must retain the above copyright 12dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines notice, this list of conditions and the following disclaimer. 13dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines 14dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines - Redistributions in binary form must reproduce the above copyright 15dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines notice, this list of conditions and the following disclaimer in the 16dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines documentation and/or other materials provided with the distribution. 17dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines 18dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines - Neither the name of the Xiph.org Foundation nor the names of its 19dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines contributors may be used to endorse or promote products derived from 20dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines this software without specific prior written permission. 21dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines 22dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 23dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 24dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 25dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR 26dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, 27dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, 28dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR 29dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF 30dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING 31dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS 32dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 33dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines*/ 34dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines 35dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines#ifndef STEREO_H 36dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines#define STEREO_H 37dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines/** @defgroup SpeexStereoState SpeexStereoState: Handling Speex stereo files 38dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines * This describes the Speex intensity stereo encoding/decoding 39dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines * @{ 40dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines */ 41 42#include "speex/speex_types.h" 43#include "speex/speex_bits.h" 44 45#ifdef __cplusplus 46extern "C" { 47#endif 48 49/** If you access any of these fields directly, I'll personally come and bite you */ 50typedef 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 */ 63SpeexStereoState *speex_stereo_state_init(); 64 65/** Reset/re-initialise an already allocated stereo state */ 66void speex_stereo_state_reset(SpeexStereoState *stereo); 67 68/** Destroy a stereo stereo state */ 69void speex_stereo_state_destroy(SpeexStereoState *stereo); 70 71/** Transforms a stereo frame into a mono frame and stores intensity stereo info in 'bits' */ 72void 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' */ 75void 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 */ 78void speex_decode_stereo(float *data, int frame_size, SpeexStereoState *stereo); 79 80/** Transforms a mono frame into a stereo frame using intensity stereo info */ 81void speex_decode_stereo_int(spx_int16_t *data, int frame_size, SpeexStereoState *stereo); 82 83/** Callback handler for intensity stereo info */ 84int speex_std_stereo_request_handler(SpeexBits *bits, void *state, void *data); 85 86#ifdef __cplusplus 87} 88#endif 89 90/** @} */ 91#endif 92