michael@0: /***********************************************************************
michael@0: Copyright (c) 2006-2011, Skype Limited. All rights reserved.
michael@0: Redistribution and use in source and binary forms, with or without
michael@0: modification, are permitted provided that the following conditions
michael@0: are met:
michael@0: - Redistributions of source code must retain the above copyright notice,
michael@0: this list of conditions and the following disclaimer.
michael@0: - Redistributions in binary form must reproduce the above copyright
michael@0: notice, this list of conditions and the following disclaimer in the
michael@0: documentation and/or other materials provided with the distribution.
michael@0: - Neither the name of Internet Society, IETF or IETF Trust, nor the
michael@0: names of specific contributors, may be used to endorse or promote
michael@0: products derived from this software without specific prior written
michael@0: permission.
michael@0: THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
michael@0: AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
michael@0: IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
michael@0: ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
michael@0: LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
michael@0: CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
michael@0: SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
michael@0: INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
michael@0: CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
michael@0: ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
michael@0: POSSIBILITY OF SUCH DAMAGE.
michael@0: ***********************************************************************/
michael@0: 
michael@0: #ifndef SILK_CONTROL_H
michael@0: #define SILK_CONTROL_H
michael@0: 
michael@0: #include "typedef.h"
michael@0: 
michael@0: #ifdef __cplusplus
michael@0: extern "C"
michael@0: {
michael@0: #endif
michael@0: 
michael@0: /* Decoder API flags */
michael@0: #define FLAG_DECODE_NORMAL                      0
michael@0: #define FLAG_PACKET_LOST                        1
michael@0: #define FLAG_DECODE_LBRR                        2
michael@0: 
michael@0: /***********************************************/
michael@0: /* Structure for controlling encoder operation */
michael@0: /***********************************************/
michael@0: typedef struct {
michael@0:     /* I:   Number of channels; 1/2                                                         */
michael@0:     opus_int32 nChannelsAPI;
michael@0: 
michael@0:     /* I:   Number of channels; 1/2                                                         */
michael@0:     opus_int32 nChannelsInternal;
michael@0: 
michael@0:     /* I:   Input signal sampling rate in Hertz; 8000/12000/16000/24000/32000/44100/48000   */
michael@0:     opus_int32 API_sampleRate;
michael@0: 
michael@0:     /* I:   Maximum internal sampling rate in Hertz; 8000/12000/16000                       */
michael@0:     opus_int32 maxInternalSampleRate;
michael@0: 
michael@0:     /* I:   Minimum internal sampling rate in Hertz; 8000/12000/16000                       */
michael@0:     opus_int32 minInternalSampleRate;
michael@0: 
michael@0:     /* I:   Soft request for internal sampling rate in Hertz; 8000/12000/16000              */
michael@0:     opus_int32 desiredInternalSampleRate;
michael@0: 
michael@0:     /* I:   Number of samples per packet in milliseconds; 10/20/40/60                       */
michael@0:     opus_int payloadSize_ms;
michael@0: 
michael@0:     /* I:   Bitrate during active speech in bits/second; internally limited                 */
michael@0:     opus_int32 bitRate;
michael@0: 
michael@0:     /* I:   Uplink packet loss in percent (0-100)                                           */
michael@0:     opus_int packetLossPercentage;
michael@0: 
michael@0:     /* I:   Complexity mode; 0 is lowest, 10 is highest complexity                          */
michael@0:     opus_int complexity;
michael@0: 
michael@0:     /* I:   Flag to enable in-band Forward Error Correction (FEC); 0/1                      */
michael@0:     opus_int useInBandFEC;
michael@0: 
michael@0:     /* I:   Flag to enable discontinuous transmission (DTX); 0/1                            */
michael@0:     opus_int useDTX;
michael@0: 
michael@0:     /* I:   Flag to use constant bitrate                                                    */
michael@0:     opus_int useCBR;
michael@0: 
michael@0:     /* I:   Maximum number of bits allowed for the frame                                    */
michael@0:     opus_int maxBits;
michael@0: 
michael@0:     /* I:   Causes a smooth downmix to mono                                                 */
michael@0:     opus_int toMono;
michael@0: 
michael@0:     /* I:   Opus encoder is allowing us to switch bandwidth                                 */
michael@0:     opus_int opusCanSwitch;
michael@0: 
michael@0:     /* I: Make frames as independent as possible (but still use LPC)                        */
michael@0:     opus_int reducedDependency;
michael@0: 
michael@0:     /* O:   Internal sampling rate used, in Hertz; 8000/12000/16000                         */
michael@0:     opus_int32 internalSampleRate;
michael@0: 
michael@0:     /* O: Flag that bandwidth switching is allowed (because low voice activity)             */
michael@0:     opus_int allowBandwidthSwitch;
michael@0: 
michael@0:     /* O:   Flag that SILK runs in WB mode without variable LP filter (use for switching between WB/SWB/FB) */
michael@0:     opus_int inWBmodeWithoutVariableLP;
michael@0: 
michael@0:     /* O:   Stereo width */
michael@0:     opus_int stereoWidth_Q14;
michael@0: 
michael@0:     /* O:   Tells the Opus encoder we're ready to switch                                    */
michael@0:     opus_int switchReady;
michael@0: 
michael@0: } silk_EncControlStruct;
michael@0: 
michael@0: /**************************************************************************/
michael@0: /* Structure for controlling decoder operation and reading decoder status */
michael@0: /**************************************************************************/
michael@0: typedef struct {
michael@0:     /* I:   Number of channels; 1/2                                                         */
michael@0:     opus_int32 nChannelsAPI;
michael@0: 
michael@0:     /* I:   Number of channels; 1/2                                                         */
michael@0:     opus_int32 nChannelsInternal;
michael@0: 
michael@0:     /* I:   Output signal sampling rate in Hertz; 8000/12000/16000/24000/32000/44100/48000  */
michael@0:     opus_int32 API_sampleRate;
michael@0: 
michael@0:     /* I:   Internal sampling rate used, in Hertz; 8000/12000/16000                         */
michael@0:     opus_int32 internalSampleRate;
michael@0: 
michael@0:     /* I:   Number of samples per packet in milliseconds; 10/20/40/60                       */
michael@0:     opus_int payloadSize_ms;
michael@0: 
michael@0:     /* O:   Pitch lag of previous frame (0 if unvoiced), measured in samples at 48 kHz      */
michael@0:     opus_int prevPitchLag;
michael@0: } silk_DecControlStruct;
michael@0: 
michael@0: #ifdef __cplusplus
michael@0: }
michael@0: #endif
michael@0: 
michael@0: #endif