opencore/codecs_v2/audio/gsm_amr/amr_nb/enc/src/amrencode.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: amrencode.h
  35
  36 ------------------------------------------------------------------------------
  37  INCLUDE DESCRIPTION
  38
  39  This file contains the function prototype of AMREncode.
  40
  41 ------------------------------------------------------------------------------
  42 */
  43
  44 #ifndef _AMRENCODE_H_
  45 #define _AMRENCODE_H_
  46
  47 /*----------------------------------------------------------------------------
  48 ; INCLUDES
  49 ----------------------------------------------------------------------------*/
  50 #include "typedef.h"
  51 #include "mode.h"
  52 #include "frame_type_3gpp.h"
  53
  54 /*--------------------------------------------------------------------------*/
  55 #ifdef __cplusplus
  56 extern "C"
  57 {
  58 #endif
  59
  60     /*----------------------------------------------------------------------------
  61     ; MACROS
  62     ; [Define module specific macros here]
  63     ----------------------------------------------------------------------------*/
  64
  65     /*----------------------------------------------------------------------------
  66     ; DEFINES
  67     ; [Include all pre-processor statements here.]
  68     ----------------------------------------------------------------------------*/
  69 #define NUM_AMRSID_TXMODE_BITS     3
  70 #define AMRSID_TXMODE_BIT_OFFSET   36
  71 #define AMRSID_TXTYPE_BIT_OFFSET   35
  72
  73     /* Output format types */
  74
  75 #define AMR_TX_WMF  0
  76 #define AMR_TX_IF2  1
  77 #define AMR_TX_ETS  2
  78 #define AMR_TX_IETF 3
  79
  80
  81     /*----------------------------------------------------------------------------
  82     ; EXTERNAL VARIABLES REFERENCES
  83     ; [Declare variables used in this module but defined elsewhere]
  84     ----------------------------------------------------------------------------*/
  85     extern const Word16 WmfEncBytesPerFrame[];
  86     extern const Word16 If2EncBytesPerFrame[];
  87
  88     /*----------------------------------------------------------------------------
  89     ; SIMPLE TYPEDEF'S
  90     ----------------------------------------------------------------------------*/
  91
  92     /*----------------------------------------------------------------------------
  93     ; ENUMERATED TYPEDEF'S
  94     ----------------------------------------------------------------------------*/
  95
  96     /*----------------------------------------------------------------------------
  97     ; STRUCTURES TYPEDEF'S
  98     ----------------------------------------------------------------------------*/
  99
 100     /*----------------------------------------------------------------------------
 101     ; GLOBAL FUNCTION DEFINITIONS
 102     ; [List function prototypes here]
 103     ----------------------------------------------------------------------------*/
 104     Word16 AMREncodeInit(
 105         void **pEncStructure,
 106         void **pSidSyncStructure,
 107         Flag dtx_enable);
 108
 109     Word16 AMREncodeReset(
 110         void *pEncStructure,
 111         void *pSidSyncStructure);
 112
 113     void AMREncodeExit(
 114         void **pEncStructure,
 115         void **pSidSyncStructure);
 116
 117     Word16 AMREncode(
 118         void *pEncState,
 119         void *pSidSyncState,
 120         enum Mode mode,
 121         Word16 *pEncInput,
 122         UWord8 *pEncOutput,
 123         enum Frame_Type_3GPP *p3gpp_frame_type,
 124         Word16 output_format
 125     );
 126
 127 #ifdef __cplusplus
 128 }
 129 #endif
 130
 131 #endif  /* _AMRENCODE_H_ */
 132
 133