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
// Copyright 2017 Lyndon Brown
//
// This file is part of the PulseAudio Rust language binding.
//
// Licensed under the MIT license or the Apache license (version 2.0), at your option. You may not
// copy, modify, or distribute this file except in compliance with said license. You can find copies
// of these licenses either in the LICENSE-MIT and LICENSE-APACHE files, or alternatively at
// <http://opensource.org/licenses/MIT> and <http://www.apache.org/licenses/LICENSE-2.0>
// respectively.
//
// Portions of documentation are copied from the LGPL 2.1+ licensed PulseAudio C headers on a
// fair-use basis, as discussed in the overall project readme (available in the git repository).
//! A binding for the PulseAudio binding ‘simple’ interface (`libpulse-simple` system library).
//!
//! # About
//!
//! This binding enables Rust projects to make use of the ‘simple’ interface of the [PulseAudio]
//! client system library. It builds upon the [separate raw FFI crate][sys] to provide a more
//! “Rusty” interface.
//!
//! The ‘simple’ interface provides a simple but limited synchronous playback and recording API. It
//! is a synchronous, simplified wrapper around the standard asynchronous API.
//!
//! Note that you will need components of the primary [`libpulse-binding`] crate to make use of
//! this.
//!
//! # Introduction
//!
//! The simple API is designed for applications with very basic sound playback or capture needs. It
//! can only support a single stream per connection and has no support for handling of complex
//! features like events, channel mappings and volume control. It is, however, very simple to use
//! and quite sufficient for many programs.
//!
//! # Usage
//!
//! Start by adding a dependency on the crate, along with the main binding crate, in your program’s
//! `Cargo.toml` file. Note that it is recommended that you rename the crates such that you can
//! refer to them by shorter names within your code (such as `pulse` and `psimple` as used below).
//! Such renaming can be done [within your `Cargo.toml` file][rename] with cargo version 1.31 or
//! newer, or otherwise with `extern crate` statements.
//!
//! Finally, establish a connection, as below.
//!
//! # Connecting
//!
//! The first step before using the sound system is to connect to the server. This is normally done
//! this way:
//!
//! ```rust
//! # extern crate libpulse_binding as pulse;
//! # extern crate libpulse_simple_binding as psimple;
//! #
//! use psimple::Simple;
//! use pulse::stream::Direction;
//! use pulse::sample::{Spec, Format};
//!
//! # fn main() {
//! let spec = Spec {
//! format: Format::S16NE,
//! channels: 2,
//! rate: 44100,
//! };
//! assert!(spec.is_valid());
//!
//! let s = Simple::new(
//! None, // Use the default server
//! "FooApp", // Our application’s name
//! Direction::Playback, // We want a playback stream
//! None, // Use the default device
//! "Music", // Description of our stream
//! &spec, // Our sample format
//! None, // Use default channel map
//! None // Use default buffering attributes
//! ).unwrap();
//! # }
//! ```
//!
//! # Transferring data
//!
//! Once the connection is established to the server, data can start flowing. Using the connection
//! is very similar to the normal read() and write() system calls using [`Simple::read()`] and
//! [`Simple::write()`] methods of the [`Simple`] object. Note that these operations always block.
//!
//! # Buffer control
//!
//! * [`Simple::get_latency()`]: Will return the total latency of the playback or record pipeline,
//! respectively.
//! * [`Simple::flush()`]: Will throw away all data currently in buffers.
//!
//! If a playback stream is used then the following operation is available:
//!
//! * [`Simple::drain()`]: Will wait for all sent data to finish playing.
//!
//! # Cleanup
//!
//! Once playback or capture is complete, the connection should be closed and resources freed. This
//! is done automatically once the [`Simple`] object is dropped.
//!
//! [sys]: https://docs.rs/libpulse-simple-sys
//! [`libpulse-binding`]: https://docs.rs/libpulse-binding
//! [PulseAudio]: https://en.wikipedia.org/wiki/PulseAudio
//! [rename]: https://doc.rust-lang.org/1.31.0/cargo/reference/specifying-dependencies.html#renaming-dependencies-in-cargotoml
#![doc(
html_logo_url = "https://github.com/jnqnfe/pulse-binding-rust/raw/master/logo.svg",
html_favicon_url = "https://github.com/jnqnfe/pulse-binding-rust/raw/master/favicon.ico"
)]
#![warn(missing_docs)]
#![cfg_attr(docsrs, feature(doc_cfg))]
extern crate libpulse_binding as pulse;
extern crate libpulse_sys as pcapi;
extern crate libpulse_simple_sys as capi;
use std::os::raw::{c_char, c_void};
use std::{ffi::CString, ptr::null};
use std::mem;
use pulse::error::{Code, PAErr};
use pulse::time::MicroSeconds;
use pulse::{stream, sample, channelmap, def};
use capi::pa_simple as SimpleInternal;
/// An opaque simple connection object.
pub struct Simple {
/// The actual C object.
ptr: *mut SimpleInternal,
}
unsafe impl Send for Simple {}
unsafe impl Sync for Simple {}
impl Simple {
/// Creates a new connection to the server.
///
/// # Params
///
/// * `server`: Server name, or `None` for default.
/// * `name`: A descriptive name for this client (application name, ...).
/// * `dir`: Open this stream for recording or playback?
/// * `dev`: Sink (resp. source) name, or `None` for default.
/// * `stream_name`: A descriptive name for this stream (application name, song title, ...).
/// * `ss`: The sample type to use.
/// * `map`: The channel map to use, or `None` for default.
/// * `attr`: Buffering attributes, or `None` for default.
pub fn new(server: Option<&str>, name: &str, dir: stream::Direction, dev: Option<&str>,
stream_name: &str, ss: &sample::Spec, map: Option<&channelmap::Map>,
attr: Option<&def::BufferAttr>) -> Result<Self, PAErr>
{
// Warning: New CStrings will be immediately freed if not bound to a variable, leading to
// as_ptr() giving dangling pointers!
let c_server = match server {
Some(server) => CString::new(server.clone()).unwrap(),
None => CString::new("").unwrap(),
};
let c_dev = match dev {
Some(dev) => CString::new(dev.clone()).unwrap(),
None => CString::new("").unwrap(),
};
let p_map = map.map_or(null::<pcapi::pa_channel_map>(), |m| m.as_ref());
let p_attr = attr.map_or(null::<pcapi::pa_buffer_attr>(), |a| a.as_ref());
let p_server = server.map_or(null::<c_char>(), |_| c_server.as_ptr() as *const c_char);
let p_dev = dev.map_or(null::<c_char>(), |_| c_dev.as_ptr() as *const c_char);
let c_name = CString::new(name.clone()).unwrap();
let c_stream_name = CString::new(stream_name.clone()).unwrap();
let mut error: i32 = 0;
let ptr = unsafe {
capi::pa_simple_new(
p_server,
c_name.as_ptr(),
dir,
p_dev,
c_stream_name.as_ptr(),
mem::transmute(ss),
p_map,
p_attr,
&mut error
)
};
match ptr.is_null() {
false => Ok(Self::from_raw(ptr)),
true => Err(PAErr(error)),
}
}
/// Creates a new `Simple` from an existing [`SimpleInternal`] pointer.
fn from_raw(ptr: *mut SimpleInternal) -> Self {
assert_eq!(false, ptr.is_null());
Self { ptr }
}
/// Writes some data to the server.
pub fn write(&self, data: &[u8]) -> Result<(), PAErr> {
let mut error: i32 = 0;
match unsafe { capi::pa_simple_write(self.ptr, data.as_ptr() as *mut c_void, data.len(),
&mut error) }
{
0 => Ok(()),
_ => Err(PAErr(error)),
}
}
/// Waits until all data already written is played by the daemon.
pub fn drain(&self) -> Result<(), PAErr> {
let mut error: i32 = 0;
match unsafe { capi::pa_simple_drain(self.ptr, &mut error) } {
0 => Ok(()),
_ => Err(PAErr(error)),
}
}
/// Reads some data from the server.
///
/// This function blocks until `data.len()` amount of data has been received from the server,
/// or until an error occurs.
pub fn read(&self, data: &mut [u8]) -> Result<(), PAErr> {
let mut error: i32 = 0;
match unsafe { capi::pa_simple_read(self.ptr, data.as_mut_ptr() as *mut c_void, data.len(),
&mut error) }
{
0 => Ok(()),
_ => Err(PAErr(error)),
}
}
/// Gets the playback or record latency.
pub fn get_latency(&self) -> Result<MicroSeconds, PAErr> {
let mut error: i32 = 0;
let ret = unsafe { capi::pa_simple_get_latency(self.ptr, &mut error) };
if error != 0 {
return Err(PAErr(error));
}
match ret {
pcapi::PA_USEC_INVALID => Err(Code::Invalid.into()),
r => Ok(MicroSeconds(r)),
}
}
/// Flushes the playback or record buffer.
///
/// This discards any audio in the buffer.
pub fn flush(&self) -> Result<(), PAErr> {
let mut error: i32 = 0;
match unsafe { capi::pa_simple_flush(self.ptr, &mut error) } {
0 => Ok(()),
_ => Err(PAErr(error)),
}
}
}
impl Drop for Simple {
fn drop(&mut self) {
// Close and free the connection to the server.
unsafe { capi::pa_simple_free(self.ptr) };
self.ptr = null::<SimpleInternal>() as *mut SimpleInternal;
}
}