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
// Copyright The pipewire-rs Contributors.
// SPDX-License-Identifier: MIT

use bitflags::bitflags;
use libc::c_void;
use std::ops::Deref;
use std::pin::Pin;
use std::{ffi::CStr, ptr};
use std::{fmt, mem};

use crate::{
    proxy::{Listener, Proxy, ProxyT},
    types::ObjectType,
};
use spa::spa_interface_call_method;

#[derive(Debug)]
pub struct Module {
    proxy: Proxy,
}

impl ProxyT for Module {
    fn type_() -> ObjectType {
        ObjectType::Module
    }

    fn upcast(self) -> Proxy {
        self.proxy
    }

    fn upcast_ref(&self) -> &Proxy {
        &self.proxy
    }

    unsafe fn from_proxy_unchecked(proxy: Proxy) -> Self
    where
        Self: Sized,
    {
        Self { proxy }
    }
}

impl Module {
    // TODO: add non-local version when we'll bind pw_thread_loop_start()
    #[must_use]
    pub fn add_listener_local(&self) -> ModuleListenerLocalBuilder {
        ModuleListenerLocalBuilder {
            module: self,
            cbs: ListenerLocalCallbacks::default(),
        }
    }
}

#[derive(Default)]
struct ListenerLocalCallbacks {
    #[allow(clippy::type_complexity)]
    info: Option<Box<dyn Fn(&ModuleInfoRef)>>,
}

pub struct ModuleListenerLocalBuilder<'a> {
    module: &'a Module,
    cbs: ListenerLocalCallbacks,
}

#[repr(transparent)]
pub struct ModuleInfoRef(pw_sys::pw_module_info);

impl ModuleInfoRef {
    pub fn as_raw(&self) -> &pw_sys::pw_module_info {
        &self.0
    }

    pub fn as_raw_ptr(&self) -> *mut pw_sys::pw_module_info {
        std::ptr::addr_of!(self.0).cast_mut()
    }

    pub fn id(&self) -> u32 {
        self.0.id
    }

    pub fn name(&self) -> &str {
        unsafe { CStr::from_ptr(self.0.name).to_str().unwrap() }
    }

    pub fn filename(&self) -> &str {
        unsafe { CStr::from_ptr(self.0.name).to_str().unwrap() }
    }

    pub fn args(&self) -> Option<&str> {
        let args = self.0.args;
        if args.is_null() {
            None
        } else {
            Some(unsafe { CStr::from_ptr(args).to_str().unwrap() })
        }
    }

    pub fn change_mask(&self) -> ModuleChangeMask {
        ModuleChangeMask::from_bits(self.0.change_mask).expect("invalid change_mask")
    }

    pub fn props(&self) -> Option<&spa::utils::dict::DictRef> {
        let props_ptr: *mut spa::utils::dict::DictRef = self.0.props.cast();
        ptr::NonNull::new(props_ptr).map(|ptr| unsafe { ptr.as_ref() })
    }
}

impl fmt::Debug for ModuleInfoRef {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        f.debug_struct("ModuleInfoRef")
            .field("id", &self.id())
            .field("filename", &self.filename())
            .field("args", &self.args())
            .field("change_mask", &self.change_mask())
            .field("props", &self.props())
            .finish()
    }
}

pub struct ModuleInfo {
    ptr: ptr::NonNull<pw_sys::pw_module_info>,
}

impl ModuleInfo {
    pub fn new(ptr: ptr::NonNull<pw_sys::pw_module_info>) -> Self {
        Self { ptr }
    }

    pub fn from_raw(raw: *mut pw_sys::pw_module_info) -> Self {
        Self {
            ptr: ptr::NonNull::new(raw).expect("Provided pointer is null"),
        }
    }

    pub fn into_raw(self) -> *mut pw_sys::pw_module_info {
        std::mem::ManuallyDrop::new(self).ptr.as_ptr()
    }
}

impl Drop for ModuleInfo {
    fn drop(&mut self) {
        unsafe { pw_sys::pw_module_info_free(self.ptr.as_ptr()) }
    }
}

impl std::ops::Deref for ModuleInfo {
    type Target = ModuleInfoRef;

    fn deref(&self) -> &Self::Target {
        unsafe { self.ptr.cast::<ModuleInfoRef>().as_ref() }
    }
}

impl AsRef<ModuleInfoRef> for ModuleInfo {
    fn as_ref(&self) -> &ModuleInfoRef {
        self.deref()
    }
}

bitflags! {
    #[derive(Debug, PartialEq, Eq, Clone, Copy)]
    pub struct ModuleChangeMask: u64 {
        const PROPS = pw_sys::PW_MODULE_CHANGE_MASK_PROPS as u64;
    }
}

impl fmt::Debug for ModuleInfo {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        f.debug_struct("ModuleInfo")
            .field("id", &self.id())
            .field("filename", &self.filename())
            .field("args", &self.args())
            .field("change_mask", &self.change_mask())
            .field("props", &self.props())
            .finish()
    }
}

pub struct ModuleListener {
    // Need to stay allocated while the listener is registered
    #[allow(dead_code)]
    events: Pin<Box<pw_sys::pw_module_events>>,
    listener: Pin<Box<spa_sys::spa_hook>>,
    #[allow(dead_code)]
    data: Box<ListenerLocalCallbacks>,
}

impl Listener for ModuleListener {}

impl Drop for ModuleListener {
    fn drop(&mut self) {
        spa::utils::hook::remove(*self.listener);
    }
}

impl<'a> ModuleListenerLocalBuilder<'a> {
    #[must_use]
    pub fn info<F>(mut self, info: F) -> Self
    where
        F: Fn(&ModuleInfoRef) + 'static,
    {
        self.cbs.info = Some(Box::new(info));
        self
    }

    #[must_use]
    pub fn register(self) -> ModuleListener {
        unsafe extern "C" fn module_events_info(
            data: *mut c_void,
            info: *const pw_sys::pw_module_info,
        ) {
            let callbacks = (data as *mut ListenerLocalCallbacks).as_ref().unwrap();
            let info =
                ptr::NonNull::new(info as *mut pw_sys::pw_module_info).expect("info is NULL");
            let info = info.cast::<ModuleInfoRef>().as_ref();
            callbacks.info.as_ref().unwrap()(info);
        }

        let e = unsafe {
            let mut e: Pin<Box<pw_sys::pw_module_events>> = Box::pin(mem::zeroed());
            e.version = pw_sys::PW_VERSION_MODULE_EVENTS;

            if self.cbs.info.is_some() {
                e.info = Some(module_events_info);
            }

            e
        };

        let (listener, data) = unsafe {
            let module = &self.module.proxy.as_ptr();

            let data = Box::into_raw(Box::new(self.cbs));
            let mut listener: Pin<Box<spa_sys::spa_hook>> = Box::pin(mem::zeroed());
            let listener_ptr: *mut spa_sys::spa_hook = listener.as_mut().get_unchecked_mut();

            spa_interface_call_method!(
                module,
                pw_sys::pw_module_methods,
                add_listener,
                listener_ptr.cast(),
                e.as_ref().get_ref(),
                data as *mut _
            );

            (listener, Box::from_raw(data))
        };

        ModuleListener {
            events: e,
            listener,
            data,
        }
    }
}