frameworks/base/media/libstagefright/codecs/amrnb/enc/src/sid_sync.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: /audio/gsm-amr/c/include/sid_sync.h
  35
  36      Date: 03/13/2002
  37
  38 ------------------------------------------------------------------------------
  39  REVISION HISTORY
  40
  41  Description: Added PV coding template sections to 3GPP version 3.2.0.
  42
  43  Description:  Replaced "int" and/or "char" with OSCL defined types.
  44
  45  Description: Moved _cplusplus #ifdef after Include section.
  46
  47  Description:
  48
  49 ------------------------------------------------------------------------------
  50  INCLUDE DESCRIPTION
  51
  52  This file contains the type definition and function prototypes used by the
  53  SID synchronization functions.
  54
  55 ------------------------------------------------------------------------------
  56 */
  57
  58 #ifndef _SID_SYNC_H_
  59 #define _SID_SYNC_H_
  60
  61 /*----------------------------------------------------------------------------
  62 ; INCLUDES
  63 ----------------------------------------------------------------------------*/
  64 #include "typedef.h"
  65 #include "mode.h"
  66 #include "frame.h"
  67
  68 /*--------------------------------------------------------------------------*/
  69 #ifdef __cplusplus
  70 extern "C"
  71 {
  72 #endif
  73
  74     /*----------------------------------------------------------------------------
  75     ; MACROS
  76     ; [Define module specific macros here]
  77     ----------------------------------------------------------------------------*/
  78
  79     /*----------------------------------------------------------------------------
  80     ; DEFINES
  81     ; [Include all pre-processor statements here.]
  82     ----------------------------------------------------------------------------*/
  83 #define sid_sync_h "$Id $"
  84
  85     /*----------------------------------------------------------------------------
  86     ; EXTERNAL VARIABLES REFERENCES
  87     ; [Declare variables used in this module but defined elsewhere]
  88     ----------------------------------------------------------------------------*/
  89
  90     /*----------------------------------------------------------------------------
  91     ; SIMPLE TYPEDEF'S
  92     ----------------------------------------------------------------------------*/
  93
  94     /*----------------------------------------------------------------------------
  95     ; ENUMERATED TYPEDEF'S
  96     ----------------------------------------------------------------------------*/
  97
  98     /*----------------------------------------------------------------------------
  99     ; STRUCTURES TYPEDEF'S
 100     ----------------------------------------------------------------------------*/
 101     typedef struct
 102     {
 103         Word16 sid_update_rate;  /* Send SID Update every sid_update_rate frame */
 104         Word16 sid_update_counter; /* Number of frames since last SID          */
 105         Word16 sid_handover_debt;  /* Number of extra SID_UPD frames to schedule*/
 106         enum TXFrameType prev_ft;
 107     } sid_syncState;
 108
 109     /*----------------------------------------------------------------------------
 110     ; GLOBAL FUNCTION DEFINITIONS
 111     ; [List function prototypes here]
 112     ----------------------------------------------------------------------------*/
 113     /* initialize one instance of the sid_sync module
 114        Stores pointer to state struct in *st. This pointer has to
 115        be passed to sid_sync in each call.
 116        returns 0 on success
 117      */
 118     Word16 sid_sync_init(void **st);
 119
 120     /* reset of sid_sync module (i.e. set state memory to zero)
 121        returns 0 on success
 122      */
 123     Word16 sid_sync_reset(void *st);
 124
 125     /* de-initialize sid_sync module (i.e. free status struct)
 126        stores NULL in *st
 127      */
 128     void sid_sync_exit(void **st);
 129
 130     /*  update handover debt
 131         debtFrames extra SID_UPD are scheduled .
 132         to update remote decoder CNI states, right after an handover.
 133         (primarily for use on MS UL side )
 134     */
 135     void sid_sync_set_handover_debt(sid_syncState *st,  /* i/o: sid_sync state  */
 136                                     Word16 debtFrames);
 137
 138     /* To ensure that the mode only switches to a neighbouring mode */
 139     void sid_sync(void *st ,
 140                   enum Mode mode,
 141                   enum TXFrameType *tx_frame_type);
 142
 143 #ifdef __cplusplus
 144 }
 145 #endif
 146
 147 #endif  /* _SID_SYNC_H_ */