xref: /frameworks/av/media/libstagefright/codecs/amrnb/common/include/q_plsf.h

/* ------------------------------------------------------------------
 * Copyright (C) 1998-2009 PacketVideo
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
 * express or implied.
 * See the License for the specific language governing permissions
 * and limitations under the License.
 * -------------------------------------------------------------------
 */
/****************************************************************************************
Portions of this file are derived from the following 3GPP standard:

    3GPP TS 26.073
    ANSI-C code for the Adaptive Multi-Rate (AMR) speech codec
    Available from http://www.3gpp.org

(C) 2004, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TTA, TTC)
Permission to distribute, modify and use this file under the standard license
terms listed above has been obtained from the copyright holder.
****************************************************************************************/
/*

 Filename: /audio/gsm_amr/c/include/q_plsf.h

------------------------------------------------------------------------------
 REVISION HISTORY

 Description: Placed header file in the proper template format.  Added
 parameter pOverflow for the basic math ops.

 Description:  Replaced "int" and/or "char" with OSCL defined types.

 Description: Moved _cplusplus #ifdef after Include section.

 Who:                       Date:
 Description:

------------------------------------------------------------------------------
 INCLUDE DESCRIPTION

 This file contains all the constant definitions and prototype definitions
 needed by the q_plsf_3.c and q_plsf_5.c

------------------------------------------------------------------------------
*/

/*----------------------------------------------------------------------------
; CONTINUE ONLY IF NOT ALREADY DEFINED
----------------------------------------------------------------------------*/
#ifndef q_plsf_h
#define q_plsf_h "$Id $"

/*----------------------------------------------------------------------------
; INCLUDES
----------------------------------------------------------------------------*/
#include "typedef.h"
#include "cnst.h"
#include "mode.h"

/*--------------------------------------------------------------------------*/
#ifdef __cplusplus
extern "C"
{
#endif

    /*----------------------------------------------------------------------------
    ; MACROS
    ; Define module specific macros here
    ----------------------------------------------------------------------------*/

    /*----------------------------------------------------------------------------
    ; DEFINES
    ; Include all pre-processor statements here.
    ----------------------------------------------------------------------------*/
#define MR795_1_SIZE  512
#define PAST_RQ_INIT_SIZE 8

#define DICO1_SIZE  256
#define DICO2_SIZE  512
#define DICO3_SIZE  512

#define DICO1_5_SIZE  128
#define DICO2_5_SIZE  256
#define DICO3_5_SIZE  256
#define DICO4_5_SIZE  256
#define DICO5_5_SIZE  64

#define MR515_3_SIZE  128

    /*----------------------------------------------------------------------------
    ; EXTERNAL VARIABLES REFERENCES
    ; Declare variables used in this module but defined elsewhere
    ----------------------------------------------------------------------------*/

    /*----------------------------------------------------------------------------
    ; SIMPLE TYPEDEF'S
    ----------------------------------------------------------------------------*/

    /*----------------------------------------------------------------------------
    ; ENUMERATED TYPEDEF'S
    ----------------------------------------------------------------------------*/

    /*----------------------------------------------------------------------------
    ; STRUCTURES TYPEDEF'S
    ----------------------------------------------------------------------------*/
    typedef struct
    {
        Word16 past_rq[M];    /* Past quantized prediction error, Q15 */

    } Q_plsfState;

    /*----------------------------------------------------------------------------
    ; GLOBAL FUNCTION DEFINITIONS
    ; Function Prototype declaration
    ----------------------------------------------------------------------------*/

    Word16 Q_plsf_init(Q_plsfState **st);
    /* initialize one instance of the state.
       Stores pointer to filter status struct in *st. This pointer has to
       be passed to Q_plsf_5 / Q_plsf_3 in each call.
       returns 0 on success
     */

    Word16 Q_plsf_reset(Q_plsfState *st);
    /* reset of state (i.e. set state memory to zero)
       returns 0 on success
     */

    void Q_plsf_exit(Q_plsfState **st);
    /* de-initialize state (i.e. free status struct)
       stores NULL in *st
     */

    void Q_plsf_3(
        Q_plsfState *st,    /* i/o: state struct                             */
        enum Mode mode,     /* i  : coder mode                               */
        Word16 *lsp1,       /* i  : 1st LSP vector                      Q15  */
        Word16 *lsp1_q,     /* o  : quantized 1st LSP vector            Q15  */
        Word16 *indice,     /* o  : quantization indices of 3 vectors   Q0   */
        Word16 *pred_init_i,/* o  : init index for MA prediction in DTX mode */
        Flag  *pOverflow    /* o : Flag set when overflow occurs             */
    );

    void Q_plsf_5(
        Q_plsfState *st,
        Word16 *lsp1,      /* i  : 1st LSP vector,                     Q15 */
        Word16 *lsp2,      /* i  : 2nd LSP vector,                     Q15 */
        Word16 *lsp1_q,    /* o  : quantized 1st LSP vector,           Q15 */
        Word16 *lsp2_q,    /* o  : quantized 2nd LSP vector,           Q15 */
        Word16 *indice,    /* o  : quantization indices of 5 matrices, Q0  */
        Flag  *pOverflow   /* o : Flag set when overflow occurs            */
    );
    /*----------------------------------------------------------------------------
    ; END
    ----------------------------------------------------------------------------*/
#ifdef __cplusplus
}
#endif

#endif /* _Q_PLSF_H_ */