SILK update
[opus.git] / src_common / SKP_Silk_control_audio_bandwidth.c
1 /***********************************************************************\r
2 Copyright (c) 2006-2010, 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 #include "SKP_Silk_main.h"\r
29 \r
30 /* Control internal sampling rate */\r
31 SKP_int SKP_Silk_control_audio_bandwidth(\r
32     SKP_Silk_encoder_state      *psEncC,            /* I/O  Pointer to Silk encoder state               */\r
33     const SKP_int32             TargetRate_bps      /* I    Target max bitrate (bps)                    */\r
34 )\r
35 {\r
36     SKP_int fs_kHz;\r
37 \r
38     fs_kHz = psEncC->fs_kHz;\r
39     if( fs_kHz == 0 ) {\r
40         /* Encoder has just been initialized */\r
41         if( TargetRate_bps >= SWB2WB_BITRATE_BPS ) {\r
42             fs_kHz = 24;\r
43         } else if( TargetRate_bps >= WB2MB_BITRATE_BPS ) {\r
44             fs_kHz = 16;\r
45         } else if( TargetRate_bps >= MB2NB_BITRATE_BPS ) {\r
46             fs_kHz = 12;\r
47         } else {\r
48             fs_kHz = 8;\r
49         }\r
50         /* Make sure internal rate is not higher than external rate or maximum allowed, or lower than minimum allowed */\r
51         fs_kHz = SKP_min( fs_kHz, SKP_DIV32_16( psEncC->API_fs_Hz, 1000 ) );\r
52         fs_kHz = SKP_min( fs_kHz, psEncC->maxInternal_fs_kHz );\r
53         fs_kHz = SKP_max( fs_kHz, psEncC->minInternal_fs_kHz );\r
54     } else if( SKP_SMULBB( fs_kHz, 1000 ) > psEncC->API_fs_Hz || fs_kHz > psEncC->maxInternal_fs_kHz || fs_kHz < psEncC->minInternal_fs_kHz ) {\r
55         /* Make sure internal rate is not higher than external rate or maximum allowed, or lower than minimum allowed */\r
56         fs_kHz = SKP_DIV32_16( psEncC->API_fs_Hz, 1000 );\r
57         fs_kHz = SKP_min( fs_kHz, psEncC->maxInternal_fs_kHz );\r
58         fs_kHz = SKP_max( fs_kHz, psEncC->minInternal_fs_kHz );\r
59     } else {\r
60         /* State machine for the internal sampling rate switching */\r
61         if( psEncC->API_fs_Hz > 8000 ) {\r
62             /* Accumulate the difference between the target rate and limit for switching down */\r
63             psEncC->bitrateDiff += SKP_MUL( psEncC->PacketSize_ms, psEncC->TargetRate_bps - psEncC->bitrate_threshold_down );\r
64             psEncC->bitrateDiff  = SKP_min( psEncC->bitrateDiff, 0 );\r
65 \r
66             if( psEncC->vadFlag == NO_VOICE_ACTIVITY ) { /* Low speech activity */\r
67                 /* Check if we should switch down */\r
68 #if SWITCH_TRANSITION_FILTERING \r
69                 if( ( psEncC->sLP.transition_frame_no == 0 ) &&                         /* Transition phase not active */\r
70                     ( psEncC->bitrateDiff <= -ACCUM_BITS_DIFF_THRESHOLD ||              /* Bitrate threshold is met */\r
71                     ( psEncC->sSWBdetect.WB_detected * psEncC->fs_kHz == 24 ) ) ) {     /* Forced down-switching due to WB input */\r
72                         psEncC->sLP.transition_frame_no = 1;                            /* Begin transition phase */\r
73                         psEncC->sLP.mode                = 0;                            /* Switch down */\r
74                 } else if( \r
75                     ( psEncC->sLP.transition_frame_no >= TRANSITION_FRAMES_DOWN ) &&    /* Transition phase complete */\r
76                     ( psEncC->sLP.mode == 0 ) ) {                                       /* Ready to switch down */\r
77                         psEncC->sLP.transition_frame_no = 0;                            /* Ready for new transition phase */\r
78 #else\r
79                 if( psEncC->bitrateDiff <= -ACCUM_BITS_DIFF_THRESHOLD ) {               /* Bitrate threshold is met */ \r
80 #endif            \r
81                     psEncC->bitrateDiff = 0;\r
82 \r
83                     /* Switch to a lower sample frequency */\r
84                     if( psEncC->fs_kHz == 24 ) {\r
85                         fs_kHz = 16;\r
86                     } else if( psEncC->fs_kHz == 16 ) {\r
87                         fs_kHz = 12;\r
88                     } else {\r
89                         SKP_assert( psEncC->fs_kHz == 12 );\r
90                         fs_kHz = 8;\r
91                     }\r
92                 }\r
93 \r
94                 /* Check if we should switch up */\r
95                 if( ( ( psEncC->fs_kHz * 1000 < psEncC->API_fs_Hz ) &&\r
96                     ( psEncC->TargetRate_bps >= psEncC->bitrate_threshold_up ) && \r
97                     ( psEncC->sSWBdetect.WB_detected * psEncC->fs_kHz < 16 ) ) && \r
98                     ( ( psEncC->fs_kHz == 16 ) && ( psEncC->maxInternal_fs_kHz >= 24 ) || \r
99                     ( psEncC->fs_kHz == 12 ) && ( psEncC->maxInternal_fs_kHz >= 16 ) ||\r
100                     ( psEncC->fs_kHz ==  8 ) && ( psEncC->maxInternal_fs_kHz >= 12 ) ) \r
101 #if SWITCH_TRANSITION_FILTERING\r
102                     && ( psEncC->sLP.transition_frame_no == 0 ) ) { /* No transition phase running, ready to switch */\r
103                         psEncC->sLP.mode = 1; /* Switch up */\r
104 #else\r
105                     ) {\r
106 #endif\r
107                         psEncC->bitrateDiff = 0;\r
108 \r
109                         /* Switch to a higher sample frequency */\r
110                         if( psEncC->fs_kHz == 8 ) {\r
111                             fs_kHz = 12;\r
112                         } else if( psEncC->fs_kHz == 12 ) {\r
113                             fs_kHz = 16;\r
114                         } else {\r
115                             SKP_assert( psEncC->fs_kHz == 16 );\r
116                             fs_kHz = 24;\r
117                         }\r
118                 }\r
119             }\r
120         }\r
121 \r
122 #if SWITCH_TRANSITION_FILTERING\r
123         /* After switching up, stop transition filter during speech inactivity */\r
124         if( ( psEncC->sLP.mode == 1 ) &&\r
125             ( psEncC->sLP.transition_frame_no >= TRANSITION_FRAMES_UP ) && \r
126             ( psEncC->vadFlag == NO_VOICE_ACTIVITY ) ) {\r
127 \r
128                 psEncC->sLP.transition_frame_no = 0;\r
129 \r
130                 /* Reset transition filter state */\r
131                 SKP_memset( psEncC->sLP.In_LP_State, 0, 2 * sizeof( SKP_int32 ) );\r
132         }\r
133 #endif\r
134     }\r
135 \r
136     return fs_kHz;\r
137 }\r