Home | History | Annotate | Download | only in inc
      1 /*
      2  * Copyright (C) 2011 The Android Open Source Project
      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 express or implied.
     13  * See the License for the specific language governing permissions and
     14  * limitations under the License.
     15  */
     16 
     17 /**
     18  ************************************************************************
     19  * @file   M4READER_Amr.h
     20  * @brief  Generic encapsulation of the core amr reader
     21  * @note   This file declares the generic shell interface retrieving function
     22  *         of the AMR reader
     23  ************************************************************************
     24 */
     25 #ifndef __M4READER_AMR_H__
     26 #define __M4READER_AMR_H__
     27 
     28 #include "M4READER_Common.h"
     29 
     30 #ifdef __cplusplus
     31 extern "C" {
     32 #endif /* __cplusplus */
     33 
     34 /**
     35 *************************************************************************
     36 * @brief Retrieves the generic interfaces implemented by the reader
     37 *
     38 * @param pMediaType             : Pointer on a M4READER_MediaType (allocated by the caller)
     39 *                              that will be filled with the media type supported by this reader
     40 * @param pRdrGlobalInterface : Address of a pointer that will be set to the global interface
     41 *                              implemented by this reader. The interface is a structure allocated
     42 *                              by the function and must be un-allocated by the caller.
     43 * @param pRdrDataInterface   : Address of a pointer that will be set to the data interface
     44 *                              implemented by this reader. The interface is a structure allocated
     45 *                              by the function and must be un-allocated by the caller.
     46 *
     47 * @returns : M4NO_ERROR     if OK
     48 *             ERR_ALLOC      if an allocation failed
     49 *            ERR_PARAMETER  at least one parameter is not properly set (in DEBUG only)
     50 *************************************************************************
     51 */
     52 M4OSA_ERR M4READER_AMR_getInterfaces(M4READER_MediaType *pMediaType,
     53                                       M4READER_GlobalInterface **pRdrGlobalInterface,
     54                                       M4READER_DataInterface **pRdrDataInterface);
     55 
     56 #ifdef __cplusplus
     57 }
     58 #endif /* __cplusplus */
     59 
     60 #endif /*__M4READER_AMR_H__*/
     61 
     62