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/src/sid_sync.c 35b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber Functions: sid_sync_init 36b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber sid_sync_reset 37b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber sid_sync_exit 38b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber sid_sync_set_handover_debt 39b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber sid_sync 40b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 41b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber Date: 03/13/2002 42b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 43b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber------------------------------------------------------------------------------ 44b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber REVISION HISTORY 45b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 46b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber Description: Changed type definition of state pointer to 'void' for 47b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber sid_sync_init, sid_sync_reset, sid_sync_exit, and sid_sync. 48b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber Updated to PV coding template. 49b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 50b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber Description: Replaced OSCL mem type functions and eliminated include 51b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber files that now are chosen by OSCL definitions 52b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 53b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber Description: Replaced "int" and/or "char" with OSCL defined types. 54b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 55b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber Description: 56b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 57b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber------------------------------------------------------------------------------ 58b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber MODULE DESCRIPTION 59b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 60b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber This file contains the functions that initialize, reset, exit, and perform 61b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber SID synchronization. 62b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 63b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber------------------------------------------------------------------------------ 64b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber*/ 65b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 66b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 67b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber/*---------------------------------------------------------------------------- 68b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber; INCLUDES 69b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber----------------------------------------------------------------------------*/ 70b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber#include <stdlib.h> 71b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 72b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber#include "typedef.h" 73b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber#include "basic_op.h" 74b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber#include "mode.h" 75b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber#include "sid_sync.h" 76b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 77b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber/*---------------------------------------------------------------------------- 78b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber; MACROS 79b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber; [Define module specific macros here] 80b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber----------------------------------------------------------------------------*/ 81b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 82b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 83b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber/*---------------------------------------------------------------------------- 84b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber; DEFINES 85b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber; [Include all pre-processor statements here. Include conditional 86b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber; compile variables also.] 87b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber----------------------------------------------------------------------------*/ 88b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 89b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber/*---------------------------------------------------------------------------- 90b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber; LOCAL FUNCTION DEFINITIONS 91b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber; [List function prototypes here] 92b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber----------------------------------------------------------------------------*/ 93b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 94b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber/*---------------------------------------------------------------------------- 95b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber; LOCAL VARIABLE DEFINITIONS 96b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber; [Variable declaration - defined here and used outside this module] 97b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber----------------------------------------------------------------------------*/ 98b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 99b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 100b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber/* 101b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber------------------------------------------------------------------------------ 102b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber FUNCTION NAME: sid_sync_init 103b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber------------------------------------------------------------------------------ 104b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber INPUT AND OUTPUT DEFINITIONS 105b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 106b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber Inputs: 107b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber state = pointer containing a pointer to the state structure used for 108b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber SID synchronization (void) 109b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 110b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber Outputs: 111b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber None 112b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 113b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber Returns: 114b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber return_value = status of sid_sync_reset function; -1, if state is pointing 115b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber to a NULL address (int) 116b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 117b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber Global Variables Used: 118b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber None 119b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 120b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber Local Variables Needed: 121b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber None 122b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 123b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber------------------------------------------------------------------------------ 124b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber FUNCTION DESCRIPTION 125b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 126b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber This function initialize one instance of the sid_sync module. It stores 127b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber the pointer to state struct in *st. This pointer has to be passed to sid_sync 128b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber in each call. This function returns 0 on success, otherwise, -1. 129b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 130b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber------------------------------------------------------------------------------ 131b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber REQUIREMENTS 132b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 133b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber None 134b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 135b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber------------------------------------------------------------------------------ 136b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber REFERENCES 137b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 138b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber sid_sync.c, UMTS GSM AMR speech codec, R99 - Version 3.2.0, March 2, 2001 139b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 140b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber------------------------------------------------------------------------------ 141b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber PSEUDO-CODE 142b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 143b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber------------------------------------------------------------------------------ 144b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber RESOURCES USED [optional] 145b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 146b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber When the code is written for a specific target processor the 147b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber the resources used should be documented below. 148b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 149b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber HEAP MEMORY USED: x bytes 150b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 151b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber STACK MEMORY USED: x bytes 152b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 153b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber CLOCK CYCLES: (cycle count equation for this function) + (variable 154b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber used to represent cycle count for each subroutine 155b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber called) 156b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber where: (cycle count variable) = cycle count for [subroutine 157b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber name] 158b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 159b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber------------------------------------------------------------------------------ 160b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber CAUTION [optional] 161b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber [State any special notes, constraints or cautions for users of this function] 162b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 163b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber------------------------------------------------------------------------------ 164b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber*/ 165b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 166b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas HuberWord16 sid_sync_init(void **state) 167b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber{ 168b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber sid_syncState* s; 169b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 170b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber if (state == NULL) 171b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber { 172b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber /* fprintf(stderr, "sid_sync_init:invalid state parameter\n"); */ 173b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber return -1; 174b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber } 175b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 176b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber *state = NULL; 177b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 178b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber /* allocate memory */ 179b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber if ((s = (sid_syncState *) 180b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber malloc(sizeof(sid_syncState))) == NULL) 181b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber { 182b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber /* fprintf(stderr, 183b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber "sid_sync_init: " 184b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber "can not malloc state structure\n"); */ 185b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber return -1; 186b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber } 187b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber s->sid_update_rate = 8; 188b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 189b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber *state = (void *)s; 190b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 191b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber return(sid_sync_reset(s)); 192b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber} 193b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 194b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber/****************************************************************************/ 195b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 196b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber/* 197b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber------------------------------------------------------------------------------ 198b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber FUNCTION NAME: sid_sync_reset 199b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber------------------------------------------------------------------------------ 200b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber INPUT AND OUTPUT DEFINITIONS 201b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 202b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber Inputs: 203b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber state = pointer to the state structure used for SID synchronization (void) 204b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 205b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber Outputs: 206b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber None 207b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 208b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber Returns: 209b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber return_value = 0 (int) 210b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 211b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber Global Variables Used: 212b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber None 213b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 214b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber Local Variables Needed: 215b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber None 216b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 217b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber------------------------------------------------------------------------------ 218b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber FUNCTION DESCRIPTION 219b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 220b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber This function performs a reset of the sid_sync module by setting the state 221b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber memory to zero. 222b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 223b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber------------------------------------------------------------------------------ 224b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber REQUIREMENTS 225b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 226b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber None 227b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 228b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber------------------------------------------------------------------------------ 229b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber REFERENCES 230b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 231b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber sid_sync.c, UMTS GSM AMR speech codec, R99 - Version 3.2.0, March 2, 2001 232b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 233b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber------------------------------------------------------------------------------ 234b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber PSEUDO-CODE 235b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 236b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber------------------------------------------------------------------------------ 237b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber RESOURCES USED [optional] 238b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 239b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber When the code is written for a specific target processor the 240b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber the resources used should be documented below. 241b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 242b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber HEAP MEMORY USED: x bytes 243b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 244b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber STACK MEMORY USED: x bytes 245b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 246b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber CLOCK CYCLES: (cycle count equation for this function) + (variable 247b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber used to represent cycle count for each subroutine 248b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber called) 249b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber where: (cycle count variable) = cycle count for [subroutine 250b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber name] 251b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 252b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber------------------------------------------------------------------------------ 253b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber CAUTION [optional] 254b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber [State any special notes, constraints or cautions for users of this function] 255b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 256b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber------------------------------------------------------------------------------ 257b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber*/ 258b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas HuberWord16 sid_sync_reset(void *st) 259b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber{ 260b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber sid_syncState *state = (sid_syncState *) st; 261b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 262b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber state->sid_update_counter = 3; 263b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber state->sid_handover_debt = 0; 264b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber state->prev_ft = TX_SPEECH_GOOD; 265b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 266b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber return 0; 267b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber} 268b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 269b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 270b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber/****************************************************************************/ 271b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 272b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber/* 273b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber------------------------------------------------------------------------------ 274b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber FUNCTION NAME: sid_sync_exit 275b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber------------------------------------------------------------------------------ 276b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber INPUT AND OUTPUT DEFINITIONS 277b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 278b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber Inputs: 279b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber state = pointer containing a pointer to the state structure used for 280b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber SID synchronization (void) 281b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 282b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber Outputs: 283b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber None 284b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 285b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber Returns: 286b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber None 287b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 288b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber Global Variables Used: 289b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber None 290b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 291b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber Local Variables Needed: 292b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber None 293b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 294b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber------------------------------------------------------------------------------ 295b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber FUNCTION DESCRIPTION 296b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 297b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber This function frees up the state structure used by sid_sync function. It 298b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber stores NULL in *state. 299b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 300b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber------------------------------------------------------------------------------ 301b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber REQUIREMENTS 302b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 303b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber None 304b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 305b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber------------------------------------------------------------------------------ 306b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber REFERENCES 307b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 308b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber sid_sync.c, UMTS GSM AMR speech codec, R99 - Version 3.2.0, March 2, 2001 309b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 310b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber------------------------------------------------------------------------------ 311b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber PSEUDO-CODE 312b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 313b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber------------------------------------------------------------------------------ 314b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber RESOURCES USED [optional] 315b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 316b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber When the code is written for a specific target processor the 317b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber the resources used should be documented below. 318b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 319b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber HEAP MEMORY USED: x bytes 320b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 321b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber STACK MEMORY USED: x bytes 322b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 323b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber CLOCK CYCLES: (cycle count equation for this function) + (variable 324b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber used to represent cycle count for each subroutine 325b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber called) 326b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber where: (cycle count variable) = cycle count for [subroutine 327b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber name] 328b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 329b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber------------------------------------------------------------------------------ 330b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber CAUTION [optional] 331b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber [State any special notes, constraints or cautions for users of this function] 332b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 333b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber------------------------------------------------------------------------------ 334b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber*/ 335b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Hubervoid sid_sync_exit(void **state) 336b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber{ 337b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber sid_syncState **st = (sid_syncState **) state; 338b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 339b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber if (st == NULL || *st == NULL) 340b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber { 341b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber return; 342b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber } 343b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 344b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber /* deallocate memory */ 345b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber free(*st); 346b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber *st = NULL; 347b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 348b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber return; 349b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 350b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber} 351b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 352b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber/****************************************************************************/ 353b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 354b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber/* 355b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber------------------------------------------------------------------------------ 356b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber FUNCTION NAME: sid_sync_set_handover_debt 357b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber------------------------------------------------------------------------------ 358b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber INPUT AND OUTPUT DEFINITIONS 359b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 360b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber Inputs: 361b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber st = pointer to the state structure used for SID synchronization 362b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber (sid_syncState) 363b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber debtFrames = number of handover debt frames (Word16) 364b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 365b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber Outputs: 366b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber st->sid_handover_debt is set to debtFrames 367b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 368b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber Returns: 369b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber return_value = 0 370b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 371b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber Global Variables Used: 372b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber None 373b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 374b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber Local Variables Needed: 375b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber None 376b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 377b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber------------------------------------------------------------------------------ 378b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber FUNCTION DESCRIPTION 379b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 380b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber This function updates the handover debt to debtFrames. Extra SID_UPD are 381b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber scheduled to update remote decoder CNI states, right after an handover. 382b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber This is primarily for use on MS UL side. 383b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 384b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber------------------------------------------------------------------------------ 385b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber REQUIREMENTS 386b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 387b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber None 388b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 389b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber------------------------------------------------------------------------------ 390b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber REFERENCES 391b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 392b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber sid_sync.c, UMTS GSM AMR speech codec, R99 - Version 3.2.0, March 2, 2001 393b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 394b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber------------------------------------------------------------------------------ 395b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber PSEUDO-CODE 396b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 397b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber------------------------------------------------------------------------------ 398b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber RESOURCES USED [optional] 399b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 400b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber When the code is written for a specific target processor the 401b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber the resources used should be documented below. 402b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 403b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber HEAP MEMORY USED: x bytes 404b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 405b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber STACK MEMORY USED: x bytes 406b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 407b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber CLOCK CYCLES: (cycle count equation for this function) + (variable 408b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber used to represent cycle count for each subroutine 409b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber called) 410b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber where: (cycle count variable) = cycle count for [subroutine 411b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber name] 412b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 413b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber------------------------------------------------------------------------------ 414b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber CAUTION [optional] 415b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber [State any special notes, constraints or cautions for users of this function] 416b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 417b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber------------------------------------------------------------------------------ 418b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber*/ 419b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Hubervoid sid_sync_set_handover_debt(sid_syncState *st, 420b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber Word16 debtFrames) 421b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber{ 422b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber /* debtFrames >= 0 */ 423b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber st->sid_handover_debt = debtFrames; 424b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber return; 425b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber} 426b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 427b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 428b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber/****************************************************************************/ 429b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 430b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber/* 431b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber------------------------------------------------------------------------------ 432b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber FUNCTION NAME: sid_sync 433b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber------------------------------------------------------------------------------ 434b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber INPUT AND OUTPUT DEFINITIONS 435b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 436b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber Inputs: 437b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber state = pointer to the state structure used for SID synchronization 438b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber (sid_syncState) 439b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber mode = codec mode (enum Mode) 440b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber tx_frame_type = pointer to TX frame type store (enum TXFrameType) 441b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 442b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber Outputs: 443b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber tx_frame_type contains the new TX frame type 444b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 445b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber Returns: 446b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber None 447b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 448b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber Global Variables Used: 449b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber None 450b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 451b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber Local Variables Needed: 452b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber None 453b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 454b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber------------------------------------------------------------------------------ 455b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber FUNCTION DESCRIPTION 456b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 457b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber This function performs SID frame synchronization to ensure that the mode 458b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber only switches to a neighbouring mode. 459b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 460b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber------------------------------------------------------------------------------ 461b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber REQUIREMENTS 462b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 463b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber None 464b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 465b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber------------------------------------------------------------------------------ 466b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber REFERENCES 467b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 468b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber sid_sync.c, UMTS GSM AMR speech codec, R99 - Version 3.2.0, March 2, 2001 469b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 470b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber------------------------------------------------------------------------------ 471b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber PSEUDO-CODE 472b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 473b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber------------------------------------------------------------------------------ 474b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber RESOURCES USED [optional] 475b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 476b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber When the code is written for a specific target processor the 477b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber the resources used should be documented below. 478b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 479b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber HEAP MEMORY USED: x bytes 480b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 481b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber STACK MEMORY USED: x bytes 482b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 483b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber CLOCK CYCLES: (cycle count equation for this function) + (variable 484b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber used to represent cycle count for each subroutine 485b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber called) 486b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber where: (cycle count variable) = cycle count for [subroutine 487b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber name] 488b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 489b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber------------------------------------------------------------------------------ 490b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber CAUTION [optional] 491b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber [State any special notes, constraints or cautions for users of this function] 492b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 493b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber------------------------------------------------------------------------------ 494b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber*/ 495b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Hubervoid sid_sync(void *state, 496b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber enum Mode mode, 497b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber enum TXFrameType *tx_frame_type) 498b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber{ 499b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 500b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber sid_syncState *st = (sid_syncState *) state; 501b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 502b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber if (mode == MRDTX) 503b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber { 504b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 505b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber st->sid_update_counter--; 506b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 507b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber if (st->prev_ft == TX_SPEECH_GOOD) 508b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber { 509b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber *tx_frame_type = TX_SID_FIRST; 510b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber st->sid_update_counter = 3; 511b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber } 512b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber else 513b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber { 514b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber /* TX_SID_UPDATE or TX_NO_DATA */ 515b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber if ((st->sid_handover_debt > 0) && 516b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber (st->sid_update_counter > 2)) 517b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber { 518b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber /* ensure extra updates are properly delayed after 519b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber a possible SID_FIRST */ 520b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber *tx_frame_type = TX_SID_UPDATE; 521b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber st->sid_handover_debt--; 522b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber } 523b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber else 524b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber { 525b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber if (st->sid_update_counter == 0) 526b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber { 527b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber *tx_frame_type = TX_SID_UPDATE; 528b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber st->sid_update_counter = st->sid_update_rate; 529b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber } 530b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber else 531b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber { 532b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber *tx_frame_type = TX_NO_DATA; 533b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber } 534b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber } 535b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber } 536b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber } 537b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber else 538b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber { 539b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber st->sid_update_counter = st->sid_update_rate ; 540b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber *tx_frame_type = TX_SPEECH_GOOD; 541b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber } 542b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber st->prev_ft = *tx_frame_type; 543b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber} 544b841f14f8e51f2365945281fbfa54ef6a1b1b5a6Andreas Huber 545