xref: /btstack/src/classic/a2dp_source.h (revision cfd2437ec63a01d0af049500b4a1d2d2cf8bad03)
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  * @param out_local_seid			Assigned stream endpoint ID used in further A2DP commands.
82  *
83  * @return status 					ERROR_CODE_SUCCESS if sucessful.
84  */
85 avdtp_stream_endpoint_t * a2dp_source_create_stream_endpoint(avdtp_media_type_t media_type, avdtp_media_codec_type_t media_codec_type,
86 	uint8_t * codec_capabilities, uint16_t codec_capabilities_len,
87 	uint8_t * codec_configuration, uint16_t codec_configuration_len);
88 
89 /**
90  * @brief Register callback for the A2DP Source client. It will receive following subevents of HCI_EVENT_A2DP_META HCI event type:
91  * - A2DP_SUBEVENT_INCOMING_CONNECTION_ESTABLISHED:		        Received when signaling connection with a remote is established .
92  * - A2DP_SUBEVENT_SIGNALING_CONNECTION_RELEASED:				Received when signaling connection with a remote is released .
93  * - A2DP_SUBEVENT_STREAM_ESTABLISHED:							Received when stream to a remote device is established.
94  * - A2DP_SUBEVENT_STREAM_STARTED:								Received when stream is started.
95  * - A2DP_SUBEVENT_STREAM_SUSPENDED:							Received when stream is paused.
96  * - A2DP_SUBEVENT_STREAM_STOPED:							    received when stream is aborted or stopped.
97  * - A2DP_SUBEVENT_STREAM_RELEASED:								Received when stream is released.
98  * - A2DP_SUBEVENT_STREAMING_CAN_SEND_MEDIA_PACKET_NOW:			Indicates that the next media packet can be sent.
99  *
100  * @param callback
101  */
102 void a2dp_source_register_packet_handler(btstack_packet_handler_t callback);
103 
104 /**
105  * @brief Open stream.
106  * @param remote
107  * @param local_seid	 	ID assigned to a local stream endpoint
108  * @param out_a2dp_cid 		Assigned A2DP channel identifyer used for furhter A2DP commands.
109  */
110 uint8_t a2dp_source_establish_stream(bd_addr_t remote, uint8_t local_seid, uint16_t * out_a2dp_cid);
111 
112     /**
113      * @brief Reconfigure stream.
114      * @param local_seid	 	  ID assigned to a local stream endpoint
115      * @param sampling_frequency  New sampling frequency to use. Cannot be called while stream is active
116      */
117 uint8_t a2dp_source_reconfigure_stream_sampling_frequency(uint16_t a2dp_cid, uint32_t sampling_frequency);
118 
119 /**
120  * @brief Start stream.
121  * @param a2dp_cid 			A2DP channel identifyer.
122  * @param local_seid	 	ID of a local stream endpoint.
123  */
124 uint8_t a2dp_source_start_stream(uint16_t a2dp_cid, uint8_t local_seid);
125 
126 /**
127  * @brief Pause stream.
128  * @param a2dp_cid 			A2DP channel identifyer.
129  * @param local_seid  		ID of a local stream endpoint.
130  */
131 uint8_t a2dp_source_pause_stream(uint16_t a2dp_cid, uint8_t local_seid);
132 
133 /**
134  * @brief Release stream and disconnect from remote.
135  * @param a2dp_cid 			A2DP channel identifyer.
136  */
137 uint8_t a2dp_source_disconnect(uint16_t a2dp_cid);
138 
139 /**
140  * @brief Request to send a media packet. Packet can be then sent on reception of A2DP_SUBEVENT_STREAMING_CAN_SEND_MEDIA_PACKET_NOW event.
141  * @param a2dp_cid 			A2DP channel identifyer.
142  * @param local_seid  		ID of a local stream endpoint.
143  */
144 void 	a2dp_source_stream_endpoint_request_can_send_now(uint16_t a2dp_cid, uint8_t local_seid);
145 
146 /**
147  * @brief Return maximal media payload size, does not include media header.
148  * @param a2dp_cid 			A2DP channel identifyer.
149  * @param local_seid  		ID of a local stream endpoint.
150  * @return max_media_payload_size_without_media_header
151  */
152 int 	a2dp_max_media_payload_size(uint16_t a2dp_cid, uint8_t local_seid);
153 
154 /**
155  * @brief Send media payload.
156  * @param a2dp_cid 			A2DP channel identifyer.
157  * @param local_seid  		ID of a local stream endpoint.
158  * @param storage
159  * @param num_bytes_to_copy
160  * @param num_frames
161  * @param marker
162  * @return max_media_payload_size_without_media_header
163  */
164 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);
165 
166 /* API_END */
167 
168 #if defined __cplusplus
169 }
170 #endif
171 
172 #endif // __A2DP_SOURCE_H
173