xref: /btstack/src/le-audio/broadcast_audio_uri_builder.c (revision 94fd3c039b168a98a6eb660aea8f697c2302549d)
1 /*
2  * Copyright (C) 2024 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 BLUEKITCHEN
24  * GMBH 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 #define BTSTACK_FILE__ "broadcast_audio_uri_builder.c"
39 
40 #include "le-audio/broadcast_audio_uri_builder.h"
41 #include "btstack_util.h"
42 #include <stdint.h>
43 #include <string.h>
44 #include <inttypes.h>
45 
46 static void broadcast_audio_uri_builder_string_hexdump(uint8_t * buffer, const uint8_t * data, uint16_t size){
47     uint8_t i;
48     for (i = 0; i < size ; i++) {
49         uint8_t byte = data[i];
50         buffer[2*i+0] = char_for_nibble(byte >> 4);
51         buffer[2*i+1] = char_for_nibble(byte & 0x0f);
52     }
53 }
54 
55 static inline bool broadcast_audio_uri_builder_have_space(const broadcast_audio_uri_builder_t * builder, uint16_t len){
56     return builder->len + len <= builder->size;
57 }
58 
59 void broadcast_audio_uri_builder_init(broadcast_audio_uri_builder_t * builder, uint8_t * buffer, uint16_t size){
60     builder->buffer = buffer;
61     builder->size = size;
62     builder->len = 0;
63 }
64 
65 uint16_t broadcast_audio_uri_builder_get_remaining_space(const broadcast_audio_uri_builder_t * builder){
66     return builder->size - builder->len;
67 }
68 
69 uint16_t broadcast_audio_uri_builder_get_size(const broadcast_audio_uri_builder_t * builder){
70     return builder->len;
71 }
72 
73 bool broadcast_audio_uri_builder_append_bytes(broadcast_audio_uri_builder_t * builder, const uint8_t * data, uint16_t len){
74     bool ok = broadcast_audio_uri_builder_have_space(builder, len);
75     if (ok){
76         memcpy(&builder->buffer[builder->len], data, len);
77         builder->len += len;
78     }
79     return ok;
80 }
81 
82 bool broadcast_audio_uri_builder_append_string(broadcast_audio_uri_builder_t * builder, const char * text){
83     uint16_t len = (uint16_t) strlen(text);
84     return broadcast_audio_uri_builder_append_bytes(builder, (const uint8_t *) text, len);
85 }
86 
87 bool broadcast_audio_uri_builder_append_broadcast_name(broadcast_audio_uri_builder_t * builder, const char * broadcast_name){
88     // TODO: base64
89     return broadcast_audio_uri_builder_append_string(builder, "BN:QnJvYWRjYXN0IE5hbWU=;");
90 }
91 
92 bool broadcast_audio_uri_builder_append_advertiser_address_type(broadcast_audio_uri_builder_t * builder, bd_addr_type_t advertiser_address_type){
93     char buffer[10];
94     btstack_snprintf_assert_complete(buffer, sizeof(buffer), "AT:%u;",advertiser_address_type == BD_ADDR_TYPE_LE_RANDOM ? 1 : 0);
95     return broadcast_audio_uri_builder_append_string(builder, buffer);
96 }
97 
98 bool broadcast_audio_uri_builder_append_standard_quality(broadcast_audio_uri_builder_t * builder, bool standard_quality){
99     char buffer[10];
100     btstack_snprintf_assert_complete(buffer, sizeof(buffer), "SQ:%u;", (int) standard_quality);
101     return broadcast_audio_uri_builder_append_string(builder, buffer);
102 }
103 
104 bool broadcast_audio_uri_builder_append_high_quality(broadcast_audio_uri_builder_t * builder, bool high_quality){
105     char buffer[10];
106     btstack_snprintf_assert_complete(buffer, sizeof(buffer), "HQ:%u;", (int) high_quality);
107     return broadcast_audio_uri_builder_append_string(builder, buffer);
108 }
109 
110 bool broadcast_audio_uri_builder_append_advertiser_address(broadcast_audio_uri_builder_t * builder, bd_addr_t advertiser_address){
111     uint16_t len = builder->len;
112     bool ok = broadcast_audio_uri_builder_append_string(builder,"AD:");
113     if (ok){
114         char buffer[13];
115         broadcast_audio_uri_builder_string_hexdump((uint8_t *)buffer, (const uint8_t *) advertiser_address, 6);
116         buffer[12] = ';';
117         broadcast_audio_uri_builder_append_bytes(builder, (const uint8_t *) buffer, sizeof(buffer));
118     } else {
119         builder->len = len;
120     }
121     return ok;
122 }
123 
124 bool broadcast_audio_uri_builder_append_broadcast_id(broadcast_audio_uri_builder_t * builder, uint32_t broadcast_id){
125     uint16_t len = builder->len;
126     bool ok = broadcast_audio_uri_builder_append_string(builder,"BI:");
127     if (ok){
128         uint8_t buffer[7];
129         uint8_t big_endian_id[3];
130         big_endian_store_24(big_endian_id, 0, broadcast_id);
131         broadcast_audio_uri_builder_string_hexdump(buffer, big_endian_id, 3);
132         buffer[6] = ';';
133         broadcast_audio_uri_builder_append_bytes(builder, (const uint8_t *) buffer, sizeof(buffer));
134     } else {
135         builder->len = len;
136     }
137     return ok;
138 
139 }
140 
141 bool broadcast_audio_uri_builder_append_broadcast_code(broadcast_audio_uri_builder_t * builder, const uint8_t * broadcast_code){
142     uint16_t len = builder->len;
143     bool ok = broadcast_audio_uri_builder_append_string(builder,"BC:");
144     if (ok){
145         uint8_t buffer[25];
146         // TODO: base64
147         memcpy(buffer, "MDEyMzQ1Njc4OWFiY2RlZg==", 24);
148         buffer[24] = ';';
149         broadcast_audio_uri_builder_append_bytes(builder, (const uint8_t *) buffer, sizeof(buffer));
150     } else {
151         builder->len = len;
152     }
153     return ok;
154 }
155 
156 bool broadcast_audio_uri_builder_append_vendor_specific(broadcast_audio_uri_builder_t * builder, uint16_t vendor_id, const uint8_t * data, uint16_t data_len){
157     uint16_t len = builder->len;
158     bool ok = broadcast_audio_uri_builder_append_string(builder, "VS:");
159     if (ok){
160         uint8_t vendor_id_big_endian_id[2];
161         big_endian_store_16(vendor_id_big_endian_id, 0, vendor_id);
162         uint8_t vendor_id_hex[4];
163         memset(vendor_id_hex, 0, sizeof(vendor_id_hex));
164         broadcast_audio_uri_builder_string_hexdump(vendor_id_hex, vendor_id_hex, 2);
165         // TODO: base64(vendor_id_hex + data)
166         ok = broadcast_audio_uri_builder_append_string(builder, ";");
167     }
168     if (ok == false){
169         builder->len = len;
170     }
171     return ok;
172 }
173 
174 bool broadcast_audio_uri_builder_append_advertising_sid(broadcast_audio_uri_builder_t * builder, uint8_t advertising_sid){
175     char buffer[10];
176     btstack_snprintf_assert_complete(buffer, sizeof(buffer), "AS:%02X;", advertising_sid);
177     return broadcast_audio_uri_builder_append_string(builder, buffer);
178 }
179 
180 bool broadcast_audio_uri_builder_append_pa_interval(broadcast_audio_uri_builder_t * builder, uint16_t pa_interval){
181     char buffer[10];
182     btstack_snprintf_assert_complete(buffer, sizeof(buffer), "PI:%04" PRIX32 ";", pa_interval);
183     return broadcast_audio_uri_builder_append_string(builder, buffer);
184 }
185 
186 bool broadcast_audio_uri_builder_append_num_subgroups(broadcast_audio_uri_builder_t * builder, uint8_t num_subgroups){
187     char buffer[10];
188     btstack_snprintf_assert_complete(buffer, sizeof(buffer), "NS:%02X", num_subgroups);
189     return broadcast_audio_uri_builder_append_string(builder, buffer);
190 }
191 
192 bool broadcast_audio_uri_builder_append_bis_sync(broadcast_audio_uri_builder_t * builder, uint32_t bis_sync){
193     char buffer[10];
194     btstack_snprintf_assert_complete(buffer, sizeof(buffer), "BS:%04" PRIX32 ";", bis_sync);
195     return broadcast_audio_uri_builder_append_string(builder, buffer);
196 }
197 
198 bool broadcast_audio_uri_builder_append_sg_number_of_bises(broadcast_audio_uri_builder_t * builder, uint32_t sg_number_of_bises){
199     char buffer[10];
200     btstack_snprintf_assert_complete(buffer, sizeof(buffer), "NB:%04" PRIX32 ";", sg_number_of_bises);
201     return broadcast_audio_uri_builder_append_string(builder, buffer);
202 }
203 
204 bool broadcast_audio_uri_builder_append_sg_metadata(broadcast_audio_uri_builder_t * builder, const uint8_t * metadata, uint16_t metadata_len){
205     uint16_t len = builder->len;
206     bool ok = broadcast_audio_uri_builder_append_string(builder, "SM:");
207     if (ok && (metadata_len > 0)) {
208         // TODO: base64(data)
209         ok = broadcast_audio_uri_builder_append_bytes(builder, metadata, metadata_len);
210     }
211     if (ok) {
212         ok = broadcast_audio_uri_builder_append_string(builder, ";");
213     } else {
214         builder->len = len;
215     }
216     return ok;
217 }
218 
219 bool broadcast_audio_uri_builder_append_public_broadcast_announcement_metadata(broadcast_audio_uri_builder_t * builder, const uint8_t * metadata, uint16_t metadata_len){
220     uint16_t len = builder->len;
221     bool ok = broadcast_audio_uri_builder_append_string(builder, "PM:");
222     if (ok && metadata_len > 0) {
223         // TODO: base64(data)
224         ok = broadcast_audio_uri_builder_append_bytes(builder, metadata, metadata_len);
225     }
226     if (ok) {
227         ok = broadcast_audio_uri_builder_append_string(builder, ";");
228     } else {
229         builder->len = len;
230     }
231     return ok;
232 }
233