xref: /btstack/src/classic/a2dp_source.h (revision 98451c7b102094e15e0a72ca2f7098d91aed2017)
1 /*
2  * Copyright (C) 2016 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 /*
39  * a2dp_source.h
40  *
41  * Advanced Audio Distribution Transport Profile (A2DP) Source
42  *
43  * A2DP Source is a device that streames media data.
44  */
45 
46 #ifndef A2DP_SOURCE_H
47 #define A2DP_SOURCE_H
48 
49 #include <stdint.h>
50 #include "classic/avdtp.h"
51 
52 #if defined __cplusplus
53 extern "C" {
54 #endif
55 
56 /* API_START */
57 
58 /**
59  * @brief Create A2DP Source service record.
60  * @param service
61  * @param service_record_handle
62  * @param supported_features 16-bit bitmap, see AVDTP_SOURCE_SF_* values in avdtp.h
63  * @param service_name
64  * @param service_provider_name
65  */
66 void a2dp_source_create_sdp_record(uint8_t * service, uint32_t service_record_handle, uint16_t supported_features, const char * service_name, const char * service_provider_name);
67 
68 /**
69  * @brief Initialize up A2DP Source device.
70  */
71 void a2dp_source_init(void);
72 
73 /**
74  * @brief Create a stream endpoint of type SOURCE, and register media codec by specifying its capabilities and the default configuration.
75  * @param media_type    			See avdtp_media_type_t values in avdtp.h (audio, video or multimedia).
76  * @param media_codec_type 			See avdtp_media_codec_type_t values in avdtp.h
77  * @param codec_capabilities        Media codec capabilities as defined in A2DP spec, section 4 - Audio Codec Interoperability Requirements.
78  * @param codec_capabilities_len	Media codec capabilities length.
79  * @param codec_configuration 		Default media codec configuration.
80  * @param codec_configuration_len	Media codec configuration length.
81  *
82  * @return local_stream_endpoint
83  */
84 avdtp_stream_endpoint_t * a2dp_source_create_stream_endpoint(avdtp_media_type_t media_type, avdtp_media_codec_type_t media_codec_type,
85                                                              const uint8_t *codec_capabilities, uint16_t codec_capabilities_len,
86                                                              uint8_t * codec_configuration, uint16_t codec_configuration_len);
87 
88 /**
89  *  @brief Unregister stream endpoint and free it's memory
90  *  @param stream_endpoint created by a2dp_source_create_stream_endpoint
91  */
92 void a2dp_source_finalize_stream_endpoint(avdtp_stream_endpoint_t * stream_endpoint);
93 
94 /**
95  * @brief Register callback for the A2DP Source client. It will receive following subevents of HCI_EVENT_A2DP_META HCI event type:
96  * - A2DP_SUBEVENT_STREAMING_CAN_SEND_MEDIA_PACKET_NOW:			Indicates that the next media packet can be sent.
97  *
98  * - A2DP_SUBEVENT_SIGNALING_CONNECTION_ESTABLISHED             Received when signaling connection with a remote is established.
99  * - A2DP_SUBEVENT_SIGNALING_CONNECTION_RELEASED                Received when signaling connection with a remote is released
100  * - A2DP_SUBEVENT_STREAM_ESTABLISHED                           Received when stream to a remote device is established.
101  * - A2DP_SUBEVENT_STREAM_STARTED                               Received when stream is started.
102  * - A2DP_SUBEVENT_STREAM_SUSPENDED                             Received when stream is paused.
103  * - A2DP_SUBEVENT_STREAM_STOPED                                received when stream is aborted or stopped.
104  * - A2DP_SUBEVENT_STREAM_RELEASED                              Received when stream is released.
105  * - A2DP_SUBEVENT_SIGNALING_DELAY_REPORTING_CAPABILITY         Currently the only capability that is passed to client
106  * - A2DP_SUBEVENT_SIGNALING_CAPABILITIES_DONE                  Signals that all capabilities are reported
107  * - A2DP_SUBEVENT_SIGNALING_DELAY_REPORT                       Delay report
108  * - A2DP_SUBEVENT_SIGNALING_MEDIA_CODEC_SBC_CONFIGURATION      SBC configuration
109  * - A2DP_SUBEVENT_STREAMING_CAN_SEND_MEDIA_PACKET_NOW          Signals that a media packet can be sent
110  * - A2DP_SUBEVENT_COMMAND_REJECTED                             Command reject
111  * @param callback
112  */
113 void a2dp_source_register_packet_handler(btstack_packet_handler_t callback);
114 
115 /**
116  * @brief Open stream.
117  * @param remote_addr
118  * @param avdtp_cid 		Assigned A2DP channel identifier used for further A2DP commands.
119  */
120 uint8_t a2dp_source_establish_stream(bd_addr_t remote_addr, uint16_t *avdtp_cid);
121 
122     /**
123      * @brief Reconfigure stream.
124      * @param local_seid	 	  ID assigned to a local stream endpoint
125      * @param sampling_frequency  New sampling frequency to use. Cannot be called while stream is active
126      */
127 uint8_t a2dp_source_reconfigure_stream_sampling_frequency(uint16_t a2dp_cid, uint32_t sampling_frequency);
128 
129 /**
130  * @brief Start stream.
131  * @param a2dp_cid 			A2DP channel identifier.
132  * @param local_seid	 	ID of a local stream endpoint.
133  */
134 uint8_t a2dp_source_start_stream(uint16_t a2dp_cid, uint8_t local_seid);
135 
136 /**
137  * @brief Pause stream.
138  * @param a2dp_cid 			A2DP channel identifier.
139  * @param local_seid  		ID of a local stream endpoint.
140  */
141 uint8_t a2dp_source_pause_stream(uint16_t a2dp_cid, uint8_t local_seid);
142 
143 /**
144  * @brief Release stream and disconnect from remote.
145  * @param a2dp_cid 			A2DP channel identifier.
146  */
147 uint8_t a2dp_source_disconnect(uint16_t a2dp_cid);
148 
149 /**
150  * @brief Request to send a media packet. Packet can be then sent on reception of A2DP_SUBEVENT_STREAMING_CAN_SEND_MEDIA_PACKET_NOW event.
151  * @param a2dp_cid 			A2DP channel identifier.
152  * @param local_seid  		ID of a local stream endpoint.
153  */
154 void 	a2dp_source_stream_endpoint_request_can_send_now(uint16_t a2dp_cid, uint8_t local_seid);
155 
156 /**
157  * @brief Return maximal media payload size, does not include media header.
158  * @param a2dp_cid 			A2DP channel identifier.
159  * @param local_seid  		ID of a local stream endpoint.
160  * @return max_media_payload_size_without_media_header
161  */
162 int 	a2dp_max_media_payload_size(uint16_t a2dp_cid, uint8_t local_seid);
163 
164 /**
165  * @brief Send media payload.
166  * @param a2dp_cid 			A2DP channel identifier.
167  * @param local_seid  		ID of a local stream endpoint.
168  * @param storage
169  * @param num_bytes_to_copy
170  * @param num_frames
171  * @param marker
172  * @return max_media_payload_size_without_media_header
173  */
174 int  	a2dp_source_stream_send_media_payload(uint16_t a2dp_cid, uint8_t local_seid, uint8_t * storage, int num_bytes_to_copy, uint8_t num_frames, uint8_t marker);
175 
176 /**
177  * @brief Send media payload.
178  * @param a2dp_cid 			A2DP channel identifier.
179  * @param local_seid  		ID of a local stream endpoint.
180  * @param marker
181  * @param payload
182  * @param payload_size
183  * @param marker
184  * @return status
185  */
186 uint8_t a2dp_source_stream_send_media_payload_rtp(uint16_t a2dp_cid, uint8_t local_seid, uint8_t marker, uint8_t * payload, uint16_t payload_size);
187 
188 /**
189  * @brief Send media packet
190  * @param a2dp_cid 			A2DP channel identifier.
191  * @param local_seid  		ID of a local stream endpoint.
192  * @param packet
193  * @param size
194  * @return status
195  */
196 uint8_t	a2dp_source_stream_send_media_packet(uint16_t a2dp_cid, uint8_t local_seid, const uint8_t * packet, uint16_t size);
197 
198 /**
199  * @brief Select and configure SBC endpoint
200  * @param a2dp_cid 			A2DP channel identifier.
201  * @param local_seid  		ID of a local stream endpoint.
202  * @param remote_seid  		ID of a remote stream endpoint.
203  * @param configuration     SBC Configuration
204  * @return status
205  */
206 uint8_t a2dp_source_set_config_sbc(uint16_t a2dp_cid, uint8_t local_seid, uint8_t remote_seid, const avdtp_configuration_sbc_t * configuration);
207 
208 /**
209  * @brief Select and configure MPEG AUDIO endpoint
210  * @param a2dp_cid 			A2DP channel identifier.
211  * @param local_seid  		ID of a local stream endpoint.
212  * @param remote_seid  		ID of a remote stream endpoint.
213  * @param configuration     MPEG AUDIO Configuration
214  * @return status
215  */
216 uint8_t a2dp_source_set_config_mpeg_audio(uint16_t a2dp_cid, uint8_t local_seid, uint8_t remote_seid, const avdtp_configuration_mpeg_audio_t * configuration);
217 
218 /**
219  * @brief Select and configure MPEG AAC endpoint
220  * @param a2dp_cid 			A2DP channel identifier.
221  * @param local_seid  		ID of a local stream endpoint.
222  * @param remote_seid  		ID of a remote stream endpoint.
223  * @param configuration     MPEG AAC Configuration
224  * @return status
225  */
226 uint8_t a2dp_source_set_config_mpeg_aac(uint16_t a2dp_cid,  uint8_t local_seid,  uint8_t remote_seid, const avdtp_configuration_mpeg_aac_t * configuration);
227 
228 /**
229  * @brief Select and configure ATRAC endpoint
230  * @param a2dp_cid 			A2DP channel identifier.
231  * @param local_seid  		ID of a local stream endpoint.
232  * @param remote_seid  		ID of a remote stream endpoint.
233  * @param configuration     ATRAC Configuration
234  * @return status
235  */
236 uint8_t a2dp_source_set_config_atrac(uint16_t a2dp_cid,  uint8_t local_seid, uint8_t remote_seid, const avdtp_configuration_atrac_t * configuration);
237 
238 /**
239  * @brief Select and configure Non-A2DP endpoint. Bytes 0-3 of codec information contain Vendor ID, bytes 4-5 contain Vendor Specific Codec ID (little endian)
240  * @param a2dp_cid 			A2DP channel identifier.
241  * @param local_seid  		ID of a local stream endpoint.
242  * @param remote_seid  		ID of a remote stream endpoint.
243  * @param media_codec_information
244  * @param media_codec_information_len
245  * @return status
246  */
247 uint8_t a2dp_source_set_config_other(uint16_t a2dp_cid,  uint8_t local_seid, uint8_t remote_seid, const uint8_t * media_codec_information, uint8_t media_codec_information_len);
248 
249 /**
250  * @brief De-Init A2DP Source device.
251  */
252 void a2dp_source_deinit(void);
253 
254 /* API_END */
255 
256 #if defined __cplusplus
257 }
258 #endif
259 
260 #endif // A2DP_SOURCE_H
261