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
use std;
use capi;
use std::os::raw::{c_char, c_void};
use std::ffi::{CStr, CString};
use std::ptr::{null, null_mut};
use error::PAErr;
pub(crate) use capi::pa_proplist as ProplistInternal;
pub use capi::pa_update_mode_t as UpdateMode;
pub mod properties {
use capi;
pub use capi::PA_PROP_MEDIA_NAME as MEDIA_NAME;
pub use capi::PA_PROP_MEDIA_TITLE as MEDIA_TITLE;
pub use capi::PA_PROP_MEDIA_ARTIST as MEDIA_ARTIST;
pub use capi::PA_PROP_MEDIA_COPYRIGHT as MEDIA_COPYRIGHT;
pub use capi::PA_PROP_MEDIA_SOFTWARE as MEDIA_SOFTWARE;
pub use capi::PA_PROP_MEDIA_LANGUAGE as MEDIA_LANGUAGE;
pub use capi::PA_PROP_MEDIA_FILENAME as MEDIA_FILENAME;
pub use capi::PA_PROP_MEDIA_ICON as MEDIA_ICON;
pub use capi::PA_PROP_MEDIA_ICON_NAME as MEDIA_ICON_NAME;
pub use capi::PA_PROP_MEDIA_ROLE as MEDIA_ROLE;
pub use capi::PA_PROP_FILTER_WANT as FILTER_WANT;
pub use capi::PA_PROP_EVENT_ID as EVENT_ID;
pub use capi::PA_PROP_EVENT_DESCRIPTION as EVENT_DESCRIPTION;
pub use capi::PA_PROP_EVENT_MOUSE_X as EVENT_MOUSE_X;
pub use capi::PA_PROP_EVENT_MOUSE_Y as EVENT_MOUSE_Y;
pub use capi::PA_PROP_EVENT_MOUSE_HPOS as EVENT_MOUSE_HPOS;
pub use capi::PA_PROP_EVENT_MOUSE_VPOS as EVENT_MOUSE_VPOS;
pub use capi::PA_PROP_EVENT_MOUSE_BUTTON as EVENT_MOUSE_BUTTON;
pub use capi::PA_PROP_WINDOW_NAME as WINDOW_NAME;
pub use capi::PA_PROP_WINDOW_ID as WINDOW_ID;
pub use capi::PA_PROP_WINDOW_ICON as WINDOW_ICON;
pub use capi::PA_PROP_WINDOW_ICON_NAME as WINDOW_ICON_NAME;
pub use capi::PA_PROP_WINDOW_X as WINDOW_X;
pub use capi::PA_PROP_WINDOW_Y as WINDOW_Y;
pub use capi::PA_PROP_WINDOW_WIDTH as WINDOW_WIDTH;
pub use capi::PA_PROP_WINDOW_HEIGHT as WINDOW_HEIGHT;
pub use capi::PA_PROP_WINDOW_HPOS as WINDOW_HPOS;
pub use capi::PA_PROP_WINDOW_VPOS as WINDOW_VPOS;
pub use capi::PA_PROP_WINDOW_DESKTOP as WINDOW_DESKTOP;
pub use capi::PA_PROP_WINDOW_X11_DISPLAY as WINDOW_X11_DISPLAY;
pub use capi::PA_PROP_WINDOW_X11_SCREEN as WINDOW_X11_SCREEN;
pub use capi::PA_PROP_WINDOW_X11_MONITOR as WINDOW_X11_MONITOR;
pub use capi::PA_PROP_WINDOW_X11_XID as WINDOW_X11_XID;
pub use capi::PA_PROP_APPLICATION_NAME as APPLICATION_NAME;
pub use capi::PA_PROP_APPLICATION_ID as APPLICATION_ID;
pub use capi::PA_PROP_APPLICATION_VERSION as APPLICATION_VERSION;
pub use capi::PA_PROP_APPLICATION_ICON as APPLICATION_ICON;
pub use capi::PA_PROP_APPLICATION_ICON_NAME as APPLICATION_ICON_NAME;
pub use capi::PA_PROP_APPLICATION_LANGUAGE as APPLICATION_LANGUAGE;
pub use capi::PA_PROP_APPLICATION_PROCESS_ID as APPLICATION_PROCESS_ID;
pub use capi::PA_PROP_APPLICATION_PROCESS_BINARY as APPLICATION_PROCESS_BINARY;
pub use capi::PA_PROP_APPLICATION_PROCESS_USER as APPLICATION_PROCESS_USER;
pub use capi::PA_PROP_APPLICATION_PROCESS_HOST as APPLICATION_PROCESS_HOST;
pub use capi::PA_PROP_APPLICATION_PROCESS_MACHINE_ID as APPLICATION_PROCESS_MACHINE_ID;
pub use capi::PA_PROP_APPLICATION_PROCESS_SESSION_ID as APPLICATION_PROCESS_SESSION_ID;
pub use capi::PA_PROP_DEVICE_STRING as DEVICE_STRING;
pub use capi::PA_PROP_DEVICE_API as DEVICE_API;
pub use capi::PA_PROP_DEVICE_DESCRIPTION as DEVICE_DESCRIPTION;
pub use capi::PA_PROP_DEVICE_BUS_PATH as DEVICE_BUS_PATH;
pub use capi::PA_PROP_DEVICE_SERIAL as DEVICE_SERIAL;
pub use capi::PA_PROP_DEVICE_VENDOR_ID as DEVICE_VENDOR_ID;
pub use capi::PA_PROP_DEVICE_VENDOR_NAME as DEVICE_VENDOR_NAME;
pub use capi::PA_PROP_DEVICE_PRODUCT_ID as DEVICE_PRODUCT_ID;
pub use capi::PA_PROP_DEVICE_PRODUCT_NAME as DEVICE_PRODUCT_NAME;
pub use capi::PA_PROP_DEVICE_CLASS as DEVICE_CLASS;
pub use capi::PA_PROP_DEVICE_FORM_FACTOR as DEVICE_FORM_FACTOR;
pub use capi::PA_PROP_DEVICE_BUS as DEVICE_BUS;
pub use capi::PA_PROP_DEVICE_ICON as DEVICE_ICON;
pub use capi::PA_PROP_DEVICE_ICON_NAME as DEVICE_ICON_NAME;
pub use capi::PA_PROP_DEVICE_ACCESS_MODE as DEVICE_ACCESS_MODE;
pub use capi::PA_PROP_DEVICE_MASTER_DEVICE as DEVICE_MASTER_DEVICE;
pub use capi::PA_PROP_DEVICE_BUFFERING_BUFFER_SIZE as DEVICE_BUFFERING_BUFFER_SIZE;
pub use capi::PA_PROP_DEVICE_BUFFERING_FRAGMENT_SIZE as DEVICE_BUFFERING_FRAGMENT_SIZE;
pub use capi::PA_PROP_DEVICE_PROFILE_NAME as DEVICE_PROFILE_NAME;
pub use capi::PA_PROP_DEVICE_PROFILE_DESCRIPTION as DEVICE_PROFILE_DESCRIPTION;
pub use capi::PA_PROP_MODULE_AUTHOR as MODULE_AUTHOR;
pub use capi::PA_PROP_MODULE_DESCRIPTION as MODULE_DESCRIPTION;
pub use capi::PA_PROP_MODULE_USAGE as MODULE_USAGE;
pub use capi::PA_PROP_MODULE_VERSION as MODULE_VERSION;
pub use capi::PA_PROP_FORMAT_RATE as FORMAT_RATE;
pub use capi::PA_PROP_FORMAT_CHANNELS as FORMAT_CHANNELS;
pub const FILTER_APPLY: &str = capi::PA_PROP_FILTER_APPLY;
pub const FILTER_SUPPRESS: &str = capi::PA_PROP_FILTER_SUPPRESS;
pub const DEVICE_INTENDED_ROLES: &str = capi::PA_PROP_DEVICE_INTENDED_ROLES;
pub const FORMAT_SAMPLE_FORMAT: &str = capi::PA_PROP_FORMAT_SAMPLE_FORMAT;
pub const FORMAT_CHANNEL_MAP: &str = capi::PA_PROP_FORMAT_CHANNEL_MAP;
}
pub struct Proplist {
pub(crate) ptr: *mut ProplistInternal,
weak: bool,
}
impl std::fmt::Debug for Proplist {
fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
write!(f, "[{}]", self.to_string_sep(", ").unwrap())
}
}
pub struct Iterator {
ptr: *const ProplistInternal,
state: *mut c_void,
}
impl Iterator {
pub fn new(pl: *const ProplistInternal) -> Self {
Self { ptr: pl, state: null_mut::<c_void>() }
}
}
impl std::iter::Iterator for Iterator {
type Item = String;
fn next(&mut self) -> Option<Self::Item> {
let state_actual = &mut self.state as *mut *mut c_void;
let key_ptr = unsafe { capi::pa_proplist_iterate(self.ptr, state_actual) };
if key_ptr.is_null() {
return None;
}
Some(unsafe { CStr::from_ptr(key_ptr).to_string_lossy().into_owned() })
}
}
impl IntoIterator for Proplist {
type Item = String;
type IntoIter = Iterator;
fn into_iter(self) -> Self::IntoIter {
self.iter()
}
}
impl Proplist {
pub fn new() -> Option<Self> {
let ptr = unsafe { capi::pa_proplist_new() };
if ptr.is_null() {
return None;
}
Some(Self::from_raw(ptr))
}
pub fn new_from_string(s: &str) -> Option<Self> {
let c_str = CString::new(s.clone()).unwrap();
let ptr = unsafe { capi::pa_proplist_from_string(c_str.as_ptr()) };
if ptr.is_null() {
return None;
}
Some(Self::from_raw(ptr))
}
pub(crate) fn from_raw(ptr: *mut ProplistInternal) -> Self {
assert_eq!(false, ptr.is_null());
Self { ptr: ptr, weak: false }
}
pub(crate) fn from_raw_weak(ptr: *mut ProplistInternal) -> Self {
assert_eq!(false, ptr.is_null());
Self { ptr: ptr, weak: true }
}
pub fn key_is_valid(key: &str) -> bool {
let c_key = CString::new(key.clone()).unwrap();
unsafe { capi::pa_proplist_key_valid(c_key.as_ptr()) != 0 }
}
pub fn sets(&mut self, key: &str, value: &str) -> Result<(), ()> {
let c_key = CString::new(key.clone()).unwrap();
let c_value = CString::new(value.clone()).unwrap();
match unsafe { capi::pa_proplist_sets(self.ptr, c_key.as_ptr(), c_value.as_ptr()) } {
0 => Ok(()),
_ => Err(()),
}
}
pub fn setp(&mut self, pair: &str) -> Result<(), ()> {
let c_pair = CString::new(pair.clone()).unwrap();
match unsafe { capi::pa_proplist_setp(self.ptr, c_pair.as_ptr()) } {
0 => Ok(()),
_ => Err(()),
}
}
pub fn set(&mut self, key: &str, data: &[u8]) -> Result<(), ()> {
let c_key = CString::new(key.clone()).unwrap();
match unsafe { capi::pa_proplist_set(self.ptr, c_key.as_ptr(), data.as_ptr() as *mut c_void,
data.len()) }
{
0 => Ok(()),
_ => Err(()),
}
}
pub fn gets(&self, key: &str) -> Option<String> {
let c_key = CString::new(key.clone()).unwrap();
let ptr = unsafe { capi::pa_proplist_gets(self.ptr, c_key.as_ptr()) };
if ptr.is_null() {
return None;
}
Some(unsafe { CStr::from_ptr(ptr).to_string_lossy().into_owned() })
}
pub fn get(&self, key: &str) -> Option<&[u8]> {
let c_key = CString::new(key.clone()).unwrap();
let mut data_ptr = null::<c_void>();
let mut nbytes: usize = 0;
if unsafe { capi::pa_proplist_get(self.ptr, c_key.as_ptr(), &mut data_ptr,
&mut nbytes) } != 0
{
return None;
}
if data_ptr.is_null() {
return None;
}
Some(unsafe { std::slice::from_raw_parts(data_ptr as *const u8, nbytes) })
}
pub fn merge(&mut self, other: &Self, mode: UpdateMode) {
unsafe { capi::pa_proplist_update(self.ptr, mode, other.ptr); }
}
pub fn unset(&mut self, key: &str) -> Result<(), PAErr> {
let c_key = CString::new(key.clone()).unwrap();
match unsafe { capi::pa_proplist_unset(self.ptr, c_key.as_ptr()) } {
0 => Ok(()),
e => Err(PAErr(e)),
}
}
pub fn unset_many(&mut self, keys: &[&str]) -> Option<u32> {
let mut c_keys: Vec<CString> = Vec::with_capacity(keys.len());
for k in keys {
c_keys.push(CString::new(k.clone()).unwrap());
}
let mut c_keys_ptrs: Vec<*const c_char> = Vec::with_capacity(c_keys.len() + 1);
for k in c_keys {
c_keys_ptrs.push(k.as_ptr());
}
c_keys_ptrs.push(null());
match unsafe { capi::pa_proplist_unset_many(self.ptr, c_keys_ptrs.as_ptr()) } {
r if r < 0 => None,
r => Some(r as u32),
}
}
pub fn iter(&self) -> Iterator {
Iterator::new(self.ptr)
}
pub fn to_string(&self) -> Option<String> {
let ptr = unsafe { capi::pa_proplist_to_string(self.ptr) };
if ptr.is_null() {
return None;
}
unsafe {
let ret = Some(CStr::from_ptr(ptr).to_string_lossy().into_owned());
capi::pa_xfree(ptr as *mut c_void);
ret
}
}
pub fn to_string_sep(&self, sep: &str) -> Option<String> {
let c_sep = CString::new(sep.clone()).unwrap();
let ptr = unsafe { capi::pa_proplist_to_string_sep(self.ptr, c_sep.as_ptr()) };
if ptr.is_null() {
return None;
}
unsafe {
let ret = Some(CStr::from_ptr(ptr).to_string_lossy().into_owned());
capi::pa_xfree(ptr as *mut c_void);
ret
}
}
pub fn contains(&self, key: &str) -> Option<bool> {
let c_key = CString::new(key.clone()).unwrap();
match unsafe { capi::pa_proplist_contains(self.ptr, c_key.as_ptr()) } {
0 => Some(false),
1 => Some(true),
_ => None,
}
}
pub fn clear(&mut self) {
unsafe { capi::pa_proplist_clear(self.ptr); }
}
pub fn len(&self) -> u32 {
unsafe { capi::pa_proplist_size(self.ptr) }
}
pub fn is_empty(&self) -> bool {
unsafe { capi::pa_proplist_isempty(self.ptr) == 0 }
}
pub fn equal_to(&self, to: &Self) -> bool {
unsafe { capi::pa_proplist_equal(self.ptr, to.ptr) != 0 }
}
}
impl Drop for Proplist {
fn drop(&mut self) {
if !self.weak {
unsafe { capi::pa_proplist_free(self.ptr) };
}
self.ptr = null_mut::<ProplistInternal>();
}
}
impl Clone for Proplist {
fn clone(&self) -> Self {
Self::from_raw(unsafe { capi::pa_proplist_copy(self.ptr) })
}
}