opencore/codecs_v2/audio/gsm_amr/amr_nb/enc/src/cbsearch.h

   1 /* ------------------------------------------------------------------
   2  * Copyright (C) 1998-2009 PacketVideo
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  *      http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
  13  * express or implied.
  14  * See the License for the specific language governing permissions
  15  * and limitations under the License.
  16  * -------------------------------------------------------------------
  17  */
  18 /****************************************************************************************
  19 Portions of this file are derived from the following 3GPP standard:
  20
  21     3GPP TS 26.073
  22     ANSI-C code for the Adaptive Multi-Rate (AMR) speech codec
  23     Available from http://www.3gpp.org
  24
  25 (C) 2004, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TTA, TTC)
  26 Permission to distribute, modify and use this file under the standard license
  27 terms listed above has been obtained from the copyright holder.
  28 ****************************************************************************************/
  29 /*
  30 ------------------------------------------------------------------------------
  31
  32
  33
  34  Filename: cbsearch.h
  35
  36 ------------------------------------------------------------------------------
  37  INCLUDE DESCRIPTION
  38
  39  This file contains all the constant definitions and prototype definitions
  40  needed by the cbsearch.c
  41
  42 ------------------------------------------------------------------------------
  43 */
  44
  45 /*----------------------------------------------------------------------------
  46 ; CONTINUE ONLY IF NOT ALREADY DEFINED
  47 ----------------------------------------------------------------------------*/
  48 #ifndef cbsearch_h
  49 #define cbsearch_h "$Id $"
  50
  51
  52 /*----------------------------------------------------------------------------
  53 ; INCLUDES
  54 ----------------------------------------------------------------------------*/
  55 #include "typedef.h"
  56 #include "mode.h"
  57 #include "get_const_tbls.h"
  58
  59 /*--------------------------------------------------------------------------*/
  60 #ifdef __cplusplus
  61 extern "C"
  62 {
  63 #endif
  64
  65     /*----------------------------------------------------------------------------
  66     ; MACROS
  67     ; Define module specific macros here
  68     ----------------------------------------------------------------------------*/
  69
  70     /*----------------------------------------------------------------------------
  71     ; DEFINES
  72     ; Include all pre-processor statements here.
  73     ----------------------------------------------------------------------------*/
  74
  75     /*----------------------------------------------------------------------------
  76     ; EXTERNAL VARIABLES REFERENCES
  77     ; Declare variables used in this module but defined elsewhere
  78     ----------------------------------------------------------------------------*/
  79
  80     /*----------------------------------------------------------------------------
  81     ; SIMPLE TYPEDEF'S
  82     ----------------------------------------------------------------------------*/
  83
  84     /*----------------------------------------------------------------------------
  85     ; ENUMERATED TYPEDEF'S
  86     ----------------------------------------------------------------------------*/
  87
  88     /*----------------------------------------------------------------------------
  89     ; STRUCTURES TYPEDEF'S
  90     ----------------------------------------------------------------------------*/
  91
  92     /*----------------------------------------------------------------------------
  93     ; GLOBAL FUNCTION DEFINITIONS
  94     ; Function Prototype declaration
  95     ----------------------------------------------------------------------------*/
  96
  97     void cbsearch(Word16 x[],     /* i : target vector, Q0                      */
  98     Word16 h[],     /* i : impulse response of weighted synthesis */
  99     /*     filter h[-L_subfr..-1] must be set to  */
 100     /*    zero. Q12                               */
 101     Word16 T0,      /* i : Pitch lag                              */
 102     Word16 pitch_sharp, /* i : Last quantized pitch gain, Q14     */
 103     Word16 gain_pit,/* i : Pitch gain, Q14                        */
 104     Word16 res2[],  /* i : Long term prediction residual, Q0      */
 105     Word16 code[],  /* o : Innovative codebook, Q13               */
 106     Word16 y[],     /* o : filtered fixed codebook excitation, Q12 */
 107     Word16 **anap,  /* o : Signs of the pulses                    */
 108     enum Mode mode, /* i : coder mode                             */
 109     Word16 subNr,   /* i : subframe number                        */
 110     CommonAmrTbls* common_amr_tbls, /* ptr to struct of tables    */
 111     Flag  *pOverflow  /* o : Flag set when overflow occurs        */
 112                  );
 113
 114     /*----------------------------------------------------------------------------
 115     ; END
 116     ----------------------------------------------------------------------------*/
 117 #ifdef __cplusplus
 118 }
 119 #endif
 120
 121 #endif /* _CBSEARCH_H_ */
 122
 123
 124