Developer World
Spresense SDK Library v1.4.0-aa7f53a
audio_renderer_api.h
Go to the documentation of this file.
1 /****************************************************************************
2  * modules/include/audio/audio_renderer_api.h
3  *
4  * Copyright 2018 Sony Semiconductor Solutions Corporation
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  *
10  * 1. Redistributions of source code must retain the above copyright
11  * notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  * notice, this list of conditions and the following disclaimer in
14  * the documentation and/or other materials provided with the
15  * distribution.
16  * 3. Neither the name of Sony Semiconductor Solutions Corporation nor
17  * the names of its contributors may be used to endorse or promote
18  * products derived from this software without specific prior written
19  * permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
24  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
25  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
26  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
27  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
28  * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
29  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
31  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
32  * POSSIBILITY OF SUCH DAMAGE.
33  *
34  ****************************************************************************/
35 
36 #ifndef __SONY_APPS_INCLUDE_AUDIOUTIL_AUDIO_RENDERER_API_H
37 #define __SONY_APPS_INCLUDE_AUDIOUTIL_AUDIO_RENDERER_API_H
38 
53 /****************************************************************************
54  * Included Files
55  ****************************************************************************/
56 
57 /****************************************************************************
58  * Pre-processor Definitions
59  ****************************************************************************/
60 
61 /****************************************************************************
62  * Public Types
63  ****************************************************************************/
64 
67 typedef struct
68 {
71  uint8_t dev0_req;
72 
75  uint8_t dev0_sync;
76 
79  uint8_t dev1_req;
80 
83  uint8_t dev1_sync;
85 
88 typedef struct
89 {
94 
95 /****************************************************************************
96  * Public Data
97  ****************************************************************************/
98 
99 /****************************************************************************
100  * Inline Functions
101  ****************************************************************************/
102 
103 /****************************************************************************
104  * Public Function Prototypes
105  ****************************************************************************/
106 
107 #ifdef __cplusplus
108 extern "C"
109 {
110 #endif
111 
121 
129 bool AS_DeleteRenderer(void);
130 
131 #ifdef __cplusplus
132 }
133 #endif
134 
135 #endif /* __SONY_APPS_INCLUDE_AUDIOUTIL_AUDIO_RENDERER_API_H */
136 
uint8_t dev0_req
[in] Message queue id of renderer device0 request
Definition: audio_renderer_api.h:71
Definition: audio_renderer_api.h:88
uint8_t dev1_req
[in] Message queue id of renderer device1 request
Definition: audio_renderer_api.h:79
AsRendererMsgQueId_t msgq_id
ID for sending messages to each channels.
Definition: audio_renderer_api.h:92
bool AS_CreateRenderer(FAR AsCreateRendererParam_t *param)
Activate audio renderer.
uint8_t dev1_sync
[in] Message queue id of renderer device1 for syncronizing
Definition: audio_renderer_api.h:83
uint8_t dev0_sync
[in] Message queue id of renderer device0 for syncronizing
Definition: audio_renderer_api.h:75
bool AS_DeleteRenderer(void)
Deactivate renderer.
Definition: audio_renderer_api.h:67