opencore/codecs_v2/audio/gsm_amr/amr_nb/common/include/lsp.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  Filename: lsp.h
  32
  33 ------------------------------------------------------------------------------
  34  INCLUDE DESCRIPTION
  35
  36  This file contains all the constant definitions and prototype definitions
  37  needed by the lsp.c
  38
  39 ------------------------------------------------------------------------------
  40 */
  41
  42 /*----------------------------------------------------------------------------
  43 ; CONTINUE ONLY IF NOT ALREADY DEFINED
  44 ----------------------------------------------------------------------------*/
  45 #ifndef lsp_h
  46 #define lsp_h "$Id $"
  47
  48 /*----------------------------------------------------------------------------
  49 ; INCLUDES
  50 ----------------------------------------------------------------------------*/
  51 #include "typedef.h"
  52 #include "q_plsf.h"
  53 #include "mode.h"
  54
  55 /*--------------------------------------------------------------------------*/
  56 #ifdef __cplusplus
  57 extern "C"
  58 {
  59 #endif
  60
  61     /*----------------------------------------------------------------------------
  62     ; MACROS
  63     ; Define module specific macros here
  64     ----------------------------------------------------------------------------*/
  65
  66     /*----------------------------------------------------------------------------
  67     ; DEFINES
  68     ; Include all pre-processor statements here.
  69     ----------------------------------------------------------------------------*/
  70
  71     /*----------------------------------------------------------------------------
  72     ; EXTERNAL VARIABLES REFERENCES
  73     ; Declare variables used in this module but defined elsewhere
  74     ----------------------------------------------------------------------------*/
  75
  76     /*----------------------------------------------------------------------------
  77     ; SIMPLE TYPEDEF'S
  78     ----------------------------------------------------------------------------*/
  79
  80     /*----------------------------------------------------------------------------
  81     ; ENUMERATED TYPEDEF'S
  82     ----------------------------------------------------------------------------*/
  83
  84     /*----------------------------------------------------------------------------
  85     ; STRUCTURES TYPEDEF'S
  86     ----------------------------------------------------------------------------*/
  87     typedef struct
  88     {
  89
  90         /* Past LSPs */
  91         Word16 lsp_old[M];
  92         Word16 lsp_old_q[M];
  93
  94         /* Quantization state */
  95         Q_plsfState *qSt;
  96
  97     } lspState;
  98
  99     /*----------------------------------------------------------------------------
 100     ; GLOBAL FUNCTION DEFINITIONS
 101     ; Function Prototype declaration
 102     ----------------------------------------------------------------------------*/
 103     /*
 104     **************************************************************************
 105     *
 106     *  Function    : lsp_init
 107     *  Purpose     : Allocates memory and initializes state variables
 108     *  Description : Stores pointer to filter status struct in *st. This
 109     *                pointer has to be passed to lsp in each call.
 110     *  Returns     : 0 on success
 111     *
 112     **************************************************************************
 113     */
 114     OSCL_IMPORT_REF Word16 lsp_init(lspState **st);
 115
 116     /*
 117     **************************************************************************
 118     *
 119     *  Function    : lsp_reset
 120     *  Purpose     : Resets state memory
 121     *  Returns     : 0 on success
 122     *
 123     **************************************************************************
 124     */
 125     OSCL_IMPORT_REF Word16 lsp_reset(lspState *st);
 126
 127     /*
 128     **************************************************************************
 129     *
 130     *  Function    : lsp_exit
 131     *  Purpose     : The memory used for state memory is freed
 132     *  Description : Stores NULL in *st
 133     *
 134     **************************************************************************
 135     */
 136     OSCL_IMPORT_REF void lsp_exit(lspState **st);
 137
 138     /*
 139     **************************************************************************
 140     *
 141     *  Function    : lsp
 142     *  Purpose     : Conversion from LP coefficients to LSPs.
 143     *                Quantization of LSPs.
 144     *  Description : Generates 2 sets of LSPs from 2 sets of
 145     *                LP coefficients for mode 12.2. For the other
 146     *                modes 1 set of LSPs is generated from 1 set of
 147     *                LP coefficients. These LSPs are quantized with
 148     *                Matrix/Vector quantization (depending on the mode)
 149     *                and interpolated for the subframes not yet having
 150     *                their own LSPs.
 151     *
 152     **************************************************************************
 153     */
 154     OSCL_IMPORT_REF void lsp(lspState *st,  /* i/o : State struct                 */
 155                              enum Mode req_mode, /* i   : requested coder mode                    */
 156                              enum Mode used_mode,/* i   : used coder mode                         */
 157                              Word16 az[],        /* i/o : interpolated LP parameters Q12          */
 158                              Word16 azQ[],       /* o   : quantization interpol. LP parameters Q12*/
 159                              Word16 lsp_new[],   /* o   : new lsp vector                          */
 160                              Word16 **anap,      /* o   : analysis parameters                     */
 161                              Flag   *pOverflow   /* o   : Flag set when overflow occurs           */
 162                             );
 163
 164     /*----------------------------------------------------------------------------
 165     ; END
 166     ----------------------------------------------------------------------------*/
 167 #ifdef __cplusplus
 168 }
 169 #endif
 170
 171 #endif /* _LSP_H_ */
 172
 173