code.delx.au - pulseaudio/blob - src/modules/bluetooth/ipc.h

   1 /*
   2  *
   3  *  BlueZ - Bluetooth protocol stack for Linux
   4  *
   5  *  Copyright (C) 2004-2009  Marcel Holtmann <marcel@holtmann.org>
   6  *
   7  *  This library is free software; you can redistribute it and/or
   8  *  modify it under the terms of the GNU Lesser General Public
   9  *  License as published by the Free Software Foundation; either
  10  *  version 2.1 of the License, or (at your option) any later version.
  11  *
  12  *  This library is distributed in the hope that it will be useful,
  13  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  *  Lesser General Public License for more details.
  16  *
  17  *  You should have received a copy of the GNU Lesser General Public
  18  *  License along with this library; if not, write to the Free Software
  19  *  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  20  *
  21  */
  22
  23 /*
  24   Message sequence chart of streaming sequence for A2DP transport
  25
  26   Audio daemon                  User
  27                                 on snd_pcm_open
  28                                 <--BT_GET_CAPABILITIES_REQ
  29
  30   BT_GET_CAPABILITIES_RSP-->
  31
  32                                 on snd_pcm_hw_params
  33                                 <--BT_SETCONFIGURATION_REQ
  34
  35   BT_SET_CONFIGURATION_RSP-->
  36
  37                                 on snd_pcm_prepare
  38                                 <--BT_START_STREAM_REQ
  39
  40   <Moves to streaming state>
  41   BT_START_STREAM_RSP-->
  42
  43   BT_NEW_STREAM_IND -->
  44
  45                                 <  streams data >
  46                                 ..........
  47
  48                                 on snd_pcm_drop/snd_pcm_drain
  49
  50                                 <--BT_STOP_STREAM_REQ
  51
  52   <Moves to open state>
  53   BT_STOP_STREAM_RSP-->
  54
  55                                 on IPC close or appl crash
  56   <Moves to idle>
  57
  58  */
  59
  60 #ifndef BT_AUDIOCLIENT_H
  61 #define BT_AUDIOCLIENT_H
  62
  63 #ifdef __cplusplus
  64 extern "C" {
  65 #endif
  66
  67 #include <stdint.h>
  68 #include <stdio.h>
  69 #include <unistd.h>
  70 #include <sys/socket.h>
  71 #include <sys/un.h>
  72 #include <errno.h>
  73
  74 #define BT_SUGGESTED_BUFFER_SIZE   128
  75 #define BT_IPC_SOCKET_NAME "\0/org/bluez/audio"
  76
  77 /* Generic message header definition, except for RESPONSE messages */
  78 typedef struct {
  79         uint8_t type;
  80         uint8_t name;
  81         uint16_t length;
  82 } __attribute__ ((packed)) bt_audio_msg_header_t;
  83
  84 typedef struct {
  85         bt_audio_msg_header_t h;
  86         uint8_t posix_errno;
  87 } __attribute__ ((packed)) bt_audio_error_t;
  88
  89 /* Message types */
  90 #define BT_REQUEST                      0
  91 #define BT_RESPONSE                     1
  92 #define BT_INDICATION                   2
  93 #define BT_ERROR                        3
  94
  95 /* Messages names */
  96 #define BT_GET_CAPABILITIES             0
  97 #define BT_SET_CONFIGURATION            1
  98 #define BT_NEW_STREAM                   2
  99 #define BT_START_STREAM                 3
 100 #define BT_STOP_STREAM                  4
 101 #define BT_CONTROL                      7
 102
 103 #define BT_CAPABILITIES_TRANSPORT_A2DP  0
 104 #define BT_CAPABILITIES_TRANSPORT_SCO   1
 105 #define BT_CAPABILITIES_TRANSPORT_ANY   2
 106
 107 #define BT_CAPABILITIES_ACCESS_MODE_READ        1
 108 #define BT_CAPABILITIES_ACCESS_MODE_WRITE       2
 109 #define BT_CAPABILITIES_ACCESS_MODE_READWRITE   3
 110
 111 #define BT_FLAG_AUTOCONNECT     1
 112
 113 struct bt_get_capabilities_req {
 114         bt_audio_msg_header_t   h;
 115         char                    device[18];     /* Address of the remote Device */
 116         uint8_t                 transport;      /* Requested transport */
 117         uint8_t                 flags;          /* Requested flags */
 118 } __attribute__ ((packed));
 119
 120 /**
 121  * SBC Codec parameters as per A2DP profile 1.0 Â§ 4.3
 122  */
 123
 124 #define BT_A2DP_CODEC_SBC                       0x00
 125 #define BT_A2DP_CODEC_MPEG12                    0x01
 126 #define BT_A2DP_CODEC_MPEG24                    0x02
 127 #define BT_A2DP_CODEC_ATRAC                     0x03
 128
 129 #define BT_SBC_SAMPLING_FREQ_16000              (1 << 3)
 130 #define BT_SBC_SAMPLING_FREQ_32000              (1 << 2)
 131 #define BT_SBC_SAMPLING_FREQ_44100              (1 << 1)
 132 #define BT_SBC_SAMPLING_FREQ_48000              1
 133
 134 #define BT_A2DP_CHANNEL_MODE_MONO               (1 << 3)
 135 #define BT_A2DP_CHANNEL_MODE_DUAL_CHANNEL       (1 << 2)
 136 #define BT_A2DP_CHANNEL_MODE_STEREO             (1 << 1)
 137 #define BT_A2DP_CHANNEL_MODE_JOINT_STEREO       1
 138
 139 #define BT_A2DP_BLOCK_LENGTH_4                  (1 << 3)
 140 #define BT_A2DP_BLOCK_LENGTH_8                  (1 << 2)
 141 #define BT_A2DP_BLOCK_LENGTH_12                 (1 << 1)
 142 #define BT_A2DP_BLOCK_LENGTH_16                 1
 143
 144 #define BT_A2DP_SUBBANDS_4                      (1 << 1)
 145 #define BT_A2DP_SUBBANDS_8                      1
 146
 147 #define BT_A2DP_ALLOCATION_SNR                  (1 << 1)
 148 #define BT_A2DP_ALLOCATION_LOUDNESS             1
 149
 150 #define BT_MPEG_SAMPLING_FREQ_16000             (1 << 5)
 151 #define BT_MPEG_SAMPLING_FREQ_22050             (1 << 4)
 152 #define BT_MPEG_SAMPLING_FREQ_24000             (1 << 3)
 153 #define BT_MPEG_SAMPLING_FREQ_32000             (1 << 2)
 154 #define BT_MPEG_SAMPLING_FREQ_44100             (1 << 1)
 155 #define BT_MPEG_SAMPLING_FREQ_48000             1
 156
 157 #define BT_MPEG_LAYER_1                         (1 << 2)
 158 #define BT_MPEG_LAYER_2                         (1 << 1)
 159 #define BT_MPEG_LAYER_3                         1
 160
 161 #define BT_HFP_CODEC_PCM                        0x00
 162
 163 #define BT_PCM_FLAG_NREC                        1
 164
 165 typedef struct {
 166         uint8_t transport;
 167         uint8_t type;
 168         uint8_t length;
 169         uint8_t data[0];
 170 } __attribute__ ((packed)) codec_capabilities_t;
 171
 172 typedef struct {
 173         codec_capabilities_t capability;
 174         uint8_t channel_mode;
 175         uint8_t frequency;
 176         uint8_t allocation_method;
 177         uint8_t subbands;
 178         uint8_t block_length;
 179         uint8_t min_bitpool;
 180         uint8_t max_bitpool;
 181 } __attribute__ ((packed)) sbc_capabilities_t;
 182
 183 typedef struct {
 184         codec_capabilities_t capability;
 185         uint8_t channel_mode;
 186         uint8_t crc;
 187         uint8_t layer;
 188         uint8_t frequency;
 189         uint8_t mpf;
 190         uint16_t bitrate;
 191 } __attribute__ ((packed)) mpeg_capabilities_t;
 192
 193 typedef struct {
 194         codec_capabilities_t capability;
 195         uint8_t flags;
 196         uint16_t sampling_rate;
 197 } __attribute__ ((packed)) pcm_capabilities_t;
 198
 199 struct bt_get_capabilities_rsp {
 200         bt_audio_msg_header_t   h;
 201         uint8_t                 data[0];        /* First codec_capabilities_t */
 202 } __attribute__ ((packed));
 203
 204 struct bt_set_configuration_req {
 205         bt_audio_msg_header_t   h;
 206         char                    device[18];     /* Address of the remote Device */
 207         uint8_t                 access_mode;    /* Requested access mode */
 208         codec_capabilities_t    codec;          /* Requested codec */
 209 } __attribute__ ((packed));
 210
 211 struct bt_set_configuration_rsp {
 212         bt_audio_msg_header_t   h;
 213         uint8_t                 transport;      /* Granted transport */
 214         uint8_t                 access_mode;    /* Granted access mode */
 215         uint16_t                link_mtu;       /* Max length that transport supports */
 216 } __attribute__ ((packed));
 217
 218 #define BT_STREAM_ACCESS_READ           0
 219 #define BT_STREAM_ACCESS_WRITE          1
 220 #define BT_STREAM_ACCESS_READWRITE      2
 221 struct bt_start_stream_req {
 222         bt_audio_msg_header_t   h;
 223 } __attribute__ ((packed));
 224
 225 struct bt_start_stream_rsp {
 226         bt_audio_msg_header_t   h;
 227 } __attribute__ ((packed));
 228
 229 /* This message is followed by one byte of data containing the stream data fd
 230    as ancilliary data */
 231 struct bt_new_stream_ind {
 232         bt_audio_msg_header_t   h;
 233 } __attribute__ ((packed));
 234
 235 struct bt_stop_stream_req {
 236         bt_audio_msg_header_t   h;
 237 } __attribute__ ((packed));
 238
 239 struct bt_stop_stream_rsp {
 240         bt_audio_msg_header_t   h;
 241 } __attribute__ ((packed));
 242
 243 struct bt_suspend_stream_ind {
 244         bt_audio_msg_header_t   h;
 245 } __attribute__ ((packed));
 246
 247 struct bt_resume_stream_ind {
 248         bt_audio_msg_header_t   h;
 249 } __attribute__ ((packed));
 250
 251 #define BT_CONTROL_KEY_POWER                    0x40
 252 #define BT_CONTROL_KEY_VOL_UP                   0x41
 253 #define BT_CONTROL_KEY_VOL_DOWN                 0x42
 254 #define BT_CONTROL_KEY_MUTE                     0x43
 255 #define BT_CONTROL_KEY_PLAY                     0x44
 256 #define BT_CONTROL_KEY_STOP                     0x45
 257 #define BT_CONTROL_KEY_PAUSE                    0x46
 258 #define BT_CONTROL_KEY_RECORD                   0x47
 259 #define BT_CONTROL_KEY_REWIND                   0x48
 260 #define BT_CONTROL_KEY_FAST_FORWARD             0x49
 261 #define BT_CONTROL_KEY_EJECT                    0x4A
 262 #define BT_CONTROL_KEY_FORWARD                  0x4B
 263 #define BT_CONTROL_KEY_BACKWARD                 0x4C
 264
 265 struct bt_control_req {
 266         bt_audio_msg_header_t   h;
 267         uint8_t                 mode;           /* Control Mode */
 268         uint8_t                 key;            /* Control Key */
 269 } __attribute__ ((packed));
 270
 271 struct bt_control_rsp {
 272         bt_audio_msg_header_t   h;
 273         uint8_t                 mode;           /* Control Mode */
 274         uint8_t                 key;            /* Control Key */
 275 } __attribute__ ((packed));
 276
 277 struct bt_control_ind {
 278         bt_audio_msg_header_t   h;
 279         uint8_t                 mode;           /* Control Mode */
 280         uint8_t                 key;            /* Control Key */
 281 } __attribute__ ((packed));
 282
 283 /* Function declaration */
 284
 285 /* Opens a connection to the audio service: return a socket descriptor */
 286 int bt_audio_service_open(void);
 287
 288 /* Closes a connection to the audio service */
 289 int bt_audio_service_close(int sk);
 290
 291 /* Receives stream data file descriptor : must be called after a
 292 BT_STREAMFD_IND message is returned */
 293 int bt_audio_service_get_data_fd(int sk);
 294
 295 /* Human readable message type string */
 296 const char *bt_audio_strtype(uint8_t type);
 297
 298 /* Human readable message name string */
 299 const char *bt_audio_strname(uint8_t name);
 300
 301 #ifdef __cplusplus
 302 }
 303 #endif
 304
 305 #endif /* BT_AUDIOCLIENT_H */