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 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339
use base64::Engine;
use souvlaki::{MediaControlEvent, MediaControls, MediaMetadata, MediaPlayback, PlatformConfig};
use std::sync::mpsc::{self, Receiver};
use termusiclib::track::Track;
use crate::{GeneralPlayer, PlayerCmd, PlayerTimeUnit, PlayerTrait, Status};
pub struct Mpris {
controls: MediaControls,
pub rx: Receiver<MediaControlEvent>,
}
impl Mpris {
pub fn new(cmd_tx: crate::PlayerCmdSender) -> Self {
// #[cfg(not(target_os = "windows"))]
// let hwnd = None;
// #[cfg(target_os = "windows")]
// let hwnd = {
// use raw_window_handle::windows::WindowsHandle;
// let handle: WindowsHandle = unimplemented!();
// Some(handle.hwnd)
// };
#[cfg(not(target_os = "windows"))]
let hwnd = None;
#[cfg(target_os = "windows")]
let (hwnd, _dummy_window) = {
let dummy_window = windows::DummyWindow::new().unwrap();
let handle = Some(dummy_window.handle.0 as _);
(handle, dummy_window)
};
let config = PlatformConfig {
dbus_name: "termusic",
display_name: "Termuisc in Rust",
hwnd,
};
let mut controls = MediaControls::new(config).unwrap();
let (tx, rx) = mpsc::sync_channel(32);
// The closure must be Send and have a static lifetime.
controls
.attach(move |event: MediaControlEvent| {
tx.send(event).ok();
// immediately process any mpris commands, current update is inside PlayerCmd::Tick
// TODO: this should likely be refactored
cmd_tx.send(PlayerCmd::Tick).ok();
})
.ok();
Self { controls, rx }
}
}
impl Mpris {
pub fn add_and_play(&mut self, track: &Track) {
// This is to fix a bug that the first track is not updated
std::thread::sleep(std::time::Duration::from_millis(100));
self.controls
.set_playback(MediaPlayback::Playing { progress: None })
.ok();
let cover_art = track.picture().map(|picture| {
format!(
"data:{};base64,{}",
picture.mime_type().map_or_else(
|| {
error!(
"Unknown mimetype for picture of track {}",
track.file().unwrap_or("<unknown file>")
);
"application/octet-stream"
},
|v| v.as_str()
),
base64::engine::general_purpose::STANDARD_NO_PAD.encode(picture.data())
)
});
self.controls
.set_metadata(MediaMetadata {
title: Some(track.title().unwrap_or("Unknown Title")),
artist: Some(track.artist().unwrap_or("Unknown Artist")),
album: Some(track.album().unwrap_or("")),
cover_url: cover_art.as_deref(),
duration: Some(track.duration()),
})
.ok();
}
pub fn pause(&mut self) {
self.controls
.set_playback(MediaPlayback::Paused { progress: None })
.ok();
}
pub fn resume(&mut self) {
self.controls
.set_playback(MediaPlayback::Playing { progress: None })
.ok();
}
/// Update Track position / progress, requires `playlist_status` because [`MediaControls`] only allows `set_playback`, not `set_position` or `get_playback`
pub fn update_progress(&mut self, position: Option<PlayerTimeUnit>, playlist_status: Status) {
if let Some(position) = position {
match playlist_status {
Status::Running => self
.controls
.set_playback(MediaPlayback::Playing {
progress: Some(souvlaki::MediaPosition(position)),
})
.ok(),
Status::Paused | Status::Stopped => self
.controls
.set_playback(MediaPlayback::Paused {
progress: Some(souvlaki::MediaPosition(position)),
})
.ok(),
};
}
}
}
impl GeneralPlayer {
pub fn mpris_handler(&mut self, e: MediaControlEvent) {
match e {
MediaControlEvent::Next => {
self.next();
}
MediaControlEvent::Previous => {
self.previous();
}
MediaControlEvent::Pause => {
self.pause();
}
MediaControlEvent::Toggle => {
self.toggle_pause();
}
MediaControlEvent::Play => {
self.play();
}
// The "Seek" even seems to currently only be used for windows, mpris uses "SeekBy"
MediaControlEvent::Seek(direction) => {
let cmd = match direction {
souvlaki::SeekDirection::Forward => PlayerCmd::SeekForward,
souvlaki::SeekDirection::Backward => PlayerCmd::SeekBackward,
};
// ignore error if sending failed
self.cmd_tx.send(cmd).ok();
}
MediaControlEvent::SetPosition(position) => {
self.seek_to(position.0);
}
MediaControlEvent::OpenUri(_uri) => {
// let wait = async {
// self.player.add_and_play(&uri).await;
// };
// let rt = tokio::runtime::Runtime::new().expect("failed to create runtime");
// rt.block_on(wait);
// TODO: handle "OpenUri"
info!("Unimplemented Event: OpenUri");
}
MediaControlEvent::SeekBy(direction, duration) => {
#[allow(clippy::cast_possible_wrap)]
let as_secs = duration.as_secs().min(i64::MAX as u64) as i64;
// mpris seeking is in micro-seconds (not milliseconds or seconds)
if as_secs == 0 {
warn!("can only seek in seconds, got less than 0 seconds");
return;
}
let offset = match direction {
souvlaki::SeekDirection::Forward => as_secs,
souvlaki::SeekDirection::Backward => -as_secs,
};
// make use of "PlayerTrait" impl on "GeneralPlayer"
// ignore result
let _ = self.seek(offset);
}
MediaControlEvent::SetVolume(volume) => {
debug!("got souvlaki SetVolume: {:#}", volume);
// volume can be anything above 0; 1.0 means a sensible max; termusic currently does not support more than 100 volume
// warn users trying to set higher than max via logging
if volume > 1.0 {
error!("SetVolume above 1.0 will be clamped to 1.0!");
}
// convert a 0.0 to 1.0 range to 0 to 100, because that is what termusic uses for volume
// default float to int casting will truncate values to the decimal point
#[allow(clippy::cast_possible_truncation, clippy::cast_sign_loss)]
let uvol = (volume.clamp(0.0, 1.0) * 100.0) as u16;
self.set_volume(uvol);
}
MediaControlEvent::Quit => {
// ignore error if sending failed
self.cmd_tx.send(PlayerCmd::Quit).ok();
}
MediaControlEvent::Stop => {
// TODO: handle "Stop"
info!("Unimplemented Event: Stop");
}
// explicitly unsupported events
MediaControlEvent::Raise => {}
}
}
pub fn update_mpris(&mut self) {
if let Ok(m) = self.mpris.rx.try_recv() {
self.mpris_handler(m);
}
// currently "set_volume" only exists for "linux"(mpris)
#[cfg(target_os = "linux")]
{
// update the reported volume in mpris
let vol = f64::from(self.volume()) / 100.0;
self.mpris.controls.set_volume(vol).ok();
}
if let Some(progress) = self.get_progress() {
self.mpris
.update_progress(progress.position, self.playlist.status());
}
}
}
// demonstrates how to make a minimal window to allow use of media keys on the command line
// ref: https://github.com/Sinono3/souvlaki/blob/master/examples/print_events.rs
#[cfg(target_os = "windows")]
#[allow(clippy::cast_possible_truncation)]
mod windows {
use std::io::Error;
use std::mem;
use windows::core::w;
// use windows::core::PCWSTR;
use windows::Win32::Foundation::{HWND, LPARAM, LRESULT, WPARAM};
use windows::Win32::System::LibraryLoader::GetModuleHandleW;
use windows::Win32::UI::WindowsAndMessaging::{
CreateWindowExW, DefWindowProcW, DestroyWindow, DispatchMessageW, GetAncestor,
IsDialogMessageW, PeekMessageW, RegisterClassExW, TranslateMessage, GA_ROOT, MSG,
PM_REMOVE, WINDOW_EX_STYLE, WINDOW_STYLE, WM_QUIT, WNDCLASSEXW,
};
pub struct DummyWindow {
pub handle: HWND,
}
impl DummyWindow {
pub fn new() -> Result<DummyWindow, String> {
let class_name = w!("SimpleTray");
let handle_result = unsafe {
let instance = GetModuleHandleW(None)
.map_err(|e| (format!("Getting module handle failed: {e}")))?;
let wnd_class = WNDCLASSEXW {
cbSize: mem::size_of::<WNDCLASSEXW>() as u32,
hInstance: instance.into(),
lpszClassName: class_name,
lpfnWndProc: Some(Self::wnd_proc),
..Default::default()
};
if RegisterClassExW(&wnd_class) == 0 {
return Err(format!(
"Registering class failed: {}",
Error::last_os_error()
));
}
let handle = CreateWindowExW(
WINDOW_EX_STYLE::default(),
class_name,
w!(""),
WINDOW_STYLE::default(),
0,
0,
0,
0,
None,
None,
instance,
None,
);
if handle.0 == 0 {
Err(format!(
"Message only window creation failed: {}",
Error::last_os_error()
))
} else {
Ok(handle)
}
};
handle_result.map(|handle| DummyWindow { handle })
}
extern "system" fn wnd_proc(
hwnd: HWND,
msg: u32,
wparam: WPARAM,
lparam: LPARAM,
) -> LRESULT {
unsafe { DefWindowProcW(hwnd, msg, wparam, lparam) }
}
}
impl Drop for DummyWindow {
fn drop(&mut self) {
unsafe {
DestroyWindow(self.handle).unwrap();
}
}
}
#[allow(dead_code)]
pub fn pump_event_queue() -> bool {
unsafe {
let mut msg: MSG = std::mem::zeroed();
let mut has_message = PeekMessageW(&mut msg, None, 0, 0, PM_REMOVE).as_bool();
while msg.message != WM_QUIT && has_message {
if !IsDialogMessageW(GetAncestor(msg.hwnd, GA_ROOT), &msg).as_bool() {
TranslateMessage(&msg);
DispatchMessageW(&msg);
}
has_message = PeekMessageW(&mut msg, None, 0, 0, PM_REMOVE).as_bool();
}
msg.message == WM_QUIT
}
}
}