xref: /btstack/src/btstack_audio.h (revision 630ffdd469bbec3276322f46b93e6cfdfcb21c27)
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_DMA_H
39 #define __BTSTACK_AUDIO_DMA_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 	 * @param Recording callback
61 	 * @return 1 on success
62 	 */
63 	int (*init)(uint8_t channels,
64 				uint32_t samplerate,
65 				void (*playback) (      int16_t * buffer, uint16_t num_samples),
66 				void (*recording)(const int16_t * buffer, uint16_t num_samples));
67 
68 	/**
69 	 * @brief Start stream
70 	 */
71 	void (*start_stream)(void);
72 
73 	/**
74 	 * @brief Close audio codec
75 	 */
76 	void (*close)(void);
77 
78 } btstack_audio_t;
79 
80 /**
81  * @brief Get BTstack Audio Instance
82  * @returns btstack_audio implementation
83  */
84 const btstack_audio_t * btstack_audio_get_instance(void);
85 
86 /**
87  * @brief Get BTstack Audio Instance
88  * @param btstack_audio implementation
89  */
90 void btstack_audio_set_instance(const btstack_audio_t * audio_impl);
91 
92 
93 // common implementations
94 const btstack_audio_t * btstack_audio_portaudio_get_instance(void);
95 const btstack_audio_t * btstack_audio_embedded_get_instance(void);
96 const btstack_audio_t * btstack_audio_esp32_get_instance(void);
97 
98 #if defined __cplusplus
99 }
100 #endif
101 
102 #endif
103