xref: /btstack/src/btstack_audio.h (revision cd5f23a3250874824c01a2b3326a9522fea3f99f)
1 /*
2  * Copyright (C) 2017 BlueKitchen GmbH
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  *
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  * 3. Neither the name of the copyright holders nor the names of
14  *    contributors may be used to endorse or promote products derived
15  *    from this software without specific prior written permission.
16  * 4. Any redistribution, use, or modification is done solely for
17  *    personal benefit and not for any commercial purpose or for
18  *    monetary gain.
19  *
20  * THIS SOFTWARE IS PROVIDED BY BLUEKITCHEN GMBH AND CONTRIBUTORS
21  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
23  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL MATTHIAS
24  * RINGWALD OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
25  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
26  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
27  * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
28  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
29  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
30  * THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31  * SUCH DAMAGE.
32  *
33  * Please inquire about commercial licensing options at
34  * [email protected]
35  *
36  */
37 
38 #ifndef BTSTACK_AUDIO_H
39 #define BTSTACK_AUDIO_H
40 
41 #include <stdint.h>
42 
43 #if defined __cplusplus
44 extern "C" {
45 #endif
46 
47 /*
48  *  btstack_audio.h
49  *
50  *  Abstraction layer for 16-bit audio playback and recording within BTstack
51  */
52 
53 typedef struct {
54 
55     /**
56      * @brief Setup audio codec for specified samplerate and number of channels
57      * @param Channels (1=mono, 2=stereo)
58      * @param Sample rate
59      * @param Playback callback
60      * @return 1 on success
61      */
62     int (*init)(uint8_t channels,
63                 uint32_t samplerate,
64                 void (*playback) (int16_t * buffer, uint16_t num_samples));
65 
66     /**
67      * @brief Set volume
68      * @param Volume 0..127
69      */
70     void (*set_volume)(uint8_t volume);
71 
72     /**
73      * @brief Start stream
74      */
75     void (*start_stream)(void);
76 
77     /**
78      * @brief Stop stream
79      */
80     void (*stop_stream)(void);
81 
82     /**
83      * @brief Close audio codec
84      */
85     void (*close)(void);
86 
87 } btstack_audio_sink_t;
88 
89 
90 typedef struct {
91 
92     /**
93      * @brief Setup audio codec for specified samplerate and number of channels
94      * @param Channels (1=mono, 2=stereo)
95      * @param Sample rate
96      * @param Recording callback
97      * @return 1 on success
98      */
99     int (*init)(uint8_t channels,
100                 uint32_t samplerate,
101                 void (*recording)(const int16_t * buffer, uint16_t num_samples));
102 
103     /**
104      * @brief Set Gain
105      * @param Gain 0..127
106      */
107     void (*set_gain)(uint8_t gain);
108 
109     /**
110      * @brief Start stream
111      */
112     void (*start_stream)(void);
113 
114     /**
115      * @brief Stop stream
116      */
117     void (*stop_stream)(void);
118 
119     /**
120      * @brief Close audio codec
121      */
122     void (*close)(void);
123 
124 } btstack_audio_source_t;
125 
126 
127 /**
128  * @brief Get BTstack Audio Sink Instance
129  * @returns btstack_audio_sink implementation
130  */
131 const btstack_audio_sink_t * btstack_audio_sink_get_instance(void);
132 
133 /**
134  * @brief Get BTstack Audio Source Instance
135  * @returns btstack_audio_source implementation
136  */
137 const btstack_audio_source_t * btstack_audio_source_get_instance(void);
138 
139 
140 /**
141  * @brief Get BTstack Audio Sink Instance
142  * @param btstack_audio_sink implementation
143  */
144 void btstack_audio_sink_set_instance(const btstack_audio_sink_t * audio_sink_impl);
145 
146 /**
147  * @brief Get BTstack Audio Source Instance
148  * @param btstack_audio_source implementation
149  */
150 void btstack_audio_source_set_instance(const btstack_audio_source_t * audio_source_impl);
151 
152 
153 // common implementations
154 const btstack_audio_sink_t *   btstack_audio_portaudio_sink_get_instance(void);
155 const btstack_audio_source_t * btstack_audio_portaudio_source_get_instance(void);
156 
157 const btstack_audio_sink_t *   btstack_audio_embedded_sink_get_instance(void);
158 const btstack_audio_source_t * btstack_audio_embedded_source_get_instance(void);
159 
160 const btstack_audio_sink_t *   btstack_audio_esp32_sink_get_instance(void);
161 // const btstack_audio_source_t *   btstack_audio_esp32_source_get_instance(void);
162 
163 #if defined __cplusplus
164 }
165 #endif
166 
167 #endif
168