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