cubeb_sys/
device.rs

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
// Copyright © 2017-2018 Mozilla Foundation
//
// This program is made available under an ISC-style license.  See the
// accompanying file LICENSE for details.

use callbacks::cubeb_device_collection_changed_callback;
use context::cubeb;
use std::ffi::CStr;
use std::os::raw::{c_char, c_int, c_uint, c_void};
use std::{fmt, mem, ptr};

cubeb_enum! {
    pub enum cubeb_device_fmt {
        CUBEB_DEVICE_FMT_S16LE          = 0x0010,
        CUBEB_DEVICE_FMT_S16BE          = 0x0020,
        CUBEB_DEVICE_FMT_F32LE          = 0x1000,
        CUBEB_DEVICE_FMT_F32BE          = 0x2000,
    }
}

#[cfg(target_endian = "big")]
pub const CUBEB_DEVICE_FMT_S16NE: cubeb_device_fmt = CUBEB_DEVICE_FMT_S16BE;
#[cfg(target_endian = "big")]
pub const CUBEB_DEVICE_FMT_F32NE: cubeb_device_fmt = CUBEB_DEVICE_FMT_F32BE;
#[cfg(target_endian = "little")]
pub const CUBEB_DEVICE_FMT_S16NE: cubeb_device_fmt = CUBEB_DEVICE_FMT_S16LE;
#[cfg(target_endian = "little")]
pub const CUBEB_DEVICE_FMT_F32NE: cubeb_device_fmt = CUBEB_DEVICE_FMT_F32LE;

pub const CUBEB_DEVICE_FMT_S16_MASK: cubeb_device_fmt =
    CUBEB_DEVICE_FMT_S16LE | CUBEB_DEVICE_FMT_S16BE;
pub const CUBEB_DEVICE_FMT_F32_MASK: cubeb_device_fmt =
    CUBEB_DEVICE_FMT_F32LE | CUBEB_DEVICE_FMT_F32BE;
pub const CUBEB_DEVICE_FMT_ALL: cubeb_device_fmt =
    CUBEB_DEVICE_FMT_S16_MASK | CUBEB_DEVICE_FMT_F32_MASK;

fn fmt_device_fmt(f: &cubeb_device_fmt) -> &'static str {
    match *f {
        CUBEB_DEVICE_FMT_S16LE => "S16LE",
        CUBEB_DEVICE_FMT_S16BE => "S16BE",
        CUBEB_DEVICE_FMT_F32LE => "F32LE",
        CUBEB_DEVICE_FMT_F32BE => "F32BE",
        CUBEB_DEVICE_FMT_S16_MASK => "S16LE | S16BE",
        CUBEB_DEVICE_FMT_F32_MASK => "F32LE | F32BE",
        CUBEB_DEVICE_FMT_ALL => "S16LE | S16BE | F32LE | F32BE",
        _ => "Unexpected device format",
    }
}

cubeb_enum! {
    pub enum cubeb_device_pref  {
        CUBEB_DEVICE_PREF_NONE          = 0x00,
        CUBEB_DEVICE_PREF_MULTIMEDIA    = 0x01,
        CUBEB_DEVICE_PREF_VOICE         = 0x02,
        CUBEB_DEVICE_PREF_NOTIFICATION  = 0x04,
        CUBEB_DEVICE_PREF_ALL           = 0x0F,
    }
}

fn fmt_device_pref(p: &cubeb_device_pref) -> &'static str {
    match *p {
        CUBEB_DEVICE_PREF_NONE => "None",
        CUBEB_DEVICE_PREF_MULTIMEDIA => "Multimedia",
        CUBEB_DEVICE_PREF_VOICE => "Voice",
        CUBEB_DEVICE_PREF_NOTIFICATION => "Notification",
        CUBEB_DEVICE_PREF_ALL => "All",
        _ => "Unexpected",
    }
}

cubeb_enum! {
    pub enum cubeb_device_state {
        CUBEB_DEVICE_STATE_DISABLED,
        CUBEB_DEVICE_STATE_UNPLUGGED,
        CUBEB_DEVICE_STATE_ENABLED,
    }
}

fn fmt_device_state(s: &cubeb_device_state) -> &'static str {
    match *s {
        CUBEB_DEVICE_STATE_DISABLED => "Disabled",
        CUBEB_DEVICE_STATE_UNPLUGGED => "Unplugged",
        CUBEB_DEVICE_STATE_ENABLED => "Enabled",
        _ => "Unexpected",
    }
}

cubeb_enum! {
    pub enum cubeb_device_type {
        CUBEB_DEVICE_TYPE_UNKNOWN,
        CUBEB_DEVICE_TYPE_INPUT,
        CUBEB_DEVICE_TYPE_OUTPUT,
    }
}

fn fmt_device_type(t: &cubeb_device_type) -> &'static str {
    match *t {
        CUBEB_DEVICE_TYPE_UNKNOWN => "Unknown",
        CUBEB_DEVICE_TYPE_INPUT => "Input",
        CUBEB_DEVICE_TYPE_OUTPUT => "Output",
        t if t == CUBEB_DEVICE_TYPE_INPUT | CUBEB_DEVICE_TYPE_OUTPUT => "Input+Output",
        _ => "Unexpected",
    }
}

pub type cubeb_devid = *const c_void;

#[repr(C)]
pub struct cubeb_device {
    pub output_name: *mut c_char,
    pub input_name: *mut c_char,
}

// Explicit Debug impl to work around bug in ctest
impl Default for cubeb_device {
    fn default() -> Self {
        unsafe { mem::zeroed() }
    }
}

impl fmt::Debug for cubeb_device {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        f.debug_struct("cubeb_device")
            .field("output_name", &self.output_name)
            .field("input_name", &self.input_name)
            .finish()
    }
}

#[repr(C)]
pub struct cubeb_device_collection {
    pub device: *mut cubeb_device_info,
    pub count: usize,
}

impl Default for cubeb_device_collection {
    fn default() -> Self {
        unsafe { mem::zeroed() }
    }
}

impl fmt::Debug for cubeb_device_collection {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        let devices = ptr::slice_from_raw_parts(self.device, self.count);
        let devices = unsafe { &*devices };
        let mut dbg = f.debug_list();
        for d in devices {
            dbg.entry(d);
        }
        dbg.finish()
    }
}

#[repr(C)]
pub struct cubeb_device_info {
    pub devid: cubeb_devid,
    pub device_id: *const c_char,
    pub friendly_name: *const c_char,
    pub group_id: *const c_char,
    pub vendor_name: *const c_char,

    pub device_type: cubeb_device_type,
    pub state: cubeb_device_state,
    pub preferred: cubeb_device_pref,

    pub format: cubeb_device_fmt,
    pub default_format: cubeb_device_fmt,
    pub max_channels: c_uint,
    pub default_rate: c_uint,
    pub max_rate: c_uint,
    pub min_rate: c_uint,

    pub latency_lo: c_uint,
    pub latency_hi: c_uint,
}

impl Default for cubeb_device_info {
    fn default() -> Self {
        unsafe { mem::zeroed() }
    }
}

impl fmt::Debug for cubeb_device_info {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        fn optional_c_str(c_str: *const c_char) -> Option<*const c_char> {
            (unsafe { c_str.as_ref() }).map(ptr::from_ref)
        }
        f.debug_struct("cubeb_device_info")
            .field("devid", &(self.devid as u32))
            .field(
                "device_id",
                &optional_c_str(self.device_id).map(|p| unsafe { CStr::from_ptr(p) }),
            )
            .field(
                "friendly_name",
                &optional_c_str(self.friendly_name).map(|p| unsafe { CStr::from_ptr(p) }),
            )
            .field(
                "group_id",
                &optional_c_str(self.group_id).map(|p| unsafe { CStr::from_ptr(p) }),
            )
            .field(
                "vendor_name",
                &optional_c_str(self.vendor_name).map(|p| unsafe { CStr::from_ptr(p) }),
            )
            .field("device_type", &fmt_device_type(&self.device_type))
            .field("state", &fmt_device_state(&self.state))
            .field("preferred", &fmt_device_pref(&self.preferred))
            .field("format", &fmt_device_fmt(&self.format))
            .field("default_format", &fmt_device_fmt(&self.default_format))
            .field("max_channels", &self.max_channels)
            .field("default_rate", &self.default_rate)
            .field("max_rate", &self.max_rate)
            .field("min_rate", &self.min_rate)
            .field("latency_lo", &self.latency_lo)
            .field("latency_hi", &self.latency_hi)
            .finish()
    }
}

extern "C" {
    pub fn cubeb_enumerate_devices(
        context: *mut cubeb,
        devtype: cubeb_device_type,
        collection: *mut cubeb_device_collection,
    ) -> c_int;
    pub fn cubeb_device_collection_destroy(
        context: *mut cubeb,
        collection: *mut cubeb_device_collection,
    ) -> c_int;
    pub fn cubeb_register_device_collection_changed(
        context: *mut cubeb,
        devtype: cubeb_device_type,
        callback: cubeb_device_collection_changed_callback,
        user_ptr: *mut c_void,
    ) -> c_int;
}