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  * @file    M4READER_Pcm.h
     19  * @brief    Generic encapsulation of the core wav reader
     20  * @note    This file declares the generic shell interface retrieving function
     21  *            of the wav reader
     22 *************************************************************************
     23 */
     24 #ifndef __M4READER_PCM_H__
     25 #define __M4READER_PCM_H__
     26 
     27 #include "M4READER_Common.h"
     28 
     29 #ifdef __cplusplus
     30 extern "C" {
     31 #endif /* __cplusplus */
     32 
     33 /**
     34 *************************************************************************
     35 * @brief Retrieves the generic interfaces implemented by the reader
     36 *
     37 * @param pMediaType             : Pointer on a M4READER_MediaType (allocated by the caller)
     38 *                              that will be filled with the media type supported by this reader
     39 * @param pRdrGlobalInterface : Address of a pointer that will be set to the global interface
     40 *                              implemented by this reader. The interface is a structure allocated
     41 *                              by the function and must be un-allocated by the caller.
     42 * @param pRdrDataInterface   : Address of a pointer that will be set to the data interface
     43 *                              implemented by this reader. The interface is a structure allocated
     44 *                              by the function and must be un-allocated by the caller.
     45 *
     46 * @returns : M4NO_ERROR     if OK
     47 *             ERR_ALLOC      if an allocation failed
     48 *            ERR_PARAMETER  at least one parameter is not properly set (in DEBUG only)
     49 *************************************************************************
     50 */
     51 M4OSA_ERR M4READER_PCM_getInterfaces(M4READER_MediaType *pMediaType,
     52                                         M4READER_GlobalInterface **pRdrGlobalInterface,
     53                                         M4READER_DataInterface **pRdrDataInterface);
     54 
     55 #ifdef __cplusplus
     56 }
     57 #endif /* __cplusplus */
     58 
     59 #endif /*__M4READER_PCM_H__*/
     60