summaryrefslogtreecommitdiffstats
path: root/src/sydney.h
blob: c718299646679ed83ad2ee7c1a620a2df04e0a00 (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
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
#ifndef foosydneyhfoo
#define foosydneyhfoo

/***
  This file is part of libsydney.

  Copyright 2007-2008 Lennart Poettering

  libsydney is free software; you can redistribute it and/or modify it
  under the terms of the GNU Lesser General Public License as
  published by the Free Software Foundation, either version 2.1 of the
  License, or (at your option) any later version.

  libsydney is distributed in the hope that it will be useful, but
  WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  Lesser General Public License for more details.

  You should have received a copy of the GNU Lesser General Public
  License along with libsydney. If not, see
  <http://www.gnu.org/licenses/>.
***/

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

#ifdef  __cplusplus
extern "C" {
#endif

#ifndef __GNUC__
/* Make sure __attribute__ works on non-gcc systems. Yes, might be a bit ugly */
#define __attribute__(x)
#endif

/* 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

/**
 * SA_PROP_MEDIA_NAME:
 *
 * A name describing the media being played. Localized if possible and applicable.
 */
#define SA_PROP_MEDIA_NAME                         "media.name"

/**
 * SA_PROP_MEDIA_TITLE:
 *
 * A (song) title describing the media being played. Localized if possible and applicable.
 */
#define SA_PROP_MEDIA_TITLE                        "media.title"

/**
 * SA_PROP_MEDIA_ARTIST:
 *
 * The artist of this media. Localized if possible and applicable.
 */
#define SA_PROP_MEDIA_ARTIST                       "media.artist"

/**
 * SA_PROP_MEDIA_LANGUAGE:
 *
 * The language this media is in, in some standard POSIX locale string, such as "de_DE".
 */
#define SA_PROP_MEDIA_LANGUAGE                     "media.language"

/**
 * SA_PROP_MEDIA_FILENAME:
 *
 * The file name this media was or can be loaded from.
 */
#define SA_PROP_MEDIA_FILENAME                     "media.filename"

/**
 * SA_PROP_MEDIA_ICON:
 *
 * An icon for this media in binary PNG format.
 */
#define SA_PROP_MEDIA_ICON                         "media.icon"

/**
 * SA_PROP_MEDIA_ICON_NAME:
 *
 * An icon name as defined in the XDG icon naming specifcation.
 */
#define SA_PROP_MEDIA_ICON_NAME                    "media.icon_name"

/**
 * SA_PROP_MEDIA_ROLE:
 *
 * The "role" this media is played in. For event sounds the string
 * "event". For other cases strings like "music", "video", "game", ...
 */
#define SA_PROP_MEDIA_ROLE                         "media.role"

/**
 * SA_PROP_EVENT_ID:
 *
 * A textual id for an event sound, as mandated by the XDG sound naming specification.
 */
#define SA_PROP_EVENT_ID                           "event.id"

/**
 * SA_PROP_EVENT_DESCRIPTION:
 *
 * A descriptive string for the sound event. Localized if possible and applicable.
 */
#define SA_PROP_EVENT_DESCRIPTION                  "event.description"

/**
 * SA_PROP_EVENT_MOUSE_X:
 *
 * If this sound event was triggered by a mouse input event, the X
 * position of the mouse cursor on the screen, formatted as string.
 */
#define SA_PROP_EVENT_MOUSE_X                      "event.mouse.x"

/**
 * SA_PROP_EVENT_MOUSE_Y:
 *
 * If this sound event was triggered by a mouse input event, the Y
 * position of the mouse cursor on the screen, formatted as string.
 */
#define SA_PROP_EVENT_MOUSE_Y                      "event.mouse.y"

/**
 * SA_PROP_EVENT_MOUSE_HPOS:
 *
 * If this sound event was triggered by a mouse input event, the X
 * position of the mouse cursor as fractional value between 0 and 1,
 * formatted as string, 0 reflecting the left side of the screen, 1
 * the right side.
 */
#define SA_PROP_EVENT_MOUSE_HPOS                   "event.mouse.hpos"

/**
 * SA_PROP_EVENT_MOUSE_VPOS:
 *
 * If this sound event was triggered by a mouse input event, the Y
 * position of the mouse cursor as fractional value between 0 and 1,
 * formatted as string, 0 reflecting the top end of the screen, 1
 * the bottom end.
 */
#define SA_PROP_EVENT_MOUSE_VPOS                   "event.mouse.vpos"

/**
 * SA_PROP_EVENT_MOUSE_BUTTON:
 *
 * If this sound event was triggered by a mouse input event, the
 * number of the mouse button that triggered it, formatted as string. 1
 * for left mouse button, 3 for right, 2 for middle.
 */
#define SA_PROP_EVENT_MOUSE_BUTTON                 "event.mouse.button"

/**
 * SA_PROP_WINDOW_NAME:
 *
 * If this sound event was triggered by a window on the screen, the
 * name of this window as human readable string.
 */
#define SA_PROP_WINDOW_NAME                        "window.name"

/**
 * SA_PROP_WINDOW_ID:
 *
 * If this sound event was triggered by a window on the screen, some
 * identification string for this window, so that the sound system can
 * recognize specific windows.
 */
#define SA_PROP_WINDOW_ID                          "window.id"

/**
 * SA_PROP_WINDOW_ICON:
 *
 * If this sound event was triggered by a window on the screen, binary
 * icon data in PNG format for this window.
 */
#define SA_PROP_WINDOW_ICON                        "window.icon"

/**
 * SA_PROP_WINDOW_ICON_NAME:
 *
 * If this sound event was triggered by a window on the screen, an
 * icon name for this window, as defined in the XDG icon naming
 * specification.
 */
#define SA_PROP_WINDOW_ICON_NAME                   "window.icon_name"

/**
 * SA_PROP_WINDOW_X11_DISPLAY:
 *
 * If this sound event was triggered by a window on the screen and the
 * windowing system is X11, the X display name of the window (e.g. ":0").
 */
#define SA_PROP_WINDOW_X11_DISPLAY                 "window.x11.display"

/**
 * SA_PROP_WINDOW_X11_SCREEN:
 *
 * If this sound event was triggered by a window on the screen and the
 * windowing system is X11, the X screen id of the window formatted as
 * string (e.g. "0").
 */
#define SA_PROP_WINDOW_X11_SCREEN                  "window.x11.screen"

/**
 * SA_PROP_WINDOW_X11_MONITOR:
 *
 * If this sound event was triggered by a window on the screen and the
 * windowing system is X11, the X monitor id of the window formatted as
 * string (e.g. "0").
 */
#define SA_PROP_WINDOW_X11_MONITOR                 "window.x11.monitor"

/**
 * SA_PROP_WINDOW_X11_XID:
 *
 * If this sound event was triggered by a window on the screen and the
 * windowing system is X11, the XID of the window formatted as string.
 */
#define SA_PROP_WINDOW_X11_XID                     "window.x11.xid"

/**
 * SA_PROP_APPLICATION_NAME:
 *
 * The name of the application this sound event was triggered by as
 * human readable string. (e.g. "GNU Emacs") Localized if possible and
 * applicable.
 */
#define SA_PROP_APPLICATION_NAME                   "application.name"

/**
 * SA_PROP_APPLICATION_ID:
 *
 * An identifier for the program this sound event was triggered
 * by. (e.g. "org.gnu.emacs").
 */
#define SA_PROP_APPLICATION_ID                     "application.id"

/**
 * SA_PROP_APPLICATION_VERSION:
 *
 * A version number for the program this sound event was triggered
 * by. (e.g. "22.2")
 */
#define SA_PROP_APPLICATION_VERSION                "application.version"

/**
 * SA_PROP_APPLICATION_ICON:
 *
 * Binary icon data in PNG format for the application this sound event
 * is triggered by.
 */
#define SA_PROP_APPLICATION_ICON                   "application.icon"

/**
 * SA_PROP_APPLICATION_ICON_NAME:
 *
 * An icon name for the application this sound event is triggered by,
 * as defined in the XDG icon naming specification.
 */
#define SA_PROP_APPLICATION_ICON_NAME              "application.icon_name"

/**
 * SA_PROP_APPLICATION_LANGUAGE:
 *
 * The locale string the application that is triggering this sound
 * event is running in. A POSIX locale string such as de_DE@euro.
 */
#define SA_PROP_APPLICATION_LANGUAGE               "application.language"

/**
 * SA_PROP_APPLICATION_PROCESS_ID:
 *
 * The unix PID of the process that is triggering this sound event, formatted as string.
 */
#define SA_PROP_APPLICATION_PROCESS_ID             "application.process.id"

/**
 * SA_PROP_APPLICATION_PROCESS_BINARY:
 *
 * The path to the process binary of the process that is triggering this sound event.
 */
#define SA_PROP_APPLICATION_PROCESS_BINARY         "application.process.binary"

/**
 * SA_PROP_APPLICATION_PROCESS_USER:
 *
 * The user that owns the process that is triggering this sound event.
 */
#define SA_PROP_APPLICATION_PROCESS_USER           "application.process.user"

/**
 * SA_PROP_APPLICATION_PROCESS_HOST:
 *
 * The host name of the host the process that is triggering this sound event runs on.
 */
#define SA_PROP_APPLICATION_PROCESS_HOST           "application.process.host"

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

/** 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:
 * SCA_SUCCESS: Success
 *
 * Error codes
 */
enum {
    SA_SUCCESS = 0,
    SA_ERROR_NOTSUPPORTED = -1,
    SA_ERROR_INVALID = -2,
    SA_ERROR_STATE = -3,
    SA_ERROR_OOM = -4,
    SA_ERROR_NODRIVER = -5,
    SA_ERROR_SYSTEM = -6,
    SA_ERROR_CORRUPT = -7,
    SA_ERROR_TOOBIG = -8,
    SA_ERROR_NOTFOUND = -9,
    SA_ERROR_DESTROYED = -10,
    SA_ERROR_CANCELED = -11,
    SA_ERROR_NOTAVAILABLE = -12,
    SA_ERROR_ACCESS = -13,
    SA_ERROR_IO = -14,
    SA_ERROR_INTERNAL = -15,
    SA_ERROR_DISABLED = -16,
    SA_ERROR_NODEVICE = -17,
    SA_ERROR_NOCODEC = -18,
    SA_ERROR_NOPCMFORMAT = -19,
    _SA_ERROR_MAX = -20
};

/** 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,
    SA_STATE_DEAD,
    /* 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;

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

/**
 * sa_proplist:
 *
 * A sydney property list object. Basically a hashtable.
 */
typedef struct sa_proplist sa_proplist;

int sa_proplist_create(sa_proplist **p);
int sa_proplist_destroy(sa_proplist *p);
int sa_proplist_sets(sa_proplist *p, const char *key, const char *value);
int sa_proplist_setf(sa_proplist *p, const char *key, const char *format, ...) __attribute__((format(printf, 3, 4)));
int sa_proplist_set(sa_proplist *p, const char *key, const void *data, size_t nbytes);

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

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

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

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

/* Buffer params */
int sa_stream_change_write_latency(sa_stream *s, size_t overall_latency_nbytes, size_t immutable_latency_nbytes, size_t process_time_nbytes);
int sa_stream_change_read_latency(sa_stream *s, size_t overall_latency_nbytes, size_t process_time_nbytes);

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

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

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

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

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

/** Enable asynchronous mode and set event callback*/
int sa_stream_set_event_callback(sa_stream *s, sa_event_callback_t callback);

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

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

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

/** Change the sampling rate */
int sa_stream_change_pcm_rate(sa_stream *s, unsigned rate);

int sa_stream_change_props(sa_stream *c, ...) __attribute__((sentinel));
int sa_stream_change_props_full(sa_stream *c, sa_proplist *p);

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

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

/* Query functions */
int sa_stream_get_mode(sa_stream *s, sa_mode_t *access_mode);
int sa_stream_get_codec(sa_stream *s, char **codec);
int sa_stream_get_pcm_format(sa_stream *s, sa_pcm_format_t *format);
int sa_stream_get_pcm_rate(sa_stream *s, unsigned *rate);
int sa_stream_get_pcm_nchannels(sa_stream *s, unsigned *nchannels);
int sa_stream_get_user_data(sa_stream *s, void **value);
int sa_stream_get_write_overall_latency(sa_stream *s, size_t *nbytes);
int sa_stream_get_write_immutable_latency(sa_stream *s, size_t *nbytes);
int sa_stream_get_write_process_time(sa_stream *s, size_t *nbytes);
int sa_stream_get_read_overall_latency(sa_stream *s, size_t *nbytes);
int sa_stream_get_read_process_time(sa_stream *s, size_t *nbytes);
int sa_stream_get_pcm_channel_map(sa_stream *s, sa_channel_t **map, unsigned *n);
int sa_stream_get_xrun_mode(sa_stream *s, sa_xrun_mode_t *mode);
int sa_stream_get_non_interleaved(sa_stream *s, int *enabled);
int sa_stream_get_dynamic_pcm_rate(sa_stream *s, int *enabled);
int sa_stream_get_driver(sa_stream *s, char **driver_name);
int sa_stream_get_device(sa_stream *s, char **device_name);
int sa_stream_get_read_volume(sa_stream *s, int32_t **vol, unsigned *n);
int sa_stream_get_write_volume(sa_stream *s, int32_t **vol, unsigned *n);
int sa_stream_get_adjust_pcm_rate(sa_stream *s, sa_adjust_t *direction);
int sa_stream_get_adjust_pcm_nchannels(sa_stream *s, sa_adjust_t *direction);
int sa_stream_get_adjust_pcm_format(sa_stream *s, sa_adjust_t *direction);


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

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

/** Obtain the notification code */
int sa_stream_get_event_notify(sa_stream *s, sa_notify_t *notify, void **data, size_t *data_nbytes);

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


/* IO calls */
int sa_stream_wait(sa_stream *s, sa_event_t *event);

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

/** Interleaved playback function */
int sa_stream_write(sa_stream *s, const void *data, size_t nbytes);
/** Non-interleaved playback function */
int sa_stream_write_ni(sa_stream *s, unsigned channel, const void *data, size_t nbytes);
/** Interleaved playback function with seek offset */
int sa_stream_pwrite(sa_stream *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 *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 *s, size_t *nbytes);
/** Query how much can be written without blocking */
int sa_stream_get_write_size(sa_stream *s, size_t *nbytes);


/* Control/xrun */

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

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

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

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

unsigned sa_stream_bytes_to_frames(sa_stream *s, size_t nbytes, int round_up);
size_t sa_stream_frames_to_bytes(sa_stream *s, unsigned nframes);

uint64_t sa_stream_bytes_to_usec(sa_stream *s, size_t nbytes, int round_up);
size_t sa_stream_usec_to_bytes(sa_stream *s, uint64_t usec, int round_up);

uint64_t sa_stream_frames_to_usec(sa_stream *s, unsigned nframes, int round_up);
unsigned sa_stream_usec_to_frames(sa_stream *s, uint64_t usec, int round_up);

typedef struct sa_allocator {
    void* (*malloc)(size_t size);
    void* (*calloc)(size_t nmemb, size_t size);
    void (*free)(void *ptr);
    void* (*realloc)(void *ptr, size_t size);
} sa_allocator;

void sa_set_allocator(const sa_allocator *a);

#ifdef __cplusplus
}
#endif

#endif