1b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber/* ------------------------------------------------------------------ 2b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber * Copyright (C) 1998-2009 PacketVideo 3b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber * 4b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber * Licensed under the Apache License, Version 2.0 (the "License"); 5b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber * you may not use this file except in compliance with the License. 6b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber * You may obtain a copy of the License at 7b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber * 8b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber * http://www.apache.org/licenses/LICENSE-2.0 9b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber * 10b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber * Unless required by applicable law or agreed to in writing, software 11b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber * distributed under the License is distributed on an "AS IS" BASIS, 12b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either 13b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber * express or implied. 14b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber * See the License for the specific language governing permissions 15b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber * and limitations under the License. 16b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber * ------------------------------------------------------------------- 17b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber */ 18b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber/**************************************************************************************** 19b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas HuberPortions of this file are derived from the following 3GPP standard: 20b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 21b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 3GPP TS 26.073 22b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber ANSI-C code for the Adaptive Multi-Rate (AMR) speech codec 23b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber Available from http://www.3gpp.org 24b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 25b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber(C) 2004, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TTA, TTC) 26b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas HuberPermission to distribute, modify and use this file under the standard license 27b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huberterms listed above has been obtained from the copyright holder. 28b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber****************************************************************************************/ 29b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber/* 30b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber------------------------------------------------------------------------------ 31b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 32b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 33b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 34b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber Filename: /audio/gsm-amr/c/include/sid_sync.h 35b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 36b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber Date: 03/13/2002 37b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 38b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber------------------------------------------------------------------------------ 39b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber REVISION HISTORY 40b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 41b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber Description: Added PV coding template sections to 3GPP version 3.2.0. 42b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 43b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber Description: Replaced "int" and/or "char" with OSCL defined types. 44b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 45b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber Description: Moved _cplusplus #ifdef after Include section. 46b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 47b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber Description: 48b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 49b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber------------------------------------------------------------------------------ 50b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber INCLUDE DESCRIPTION 51b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 52b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber This file contains the type definition and function prototypes used by the 53b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber SID synchronization functions. 54b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 55b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber------------------------------------------------------------------------------ 56b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber*/ 57b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 58b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber#ifndef _SID_SYNC_H_ 59b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber#define _SID_SYNC_H_ 60b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 61b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber/*---------------------------------------------------------------------------- 62b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber; INCLUDES 63b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber----------------------------------------------------------------------------*/ 64b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber#include "typedef.h" 65b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber#include "mode.h" 66b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber#include "frame.h" 67b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 68b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber/*--------------------------------------------------------------------------*/ 69b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber#ifdef __cplusplus 70b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huberextern "C" 71b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber{ 72b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber#endif 73b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 74b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber /*---------------------------------------------------------------------------- 75b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber ; MACROS 76b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber ; [Define module specific macros here] 77b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber ----------------------------------------------------------------------------*/ 78b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 79b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber /*---------------------------------------------------------------------------- 80b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber ; DEFINES 81b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber ; [Include all pre-processor statements here.] 82b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber ----------------------------------------------------------------------------*/ 83b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber#define sid_sync_h "$Id $" 84b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 85b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber /*---------------------------------------------------------------------------- 86b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber ; EXTERNAL VARIABLES REFERENCES 87b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber ; [Declare variables used in this module but defined elsewhere] 88b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber ----------------------------------------------------------------------------*/ 89b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 90b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber /*---------------------------------------------------------------------------- 91b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber ; SIMPLE TYPEDEF'S 92b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber ----------------------------------------------------------------------------*/ 93b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 94b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber /*---------------------------------------------------------------------------- 95b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber ; ENUMERATED TYPEDEF'S 96b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber ----------------------------------------------------------------------------*/ 97b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 98b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber /*---------------------------------------------------------------------------- 99b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber ; STRUCTURES TYPEDEF'S 100b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber ----------------------------------------------------------------------------*/ 101b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber typedef struct 102b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber { 103b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber Word16 sid_update_rate; /* Send SID Update every sid_update_rate frame */ 104b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber Word16 sid_update_counter; /* Number of frames since last SID */ 105b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber Word16 sid_handover_debt; /* Number of extra SID_UPD frames to schedule*/ 106b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber enum TXFrameType prev_ft; 107b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber } sid_syncState; 108b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 109b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber /*---------------------------------------------------------------------------- 110b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber ; GLOBAL FUNCTION DEFINITIONS 111b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber ; [List function prototypes here] 112b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber ----------------------------------------------------------------------------*/ 113b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber /* initialize one instance of the sid_sync module 114b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber Stores pointer to state struct in *st. This pointer has to 115b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber be passed to sid_sync in each call. 116b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber returns 0 on success 117b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber */ 118b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber Word16 sid_sync_init(void **st); 119b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 120b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber /* reset of sid_sync module (i.e. set state memory to zero) 121b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber returns 0 on success 122b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber */ 123b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber Word16 sid_sync_reset(void *st); 124b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 125b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber /* de-initialize sid_sync module (i.e. free status struct) 126b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber stores NULL in *st 127b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber */ 128b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber void sid_sync_exit(void **st); 129b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 130b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber /* update handover debt 131b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber debtFrames extra SID_UPD are scheduled . 132b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber to update remote decoder CNI states, right after an handover. 133b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber (primarily for use on MS UL side ) 134b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber */ 135b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber void sid_sync_set_handover_debt(sid_syncState *st, /* i/o: sid_sync state */ 136b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber Word16 debtFrames); 137b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 138b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber /* To ensure that the mode only switches to a neighbouring mode */ 139b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber void sid_sync(void *st , 140b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber enum Mode mode, 141b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber enum TXFrameType *tx_frame_type); 142b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 143b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber#ifdef __cplusplus 144b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber} 145b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber#endif 146b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 147b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber#endif /* _SID_SYNC_H_ */ 148