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
//! Global definitions // This file is part of the PulseAudio Rust language binding. // // Copyright (c) 2017 Lyndon Brown // // This library 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. // // This library 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 this library; // if not, see <http://www.gnu.org/licenses/>. use std; use capi; use std::os::raw::c_void; use time::{Timeval, MicroSeconds}; pub use capi::PA_INVALID_INDEX as INVALID_INDEX; pub use capi::pa_device_type_t as Device; pub use capi::pa_port_available_t as PortAvailable; pub type FreeCb = extern "C" fn(p: *mut c_void); pub type RetvalActual = i32; /// A wrapper around integer 'quit return values' returned by PulseAudio. #[repr(C)] #[derive(Debug, Copy, Clone, PartialEq, Eq)] pub struct Retval(pub RetvalActual); /// Playback and record buffer metrics #[repr(C)] #[derive(Debug, Default, Copy, Clone, PartialEq, Eq)] pub struct BufferAttr { /// Maximum length of the buffer in bytes. /// /// Setting this to `std::u32::MAX` will initialize this to the maximum value supported by the /// server, which is recommended. In strict low-latency playback scenarios you might want to set /// this to a lower value, likely together with the [`stream::flags::ADJUST_LATENCY`] flag. If /// you do so, you ensure that the latency doesn't grow beyond what is acceptable for the use /// case, at the cost of getting more underruns if the latency is lower than what the server can /// reliably handle. /// /// [`stream::flags::ADJUST_LATENCY`]: ../stream/flags/constant.ADJUST_LATENCY.html pub maxlength: u32, /// Target length of the buffer (playback only). The server tries to assure that at least /// `tlength` bytes are always available in the per-stream server-side playback buffer. The /// server will only send requests for more data as long as the buffer has less than this number /// of bytes of data. /// /// It is recommended to set this to `std::u32::MAX`, which will initialize this to a value that /// is deemed sensible by the server. However, this value will default to something like 2s; for /// applications that have specific latency requirements this value should be set to the maximum /// latency that the application can deal with. /// /// When [`stream::flags::ADJUST_LATENCY`] is not set this value will influence only the /// per-stream playback buffer size. When [`stream::flags::ADJUST_LATENCY`] is set, the overall /// latency of the sink plus the playback buffer size is configured to this value. Set /// [`stream::flags::ADJUST_LATENCY`] if you are interested in adjusting the overall latency. /// Don't set it if you are interested in configuring the server-side per-stream playback buffer /// size. /// /// [`stream::flags::ADJUST_LATENCY`]: ../stream/flags/constant.ADJUST_LATENCY.html pub tlength: u32, /// Pre-buffering (playback only). The server does not start with playback before at least /// `prebuf` bytes are available in the buffer. It is recommended to set this to /// `std::u32::MAX`, which will initialize this to the same value as `tlength`, whatever that /// may be. /// /// Initialize to `0` to enable manual start/stop control of the stream. This means that /// playback will not stop on underrun and playback will not start automatically, instead /// [`stream::Stream::cork`] needs to be called explicitly. If you set this value to `0` you /// should also set [`stream::flags::START_CORKED`]. Should underrun occur, the read index of /// the output buffer overtakes the write index, and hence the fill level of the buffer is /// negative. /// /// Start of playback can be forced using [`stream::Stream::trigger`] even though the prebuffer /// size hasn't been reached. If a buffer underrun occurs, this prebuffering will be again /// enabled. /// /// [`stream::Stream::cork`]: ../stream/struct.Stream.html#method.cork /// [`stream::Stream::trigger`]: ../stream/struct.Stream.html#method.trigger /// [`stream::flags::START_CORKED`]: ../stream/flags/constant.START_CORKED.html pub prebuf: u32, /// Minimum request (playback only). The server does not request less than `minreq` bytes from /// the client, instead it waits until the buffer is free enough to request more bytes at once. /// /// It is recommended to set this to `std::u32::MAX`, which will initialize this to a value that /// is deemed sensible by the server. This should be set to a value that gives PulseAudio enough /// time to move the data from the per-stream playback buffer into the hardware playback buffer. pub minreq: u32, /// Fragment size (recording only). The server sends data in blocks of `fragsize` bytes size. /// /// Large values diminish interactivity with other operations on the connection context but /// decrease control overhead. It is recommended to set this to `std::u32::MAX`, which will /// initialize this to a value that is deemed sensible by the server. However, this value will /// default to something like 2s; For applications that have specific latency requirements this /// value should be set to the maximum latency that the application can deal with. /// /// If [`stream::flags::ADJUST_LATENCY`] is set the overall source latency will be adjusted /// according to this value. If it is not set the source latency is left unmodified. /// /// [`stream::flags::ADJUST_LATENCY`]: ../stream/flags/constant.ADJUST_LATENCY.html pub fragsize: u32, } /// A structure for all kinds of timing information of a stream. /// /// See [`stream::Stream::update_timing_info`] and [`stream::Stream::get_timing_info`]. /// /// The total output latency a sample that is written with [`stream::Stream::write`] takes to be /// played may be estimated by: /// /// `` /// sink_usec + buffer_usec + transport_usec /// `` /// /// (Where `buffer_usec` is defined as the result of passing ``write_index - read_index`` to /// [`sample::Spec::bytes_to_usec`]). The output buffer which `buffer_usec` relates to may be /// manipulated freely (with [`stream::Stream::write`]'s `seek` argument, [`stream::Stream::flush`] /// and friends), the buffers `sink_usec` and `source_usec` relate to are first-in first-out (FIFO) /// buffers which cannot be flushed or manipulated in any way. The total input latency a sample that /// is recorded takes to be delivered to the application is: /// /// `` /// source_usec + buffer_usec + transport_usec - sink_usec /// `` /// /// (Take care of sign issues!). When connected to a monitor source `sink_usec` contains the latency /// of the owning sink. The two latency estimations described here are implemented in /// [`stream::Stream::get_latency`]. /// /// All time values are in the sound card clock domain, unless noted otherwise. The sound card clock /// usually runs at a slightly different rate than the system clock. /// /// Please note that this structure can be extended as part of evolutionary API updates at any time /// in any new release. /// /// [`sample::Spec::bytes_to_usec`]: ../sample/struct.Spec.html#method.bytes_to_usec /// [`stream::Stream::update_timing_info`]: ../stream/struct.Stream.html#method.update_timing_info /// [`stream::Stream::get_timing_info`]: ../stream/struct.Stream.html#method.get_timing_info /// [`stream::Stream::write`]: ../stream/struct.Stream.html#method.write /// [`stream::Stream::flush`]: ../stream/struct.Stream.html#method.flush /// [`stream::Stream::get_latency`]: ../stream/struct.Stream.html#method.get_latency #[repr(C)] #[derive(Debug, Copy, Clone, PartialEq, Eq)] pub struct TimingInfo { /// The system clock time when this timing info structure was current. pub timestamp: Timeval, /// Non-zero if the local and the remote machine have synchronized clocks. If synchronized /// clocks are detected `transport_usec` becomes much more reliable. However, the code that /// detects synchronized clocks is very limited and unreliable itself. pub synchronized_clocks: i32, /// Time in usecs a sample takes to be played on the sink. For playback streams and record /// streams connected to a monitor source. pub sink_usec: MicroSeconds, /// Time in usecs a sample takes from being recorded to being delivered to the application. Only /// for record streams. pub source_usec: MicroSeconds, /// Estimated time in usecs a sample takes to be transferred to/from the daemon. For both /// playback and record streams. pub transport_usec: MicroSeconds, /// Non-zero when the stream is currently not underrun and data is being passed on to the /// device. Only for playback streams. This field does not say whether the data is actually /// already being played. To determine this check whether `since_underrun` (converted to usec) /// is larger than `sink_usec`. pub playing: i32, /// Non-zero if `write_index` is not up-to-date because a local write command that corrupted it /// has been issued in the time since this latency info was current. Only write commands with /// [`stream::SeekMode::RelativeOnRead`] and [`stream::SeekMode::RelativeEnd`] can corrupt /// `write_index`. /// /// [`stream::SeekMode::RelativeOnRead`]: ../stream/enum.SeekMode.html#RelativeOnRead.v /// [`stream::SeekMode::RelativeEnd`]: ../stream/enum.SeekMode.html#RelativeEnd.v pub write_index_corrupt: i32, /// Current write index into the playback buffer in bytes. /// /// Think twice before using this for seeking purposes: it might be out of date at the time you /// want to use it. Consider using [`stream::SeekMode::Relative`] instead. /// /// [`stream::SeekMode::Relative`]: ../stream/enum.SeekMode.html#Relative.v pub write_index: i64, /// Non-zero if `read_index` is not up-to-date because a local pause or flush request that /// corrupted it has been issued in the time since this latency info was current. pub read_index_corrupt: i32, /// Current read index into the playback buffer in bytes. /// /// Think twice before using this for seeking purposes: it might be out of date at the time you /// want to use it. Consider using [`stream::SeekMode::RelativeOnRead`] instead. /// /// [`stream::SeekMode::RelativeOnRead`]: ../stream/enum.SeekMode.html#RelativeOnRead.v pub read_index: i64, /// The configured latency for the sink. pub configured_sink_usec: MicroSeconds, /// The configured latency for the source. pub configured_source_usec: MicroSeconds, /// Bytes that were handed to the sink since the last underrun happened, or since playback /// started again after the last underrun. `playing` will tell you which case it is. pub since_underrun: i64, } /// A structure for the spawn API. /// /// This may be used to integrate auto spawned daemons into your application. For more information /// see [`context::Context::connect`]. When spawning a new child process the `waitpid()` is used on /// the child's PID. The spawn routine will not block or ignore SIGCHLD signals, since this cannot /// be done in a thread compatible way. You might have to do this in prefork/postfork. /// /// [`context::Context::connect`]: ../context/struct.Context.html#method.connect #[repr(C)] #[derive(Debug)] pub struct SpawnApi { /// Is called just before the fork in the parent process. pub prefork: Option<extern "C" fn()>, /// Is called immediately after the fork in the parent process. pub postfork: Option<extern "C" fn()>, /// Is called immediately after the fork in the child process. /// /// It is not safe to close all file descriptors in this function unconditionally, since a UNIX /// socket (created using socketpair()) is passed to the new process. pub atfork: Option<extern "C" fn()>, } pub type SinkFlagSet = capi::def::pa_sink_flags_t; /// Special sink flags. pub mod sink_flags { use capi; use super::SinkFlagSet; /// Flag to pass when no specific options are needed pub const NOFLAGS: SinkFlagSet = capi::PA_SINK_NOFLAGS; /// Supports hardware volume control. This is a dynamic flag and may change at runtime after the /// sink has initialized. pub const HW_VOLUME_CTRL: SinkFlagSet = capi::PA_SINK_HW_VOLUME_CTRL; /// Supports latency querying pub const LATENCY: SinkFlagSet = capi::PA_SINK_LATENCY; /// Is a hardware sink of some kind, in contrast to "virtual"/software sinks. pub const HARDWARE: SinkFlagSet = capi::PA_SINK_HARDWARE; /// Is a networked sink of some kind. pub const NETWORK: SinkFlagSet = capi::PA_SINK_NETWORK; /// Supports hardware mute control. This is a dynamic flag and may change at runtime after the /// sink has initialized. pub const HW_MUTE_CTRL: SinkFlagSet = capi::PA_SINK_HW_MUTE_CTRL; /// Volume can be translated to dB with [`::volume::sw_volume_to_db`]. This is a dynamic flag /// and may change at runtime after the sink has initialized. /// /// [`::volume::sw_volume_to_db`]: ../../volume/fn.sw_volume_to_db.html pub const DECIBEL_VOLUME: SinkFlagSet = capi::PA_SINK_DECIBEL_VOLUME; /// This sink is in flat volume mode, i.e. always the maximum of the volume of all connected /// inputs. pub const FLAT_VOLUME: SinkFlagSet = capi::PA_SINK_FLAT_VOLUME; /// The latency can be adjusted dynamically depending on the needs of the connected streams. pub const DYNAMIC_LATENCY: SinkFlagSet = capi::PA_SINK_DYNAMIC_LATENCY; /// The sink allows setting what formats are supported by the connected hardware. The actual /// functionality to do this might be provided by an extension. pub const SET_FORMATS: SinkFlagSet = capi::PA_SINK_SET_FORMATS; } #[repr(C)] #[derive(Debug, Copy, Clone, PartialEq, Eq)] pub enum SinkState { /// This state is used when the server does not support sink state introspection. Invalid = -1, /// Running, sink is playing and used by at least one non-corked sink-input. Running = 0, /// When idle, the sink is playing but there is no non-corked sink-input attached to it. Idle = 1, /// When suspended, actual sink access can be closed, for instance. Suspended = 2, } impl From<SinkState> for capi::pa_sink_state_t { fn from(s: SinkState) -> Self { unsafe { std::mem::transmute(s) } } } impl From<capi::pa_sink_state_t> for SinkState { fn from(s: capi::pa_sink_state_t) -> Self { unsafe { std::mem::transmute(s) } } } impl SinkState { /// Returns `true` if sink is playing: running or idle. pub fn is_opened(self) -> bool { self == SinkState::Running || self == SinkState::Idle } /// Returns `true` if sink is running. pub fn is_running(self) -> bool { self == SinkState::Running } } pub type SourceFlagSet = capi::def::pa_source_flags_t; /// Special source flags. pub mod source_flags { use capi; use super::SourceFlagSet; /// Flag to pass when no specific options are needed pub const NOFLAGS: SourceFlagSet = capi::PA_SOURCE_NOFLAGS; /// Supports hardware volume control. This is a dynamic flag and may change at runtime after the /// source has initialized. pub const HW_VOLUME_CTRL: SourceFlagSet = capi::PA_SOURCE_HW_VOLUME_CTRL; /// Supports latency querying pub const LATENCY: SourceFlagSet = capi::PA_SOURCE_LATENCY; /// Is a hardware source of some kind, in contrast to "virtual"/software source. pub const HARDWARE: SourceFlagSet = capi::PA_SOURCE_HARDWARE; /// Is a networked source of some kind. pub const NETWORK: SourceFlagSet = capi::PA_SOURCE_NETWORK; /// Supports hardware mute control. This is a dynamic flag and may change at runtime after the /// source has initialized. pub const HW_MUTE_CTRL: SourceFlagSet = capi::PA_SOURCE_HW_MUTE_CTRL; /// Volume can be translated to dB with [`::volume::sw_volume_to_db`]. This is a dynamic flag /// and may change at runtime after the sink has initialized. Volume can be translated to dB /// with [`::volume::sw_volume_to_db`]. This is a dynamic flag and may change at runtime after /// the source has initialized. /// /// [`::volume::sw_volume_to_db`]: ../../volume/fn.sw_volume_to_db.html pub const DECIBEL_VOLUME: SourceFlagSet = capi::PA_SOURCE_DECIBEL_VOLUME; /// The latency can be adjusted dynamically depending on the needs of the connected streams. pub const DYNAMIC_LATENCY: SourceFlagSet = capi::PA_SOURCE_DYNAMIC_LATENCY; /// This source is in flat volume mode, i.e. always the maximum of the volume of all connected /// outputs. pub const FLAT_VOLUME: SourceFlagSet = capi::PA_SOURCE_FLAT_VOLUME; } /// Source state. #[repr(C)] #[derive(Debug, Copy, Clone, PartialEq, Eq)] pub enum SourceState { /// This state is used when the server does not support source state introspection. Invalid = -1, /// Running, source is recording and used by at least one non-corked source-output. Running = 0, /// When idle, the source is still recording but there is no non-corked source-output. Idle = 1, /// When suspended, actual source access can be closed, for instance. Suspended = 2, } impl From<SourceState> for capi::pa_source_state_t { fn from(s: SourceState) -> Self { unsafe { std::mem::transmute(s) } } } impl From<capi::pa_source_state_t> for SourceState { fn from(s: capi::pa_source_state_t) -> Self { unsafe { std::mem::transmute(s) } } } impl SourceState { /// Returns `true` if source is recording: running or idle. pub fn is_opened(self) -> bool { self == SourceState::Running || self == SourceState::Idle } /// Returns `true` if source is running. pub fn is_running(self) -> bool { self == SourceState::Running } }