注释未使用包

This commit is contained in:
rang 2025-12-09 17:26:04 +08:00
parent 50a27fdf67
commit 20a3b95edc
48 changed files with 637 additions and 1472 deletions

View file

@ -1,336 +0,0 @@
// ignore_for_file: public_member_api_docs, sort_constructors_first
import 'dart:async';
import 'package:audio_service/audio_service.dart';
import 'package:collection/collection.dart';
import 'package:just_audio/just_audio.dart';
import 'package:logging/logging.dart';
import 'package:rxdart/rxdart.dart';
import 'package:shelfsdk/audiobookshelf_api.dart';
import 'package:vaani/features/settings/app_settings_provider.dart';
import 'package:vaani/features/settings/models/app_settings.dart';
import 'package:vaani/shared/extensions/chapter.dart';
import 'package:vaani/shared/extensions/model_conversions.dart';
final offset = Duration(milliseconds: 10);
final _logger = Logger('AbsAudioPlayer');
abstract class AbsAudioPlayer {
final _mediaItemController = BehaviorSubject<MediaItem?>.seeded(null);
final playerStateSubject =
BehaviorSubject.seeded(AbsPlayerState(false, AbsProcessingState.idle));
final _bookStreamController = BehaviorSubject<BookExpanded?>.seeded(null);
final _chapterStreamController = BehaviorSubject<BookChapter?>.seeded(null);
BookExpanded? get book => _bookStreamController.nvalue;
BookChapter? get currentChapter => _chapterStreamController.nvalue;
AbsPlayerState get playerState => playerStateSubject.value;
Stream<MediaItem?> get mediaItemStream => _mediaItemController.stream;
Stream<AbsPlayerState> get playerStateStream => playerStateSubject.stream;
Future<void> load(
BookExpanded book, {
required Uri baseUrl,
required String token,
Duration? initialPosition,
List<Uri>? downloadedUris,
}) async {
if (_bookStreamController.nvalue == book) {
_logger.info('Book is the same, doing nothing');
return;
}
_bookStreamController.add(book);
final appSettings = loadOrCreateAppSettings();
final currentTrack = book.findTrackAtTime(initialPosition ?? Duration.zero);
final indexTrack = book.tracks.indexOf(currentTrack);
final positionInTrack = initialPosition != null
? initialPosition - currentTrack.startOffset
: null;
final title = appSettings.notificationSettings.primaryTitle
.formatNotificationTitle(book);
final artist = appSettings.notificationSettings.secondaryTitle
.formatNotificationTitle(book);
_chapterStreamController
.add(book.findChapterAtTime(initialPosition ?? Duration.zero));
final item = MediaItem(
id: book.libraryItemId,
title: title,
artist: artist,
duration: currentChapter?.duration ?? book.duration,
artUri: Uri.parse(
'$baseUrl/api/items/${book.libraryItemId}/cover?token=$token',
),
);
_mediaItemController.sink.add(item);
final playlist = book.tracks
.map(
(track) => _getUri(currentTrack, downloadedUris,
baseUrl: baseUrl, token: token),
)
.toList();
await setPlayList(playlist, index: indexTrack, position: positionInTrack);
}
Future<void> setPlayList(
List<Uri> playlist, {
int? index,
Duration? position,
});
Future<void> play();
Future<void> pause();
Future<void> playOrPause();
//
Future<void> next() async {
final chapter = currentChapter;
if (book == null || chapter == null) {
return;
}
final chapterIndex = book!.chapters.indexOf(chapter);
if (chapterIndex < book!.chapters.length - 1) {
final nextChapter = book!.chapters[chapterIndex + 1];
await switchChapter(nextChapter.id);
}
}
//
Future<void> previous() async {
final chapter = currentChapter;
if (book == null || chapter == null) {
return;
}
final currentIndex = book!.chapters.indexOf(chapter);
if (currentIndex > 0) {
final prevChapter = book!.chapters[currentIndex - 1];
await switchChapter(prevChapter.id);
} else {
//
await seekInBook(Duration.zero);
}
}
Future<void> seek(Duration position, {int? index});
Future<void> seekInBook(Duration position) async {
if (book == null) return;
//
final track = book!.findTrackAtTime(position);
final index = book!.tracks.indexOf(track);
Duration positionInTrack = position - track.startOffset;
if (positionInTrack <= Duration.zero) {
positionInTrack = offset;
}
//
await seek(positionInTrack, index: index);
}
Future<void> setSpeed(double speed);
Future<void> setVolume(double volume);
Future<void> switchChapter(int chapterId) async {
if (book == null) return;
final chapter = book!.chapters.firstWhere(
(ch) => ch.id == chapterId,
orElse: () => throw Exception('Chapter not found'),
);
await seekInBook(chapter.start + offset);
}
bool get playing => playerState.playing;
Stream<bool> get playingStream;
Stream<BookExpanded?> get bookStream => _bookStreamController.stream;
Stream<BookChapter?> get chapterStream => _chapterStreamController.stream;
int get currentIndex;
double get speed;
Duration get position;
Stream<Duration> get positionStream;
Duration get positionInChapter {
final globalPosition = positionInBook;
return globalPosition -
(book?.findChapterAtTime(globalPosition).start ?? Duration.zero);
}
Duration get positionInBook =>
position + (book?.tracks[currentIndex].startOffset ?? Duration.zero);
Stream<Duration> get positionInChapterStream =>
positionStream.map((position) {
return positionInChapter;
});
Stream<Duration> get positionInBookStream => positionStream.map((position) {
return positionInBook;
});
Duration get bufferedPosition;
Stream<Duration> get bufferedPositionStream;
Duration get bufferedPositionInBook =>
bufferedPosition +
(book?.tracks[currentIndex].startOffset ?? Duration.zero);
Stream<Duration> get bufferedPositionInBookStream =>
bufferedPositionStream.map((position) {
return bufferedPositionInBook;
});
dispose() {
_mediaItemController.close();
playerStateSubject.close();
_bookStreamController.close();
_chapterStreamController.close();
}
}
/// Enumerates the different processing states of a player.
enum AbsProcessingState {
/// The player has not loaded an [AudioSource].
idle,
/// The player is loading an [AudioSource].
loading,
/// The player is buffering audio and unable to play.
buffering,
/// The player is has enough audio buffered and is able to play.
ready,
/// The player has reached the end of the audio.
completed,
}
/// Encapsulates the playing and processing states. These two states vary
/// orthogonally, and so if [processingState] is [ProcessingState.buffering],
/// you can check [playing] to determine whether the buffering occurred while
/// the player was playing or while the player was paused.
class AbsPlayerState {
/// Whether the player will play when [processingState] is
/// [ProcessingState.ready].
final bool playing;
/// The current processing state of the player.
final AbsProcessingState processingState;
AbsPlayerState(this.playing, this.processingState);
@override
String toString() => 'playing=$playing,processingState=$processingState';
@override
int get hashCode => Object.hash(playing, processingState);
@override
bool operator ==(Object other) =>
other.runtimeType == runtimeType &&
other is PlayerState &&
other.playing == playing &&
other.processingState == processingState;
AbsPlayerState copyWith({
bool? playing,
AbsProcessingState? processingState,
}) {
return AbsPlayerState(
playing ?? this.playing,
processingState ?? this.processingState,
);
}
}
Uri _getUri(
AudioTrack track,
List<Uri>? downloadedUris, {
required Uri baseUrl,
required String token,
}) {
// check if the track is in the downloadedUris
final uri = downloadedUris?.firstWhereOrNull(
(element) {
return element.pathSegments.last == track.metadata?.filename;
},
);
return uri ??
Uri.parse('${baseUrl.toString()}${track.contentUrl}?token=$token');
}
/// Backwards compatible extensions on rxdart's ValueStream
extension _ValueStreamExtension<T> on ValueStream<T> {
/// Backwards compatible version of valueOrNull.
T? get nvalue => hasValue ? value : null;
}
extension FormatNotificationTitle on String {
String formatNotificationTitle(BookExpanded book) {
return replaceAllMapped(
RegExp(r'\$(\w+)'),
(match) {
final type = match.group(1);
return NotificationTitleType.values
.firstWhere((element) => element.name == type)
.extractFrom(book) ??
match.group(0) ??
'';
},
);
}
}
extension NotificationTitleUtils on NotificationTitleType {
String? extractFrom(BookExpanded book) {
var bookMetadataExpanded = book.metadata.asBookMetadataExpanded;
switch (this) {
case NotificationTitleType.bookTitle:
return bookMetadataExpanded.title;
case NotificationTitleType.chapterTitle:
// TODO: implement chapter title; depends on https://github.com/Dr-Blank/Vaani/issues/2
return bookMetadataExpanded.title;
case NotificationTitleType.author:
return bookMetadataExpanded.authorName;
case NotificationTitleType.narrator:
return bookMetadataExpanded.narratorName;
case NotificationTitleType.series:
return bookMetadataExpanded.seriesName;
case NotificationTitleType.subtitle:
return bookMetadataExpanded.subtitle;
case NotificationTitleType.year:
return bookMetadataExpanded.publishedYear;
}
}
}
extension BookExpandedExtension on BookExpanded {
BookChapter findChapterAtTime(Duration position) {
return chapters.firstWhere(
(element) {
return element.start <= position && element.end >= position + offset;
},
orElse: () => chapters.first,
);
}
AudioTrack findTrackAtTime(Duration position) {
return tracks.firstWhere(
(element) {
return element.startOffset <= position &&
element.startOffset + element.duration >= position + offset;
},
orElse: () => tracks.first,
);
}
int findTrackIndexAtTime(Duration position) {
return tracks.indexWhere((element) {
return element.startOffset <= position &&
element.startOffset + element.duration >= position + offset;
});
}
Duration getTrackStartOffset(int index) {
return tracks[index].startOffset;
}
}

View file

@ -1,101 +0,0 @@
import 'dart:async';
import 'package:media_kit/media_kit.dart' hide PlayerState;
import 'package:vaani/shared/audio_player.dart';
class AbsMpvAudioPlayer extends AbsAudioPlayer {
final player = Player();
AbsMpvAudioPlayer() {
player.stream.playing.listen((playing) {
final state = playerState;
playerStateSubject.add(
state.copyWith(
playing: playing,
processingState: playing
? state.processingState == AbsProcessingState.idle
? AbsProcessingState.ready
: state.processingState
: player.state.buffering
? AbsProcessingState.buffering
: player.state.completed
? AbsProcessingState.completed
: AbsProcessingState.ready,
),
);
});
}
@override
Duration get bufferedPosition => player.state.buffer;
@override
Stream<Duration> get bufferedPositionStream => player.stream.buffer;
@override
int get currentIndex => player.state.playlist.index;
@override
Future<void> pause() async {
await player.pause();
}
@override
Future<void> play() async {
await player.play();
}
@override
Future<void> playOrPause() async {
await player.playOrPause();
}
@override
Stream<bool> get playingStream => player.stream.playing;
@override
Duration get position => player.state.position;
@override
Stream<Duration> get positionStream => player.stream.position;
@override
Future<void> seek(Duration position, {int? index}) async {
if (index != null) {
await player.jump(index);
}
await player.seek(position);
}
@override
Future<void> setPlayList(
List<Uri> playlist, {
int? index,
Duration? position,
}) async {
await player.open(
Playlist(
playlist.map((uri) => Media(uri.toString())).toList(),
index: index ?? 0,
),
play: false,
);
// open方法加载完成
// ignore: unnecessary_null_comparison
await player.stream.duration.firstWhere((d) => d != null);
if (position != null) {
await player.seek(position);
}
}
@override
Future<void> setSpeed(double speed) async {
await player.setRate(speed);
}
@override
Future<void> setVolume(double volume) async {
await player.setVolume(volume);
}
@override
double get speed => player.state.rate;
}

View file

@ -1,96 +0,0 @@
import 'package:just_audio/just_audio.dart';
import 'package:logging/logging.dart';
import 'package:vaani/shared/audio_player.dart';
final _logger = Logger('AbsPlatformAudioPlayer');
class AbsPlatformAudioPlayer extends AbsAudioPlayer {
final AudioPlayer player = AudioPlayer();
AbsPlatformAudioPlayer() {
player.playerStateStream.listen((state) {
playerStateSubject.add(
playerState.copyWith(
playing: state.playing,
processingState: {
ProcessingState.idle: AbsProcessingState.idle,
ProcessingState.buffering: AbsProcessingState.buffering,
ProcessingState.completed: AbsProcessingState.completed,
ProcessingState.loading: AbsProcessingState.loading,
ProcessingState.ready: AbsProcessingState.ready,
}[state.processingState],
),
);
});
}
@override
Duration get bufferedPosition => player.bufferedPosition;
@override
Stream<Duration> get bufferedPositionStream => player.bufferedPositionStream;
@override
int get currentIndex => player.currentIndex ?? 0;
@override
Future<void> pause() async {
await player.pause();
}
@override
Future<void> play() async {
await player.play();
}
@override
Future<void> playOrPause() async {
player.playing ? await player.pause() : await player.play();
}
@override
Stream<bool> get playingStream => player.playingStream;
@override
Duration get position => player.position;
@override
Stream<Duration> get positionStream => player.positionStream;
@override
Future<void> seek(Duration position, {int? index}) async {
await player.seek(position, index: index);
}
@override
Future<void> setPlayList(
List<Uri> playlist, {
int? index,
Duration? position,
}) async {
List<AudioSource> audioSources =
playlist.map((uri) => AudioSource.uri(uri)).toList();
await player
.setAudioSources(
audioSources,
preload: true,
initialIndex: index,
initialPosition: position,
)
.catchError((error) {
_logger.shout('Error in setting audio source: $error');
return null;
});
}
@override
Future<void> setSpeed(double speed) async {
await player.setSpeed(speed);
}
@override
Future<void> setVolume(double volume) async {
await player.setVolume(volume);
}
@override
double get speed => player.speed;
}

View file

@ -25,12 +25,11 @@ class MyDrawer extends StatelessWidget {
ListTile(
title: const Text('server Settings'),
onTap: () {
// Navigator.of(context).push(
// PageRoute(
// context: context,
// builder: (context) => const ServerManagerPage(),
// ),
// );
Navigator.of(context).push(
MaterialPageRoute(
builder: (context) => const ServerManagerPage(),
),
);
},
),
ListTile(

View file

@ -294,7 +294,7 @@ class _BookOnShelfPlayButton extends HookConsumerWidget {
// book.media.asBookExpanded,
// userProgress?.currentTime,
// );
ref.read(absAudioPlayerProvider.notifier).load(
ref.read(audioPlayerProvider.notifier).load(
book.media.asBookExpanded,
initialPosition: userProgress?.currentTime,
);

View file

@ -46,17 +46,17 @@ class _TrayManagerState extends ConsumerState<TrayManager>
MenuItem(
key: 'play_pause',
label: '播放/暂停',
onClick: (menuItem) => ref.read(absAudioPlayerProvider).playOrPause(),
onClick: (menuItem) => ref.read(audioPlayerProvider).playOrPause(),
),
MenuItem(
key: 'previous',
label: '上一个',
onClick: (menuItem) => ref.read(absAudioPlayerProvider).previous(),
onClick: (menuItem) => ref.read(audioPlayerProvider).previous(),
),
MenuItem(
key: 'next',
label: '下一个',
onClick: (menuItem) => ref.read(absAudioPlayerProvider).next(),
onClick: (menuItem) => ref.read(audioPlayerProvider).next(),
),
MenuItem.separator(),
MenuItem(