Home | History | Annotate | Download | only in silk
      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, are permitted provided that the following conditions
      5 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 Internet Society, IETF or IETF Trust, nor the
     12 names of specific contributors, may be used to endorse or promote
     13 products derived from this software without specific prior written
     14 permission.
     15 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
     16 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
     17 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
     18 ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
     19 LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
     20 CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
     21 SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
     22 INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
     23 CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
     24 ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
     25 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     /* I: Make frames as independent as possible (but still use LPC)                        */
     96     opus_int reducedDependency;
     97 
     98     /* O:   Internal sampling rate used, in Hertz; 8000/12000/16000                         */
     99     opus_int32 internalSampleRate;
    100 
    101     /* O: Flag that bandwidth switching is allowed (because low voice activity)             */
    102     opus_int allowBandwidthSwitch;
    103 
    104     /* O:   Flag that SILK runs in WB mode without variable LP filter (use for switching between WB/SWB/FB) */
    105     opus_int inWBmodeWithoutVariableLP;
    106 
    107     /* O:   Stereo width */
    108     opus_int stereoWidth_Q14;
    109 
    110     /* O:   Tells the Opus encoder we're ready to switch                                    */
    111     opus_int switchReady;
    112 
    113 } silk_EncControlStruct;
    114 
    115 /**************************************************************************/
    116 /* Structure for controlling decoder operation and reading decoder status */
    117 /**************************************************************************/
    118 typedef struct {
    119     /* I:   Number of channels; 1/2                                                         */
    120     opus_int32 nChannelsAPI;
    121 
    122     /* I:   Number of channels; 1/2                                                         */
    123     opus_int32 nChannelsInternal;
    124 
    125     /* I:   Output signal sampling rate in Hertz; 8000/12000/16000/24000/32000/44100/48000  */
    126     opus_int32 API_sampleRate;
    127 
    128     /* I:   Internal sampling rate used, in Hertz; 8000/12000/16000                         */
    129     opus_int32 internalSampleRate;
    130 
    131     /* I:   Number of samples per packet in milliseconds; 10/20/40/60                       */
    132     opus_int payloadSize_ms;
    133 
    134     /* O:   Pitch lag of previous frame (0 if unvoiced), measured in samples at 48 kHz      */
    135     opus_int prevPitchLag;
    136 } silk_DecControlStruct;
    137 
    138 #ifdef __cplusplus
    139 }
    140 #endif
    141 
    142 #endif
    143