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