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 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 __HAL_AUDIO_H 39 #define __HAL_AUDIO_H 40 41 #include <stdint.h> 42 43 /* 44 * hal_audio.h 45 * 46 * Hardware abstraction layer that provides circular audio playback and recording 47 * 48 * Assumptions: 49 * - num buffers n >= 2 50 * - after start, buffers are played in sequence 0, 1, ... , n-1, 0, 1, .. , n-1, ... 51 * - after a buffer is played, the callback is called with tbe index of the played buffer 52 */ 53 54 /** 55 * @brief Setup audio codec for specified samplerate and number channels 56 * @param Channels 57 * @param Sample rate 58 * @param Buffer played callback 59 * @param Buffer recorded callback (use NULL if no recording) 60 */ 61 void hal_audio_init(uint8_t channels, 62 uint32_t sample_rate, 63 void (*buffer_played_callback) (uint8_t buffer_index), 64 void (*buffer_recorded_callback)(const int16_t * buffer, uint16_t num_samples)); 65 66 /** 67 * @brief Get number of output buffers in HAL 68 * @returns num buffers 69 */ 70 uint16_t hal_audio_get_num_output_buffers(void); 71 72 /** 73 * @brief Get size of single output buffer in HAL 74 * @returns buffer size 75 */ 76 uint16_t hal_audio_get_num_output_buffer_samples(void); 77 78 /** 79 * @brief Gey output buffer 80 * @param buffer index 81 * @returns buffer 82 */ 83 int16_t * hal_audio_get_output_buffer(uint8_t buffer_index); 84 85 /** 86 * @brief Start stream 87 */ 88 void hal_audio_start(void); 89 90 /** 91 * @brief Close audio codec 92 */ 93 void hal_audio_close(void); 94 95 #endif 96