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