opencore/codecs_v2/audio/gsm_amr/amr_nb/enc/src/sp_enc.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: sp_enc.h
  35
  36 ------------------------------------------------------------------------------
  37  INCLUDE DESCRIPTION
  38
  39        File             : sp_enc.h
  40        Purpose          : Encoding of one speech frame
  41
  42 ------------------------------------------------------------------------------
  43 */
  44
  45 #ifndef sp_enc_h
  46 #define sp_enc_h "$Id $"
  47
  48 /*----------------------------------------------------------------------------
  49 ; INCLUDES
  50 ----------------------------------------------------------------------------*/
  51 #include "typedef.h"
  52 #include "cnst.h"
  53 #include "pre_proc.h"
  54 #include "mode.h"
  55 #include "cod_amr.h"
  56
  57 /*--------------------------------------------------------------------------*/
  58 #ifdef __cplusplus
  59 extern "C"
  60 {
  61 #endif
  62
  63     /*----------------------------------------------------------------------------
  64     ; MACROS
  65     ; [Define module specific macros here]
  66     ----------------------------------------------------------------------------*/
  67
  68     /*----------------------------------------------------------------------------
  69     ; DEFINES
  70     ; [Include all pre-processor statements here.]
  71     ----------------------------------------------------------------------------*/
  72
  73
  74     /*----------------------------------------------------------------------------
  75     ; EXTERNAL VARIABLES REFERENCES
  76     ; [Declare variables used in this module but defined elsewhere]
  77     ----------------------------------------------------------------------------*/
  78
  79     /*----------------------------------------------------------------------------
  80     ; SIMPLE TYPEDEF'S
  81     ----------------------------------------------------------------------------*/
  82
  83     /*----------------------------------------------------------------------------
  84     ; ENUMERATED TYPEDEF'S
  85     ----------------------------------------------------------------------------*/
  86
  87     /*----------------------------------------------------------------------------
  88     ; STRUCTURES TYPEDEF'S
  89     ----------------------------------------------------------------------------*/
  90     typedef struct
  91     {
  92         Pre_ProcessState *pre_state;
  93         cod_amrState   *cod_amr_state;
  94         Flag dtx;
  95     } Speech_Encode_FrameState;
  96
  97     /*----------------------------------------------------------------------------
  98     ; GLOBAL FUNCTION DEFINITIONS
  99     ; [List function prototypes here]
 100     ----------------------------------------------------------------------------*/
 101     /* initialize one instance of the speech encoder
 102        Stores pointer to filter status struct in *st. This pointer has to
 103        be passed to Speech_Encode_Frame in each call.
 104        returns 0 on success */
 105     Word16 GSMInitEncode(void **state_data,
 106                          Flag   dtx,
 107                          Word8  *id);
 108
 109
 110     /* reset speech encoder (i.e. set state memory to zero)
 111        returns 0 on success */
 112     Word16 Speech_Encode_Frame_reset(void *state_data);
 113
 114     /* de-initialize speech encoder (i.e. free status struct)
 115        stores NULL in *s */
 116     void GSMEncodeFrameExit(void **state_data);
 117
 118     void Speech_Encode_Frame_First(
 119         Speech_Encode_FrameState *st, /* i/o : post filter states     */
 120         Word16 *new_speech);          /* i   : speech input           */
 121
 122     void GSMEncodeFrame(
 123         void *state_data,             /* i/o : encoder states         */
 124         enum Mode mode,               /* i   : speech coder mode      */
 125         Word16 *new_speech,           /* i   : input speech           */
 126         Word16 *serial,               /* o   : serial bit stream      */
 127         enum Mode *usedMode           /* o   : used speech coder mode */
 128     );
 129
 130 #ifdef __cplusplus
 131 }
 132 #endif
 133
 134 #endif  /* _sp_enc_h_ */
 135