libpulse_simple_sys/
lib.rs

1// Copyright 2017 Lyndon Brown
2//
3// This file is part of the PulseAudio Rust language linking library.
4//
5// Licensed under the MIT license or the Apache license (version 2.0), at your option. You may not
6// copy, modify, or distribute this file except in compliance with said license. You can find copies
7// of these licenses either in the LICENSE-MIT and LICENSE-APACHE files, or alternatively at
8// <http://opensource.org/licenses/MIT> and <http://www.apache.org/licenses/LICENSE-2.0>
9// respectively.
10//
11// Portions of documentation are copied from the LGPL 2.1+ licensed PulseAudio C headers on a
12// fair-use basis, as discussed in the overall project readme (available in the git repository).
13
14//! PulseAudio FFI binding for the `libpulse-simple` system library.
15//!
16//! This crate does nothing more than offer a simple FFI binding to the C API of the [PulseAudio]
17//! client system library, specifically the “simple” interface component only. Please note that
18//! there is a “higher-level” binding available (the [`libpulse-simple-binding`] crate), built on
19//! top of this, which offers a more Rust-oriented interface.
20//!
21//! Unlike the “higher-level” binding just mentioned, virtually no documentation is provided here.
22//! Things that *are* documented here are typically only those directly re-exported by the
23//! “higher-level” binding. Please see either the equivalent documentation in that, or the
24//! documentation of the actual PulseAudio C header files, if you need documentation.
25//!
26//! [`libpulse-simple-binding`]: https://docs.rs/libpulse-simple-binding
27//! [PulseAudio]: https://en.wikipedia.org/wiki/PulseAudio
28
29#![doc(
30    html_logo_url = "https://github.com/jnqnfe/pulse-binding-rust/raw/master/logo.svg",
31    html_favicon_url = "https://github.com/jnqnfe/pulse-binding-rust/raw/master/favicon.ico"
32)]
33
34#![allow(non_camel_case_types, non_snake_case)]
35
36#![cfg_attr(docsrs, feature(doc_cfg))]
37
38extern crate libpulse_sys as pulse;
39
40use std::os::raw::{c_char, c_void};
41
42/// An opaque simple connection object.
43#[repr(C)] pub struct pa_simple { _private: [u8; 0] }
44
45#[rustfmt::skip]
46#[link(name = "pulse-simple")]
47extern "C" {
48    pub fn pa_simple_new(server: *const c_char, name: *const c_char, dir: pulse::stream::pa_stream_direction_t, dev: *const c_char, stream_name: *const c_char, ss: *const pulse::sample::pa_sample_spec, map: *const pulse::channelmap::pa_channel_map, attr: *const pulse::def::pa_buffer_attr, error: *mut i32) -> *mut pa_simple;
49    pub fn pa_simple_free(s: *mut pa_simple);
50    pub fn pa_simple_write(s: *mut pa_simple, data: *const c_void, bytes: usize, error: *mut i32) -> i32;
51    pub fn pa_simple_drain(s: *mut pa_simple, error: *mut i32) -> i32;
52    pub fn pa_simple_read(s: *mut pa_simple, data: *mut c_void, bytes: usize, error: *mut i32) -> i32;
53    pub fn pa_simple_get_latency(s: *mut pa_simple, error: *mut i32) -> pulse::sample::pa_usec_t;
54    pub fn pa_simple_flush(s: *mut pa_simple, error: *mut i32) -> i32;
55}
libpulse_simple_sys/lib.rs

libpulse_simple_sys/
lib.rs
