xref: /btstack/src/btstack_audio.h (revision 1b464e99afd70ddaf6b75be1ba7cc563a5f5dfd8)
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 Start stream
68      */
69     void (*start_stream)(void);
70 
71     /**
72      * @brief Stop stream
73      */
74     void (*stop_stream)(void);
75 
76     /**
77      * @brief Close audio codec
78      */
79     void (*close)(void);
80 
81 } btstack_audio_sink_t;
82 
83 
84 typedef struct {
85 
86     /**
87      * @brief Setup audio codec for specified samplerate and number of channels
88      * @param Channels (1=mono, 2=stereo)
89      * @param Sample rate
90      * @param Recording callback
91      * @return 1 on success
92      */
93     int (*init)(uint8_t channels,
94                 uint32_t samplerate,
95                 void (*recording)(const int16_t * buffer, uint16_t num_samples));
96 
97     /**
98      * @brief Start stream
99      */
100     void (*start_stream)(void);
101 
102     /**
103      * @brief Stop stream
104      */
105     void (*stop_stream)(void);
106 
107     /**
108      * @brief Close audio codec
109      */
110     void (*close)(void);
111 
112 } btstack_audio_source_t;
113 
114 
115 /**
116  * @brief Get BTstack Audio Sink Instance
117  * @returns btstack_audio_sink implementation
118  */
119 const btstack_audio_sink_t * btstack_audio_sink_get_instance(void);
120 
121 /**
122  * @brief Get BTstack Audio Source Instance
123  * @returns btstack_audio_source implementation
124  */
125 const btstack_audio_source_t * btstack_audio_source_get_instance(void);
126 
127 
128 /**
129  * @brief Get BTstack Audio Sink Instance
130  * @param btstack_audio_sink implementation
131  */
132 void btstack_audio_sink_set_instance(const btstack_audio_sink_t * audio_sink_impl);
133 
134 /**
135  * @brief Get BTstack Audio Source Instance
136  * @param btstack_audio_source implementation
137  */
138 void btstack_audio_source_set_instance(const btstack_audio_source_t * audio_source_impl);
139 
140 
141 // common implementations
142 const btstack_audio_sink_t *   btstack_audio_portaudio_sink_get_instance(void);
143 const btstack_audio_source_t * btstack_audio_portaudio_source_get_instance(void);
144 
145 const btstack_audio_sink_t *   btstack_audio_embedded_sink_get_instance(void);
146 const btstack_audio_source_t * btstack_audio_embedded_source_get_instance(void);
147 
148 const btstack_audio_sink_t *   btstack_audio_esp32_sink_get_instance(void);
149 // const btstack_audio_source_t *   btstack_audio_esp32_source_get_instance(void);
150 
151 #if defined __cplusplus
152 }
153 #endif
154 
155 #endif
156