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