Fixes two encoder bugs causing glitches in stereo->mono switches
[opus.git] / silk / check_control_input.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 "control.h"
34 #include "errors.h"
35
36 /* Check encoder control struct */
37 opus_int check_control_input(
38     silk_EncControlStruct        *encControl     /* I:   Control structure                               */
39 )
40 {
41     silk_assert( encControl != NULL );
42
43     if( ( ( encControl->API_sampleRate            !=  8000 ) &&
44           ( encControl->API_sampleRate            != 12000 ) &&
45           ( encControl->API_sampleRate            != 16000 ) &&
46           ( encControl->API_sampleRate            != 24000 ) &&
47           ( encControl->API_sampleRate            != 32000 ) &&
48           ( encControl->API_sampleRate            != 44100 ) &&
49           ( encControl->API_sampleRate            != 48000 ) ) ||
50         ( ( encControl->desiredInternalSampleRate !=  8000 ) &&
51           ( encControl->desiredInternalSampleRate != 12000 ) &&
52           ( encControl->desiredInternalSampleRate != 16000 ) ) ||
53         ( ( encControl->maxInternalSampleRate     !=  8000 ) &&
54           ( encControl->maxInternalSampleRate     != 12000 ) &&
55           ( encControl->maxInternalSampleRate     != 16000 ) ) ||
56         ( ( encControl->minInternalSampleRate     !=  8000 ) &&
57           ( encControl->minInternalSampleRate     != 12000 ) &&
58           ( encControl->minInternalSampleRate     != 16000 ) ) ||
59           ( encControl->minInternalSampleRate > encControl->desiredInternalSampleRate ) ||
60           ( encControl->maxInternalSampleRate < encControl->desiredInternalSampleRate ) ||
61           ( encControl->minInternalSampleRate > encControl->maxInternalSampleRate ) ) {
62         silk_assert( 0 );
63         return SILK_ENC_FS_NOT_SUPPORTED;
64     }
65     if( encControl->payloadSize_ms != 10 &&
66         encControl->payloadSize_ms != 20 &&
67         encControl->payloadSize_ms != 40 &&
68         encControl->payloadSize_ms != 60 ) {
69         silk_assert( 0 );
70         return SILK_ENC_PACKET_SIZE_NOT_SUPPORTED;
71     }
72     if( encControl->packetLossPercentage < 0 || encControl->packetLossPercentage > 100 ) {
73         silk_assert( 0 );
74         return SILK_ENC_INVALID_LOSS_RATE;
75     }
76     if( encControl->useDTX < 0 || encControl->useDTX > 1 ) {
77         silk_assert( 0 );
78         return SILK_ENC_INVALID_DTX_SETTING;
79     }
80     if( encControl->useCBR < 0 || encControl->useCBR > 1 ) {
81         silk_assert( 0 );
82         return SILK_ENC_INVALID_CBR_SETTING;
83     }
84     if( encControl->useInBandFEC < 0 || encControl->useInBandFEC > 1 ) {
85         silk_assert( 0 );
86         return SILK_ENC_INVALID_INBAND_FEC_SETTING;
87     }
88     if( encControl->nChannelsAPI < 1 || encControl->nChannelsAPI > ENCODER_NUM_CHANNELS ) {
89         silk_assert( 0 );
90         return SILK_ENC_INVALID_NUMBER_OF_CHANNELS_ERROR;
91     }
92     if( encControl->nChannelsInternal < 1 || encControl->nChannelsInternal > ENCODER_NUM_CHANNELS ) {
93         silk_assert( 0 );
94         return SILK_ENC_INVALID_NUMBER_OF_CHANNELS_ERROR;
95     }
96     if( encControl->nChannelsInternal > encControl->nChannelsAPI ) {
97         silk_assert( 0 );
98         return SILK_ENC_INVALID_NUMBER_OF_CHANNELS_ERROR;
99     }
100     if( encControl->complexity < 0 || encControl->complexity > 10 ) {
101         silk_assert( 0 );
102         return SILK_ENC_INVALID_COMPLEXITY_SETTING;
103     }
104
105     return SILK_NO_ERROR;
106 }