summaryrefslogtreecommitdiffstats
path: root/src/sydney.h
blob: 58324cac29d9adbb3890363851a366d0ad4d1bae (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
#ifndef foosydneyhfoo
#define foosydneyhfoo

#ifdef  __cplusplus
extern "C" {
#endif

/*
  Requirements & General observations

    - In sync mode, the device will automatically write data so that an
      initial read causes writes of zeros to be issued to that one can
      do "while (1); {read(); write()}
    - All functions are thread-safe and can be called in any thread
      context. None of the functions is async-signal safe.
    - It is assumed that duplex streams have a single clock (synchronised)
    - Property set extensible. To be kept in sync with PulseAudio and libsydney.
    - Property keys need to be valid UTF-8, text values, too.
    - Will warn if application.name or application.id not set.
    - Error codes are returned immediately, as negative integers
    - application.process.* will be filled in automatically but may be overwritten by the client.
      They thus should not be used for authentication purposes.
    - It is recommended to set most properties before the _open() call.

*/

#include <sys/types.h>
#include <sys/param.h>
#include <inttypes.h>

/* Detect byte order, based on sys/param.h */
#if (defined(__BYTE_ORDER) && (__BYTE_ORDER == __LITTLE_ENDIAN)) || defined(WIN32)
#define SA_LITTLE_ENDIAN 1
#undef SA_BIG_ENDIAN
#elif (defined(__BYTE_ORDER) && (__BYTE_ORDER == __BIG_ENDIAN))
#undef SA_LITTLE_ENDIAN
#define SA_BIG_ENDIAN 1
#else
#error "Cannot determine byte order!"
#endif

/** Stream object */
typedef struct sa_stream sa_stream_t;

/** Volume that corresponds to muted in/out */
#define SA_VOLUME_MUTED ((int32_t) (-0x80000000))

/** Ways to express seek offsets for pread/pwrite */
typedef enum {
    SA_SEEK_RELATIVE,
    SA_SEEK_ABSOLUTE,
    SA_SEEK_RELATIVE_END,
    _SA_SEEK_MAX
} sa_seek_t;

/** Supported formats */
typedef enum {
    SA_PCM_FORMAT_U8,
    SA_PCM_FORMAT_ULAW,
    SA_PCM_FORMAT_ALAW,
    SA_PCM_FORMAT_S16_LE,
    SA_PCM_FORMAT_S16_BE,
    SA_PCM_FORMAT_S24_LE,
    SA_PCM_FORMAT_S24_BE,
    SA_PCM_FORMAT_S32_LE,
    SA_PCM_FORMAT_S32_BE,
    SA_PCM_FORMAT_FLOAT32_LE,
    SA_PCM_FORMAT_FLOAT32_BE,
    _SA_PCM_FORMAT_MAX
} sa_pcm_format_t;

/* Native/reverse endianness definitions for PCM */
#ifdef SA_LITTLE_ENDIAN
#define SA_PCM_FORMAT_S16_NE SA_PCM_FORMAT_S16_LE
#define SA_PCM_FORMAT_S24_NE SA_PCM_FORMAT_S24_LE
#define SA_PCM_FORMAT_S32_NE SA_PCM_FORMAT_S32_LE
#define SA_PCM_FORMAT_FLOAT32_NE SA_PCM_FORMAT_FLOAT32_LE
#define SA_PCM_FORMAT_S16_RE SA_PCM_FORMAT_S16_BE
#define SA_PCM_FORMAT_S24_RE SA_PCM_FORMAT_S24_BE
#define SA_PCM_FORMAT_S32_RE SA_PCM_FORMAT_S32_BE
#define SA_PCM_FORMAT_FLOAT32_RE SA_PCM_FORMAT_FLOAT32_BE
#else
#define SA_PCM_FORMAT_S16_NE SA_PCM_FORMAT_S16_BE
#define SA_PCM_FORMAT_S24_NE SA_PCM_FORMAT_S24_BE
#define SA_PCM_FORMAT_S32_NE SA_PCM_FORMAT_S32_BE
#define SA_PCM_FORMAT_FLOAT32_NE SA_PCM_FORMAT_FLOAT32_BE
#define SA_PCM_FORMAT_S16_RE SA_PCM_FORMAT_S16_LE
#define SA_PCM_FORMAT_S24_RE SA_PCM_FORMAT_S24_LE
#define SA_PCM_FORMAT_S32_RE SA_PCM_FORMAT_S32_LE
#define SA_PCM_FORMAT_FLOAT32_RE SA_PCM_FORMAT_FLOAT32_LE
#endif

#define SA_CODEC_MPEG "mpeg"
#define SA_CODEC_AC3 "ac3"
#define SA_CODEC_GSM "gsm"
#define SA_CODEC_VORBIS "vorbis"
#define SA_CODEC_SPEEX "speex"

/** Device opening modes */
typedef enum {
    SA_MODE_WRONLY = 1,
    SA_MODE_RDONLY = 2,
    SA_MODE_RDWR   = 3,
    _SA_MODE_MAX   = 4
} sa_mode_t;

/** Error codes */
enum {
    SA_SUCCESS = 0,
    SA_ERROR_NOT_SUPPORTED = -1,
    SA_ERROR_INVALID = -2,
    SA_ERROR_STATE = -3,
    SA_ERROR_OOM = -4,
    SA_ERROR_NO_DEVICE = -5,
    SA_ERROR_NO_DRIVER = -6,
    SA_ERROR_NO_CODEC = -7,
    SA_ERROR_NO_PCM_FORMAT = -7,
    SA_ERROR_SYSTEM = -8,
    SA_ERROR_NO_INIT = -9,
    SA_ERROR_NO_META = -10,
    SA_ERROR_NO_DATA = -11,
    SA_ERROR_NO_SPACE = -12,
    _SA_ERROR_MAX = -13
};

/** Possible events for notifications */
typedef enum {
    SA_NOTIFY_REQUEST_START,
    SA_NOTIFY_REQUEST_STOP,
    SA_NOTIFY_CHANGED_READ_VOLUME,
    SA_NOTIFY_CHANGED_WRITE_VOLUME,
    SA_NOTIFY_CHANGED_DEVICE,
    _SA_NOTIFY_MAX
} sa_notify_t;

/** Classes of events */
typedef enum {
    SA_EVENT_REQUEST_IO,
    SA_EVENT_INIT_THREAD,
    SA_EVENT_NOTIFY,
    SA_EVENT_ERROR,
    SA_EVENT_XRUN,
    _SA_EVENT_MAX
} sa_event_t;

/** List of sample position queries */
typedef enum {
    SA_POSITION_WRITE_DELAY,
    SA_POSITION_WRITE_HARDWARE,
    SA_POSITION_WRITE_SOFTWARE,
    SA_POSITION_READ_DELAY,
    SA_POSITION_READ_HARDWARE,
    SA_POSITION_READ_SOFTWARE,
    SA_POSITION_DUPLEX_DELAY,
    _SA_POSITION_MAX
} sa_position_t;

/* Channel positions */
typedef enum {
    SA_CHANNEL_MONO,
    SA_CHANNEL_LEFT,
    SA_CHANNEL_RIGHT,
    SA_CHANNEL_CENTER,
    SA_CHANNEL_FRONT_LEFT,
    SA_CHANNEL_FRONT_RIGHT,
    SA_CHANNEL_FRONT_CENTER,
    SA_CHANNEL_REAR_LEFT,
    SA_CHANNEL_REAR_RIGHT,
    SA_CHANNEL_REAR_CENTER,
    SA_CHANNEL_LFE,
    SA_CHANNEL_FRONT_LEFT_OF_CENTER,
    SA_CHANNEL_FRONT_RIGHT_OF_CENTER,
    SA_CHANNEL_SIDE_LEFT,
    SA_CHANNEL_SIDE_RIGHT,
    SA_CHANNEL_TOP_CENTER,
    SA_CHANNEL_TOP_FRONT_LEFT,
    SA_CHANNEL_TOP_FRONT_RIGHT,
    SA_CHANNEL_TOP_FRONT_CENTER,
    SA_CHANNEL_TOP_REAR_LEFT,
    SA_CHANNEL_TOP_REAR_RIGHT,
    SA_CHANNEL_TOP_REAR_CENTER,
    SA_CHANNEL_AUX0,
    SA_CHANNEL_AUX1,
    SA_CHANNEL_AUX2,
    SA_CHANNEL_AUX3,
    SA_CHANNEL_AUX4,
    SA_CHANNEL_AUX5,
    SA_CHANNEL_AUX6,
    SA_CHANNEL_AUX7,
    SA_CHANNEL_AUX8,
    SA_CHANNEL_AUX9,
    SA_CHANNEL_AUX10,
    SA_CHANNEL_AUX11,
    SA_CHANNEL_AUX12,
    SA_CHANNEL_AUX13,
    SA_CHANNEL_AUX14,
    SA_CHANNEL_AUX15,
    SA_CHANNEL_AUX16,
    SA_CHANNEL_AUX17,
    SA_CHANNEL_AUX18,
    SA_CHANNEL_AUX19,
    SA_CHANNEL_AUX20,
    SA_CHANNEL_AUX21,
    SA_CHANNEL_AUX22,
    SA_CHANNEL_AUX23,
    SA_CHANNEL_AUX24,
    SA_CHANNEL_AUX25,
    SA_CHANNEL_AUX26,
    SA_CHANNEL_AUX27,
    SA_CHANNEL_AUX28,
    SA_CHANNEL_AUX29,
    SA_CHANNEL_AUX30,
    SA_CHANNEL_AUX31,
    _SA_CHANNEL_MAX
} sa_channel_t;

typedef enum {
    SA_STATE_INIT,
    SA_STATE_RUNNING,
    SA_STATE_STOPPED,
    SA_STATE_DRAINING,
    /* put more stuff */
    _SA_STATE_MAX
} sa_state_t;

typedef enum {
    SA_XRUN_MODE_STOP,
    SA_XRUN_MODE_SPIN,
    SA_XRUN_MODE_FILL,
    _SA_XRUN_MODE_MAX
} sa_xrun_mode_t;

typedef enum {
    SA_ADJUST_UP = 1,
    SA_ADJUST_DOWN = -1,
    SA_ADJUST_NONE = 0
} sa_adjust_t;

/** Stream properties */
#define SA_PROP_MEDIA_NAME                  "media.name"
#define SA_PROP_MEDIA_TITLE                 "media.title"
#define SA_PROP_MEDIA_ARTIST                "media.artist"
#define SA_PROP_MEDIA_LANGUAGE              "media.language"
#define SA_PROP_MEDIA_FILENAME              "media.filename"
#define SA_PROP_MEDIA_ICON                  "media.icon"
#define SA_PROP_MEDIA_ICON_NAME             "media.icon_name"
#define SA_PROP_MEDIA_ROLE                  "media.role"
#define SA_PROP_EVENT_ID                    "event.id"
#define SA_PROP_EVENT_X11_DISPLAY           "event.x11.display"
#define SA_PROP_EVENT_X11_XID               "event.x11.xid"
#define SA_PROP_EVENT_MOUSE_X               "event.mouse.x"
#define SA_PROP_EVENT_MOUSE_Y               "event.mouse.y"
#define SA_PROP_EVENT_MOUSE_BUTTON          "event.mouse.button"
#define SA_PROP_APPLICATION_NAME            "application.name"
#define SA_PROP_APPLICATION_ID              "application.id"
#define SA_PROP_APPLICATION_VERSION         "application.version"
#define SA_PROP_APPLICATION_ICON            "application.icon"
#define SA_PROP_APPLICATION_ICON_NAME       "application.icon_name"
#define SA_PROP_APPLICATION_LANGUAGE        "application.language"
#define SA_PROP_APPLICATION_PROCESS_ID      "application.process.id"
#define SA_PROP_APPLICATION_PROCESS_BINARY  "application.process.binary"
#define SA_PROP_APPLICATION_PROCESS_USER    "application.process.user"
#define SA_PROP_APPLICATION_PROCESS_HOST    "application.process.host"

/** Main callback function */
typedef int (*sa_event_callback_t)(sa_stream_t *s, sa_event_t event);

/** Create an opaque (e.g. AC3) codec stream */
int sa_stream_create_opaque(sa_stream_t **s, const char *client_name, sa_mode_t mode, const char *codec);

/** Normal way to open a PCM device */
int sa_stream_create_pcm(sa_stream_t **s, const char *client_name, sa_mode_t mode, sa_pcm_format_t format, unsigned rate, unsigned nchannels);

/** Initialise the device */
int sa_stream_open(sa_stream_t *s);

/** Close/destroy everything */
int sa_stream_destroy(sa_stream_t *s);

/* Buffer params */
int sa_stream_set_write_latency(sa_stream_t *s, size_t nbytes);
int sa_stream_set_write_wakeup(sa_stream_t *s, size_t nbytes);
int sa_stream_set_read_latency(sa_stream_t *s, size_t nbytes);
int sa_stream_set_read_wakeup(sa_stream_t *s, size_t nbytes);

/** Set the mapping between channels and the loudspeakers */
int sa_stream_set_channel_map(sa_stream_t *s, const sa_channel_t map[], unsigned n);

/** Whether xruns cause the card to reset */
int sa_stream_set_xrun_mode(sa_stream_t *s, sa_xrun_mode_t mode);

/** Set the device to non-interleaved mode */
int sa_stream_set_non_interleaved(sa_stream_t *s, int enable);

/** Allow that the sample rate may be changed during runtime */
int sa_stream_set_dynamic_rate(sa_stream_t *s, int enabled);

/** Set the number of PCM channels for input */
int sa_stream_set_read_pcm_nchannels(sa_stream *s, unsigned nchannels);

/** Set the number of PCM channels for output */
int sa_stream_set_write_pcm_nchannels(sa_stream *s, unsigned nchannels);

/** Select driver */
int sa_stream_set_driver(sa_stream_t *s, const char *driver);

/** Start callback thread */
int sa_stream_start_thread(sa_stream_t *s, sa_event_callback_t callback);

/** Start callback thread */
int sa_stream_stop_thread(sa_stream_t *s);

/** Change the device connected to the stream */
int sa_stream_change_device(sa_stream_t *s, const char *device_name);

/** volume in hundreths of dB*/
int sa_stream_change_read_volume(sa_stream_t *s, const int32_t vol[], unsigned n);

/** volume in hundreths of dB*/
int sa_stream_change_write_volume(sa_stream_t *s, const int32_t vol[], unsigned n);

/** Change the sampling rate */
int sa_stream_change_rate(sa_stream_t *s, unsigned rate);

/** Associate opaque user data */
int sa_stream_change_user_data(sa_stream_t *s, const void *value);

/* Hardware-related. This is implementation-specific and hardware specific. */
int sa_stream_set_adjust_rate(sa_stream_t *s, sa_adjust_t direction);
int sa_stream_set_adjust_nchannels(sa_stream_t *s, sa_adjust_t direction);
int sa_stream_set_adjust_pcm_format(sa_stream_t *s, sa_adjust_t direction);

/* Query functions */
int sa_stream_get_mode(sa_stream_t *s, sa_mode_t *access_mode);
int sa_stream_get_codec(sa_stream_t *s, char *codec, size_t *size);
int sa_stream_get_pcm_format(sa_stream_t *s, sa_pcm_format_t *format);
int sa_stream_get_pcm_rate(sa_stream_t *s, unsigned *rate);
int sa_stream_get_pcm_nchannels(sa_stream_t *s, int *nchannels);
int sa_stream_get_user_data(sa_stream_t *s, void **value);
int sa_stream_get_write_latency(sa_stream_t *s, size_t *nbytes);
int sa_stream_get_write_wakeup(sa_stream_t *s, size_t *nbytes);
int sa_stream_get_read_latency(sa_stream_t *s, size_t *nbytes);
int sa_stream_get_read_wakeup(sa_stream_t *s, size_t *nbytes);
int sa_stream_get_pcm_channel_map(sa_stream_t *s, sa_channel_t map[], unsigned *n);
int sa_stream_get_xrun_mode(sa_stream_t *s, sa_xrun_mode_t *mode);
int sa_stream_get_non_interleaved(sa_stream_t *s, int *enabled);
int sa_stream_get_pcm_dynamic_rate(sa_stream_t *s, int *enabled);
int sa_stream_get_driver(sa_stream_t *s, char *driver_name, size_t *size);
int sa_stream_get_device(sa_stream_t *s, char *device_name, size_t *size);
int sa_stream_get_read_volume(sa_stream_t *s, int32_t vol[], unsigned *n);
int sa_stream_get_write_volume(sa_stream_t *s, int32_t vol[], unsigned *n);
int sa_stream_get_meta_data(sa_stream_t *s, const char *name, void*data, size_t *size);
int sa_stream_get_adjust_pcm_rate(sa_stream_t *s, sa_adjust_t *direction);
int sa_stream_get_adjust_pcm_nchannels(sa_stream_t *s, sa_adjust_t *direction);
int sa_stream_get_adjust_pcm_format(sa_stream_t *s, sa_adjust_t *direction);


/** Get current state of the audio device */
int sa_stream_get_state(sa_stream_t *s, sa_state_t *state);

/** Obtain the error code */
int sa_stream_get_event_error(sa_stream_t *s, int *error);

/** Obtain the notification code */
int sa_stream_get_event_notify(sa_stream_t *s, sa_notify_t *notify);

/** sync/timing */
int sa_stream_get_position(sa_stream_t *s, sa_position_t position, int64_t *pos);


/* Blocking IO calls */

/** Interleaved capture function */
int sa_stream_read(sa_stream_t *s, void *data, size_t nbytes);
/** Non-interleaved capture function */
int sa_stream_read_ni(sa_stream_t *s, unsigned channel, void *data, size_t nbytes);

/** Interleaved playback function */
int sa_stream_write(sa_stream_t *s, const void *data, size_t nbytes);
/** Non-interleaved playback function */
int sa_stream_write_ni(sa_stream_t *s, unsigned channel, const void *data, size_t nbytes);
/** Interleaved playback function with seek offset */
int sa_stream_pwrite(sa_stream_t *s, const void *data, size_t nbytes, int64_t offset, sa_seek_t whence);
/** Non-interleaved playback function with seek offset */
int sa_stream_pwrite_ni(sa_stream_t *s, unsigned channel, const void *data, size_t nbytes, int64_t offset, sa_seek_t whence);


/** Query how much can be read without blocking */
int sa_stream_get_read_size(sa_stream_t *s, size_t *nbytes);
/** Query how much can be written without blocking */
int sa_stream_get_write_size(sa_stream_t *s, size_t *nbytes);


/* Control/xrun */

/** Resume playing after a pause */
int sa_stream_start(sa_stream_t *s);

/** Pause audio playback (do not empty the buffer) */
int sa_stream_stop(sa_stream_t *s);

/** Block until all audio has been played */
int sa_stream_drain(sa_stream_t *s);

/** Return a human readable error */
const char *sa_strerror(int code);

/* Stream properties */

/** Update meta data string properties that are attached to this stream. Takes a NULL terminated list of string key/value pairs. */
int sa_stream_change_props(sa_stream_t *s, ...) SA_GCC_SENTINEL;

/** Update abritrary meta data properties that are attached to this stream */
int sa_stream_change_prop(sa_stream_t *s, const char *key, const void *data, size_t nbytes);

/** Remove abritrary meta data properties that are attached to this stream */
int sa_stream_remove_prop(sa_stream_t *s, ...) SA_GCC_SENTINEL;

#ifdef __cplusplus
}
#endif

#endif