xref: /btstack/example/hsp_hs_demo.c (revision f9f2075ceac5e9dc08e9abea437e43d733a3a0ea)
1 /*
2  * Copyright (C) 2014 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  * hsp_hs_demo.c
40  */
41 
42 // *****************************************************************************
43 /* EXAMPLE_START(hsp_hs_demo): HSP Headset Demo
44  *
45  * @text This example implements a HSP Headset device that sends and receives
46  * audio signal over HCI SCO. It demonstrates how to receive
47  * an output from a remote audio gateway (AG), and,
48  * if HAVE_POSIX_STDIN is defined, how to control the AG.
49  */
50 // *****************************************************************************
51 
52 #include "btstack_config.h"
53 
54 #include <stdint.h>
55 #include <stdio.h>
56 #include <stdlib.h>
57 #include <string.h>
58 #include <unistd.h>
59 
60 #include "btstack.h"
61 #include "sco_demo_util.h"
62 #ifdef HAVE_POSIX_STDIN
63 #include "stdin_support.h"
64 #endif
65 
66 static btstack_packet_callback_registration_t hci_event_callback_registration;
67 
68 static uint8_t hsp_service_buffer[150];
69 static const uint8_t rfcomm_channel_nr = 1;
70 static const char    hsp_hs_service_name[] = "Headset Test";
71 static hci_con_handle_t sco_handle = 0;
72 
73 static char hs_cmd_buffer[100];
74 static bd_addr_t device_addr = {0x00,0x1b,0xDC,0x07,0x32,0xEF};
75 
76 /* @section Audio Transfer Setup
77  *
78  * @text A pre-computed sine wave (160Hz) is used as the input audio signal. 160 Hz.
79  * To send and receive an audio signal, ENABLE_SCO_OVER_HCI has to be defined.
80  *
81  * Tested working setups:
82  * - Ubuntu 14 64-bit, CC2564B connected via FTDI USB-2-UART adapter, 921600 baud
83  * - Ubuntu 14 64-bit, CSR USB dongle
84  * - OS X 10.11, CSR USB dongle
85  *
86  * Broken setups:
87  * - OS X 10.11, CC2564B connected via FDTI USB-2-UART adapter, 921600 baud
88  * - select(..) blocks > 400 ms -> num completed is received to late -> gaps between audio
89  * - looks like bug in select->FTDI driver as it works correct on Linux
90  *
91  * SCO not routed over HCI yet:
92  * - CSR UART dongle
93  * - Broadcom USB dongle
94  * - Broadcom UART chipset
95  * - ..
96  *
97  */
98 
99 
100 static void show_usage(void){
101     bd_addr_t iut_address;
102     gap_local_bd_addr(iut_address);
103 
104     printf("\n--- Bluetooth HSP Headset Test Console %s ---\n", bd_addr_to_str(iut_address));
105     printf("---\n");
106     printf("c - Connect to %s\n", bd_addr_to_str(device_addr));
107     printf("C - Disconnect\n");
108     printf("a - establish audio connection\n");
109     printf("A - release audio connection\n");
110     printf("b - press user button\n");
111     printf("z - set microphone gain 0\n");
112     printf("m - set microphone gain 8\n");
113     printf("M - set microphone gain 15\n");
114     printf("o - set speaker gain 0\n");
115     printf("s - set speaker gain 8\n");
116     printf("S - set speaker gain 15\n");
117     printf("---\n");
118     printf("Ctrl-c - exit\n");
119     printf("---\n");
120 }
121 
122 #ifdef HAVE_POSIX_STDIN
123 static void stdin_process(btstack_data_source_t *ds, btstack_data_source_callback_type_t callback_type){
124     UNUSED(ds);
125     UNUSED(callback_type);
126 
127     char buffer = btstack_stdin_read();
128 
129     switch (buffer){
130         case 'c':
131             printf("Connect to %s\n", bd_addr_to_str(device_addr));
132             hsp_hs_connect(device_addr);
133             break;
134         case 'C':
135             printf("Disconnect.\n");
136             hsp_hs_disconnect();
137             break;
138         case 'a':
139             printf("Establish audio connection\n");
140             hsp_hs_establish_audio_connection();
141             break;
142         case 'A':
143             printf("Release audio connection\n");
144             hsp_hs_release_audio_connection();
145             break;
146 
147         case 'z':
148             printf("Setting microphone gain 0\n");
149             hsp_hs_set_microphone_gain(0);
150             break;
151         case 'm':
152             printf("Setting microphone gain 8\n");
153             hsp_hs_set_microphone_gain(8);
154             break;
155         case 'M':
156             printf("Setting microphone gain 15\n");
157             hsp_hs_set_microphone_gain(15);
158             break;
159         case 'o':
160             printf("Setting speaker gain 0\n");
161             hsp_hs_set_speaker_gain(0);
162             break;
163         case 's':
164             printf("Setting speaker gain 8\n");
165             hsp_hs_set_speaker_gain(8);
166             break;
167         case 'S':
168             printf("Setting speaker gain 15\n");
169             hsp_hs_set_speaker_gain(15);
170             break;
171         case 'b':
172             printf("Press user button\n");
173             hsp_hs_send_button_press();
174             break;
175         default:
176             show_usage();
177             break;
178     }
179 }
180 #endif
181 
182 static void packet_handler(uint8_t packet_type, uint16_t channel, uint8_t * event, uint16_t event_size){
183     UNUSED(channel);
184 
185     switch (packet_type){
186         case HCI_SCO_DATA_PACKET:
187             sco_demo_receive(event, event_size);
188             break;
189         case HCI_EVENT_PACKET:
190             switch (event[0]) {
191                 case BTSTACK_EVENT_STATE:
192                     if (btstack_event_state_get_state(event) != HCI_STATE_WORKING) break;
193                     show_usage();
194                     break;
195                 case HCI_EVENT_SCO_CAN_SEND_NOW:
196                     sco_demo_send(sco_handle);
197                     break;
198                 case HCI_EVENT_HSP_META:
199                     switch (event[2]) {
200                         case HSP_SUBEVENT_RFCOMM_CONNECTION_COMPLETE:
201                             if (hsp_subevent_rfcomm_connection_complete_get_status(event)){
202                                 printf("RFCOMM connection establishement failed with status %u\n", hsp_subevent_rfcomm_connection_complete_get_status(event));
203                             } else {
204                                 printf("RFCOMM connection established.\n");
205                             }
206                             break;
207                         case HSP_SUBEVENT_RFCOMM_DISCONNECTION_COMPLETE:
208                             if (hsp_subevent_rfcomm_disconnection_complete_get_status(event)){
209                                 printf("RFCOMM disconnection failed with status %u.\n", hsp_subevent_rfcomm_disconnection_complete_get_status(event));
210                             } else {
211                                 printf("RFCOMM disconnected.\n");
212                             }
213                             break;
214                         case HSP_SUBEVENT_AUDIO_CONNECTION_COMPLETE:
215                             if (hsp_subevent_audio_connection_complete_get_status(event)){
216                                 printf("Audio connection establishment failed with status %u\n", hsp_subevent_audio_connection_complete_get_status(event));
217                                 sco_handle = 0;
218                             } else {
219                                 sco_handle = hsp_subevent_audio_connection_complete_get_handle(event);
220                                 printf("Audio connection established with SCO handle 0x%04x.\n", sco_handle);
221                                 hci_request_sco_can_send_now_event();
222                             }
223                             break;
224                         case HSP_SUBEVENT_AUDIO_DISCONNECTION_COMPLETE:
225                             if (hsp_subevent_audio_disconnection_complete_get_status(event)){
226                                 printf("Audio connection releasing failed with status %u\n", hsp_subevent_audio_disconnection_complete_get_status(event));
227                             } else {
228                                 printf("Audio connection released.\n\n");
229                                 sco_handle = 0;
230                             }
231                             break;
232                         case HSP_SUBEVENT_MICROPHONE_GAIN_CHANGED:
233                             printf("Received microphone gain change %d\n", hsp_subevent_microphone_gain_changed_get_gain(event));
234                             break;
235                         case HSP_SUBEVENT_SPEAKER_GAIN_CHANGED:
236                             printf("Received speaker gain change %d\n", hsp_subevent_speaker_gain_changed_get_gain(event));
237                             break;
238                         case HSP_SUBEVENT_RING:
239                             printf("HS: RING RING!\n");
240                             break;
241                         case HSP_SUBEVENT_AG_INDICATION: {
242                             memset(hs_cmd_buffer, 0, sizeof(hs_cmd_buffer));
243                             int size = hsp_subevent_ag_indication_get_value_length(event);
244                             if (size >= sizeof(hs_cmd_buffer)-1){
245                                 size =  sizeof(hs_cmd_buffer)-1;
246                             }
247                             memcpy(hs_cmd_buffer, hsp_subevent_ag_indication_get_value(event), size);
248                             printf("Received custom indication: \"%s\". \nExit code or call hsp_hs_send_result.\n", hs_cmd_buffer);
249 
250                         }
251                             break;
252                         default:
253                             printf("event not handled %u\n", event[2]);
254                             break;
255                     }
256                     break;
257                 default:
258                     break;
259             }
260         default:
261             break;
262     }
263 }
264 
265 /* @section Main Application Setup
266  *
267  * @text Listing MainConfiguration shows main application code.
268  * To run a HSP Headset service you need to initialize the SDP, and to create and register HSP HS record with it.
269  * In this example, the SCO over HCI is used to receive and send an audio signal.
270  *
271  * Two packet handlers are registered:
272  * - The HCI SCO packet handler receives audio data.
273  * - The HSP HS packet handler is used to trigger sending of audio data and commands to the AG. It also receives the AG's answers.
274  *
275  * The stdin_process callback allows for sending commands to the AG.
276  * At the end the Bluetooth stack is started.
277  */
278 
279 /* LISTING_START(MainConfiguration): Setup HSP Headset */
280 int btstack_main(int argc, const char * argv[]);
281 int btstack_main(int argc, const char * argv[]){
282     (void)argc;
283     (void)argv;
284 
285     sco_demo_init();
286 
287     // register for HCI events
288     hci_event_callback_registration.callback = &packet_handler;
289     hci_add_event_handler(&hci_event_callback_registration);
290     hci_register_sco_packet_handler(&packet_handler);
291 
292     l2cap_init();
293 
294     sdp_init();
295     memset(hsp_service_buffer, 0, sizeof(hsp_service_buffer));
296     hsp_hs_create_sdp_record(hsp_service_buffer, 0x10001, rfcomm_channel_nr, hsp_hs_service_name, 0);
297     sdp_register_service(hsp_service_buffer);
298 
299     rfcomm_init();
300 
301     hsp_hs_init(rfcomm_channel_nr);
302     hsp_hs_register_packet_handler(packet_handler);
303 
304 #ifdef HAVE_POSIX_STDIN
305     btstack_stdin_setup(stdin_process);
306 #endif
307 
308     gap_set_local_name("BTstack HSP HS");
309     gap_discoverable_control(1);
310     gap_ssp_set_io_capability(SSP_IO_CAPABILITY_DISPLAY_YES_NO);
311     gap_set_class_of_device(0x240404);
312 
313     // turn on!
314     hci_power_control(HCI_POWER_ON);
315     return 0;
316 }
317 /* LISTING_END */
318 /* EXAMPLE_END */
319