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 BLUEKITCHEN 24 * GMBH 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 /** 39 * @title Audio Interface 40 * 41 * Abstraction layer for 16-bit audio playback and recording within BTstack. 42 */ 43 44 #ifndef BTSTACK_AUDIO_H 45 #define BTSTACK_AUDIO_H 46 47 #include <stdint.h> 48 49 #if defined __cplusplus 50 extern "C" { 51 #endif 52 53 /* API_START */ 54 55 typedef struct { 56 57 /** 58 * @brief Setup audio codec for specified samplerate and number of channels 59 * @param Channels (1=mono, 2=stereo) 60 * @param Sample rate 61 * @param Playback callback 62 * @return 1 on success 63 */ 64 int (*init)(uint8_t channels, 65 uint32_t samplerate, 66 void (*playback) (int16_t * buffer, uint16_t num_samples)); 67 68 /** 69 * @brief Set volume 70 * @param Volume 0..127 71 */ 72 void (*set_volume)(uint8_t volume); 73 74 /** 75 * @brief Start stream 76 */ 77 void (*start_stream)(void); 78 79 /** 80 * @brief Stop stream 81 */ 82 void (*stop_stream)(void); 83 84 /** 85 * @brief Close audio codec 86 */ 87 void (*close)(void); 88 89 } btstack_audio_sink_t; 90 91 92 typedef struct { 93 94 /** 95 * @brief Setup audio codec for specified samplerate and number of channels 96 * @param Channels (1=mono, 2=stereo) 97 * @param Sample rate 98 * @param Recording callback 99 * @return 1 on success 100 */ 101 int (*init)(uint8_t channels, 102 uint32_t samplerate, 103 void (*recording)(const int16_t * buffer, uint16_t num_samples)); 104 105 /** 106 * @brief Set Gain 107 * @param Gain 0..127 108 */ 109 void (*set_gain)(uint8_t gain); 110 111 /** 112 * @brief Start stream 113 */ 114 void (*start_stream)(void); 115 116 /** 117 * @brief Stop stream 118 */ 119 void (*stop_stream)(void); 120 121 /** 122 * @brief Close audio codec 123 */ 124 void (*close)(void); 125 126 } btstack_audio_source_t; 127 128 129 /** 130 * @brief Get BTstack Audio Sink Instance 131 * @return btstack_audio_sink implementation 132 */ 133 const btstack_audio_sink_t * btstack_audio_sink_get_instance(void); 134 135 /** 136 * @brief Get BTstack Audio Source Instance 137 * @return btstack_audio_source implementation 138 */ 139 const btstack_audio_source_t * btstack_audio_source_get_instance(void); 140 141 142 /** 143 * @brief Get BTstack Audio Sink Instance 144 * @param btstack_audio_sink implementation 145 */ 146 void btstack_audio_sink_set_instance(const btstack_audio_sink_t * audio_sink_impl); 147 148 /** 149 * @brief Get BTstack Audio Source Instance 150 * @param btstack_audio_source implementation 151 */ 152 void btstack_audio_source_set_instance(const btstack_audio_source_t * audio_source_impl); 153 154 155 // common implementations 156 const btstack_audio_sink_t * btstack_audio_portaudio_sink_get_instance(void); 157 const btstack_audio_source_t * btstack_audio_portaudio_source_get_instance(void); 158 159 const btstack_audio_sink_t * btstack_audio_embedded_sink_get_instance(void); 160 const btstack_audio_source_t * btstack_audio_embedded_source_get_instance(void); 161 162 const btstack_audio_sink_t * btstack_audio_esp32_sink_get_instance(void); 163 /* API_END */ 164 165 // const btstack_audio_source_t * btstack_audio_esp32_source_get_instance(void); 166 167 #if defined __cplusplus 168 } 169 #endif 170 171 #endif 172