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
// 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). //! Daemon introspection event subscription subsystem. //! //! # Overview //! //! The application can be notified, asynchronously, whenever the internal layout of the server //! changes. The set of facilities and operations for which notifications are generated are //! enumerated in [`Facility`] and [`Operation`]. //! //! The application sets the notification mask using [`context::Context::subscribe`] and the //! callback function that will be called whenever a notification occurs using //! [`context::Context::set_subscribe_callback`]. //! //! The mask provided to [`context::Context::subscribe`] can be created by binary ORing a set of //! values, either produced with [`Facility::to_interest_mask`], or more simply with the provided //! constants in the [`subscription_masks`] submodule. //! //! The callback will be called with event type information representing the event that caused the //! callback, detailing *facility* and *operation*, where for instance `Facility::Source` with //! `Operation::New` indicates that a new source was added. //! //! # Example //! //! Subscribe (declare interest): //! //! ```rust,ignore //! use pulse::context::subscribe::subscription_masks; //! //! let interest = subscription_masks::SINK | //! subscription_masks::SOURCE; //! //! let op = my_context.subscribe( //! interest, // Our interest mask //! |_| {} // We won’t bother doing anything in the success callback in this example //! ); //! ``` //! //! [`Facility`]: enum.Facility.html //! [`Operation`]: enum.Operation.html //! [`Facility::to_interest_mask`]: enum.Facility.html#method.to_interest_mask //! [`context::Context::subscribe`]: ../struct.Context.html#method.subscribe //! [`context::Context::set_subscribe_callback`]: ../struct.Context.html#method.set_subscribe_callback //! [`subscription_masks`]: subscription_masks/index.html use std::os::raw::c_void; use super::{ContextInternal, Context}; use crate::operation; use crate::callbacks::{box_closure_get_capi_ptr, MultiUseCallback}; pub use capi::context::subscribe::pa_subscription_event_type_t as EventType; pub use capi::PA_SUBSCRIPTION_EVENT_FACILITY_MASK as FACILITY_MASK; pub use capi::PA_SUBSCRIPTION_EVENT_TYPE_MASK as OPERATION_MASK; /// A set of facility masks, passed to /// [`Context::subscribe`](../struct.Context.html#method.subscribe). Convert a /// [`Facility`](enum.Facility.html) to a mask with [`facility_to_mask`](fn.facility_to_mask.html). pub type InterestMaskSet = capi::context::subscribe::pa_subscription_mask_t; /// A set of masks used for expressing which facilities you are interested in when subscribing. pub mod subscription_masks { use capi; use super::InterestMaskSet; pub const NULL: InterestMaskSet = capi::PA_SUBSCRIPTION_MASK_NULL; pub const SINK: InterestMaskSet = capi::PA_SUBSCRIPTION_MASK_SINK; pub const SOURCE: InterestMaskSet = capi::PA_SUBSCRIPTION_MASK_SOURCE; pub const SINK_INPUT: InterestMaskSet = capi::PA_SUBSCRIPTION_MASK_SINK_INPUT; pub const SOURCE_OUTPUT: InterestMaskSet = capi::PA_SUBSCRIPTION_MASK_SOURCE_OUTPUT; pub const MODULE: InterestMaskSet = capi::PA_SUBSCRIPTION_MASK_MODULE; pub const CLIENT: InterestMaskSet = capi::PA_SUBSCRIPTION_MASK_CLIENT; pub const SAMPLE_CACHE: InterestMaskSet = capi::PA_SUBSCRIPTION_MASK_SAMPLE_CACHE; pub const SERVER: InterestMaskSet = capi::PA_SUBSCRIPTION_MASK_SERVER; pub const MASK_CARD: InterestMaskSet = capi::PA_SUBSCRIPTION_MASK_CARD; pub const ALL: InterestMaskSet = capi::PA_SUBSCRIPTION_MASK_ALL; } /// Facility component of an event. #[repr(u32)] #[derive(Debug, Copy, Clone, PartialEq, Eq)] pub enum Facility { Sink = 0, Source = 1, SinkInput = 2, SourceOutput = 3, Module = 4, Client = 5, SampleCache = 6, /// Global server change, only occurring with /// [`Operation::Changed`](enum.Operation.html#Changed.v). Server = 7, /* NOTE: value `8` previously assigned, obsoleted */ Card = 9, } /// Operation component of an event. #[repr(u32)] #[derive(Debug, Copy, Clone, PartialEq, Eq)] pub enum Operation { /// A new object was created New = 0, /// A property of the object was modified Changed = 0x10, /// An object was removed Removed = 0x20, } impl Facility { fn from_int(value: u32) -> Option<Facility> { match value { 0 => Some(Facility::Sink), 1 => Some(Facility::Source), 2 => Some(Facility::SinkInput), 3 => Some(Facility::SourceOutput), 4 => Some(Facility::Module), 5 => Some(Facility::Client), 6 => Some(Facility::SampleCache), 7 => Some(Facility::Server), /* NOTE: value `8` previously assigned, obsoleted */ 9 => Some(Facility::Card), _ => None, } } /// Converts to an interest mask. #[inline(always)] pub const fn to_interest_mask(self) -> InterestMaskSet { 1u32 << (self as u32) } } impl Operation { fn from_int(value: u32) -> Option<Operation> { match value { 0 => Some(Operation::New), 0x10 => Some(Operation::Changed), 0x20 => Some(Operation::Removed), _ => None, } } } /// Extracts facility from `EventType` value. #[inline] fn get_facility(value: EventType) -> Option<Facility> { Facility::from_int((value & FACILITY_MASK) as u32) } /// Extracts operation from `EventType` value. #[inline] fn get_operation(value: EventType) -> Option<Operation> { Operation::from_int((value & OPERATION_MASK) as u32) } pub(super) type Callback = MultiUseCallback<dyn FnMut(Option<Facility>, Option<Operation>, u32), extern "C" fn(*mut ContextInternal, EventType, u32, *mut c_void)>; impl Context { /// Enables event notification. /// /// The `mask` parameter is used to specify which facilities you are interested in being /// modified about. Use [`set_subscribe_callback`](#method.set_subscribe_callback) to set the /// actual callback that will be called when an event occurs. /// /// The callback must accept a `bool`, which indicates success. /// /// Panics if the underlying C function returns a null pointer. pub fn subscribe<F>(&mut self, mask: InterestMaskSet, callback: F) -> operation::Operation<dyn FnMut(bool)> where F: FnMut(bool) + 'static { let cb_data = box_closure_get_capi_ptr::<dyn FnMut(bool)>(Box::new(callback)); let ptr = unsafe { capi::pa_context_subscribe(self.ptr, mask, Some(super::success_cb_proxy), cb_data) }; assert!(!ptr.is_null()); operation::Operation::from_raw(ptr, cb_data as *mut Box<dyn FnMut(bool)>) } /// Sets the context specific call back function that is called whenever a subscribed-to event /// occurs. /// /// Use [`subscribe`](#method.subscribe) to set the facilities you are interested in receiving /// notifications for, and thus to start receiving notifications with the callback set here. /// /// The callback must take three parameters. The first two are the facility and operation /// components of the event type respectively (the underlying C API provides this information /// combined into a single integer, here we extract the two component parts for you); these are /// wrapped in `Option` wrappers should the given values ever not map to the enum variants, but /// it’s probably safe to always just `unwrap()` them). The third parameter is an associated /// index value. pub fn set_subscribe_callback(&mut self, callback: Option<Box<dyn FnMut(Option<Facility>, Option<Operation>, u32) + 'static>>) { let saved = &mut self.cb_ptrs.subscribe; *saved = Callback::new(callback); let (cb_fn, cb_data) = saved.get_capi_params(cb_proxy); unsafe { capi::pa_context_set_subscribe_callback(self.ptr, cb_fn, cb_data); } } } /// Proxy for callbacks. /// /// Warning: This is for multi-use cases! It does **not** destroy the actual closure callback, which /// must be accomplished separately to avoid a memory leak. extern "C" fn cb_proxy(_: *mut ContextInternal, et: EventType, index: u32, userdata: *mut c_void) { let _ = std::panic::catch_unwind(|| { let facility = get_facility(et); let operation = get_operation(et); let callback = Callback::get_callback(userdata); (callback)(facility, operation, index); }); }