Implements glitchless switching between SILK bandwidths
[opus.git] / silk / control.h
1 /***********************************************************************
2 Copyright (c) 2006-2011, Skype Limited. All rights reserved.
3 Redistribution and use in source and binary forms, with or without
4 modification, (subject to the limitations in the disclaimer below)
5 are permitted provided that the following conditions are met:
6 - Redistributions of source code must retain the above copyright notice,
7 this list of conditions and the following disclaimer.
8 - Redistributions in binary form must reproduce the above copyright
9 notice, this list of conditions and the following disclaimer in the
10 documentation and/or other materials provided with the distribution.
11 - Neither the name of Skype Limited, nor the names of specific
12 contributors, may be used to endorse or promote products derived from
13 this software without specific prior written permission.
14 NO EXPRESS OR IMPLIED LICENSES TO ANY PARTY'S PATENT RIGHTS ARE GRANTED
15 BY THIS LICENSE. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
16 CONTRIBUTORS ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING,
17 BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
18 FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
19 COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
20 INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
21 NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
22 USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
23 ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
25 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26 ***********************************************************************/
27
28 #ifndef SILK_CONTROL_H
29 #define SILK_CONTROL_H
30
31 #include "typedef.h"
32
33 #ifdef __cplusplus
34 extern "C"
35 {
36 #endif
37
38 /* Decoder API flags */
39 #define FLAG_DECODE_NORMAL                      0
40 #define FLAG_PACKET_LOST                        1
41 #define FLAG_DECODE_LBRR                        2
42
43 /***********************************************/
44 /* Structure for controlling encoder operation */
45 /***********************************************/
46 typedef struct {
47     /* I:   Number of channels; 1/2                                                         */
48     opus_int32 nChannelsAPI;
49
50     /* I:   Number of channels; 1/2                                                         */
51     opus_int32 nChannelsInternal;
52
53     /* I:   Input signal sampling rate in Hertz; 8000/12000/16000/24000/32000/44100/48000   */
54     opus_int32 API_sampleRate;
55
56     /* I:   Maximum internal sampling rate in Hertz; 8000/12000/16000                       */
57     opus_int32 maxInternalSampleRate;
58
59     /* I:   Minimum internal sampling rate in Hertz; 8000/12000/16000                       */
60     opus_int32 minInternalSampleRate;
61
62     /* I:   Soft request for internal sampling rate in Hertz; 8000/12000/16000              */
63     opus_int32 desiredInternalSampleRate;
64
65     /* I:   Number of samples per packet in milliseconds; 10/20/40/60                       */
66     opus_int payloadSize_ms;
67
68     /* I:   Bitrate during active speech in bits/second; internally limited                 */
69     opus_int32 bitRate;
70
71     /* I:   Uplink packet loss in percent (0-100)                                           */
72     opus_int packetLossPercentage;
73
74     /* I:   Complexity mode; 0 is lowest, 10 is highest complexity                          */
75     opus_int complexity;
76
77     /* I:   Flag to enable in-band Forward Error Correction (FEC); 0/1                      */
78     opus_int useInBandFEC;
79
80     /* I:   Flag to enable discontinuous transmission (DTX); 0/1                            */
81     opus_int useDTX;
82
83     /* I:   Flag to use constant bitrate                                                    */
84     opus_int useCBR;
85
86     /* I:   Maximum number of bits allowed for the frame */
87     opus_int maxBits;
88
89     /* I:   Causes a smooth downmix to mono */
90     opus_int toMono;
91
92     /* I:   Opus encoder is allowing us to switch bandwidth */
93     opus_int opusCanSwitch;
94
95     /* O:   Internal sampling rate used, in Hertz; 8000/12000/16000                         */
96     opus_int32 internalSampleRate;
97
98     /* O: Flag that bandwidth switching is allowed (because low voice activity)             */
99     opus_int allowBandwidthSwitch;
100
101     /* O:   Flag that SILK runs in WB mode without variable LP filter (use for switching between WB/SWB/FB) */
102     opus_int inWBmodeWithoutVariableLP;
103
104     /* O:   Stereo width */
105     opus_int stereoWidth_Q14;
106
107     /* O:   Tells the Opus encoder we're ready to switch */
108     opus_int switchReady;
109
110 } silk_EncControlStruct;
111
112 /**************************************************************************/
113 /* Structure for controlling decoder operation and reading decoder status */
114 /**************************************************************************/
115 typedef struct {
116     /* I:   Number of channels; 1/2                                                         */
117     opus_int32 nChannelsAPI;
118
119     /* I:   Number of channels; 1/2                                                         */
120     opus_int32 nChannelsInternal;
121
122     /* I:   Output signal sampling rate in Hertz; 8000/12000/16000/24000/32000/44100/48000  */
123     opus_int32 API_sampleRate;
124
125     /* I:   Internal sampling rate used, in Hertz; 8000/12000/16000                         */
126     opus_int32 internalSampleRate;
127
128     /* I:   Number of samples per packet in milliseconds; 10/20/40/60                       */
129     opus_int payloadSize_ms;
130
131     /* O:   Pitch lag of previous frame (0 if unvoiced), measured in samples at 48 kHz      */
132     opus_int prevPitchLag;
133 } silk_DecControlStruct;
134
135 #ifdef __cplusplus
136 }
137 #endif
138
139 #endif