Files
plezy/lib/services/media_controls_manager.dart
T
edde746andClaude Fable 5 28bc4a5df8 feat(player): handle stop/skip/speed media-session commands
The platforms advertise stop, skip forward/backward, and playback-rate
commands by default, but both the music and video handlers silently
dropped them (Android Auto/Bluetooth stop and FF/rewind did nothing;
iOS/macOS showed a dead rate control). setControlsEnabled now manages
those controls: music handles Stop and in-track skips and stops
advertising a speed control; video handles Stop (exit, matching the
companion remote), skips via a shared relative-seek helper, and rate
changes through player.setRate. Skip commands stay off on iOS/macOS
where they would displace the next/previous lock-screen buttons.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
2026-07-06 15:28:24 +02:00

285 lines
9.5 KiB
Dart

import 'dart:io' show Platform;
import 'package:os_media_controls/os_media_controls.dart';
import 'package:rate_limiter/rate_limiter.dart';
import '../media/media_server_client.dart';
import '../media/media_item.dart';
import '../media/media_item_types.dart';
import '../media/media_kind.dart';
import '../utils/app_logger.dart';
/// Manages OS media controls integration for video playback.
///
/// Handles:
/// - Metadata updates (title, artwork, etc.)
/// - Playback state updates (playing/paused, position, speed)
/// - Control event streaming (play, pause, next, previous, seek)
/// - Position update throttling to prevent excessive API calls
class MediaControlsManager {
/// Stream of control events from OS media controls
Stream<MediaControlEvent> get controlEvents => OsMediaControls.controlEvents;
/// Throttled playback state update (1 second interval, leading + trailing)
late final Throttle _throttledUpdate;
/// Cached control enabled state to avoid redundant platform calls
bool? _lastCanGoNext;
bool? _lastCanGoPrevious;
bool? _lastCanSeek;
bool? _lastCanStop;
bool? _lastCanSkip;
bool? _lastCanSetSpeed;
bool _updatesSuspended = false;
MediaControlsManager() {
_throttledUpdate = throttle(
_doUpdatePlaybackState,
const Duration(seconds: 1),
leading: true,
trailing: true, // Send final position at end of throttle window
);
}
/// Update media metadata displayed in OS media controls
///
/// This includes title, artist, artwork, and duration. Backend-neutral —
/// the [MediaServerClient.thumbnailUrl] adapter handles per-backend URL
/// shape (Plex's `/photo/:/transcode` proxy vs. Jellyfin's
/// self-authenticated image URL).
Future<void> updateMetadata({required MediaItem metadata, MediaServerClient? client, Duration? duration}) async {
if (_updatesSuspended) return;
try {
String? artworkUrl;
if (client != null && metadata.thumbPath != null) {
try {
artworkUrl = client.thumbnailUrl(metadata.thumbPath!);
appLogger.d('Artwork URL for media controls: $artworkUrl');
} catch (e) {
appLogger.w('Failed to build artwork URL', error: e);
}
}
await OsMediaControls.setMetadata(
MediaMetadata(
title: metadata.title ?? '',
artist: _buildArtist(metadata),
// Music-only: null for video content, so video behavior is untouched.
album: metadata.kind == MediaKind.track ? metadata.albumTitle : null,
artworkUrl: artworkUrl,
duration: duration,
),
);
appLogger.d('Updated media controls metadata: ${metadata.title}');
} catch (e) {
appLogger.w('Failed to update media controls metadata', error: e);
}
}
/// Update playback state in OS media controls
///
/// Updates the current playing state, position, and playback speed.
/// Position updates are throttled to avoid excessive API calls.
Future<void> updatePlaybackState({
required bool isPlaying,
required Duration position,
required double speed,
bool force = false,
}) async {
if (_updatesSuspended) return;
final params = _PlaybackStateParams(isPlaying: isPlaying, position: position, speed: speed);
if (force) {
// Cancel any pending throttled update to prevent stale state from overwriting
_throttledUpdate.cancel();
await _doUpdatePlaybackState(params);
} else {
_throttledUpdate([params]);
}
}
Future<void> _doUpdatePlaybackState(_PlaybackStateParams params) async {
try {
await OsMediaControls.setPlaybackState(
MediaPlaybackState(
state: params.isPlaying ? PlaybackState.playing : PlaybackState.paused,
position: params.position,
speed: params.speed,
),
);
} catch (e) {
appLogger.w('Failed to update media controls playback state', error: e);
}
}
/// Enable or disable transport controls in the OS media session.
///
/// next/previous/seek reflect the content (adjacent episodes, playlist
/// position, seekability). stop/skip/speed reflect what the active surface
/// actually handles — the platform sides enable several commands by
/// default, so anything the caller leaves disabled here is explicitly
/// un-advertised rather than shown as a dead button.
///
/// [canSkip] is never honored on iOS/macOS: enabling the
/// MPRemoteCommandCenter skip commands displaces the next/previous track
/// buttons on the lock screen / Control Center, and next/previous are the
/// primary transport there. Android's fast-forward/rewind actions are
/// independent of next/previous, so skip is safe to advertise.
Future<void> setControlsEnabled({
bool canGoNext = false,
bool canGoPrevious = false,
bool canSeek = false,
bool canStop = false,
bool canSkip = false,
bool canSetSpeed = false,
}) async {
if (_updatesSuspended) return;
final effectiveCanSkip = canSkip && !Platform.isIOS && !Platform.isMacOS;
try {
final controlsToEnable = <MediaControl>[];
final controlsToDisable = <MediaControl>[];
if (canGoPrevious != _lastCanGoPrevious) {
(canGoPrevious ? controlsToEnable : controlsToDisable).add(MediaControl.previous);
}
if (canGoNext != _lastCanGoNext) {
(canGoNext ? controlsToEnable : controlsToDisable).add(MediaControl.next);
}
if (canSeek != _lastCanSeek) {
(canSeek ? controlsToEnable : controlsToDisable).add(MediaControl.seek);
}
if (canStop != _lastCanStop) {
(canStop ? controlsToEnable : controlsToDisable).add(MediaControl.stop);
}
if (effectiveCanSkip != _lastCanSkip) {
(effectiveCanSkip ? controlsToEnable : controlsToDisable)
..add(MediaControl.skipForward)
..add(MediaControl.skipBackward);
}
if (canSetSpeed != _lastCanSetSpeed) {
(canSetSpeed ? controlsToEnable : controlsToDisable).add(MediaControl.changeSpeed);
}
if (controlsToEnable.isEmpty && controlsToDisable.isEmpty) return;
if (controlsToEnable.isNotEmpty) {
await OsMediaControls.enableControls(controlsToEnable);
}
if (controlsToDisable.isNotEmpty) {
await OsMediaControls.disableControls(controlsToDisable);
}
_lastCanGoNext = canGoNext;
_lastCanGoPrevious = canGoPrevious;
_lastCanSeek = canSeek;
_lastCanStop = canStop;
_lastCanSkip = effectiveCanSkip;
_lastCanSetSpeed = canSetSpeed;
appLogger.d(
'Media controls updated - Previous: $canGoPrevious, Next: $canGoNext, Seek: $canSeek, '
'Stop: $canStop, Skip: $effectiveCanSkip, Speed: $canSetSpeed',
);
} catch (e) {
appLogger.w('Failed to set media controls enabled state', error: e);
}
}
/// Enable/disable Android background playback: while enabled, the plugin
/// keeps audio alive with a `mediaPlayback` foreground service and shows a
/// MediaStyle notification for the session. No-op on other platforms.
Future<void> setBackgroundMode(bool enabled) async {
try {
await OsMediaControls.setBackgroundMode(enabled);
appLogger.d('Media controls background mode: $enabled');
} catch (e) {
appLogger.w('Failed to set media controls background mode', error: e);
}
}
/// Clear all media controls
///
/// Should be called when playback stops or screen is disposed.
Future<void> clear() async {
try {
await OsMediaControls.clear();
_throttledUpdate.cancel();
_lastCanGoNext = null;
_lastCanGoPrevious = null;
_lastCanSeek = null;
_lastCanStop = null;
_lastCanSkip = null;
_lastCanSetSpeed = null;
appLogger.d('Media controls cleared');
} catch (e) {
appLogger.w('Failed to clear media controls', error: e);
}
}
void suspendUpdates() {
if (_updatesSuspended) return;
_updatesSuspended = true;
_throttledUpdate.cancel();
appLogger.d('Media controls updates suspended');
}
void resumeUpdates() {
if (!_updatesSuspended) return;
_updatesSuspended = false;
appLogger.d('Media controls updates resumed');
}
/// Dispose resources
void dispose() {
_throttledUpdate.cancel();
}
/// Build artist string from metadata
///
/// For music tracks: the performing artist
/// For episodes: "Show Name - Season X Episode Y"
/// For movies: Director or studio
/// For other content: Fallback to year or empty
String _buildArtist(MediaItem metadata) {
if (metadata.kind == MediaKind.track) {
// Performing artist with album-artist fallback (compilations store the
// track's own artist separately).
return metadata.trackArtistTitle ?? '';
}
if (metadata.isEpisode) {
final parts = <String>[];
if (metadata.grandparentTitle != null) {
parts.add(metadata.grandparentTitle!);
}
if (metadata.parentIndex != null && metadata.index != null) {
parts.add('S${metadata.parentIndex} E${metadata.index}');
} else if (metadata.parentTitle != null) {
parts.add(metadata.parentTitle!);
}
return parts.join(' • ');
} else if (metadata.isMovie) {
if (metadata.year != null) {
return metadata.year.toString();
}
}
return '';
}
}
/// Parameters for playback state update (used with throttle)
class _PlaybackStateParams {
final bool isPlaying;
final Duration position;
final double speed;
const _PlaybackStateParams({required this.isPlaying, required this.position, required this.speed});
}