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
/*
* SPDX-License-Identifier: MIT
*/
//! PipeWire [Registry](https://docs.pipewire.org/group__pw__registry.html) bindings.
//!
use std::ops::{Deref, DerefMut};
use std::pin::Pin;
use std::ptr::NonNull;
use std::rc::Rc;
use std::sync::atomic::{AtomicBool, Ordering};
use std::sync::Arc;
use pw_sys::pw_proxy;
use pipewire_wrapper_proc_macro::{interface, proxy_wrapper, RawWrapper, Wrapper};
use crate::core_api::core::Core;
use crate::core_api::factory::events::FactoryEvents;
use crate::core_api::factory::FactoryRef;
use crate::core_api::proxy::Proxied;
use crate::core_api::proxy::{Proxy, ProxyRef};
use crate::core_api::registry::events::RegistryEvents;
use crate::core_api::registry::restricted::RegistryBind;
use crate::core_api::type_info::TypeInfo;
use crate::listeners::{AddListener, ListenerId, Listeners, OwnListeners};
use crate::spa_interface_call;
use crate::wrapper::*;
use crate::{i32_as_void_result, raw_wrapper};
pub mod events;
/// Wrapper for the external [pw_sys::pw_registry] proxy.
///
/// The registry object is a singleton object that keeps track of global objects on the PipeWire instance.
/// When a client creates a registry object, the registry object will emit a global event for each
/// global currently in the registry. Globals come and go as a result of device hotplugs or
/// reconfiguration or other events, and the registry will send out global and global_remove events
/// to keep the client up to date with the changes. To mark the end of the initial burst of events,
/// the client can use the pw_core.sync method immediately after calling pw_core.get_registry.
///
/// A client can bind to a global object by using the bind request. This creates a client-side
/// proxy that lets the object emit events to the client and lets the client invoke methods on the
/// object.
///
/// # Examples
///
/// ```
/// use std::sync::Arc;
/// use pipewire_wrapper::core_api::core::Core;
/// use pipewire_wrapper::core_api::device::DeviceRef;
/// use pipewire_wrapper::core_api::registry::events::RegistryEventsBuilder;
/// use pipewire_wrapper::listeners::OwnListeners;
/// use std::time::Duration;
///
/// let core = Core::default();
/// let context = core.context();
/// let main_loop = context.main_loop();
/// let registry = core.get_registry(0).unwrap();
///
/// let _registry_events = registry.add_listener(
/// RegistryEventsBuilder::default()
/// .global(Box::new(
/// |_id, permissions, type_info, version, properties| {
/// println!(
/// "Global {:?} {:?} {:?} {:?}",
/// permissions, type_info, version, properties
/// );
/// },
/// ))
/// .build(),
/// );
///
/// let timer_callback = |_| {
/// core.context().main_loop().quit().unwrap();
/// };
/// let timer = main_loop
/// .get_loop()
/// .add_timer(Box::new(timer_callback))
/// .unwrap();
/// main_loop
/// .get_loop()
/// .update_timer(&timer, Duration::from_secs(1), Duration::ZERO, false)
/// .unwrap();
///
/// main_loop.run().unwrap();
/// ```
#[derive(RawWrapper, Debug)]
#[interface(methods=pw_sys::pw_registry_methods, interface="Registry")]
#[repr(transparent)]
pub struct RegistryRef {
#[raw]
raw: pw_sys::pw_registry,
}
impl RegistryRef {
/// Bind to the global object with id and use the client proxy.
/// After this call, methods can be send to the remote global object and events can be received.
///
/// # Arguments
///
/// * `id` - global object id
/// * `type_info` - global object type
/// * `version` - interface version
///
/// Returns reference to the proxy object.
pub(crate) fn bind(
&self,
id: u32,
type_info: TypeInfo,
version: u32,
) -> crate::Result<&ProxyRef> {
let result =
unsafe { spa_interface_call!(self, bind, id, type_info.as_ptr(), version, 0)? };
raw_wrapper(result as *mut pw_proxy)
}
/// Attempt to destroy a global object.
pub fn destroy(&self, id: u32) -> crate::Result<()> {
let result = spa_interface_call!(self, destroy, id)?;
i32_as_void_result(result)
}
}
impl<'a> AddListener<'a> for RegistryRef {
type Events = RegistryEvents<'a>;
fn add_listener(&self, events: Pin<Box<Self::Events>>) -> Pin<Box<Self::Events>> {
unsafe {
spa_interface_call!(
self,
add_listener,
events.hook().as_raw_ptr(),
events.as_raw_ptr(),
&*events as *const _ as *mut _
)
};
events
}
}
/// [Wrapper] for the Registry proxy.
/// See [RegistryRef]
#[derive(Clone, Debug)]
#[proxy_wrapper(RegistryRef)]
pub struct Registry<'c> {
ref_: Proxy<'c>,
listeners: Listeners<Pin<Box<RegistryEvents<'c>>>>,
}
impl<'c> RegistryBind<'c> for Registry<'c> {
fn from_ref(core: &'c Core, ref_: &ProxyRef) -> Self {
Self {
ref_: Proxy::from_ref(core, ref_),
listeners: Listeners::default(),
}
}
}
impl<'a> OwnListeners<'a> for Registry<'a> {
fn listeners(
&self,
) -> &Listeners<Pin<Box<<<Self as Wrapper>::RawWrapperType as AddListener<'a>>::Events>>> {
&self.listeners
}
}
impl<'c> Registry<'c> {
/// Bind to the global object with id and use the client proxy.
/// After this call, methods can be send to the remote global object and events can be received.
///
/// # Arguments
///
/// * `id` - global object id
/// * `version` - interface version, usually 0
///
/// Returns bound [Proxy] object.
pub fn bind_proxy<T>(&self, id: u32, version: u32) -> crate::Result<T>
where
T: RegistryBind<'c>,
<T as Wrapper>::RawWrapperType: Proxied,
{
let type_info = T::RawWrapperType::type_info();
let ref_ = self.bind(id, type_info, version)?;
Ok(T::from_ref(self.ref_.core(), ref_))
}
}
pub(crate) mod restricted {
use std::sync::Arc;
use crate::core_api::proxy::{Proxied, ProxyRef};
use crate::wrapper::Wrapper;
pub trait RegistryBind<'c>
where
Self: Wrapper,
Self::RawWrapperType: Proxied,
{
fn from_ref(core: &'c crate::core_api::core::Core, ref_: &ProxyRef) -> Self;
}
}