frameworks/base/media/libeffects/lvm/lib/Reverb/src/LVREV_GetControlParameters.c

   1 /*
   2  * Copyright (C) 2004-2010 NXP Software
   3  * Copyright (C) 2010 The Android Open Source Project
   4  *
   5  * Licensed under the Apache License, Version 2.0 (the "License");
   6  * you may not use this file except in compliance with the License.
   7  * You may obtain a copy of the License at
   8  *
   9  *      http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  * Unless required by applicable law or agreed to in writing, software
  12  * distributed under the License is distributed on an "AS IS" BASIS,
  13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  * See the License for the specific language governing permissions and
  15  * limitations under the License.
  16  */
  17
  18 /****************************************************************************************/
  19 /*                                                                                      */
  20 /*  Includes                                                                            */
  21 /*                                                                                      */
  22 /****************************************************************************************/
  23 #include "LVREV_Private.h"
  24
  25
  26 /****************************************************************************************/
  27 /*                                                                                      */
  28 /* FUNCTION:                LVREV_GetControlParameters                                  */
  29 /*                                                                                      */
  30 /* DESCRIPTION:                                                                         */
  31 /*  Request the LVREV module control parameters. The current parameter set is returned  */
  32 /*  via the parameter pointer.                                                          */
  33 /*                                                                                      */
  34 /* PARAMETERS:                                                                          */
  35 /*  hInstance               Instance handle                                             */
  36 /*  pControlParams          Pointer to an empty parameter structure                     */
  37 /*                                                                                      */
  38 /* RETURNS:                                                                             */
  39 /*  LVREV_Success           Succeeded                                                   */
  40 /*  LVREV_NULLADDRESS       When hInstance or pControlParams is NULL                    */
  41 /*                                                                                      */
  42 /* NOTES:                                                                               */
  43 /*  1.  This function may be interrupted by the LVREV_Process function                  */
  44 /*                                                                                      */
  45 /****************************************************************************************/
  46 LVREV_ReturnStatus_en LVREV_GetControlParameters(LVREV_Handle_t           hInstance,
  47                                                  LVREV_ControlParams_st   *pControlParams)
  48 {
  49
  50     LVREV_Instance_st  *pLVREV_Private = (LVREV_Instance_st *)hInstance;
  51
  52
  53     /*
  54      * Check for error conditions
  55      */
  56     if((hInstance == LVM_NULL) || (pControlParams == LVM_NULL))
  57     {
  58         return LVREV_NULLADDRESS;
  59     }
  60
  61     /*
  62      * Return the current parameters
  63      */
  64     *pControlParams = pLVREV_Private->NewParams;
  65
  66     return LVREV_SUCCESS;
  67 }
  68
  69 /* End of file */