Implements glitchless switching between SILK bandwidths
[opus.git] / silk / control_audio_bandwidth.c
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 #ifdef HAVE_CONFIG_H
29 #include "config.h"
30 #endif
31
32 #include "main.h"
33 #include "tuning_parameters.h"
34
35 /* Control internal sampling rate */
36 opus_int silk_control_audio_bandwidth(
37     silk_encoder_state      *psEncC,            /* I/O  Pointer to Silk encoder state               */
38     silk_EncControlStruct   *encControl         /* I:   Control structure                       */
39 )
40 {
41     opus_int   fs_kHz;
42     opus_int32 fs_Hz;
43
44     fs_kHz = psEncC->fs_kHz;
45     fs_Hz = silk_SMULBB( fs_kHz, 1000 );
46     if( fs_Hz == 0 ) {
47         /* Encoder has just been initialized */
48         fs_Hz  = silk_min( psEncC->desiredInternal_fs_Hz, psEncC->API_fs_Hz );
49         fs_kHz = silk_DIV32_16( fs_Hz, 1000 );
50     } else if( fs_Hz > psEncC->API_fs_Hz || fs_Hz > psEncC->maxInternal_fs_Hz || fs_Hz < psEncC->minInternal_fs_Hz ) {
51         /* Make sure internal rate is not higher than external rate or maximum allowed, or lower than minimum allowed */
52         fs_Hz  = psEncC->API_fs_Hz;
53         fs_Hz  = silk_min( fs_Hz, psEncC->maxInternal_fs_Hz );
54         fs_Hz  = silk_max( fs_Hz, psEncC->minInternal_fs_Hz );
55         fs_kHz = silk_DIV32_16( fs_Hz, 1000 );
56     } else {
57         /* State machine for the internal sampling rate switching */
58         if( psEncC->sLP.transition_frame_no >= TRANSITION_FRAMES ) {
59             /* Stop transition phase */
60             psEncC->sLP.mode = 0;
61         }
62         if( psEncC->allow_bandwidth_switch || encControl->opusCanSwitch ) {
63             /* Check if we should switch down */
64             if( silk_SMULBB( psEncC->fs_kHz, 1000 ) > psEncC->desiredInternal_fs_Hz )
65             {
66                 /* Switch down */
67                 if( psEncC->sLP.mode == 0 ) {
68                     /* New transition */
69                     psEncC->sLP.transition_frame_no = TRANSITION_FRAMES;
70
71                     /* Reset transition filter state */
72                     silk_memset( psEncC->sLP.In_LP_State, 0, sizeof( psEncC->sLP.In_LP_State ) );
73                 }
74                 if (encControl->opusCanSwitch) {
75                     /* Stop transition phase */
76                     psEncC->sLP.mode = 0;
77
78                     /* Switch to a lower sample frequency */
79                     fs_kHz = psEncC->fs_kHz == 16 ? 12 : 8;
80                 } else {
81                    if( psEncC->sLP.transition_frame_no <= 0 ) {
82                        encControl->switchReady = 1;
83                    } else {
84                        /* Direction: down (at double speed) */
85                        psEncC->sLP.mode = -2;
86                    }
87                 }
88             }
89             else
90             /* Check if we should switch up */
91             if( silk_SMULBB( psEncC->fs_kHz, 1000 ) < psEncC->desiredInternal_fs_Hz )
92             {
93                 /* Switch up */
94                 if (encControl->opusCanSwitch) {
95                     /* Switch to a higher sample frequency */
96                     fs_kHz = psEncC->fs_kHz == 8 ? 12 : 16;
97
98                     /* New transition */
99                     psEncC->sLP.transition_frame_no = 0;
100
101                     /* Reset transition filter state */
102                     silk_memset( psEncC->sLP.In_LP_State, 0, sizeof( psEncC->sLP.In_LP_State ) );
103
104                     /* Direction: up */
105                     psEncC->sLP.mode = 1;
106                 } else {
107                    if( psEncC->sLP.mode == 0 ) {
108                        encControl->switchReady = 1;
109                    } else {
110                        /* Direction: up */
111                        psEncC->sLP.mode = 1;
112                    }
113                 }
114             }
115         }
116     }
117
118 #ifdef FORCE_INTERNAL_FS_KHZ
119     fs_kHz = FORCE_INTERNAL_FS_KHZ;
120 #endif
121
122     return fs_kHz;
123 }