xref: /btstack/src/classic/a2dp_sink.h (revision cd5f23a3250874824c01a2b3326a9522fea3f99f)
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_sink.h
40  *
41  * Advanced Audio Distribution Transport Profile (A2DP) Sink
42  *
43  * A2DP Sink is a device that accepts streamed media data.
44  */
45 
46 #ifndef A2DP_SINK_H
47 #define A2DP_SINK_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 Sink service record.
60  * @param service
61  * @param service_record_handle
62  * @param supported_features 16-bit bitmap, see AVDTP_SINK_SF_* values in avdtp.h
63  * @param service_name
64  * @param service_provider_name
65  */
66 void a2dp_sink_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 Sink device.
70  */
71 void a2dp_sink_init(void);
72 
73 /**
74  * @brief Create a stream endpoint of type SINK, 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_sink_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_sink_create_stream_endpoint
91  */
92 void a2dp_sink_finalize_stream_endpoint(avdtp_stream_endpoint_t * stream_endpoint);
93 
94 /**
95  * @brief Register callback for the A2DP Sink client. It will receive following subevents of HCI_EVENT_A2DP_META HCI event type:
96  * - A2DP_SUBEVENT_SIGNALING_MEDIA_CODEC_SBC_CONFIGURATION:		indicates from remote chosen SBC media codec configuration
97  * - A2DP_SUBEVENT_SIGNALING_MEDIA_CODEC_OTHER_CONFIGURATION:	indicates from remote chosen other then SBC media codec configuration
98  * - A2DP_SUBEVENT_STREAM_ESTABLISHED:							received when stream to a remote device is established
99  * - A2DP_SUBEVENT_STREAM_STARTED:								received when stream is started
100  * - A2DP_SUBEVENT_STREAM_SUSPENDED:							received when stream is paused
101  * - A2DP_SUBEVENT_STREAM_STOPED:							    received when stream is aborted or stopped
102  * - A2DP_SUBEVENT_STREAM_RELEASED:								received when stream is released
103  * - A2DP_SUBEVENT_SIGNALING_CONNECTION_RELEASED: 				received when signaling channel is disconnected
104  *
105  * @param callback
106  */
107 void a2dp_sink_register_packet_handler(btstack_packet_handler_t callback);
108 
109 /**
110  * @brief Register media handler for the A2DP Sink client.
111  * @param callback
112  * @param packet
113  * @param size
114  */
115 void a2dp_sink_register_media_handler(void (*callback)(uint8_t local_seid, uint8_t *packet, uint16_t size));
116 
117 /**
118  * @brief Establish stream.
119  * @param remote
120  * @param local_seid  		ID of a local stream endpoint.
121  * @param out_a2dp_cid 		Assigned A2DP channel identifyer used for furhter A2DP commands.
122  */
123 uint8_t a2dp_sink_establish_stream(bd_addr_t remote, uint8_t local_seid, uint16_t * out_a2dp_cid);
124 
125 /**
126  * @brief Release stream and disconnect from remote.
127  * @param a2dp_cid 			A2DP channel identifyer.
128  */
129 void a2dp_sink_disconnect(uint16_t a2dp_cid);
130 
131 /**
132  * @brief De-Init A2DP Sink device.
133  */
134 void a2dp_sink_deinit(void);
135 
136 /* API_END */
137 
138 
139 #if defined __cplusplus
140 }
141 #endif
142 
143 #endif // A2DP_SINK_H
144