opencore/codecs_v2/audio/gsm_amr/amr_nb/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: sid_sync.h
  35
  36 ------------------------------------------------------------------------------
  37  INCLUDE DESCRIPTION
  38
  39  This file contains the type definition and function prototypes used by the
  40  SID synchronization functions.
  41
  42 ------------------------------------------------------------------------------
  43 */
  44
  45 #ifndef _SID_SYNC_H_
  46 #define _SID_SYNC_H_
  47
  48 /*----------------------------------------------------------------------------
  49 ; INCLUDES
  50 ----------------------------------------------------------------------------*/
  51 #include "typedef.h"
  52 #include "mode.h"
  53 #include "frame.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 #define sid_sync_h "$Id $"
  71
  72     /*----------------------------------------------------------------------------
  73     ; EXTERNAL VARIABLES REFERENCES
  74     ; [Declare variables used in this module but defined elsewhere]
  75     ----------------------------------------------------------------------------*/
  76
  77     /*----------------------------------------------------------------------------
  78     ; SIMPLE TYPEDEF'S
  79     ----------------------------------------------------------------------------*/
  80
  81     /*----------------------------------------------------------------------------
  82     ; ENUMERATED TYPEDEF'S
  83     ----------------------------------------------------------------------------*/
  84
  85     /*----------------------------------------------------------------------------
  86     ; STRUCTURES TYPEDEF'S
  87     ----------------------------------------------------------------------------*/
  88     typedef struct
  89     {
  90         Word16 sid_update_rate;  /* Send SID Update every sid_update_rate frame */
  91         Word16 sid_update_counter; /* Number of frames since last SID          */
  92         Word16 sid_handover_debt;  /* Number of extra SID_UPD frames to schedule*/
  93         enum TXFrameType prev_ft;
  94     } sid_syncState;
  95
  96     /*----------------------------------------------------------------------------
  97     ; GLOBAL FUNCTION DEFINITIONS
  98     ; [List function prototypes here]
  99     ----------------------------------------------------------------------------*/
 100     /* initialize one instance of the sid_sync module
 101        Stores pointer to state struct in *st. This pointer has to
 102        be passed to sid_sync in each call.
 103        returns 0 on success
 104      */
 105     Word16 sid_sync_init(void **st);
 106
 107     /* reset of sid_sync module (i.e. set state memory to zero)
 108        returns 0 on success
 109      */
 110     Word16 sid_sync_reset(void *st);
 111
 112     /* de-initialize sid_sync module (i.e. free status struct)
 113        stores NULL in *st
 114      */
 115     void sid_sync_exit(void **st);
 116
 117     /*  update handover debt
 118         debtFrames extra SID_UPD are scheduled .
 119         to update remote decoder CNI states, right after an handover.
 120         (primarily for use on MS UL side )
 121     */
 122     void sid_sync_set_handover_debt(sid_syncState *st,  /* i/o: sid_sync state  */
 123                                     Word16 debtFrames);
 124
 125     /* To ensure that the mode only switches to a neighbouring mode */
 126     void sid_sync(void *st ,
 127                   enum Mode mode,
 128                   enum TXFrameType *tx_frame_type);
 129
 130 #ifdef __cplusplus
 131 }
 132 #endif
 133
 134 #endif  /* _SID_SYNC_H_ */