1 /* 2 * Copyright (C) 2018 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 #ifndef HAL_AUDIO_H 39 #define HAL_AUDIO_H 40 41 #include <stdint.h> 42 43 #if defined __cplusplus 44 extern "C" { 45 #endif 46 47 /* 48 * hal_audio.h 49 * 50 * Hardware abstraction layer that provides circular audio playback and recording 51 * 52 * Assumptions: 53 * - num buffers n >= 2 54 * - after start, buffers are played in sequence 0, 1, ... , n-1, 0, 1, .. , n-1, ... 55 * - after a buffer is played, the callback is called with tbe index of the played buffer 56 */ 57 58 /** 59 * @brief Setup audio codec for playback using specified samplerate and number of channels 60 * @param Channels 61 * @param Sample rate 62 * @param Buffer played callback 63 */ 64 void hal_audio_sink_init(uint8_t channels, 65 uint32_t sample_rate, 66 void (*buffer_played_callback)(uint8_t buffer_index)); 67 68 /** 69 * @brief Get number of output buffers in HAL 70 * @returns num buffers 71 */ 72 uint16_t hal_audio_sink_get_num_output_buffers(void); 73 74 /** 75 * @brief Get size of single output buffer in HAL 76 * @returns buffer size 77 */ 78 uint16_t hal_audio_sink_get_num_output_buffer_samples(void); 79 80 /** 81 * @brief Get output buffer 82 * @param buffer index 83 * @returns buffer 84 */ 85 int16_t * hal_audio_sink_get_output_buffer(uint8_t buffer_index); 86 87 /** 88 * @brief Start stream 89 */ 90 void hal_audio_sink_start(void); 91 92 /** 93 * @brief Stop stream 94 */ 95 void hal_audio_sink_stop(void); 96 97 /** 98 * @brief Close audio codec 99 */ 100 void hal_audio_sink_close(void); 101 102 103 /** 104 * @brief Setup audio codec for recording using specified samplerate and number of channels 105 * @param Channels 106 * @param Sample rate 107 * @param Buffer recorded callback 108 */ 109 void hal_audio_source_init(uint8_t channels, 110 uint32_t sample_rate, 111 void (*buffer_recorded_callback)(const int16_t * buffer, uint16_t num_samples)); 112 113 /** 114 * @brief Start stream 115 */ 116 void hal_audio_source_start(void); 117 118 /** 119 * @brief Stop stream 120 */ 121 void hal_audio_source_stop(void); 122 123 /** 124 * @brief Close audio codec 125 */ 126 void hal_audio_source_close(void); 127 128 #if defined __cplusplus 129 } 130 #endif 131 132 #endif 133