Merge pull request #69 from adeeteya/lyrics

Lyrics

Author: adeeteya

.github/workflows/pr-checker.yaml

@@ -4,7 +4,7 @@ on:
   pull_request:
 
 env:
-  FLUTTER_VERSION: 3.35.6
+  FLUTTER_VERSION: 3.35.7
 
 jobs:
   lint:

lib/core/models/music_metadata.dart

@@ -100,6 +100,8 @@ class MusicMetadata extends HiveObject {
   /// Rating of the track.
   final int rating;
 
+  final String? lyrics;
+
   MusicMetadata({
     this.trackName,
     this.trackArtistNames,
@@ -118,6 +120,7 @@ class MusicMetadata extends HiveObject {
     this.originalSongIndex = 0,
     this.isOnDevice = true,
     this.rating = 0,
+    this.lyrics,
   });
 
   factory MusicMetadata.fromAudioMetadata(
@@ -148,6 +151,7 @@ class MusicMetadata extends HiveObject {
       filePath: audioMetadata.file.path,
       thumbnailPath: thumbnailPath,
       originalSongIndex: originalSongIndex,
+      lyrics: audioMetadata.lyrics,
     );
   }
 
@@ -173,6 +177,7 @@ class MusicMetadata extends HiveObject {
     originalSongIndex: map['originalSongIndex'],
     isOnDevice: map['isOnDevice'],
     rating: map['rating'],
+    lyrics: map['lyrics'],
   );
 
   Map<String, dynamic> toMap() => {
@@ -193,6 +198,7 @@ class MusicMetadata extends HiveObject {
     'originalSongIndex': originalSongIndex,
     'isOnDevice': isOnDevice,
     'rating': rating,
+    'lyrics': lyrics,
   };
 
   factory MusicMetadata.fromJson(String source) =>
@@ -218,6 +224,7 @@ class MusicMetadata extends HiveObject {
     int? originalSongIndex,
     bool? isOnDevice,
     int? rating,
+    String? lyrics,
   }) {
     return MusicMetadata(
       trackName: trackName ?? this.trackName,
@@ -237,6 +244,7 @@ class MusicMetadata extends HiveObject {
       originalSongIndex: originalSongIndex ?? this.originalSongIndex,
       isOnDevice: isOnDevice ?? this.isOnDevice,
       rating: rating ?? this.rating,
+      lyrics: lyrics ?? this.lyrics,
     );
   }
 
@@ -376,7 +384,8 @@ class MusicMetadata extends HiveObject {
         trackDuration == other.trackDuration &&
         bitrate == other.bitrate &&
         filePath == other.filePath &&
-        rating == other.rating;
+        rating == other.rating &&
+        lyrics == other.lyrics;
   }
 
   @override
@@ -395,6 +404,7 @@ class MusicMetadata extends HiveObject {
     bitrate,
     filePath,
     rating,
+    lyrics,
   );
 }
 

lib/features/now_playing/screen/now_playing_screen.dart

@@ -8,6 +8,7 @@ import 'package:classipod/core/widgets/empty_state_widget.dart';
 import 'package:classipod/features/device/models/device_action.dart';
 import 'package:classipod/features/device/services/device_buttons_service_provider.dart';
 import 'package:classipod/features/now_playing/provider/now_playing_details_provider.dart';
+import 'package:classipod/features/now_playing/widgets/lyrics_view.dart';
 import 'package:classipod/features/now_playing/widgets/now_playing_bottom_bar.dart';
 import 'package:classipod/features/now_playing/widgets/now_playing_widget.dart';
 import 'package:classipod/features/now_playing/widgets/rating_bar.dart';
@@ -27,6 +28,7 @@ enum _NowPlayingBottomBarPage {
   volumeBar,
   shuffleBar,
   ratingBar,
+  lyrics,
 }
 
 class NowPlayingScreen extends ConsumerStatefulWidget {
@@ -38,14 +40,22 @@ class NowPlayingScreen extends ConsumerStatefulWidget {
 
 class _NowPlayingScreenState extends ConsumerState<NowPlayingScreen> {
   final PageController _bottomBarPageController = PageController();
+  final ScrollController _lyricsScrollController = ScrollController();
   late Timer _longPressTimer;
   Timer _lastVolumeChangeTimer = Timer(Duration.zero, () {});
   bool _isShuffleEnabled = false;
   _NowPlayingBottomBarPage _bottomBarPage = _NowPlayingBottomBarPage.seekBar;
+  int? _lastLyricsSongIndex;
 
   String get routeName => Routes.nowPlaying.name;
 
   Future<void> onSelectPressed() async {
+    final String? lyrics = ref
+        .read(nowPlayingDetailsProvider)
+        .currentMetadata
+        ?.lyrics;
+    final bool hasLyrics = lyrics != null && lyrics.trim().isNotEmpty;
+
     if (_bottomBarPage == _NowPlayingBottomBarPage.seekBar) {
       await _bottomBarPageController.animateToPage(
         1,
@@ -77,6 +87,26 @@ class _NowPlayingScreenState extends ConsumerState<NowPlayingScreen> {
         _bottomBarPage = _NowPlayingBottomBarPage.ratingBar;
       });
     } else if (_bottomBarPage == _NowPlayingBottomBarPage.ratingBar) {
+      if (hasLyrics) {
+        await _bottomBarPageController.animateToPage(
+          4,
+          duration: const Duration(milliseconds: 300),
+          curve: Curves.ease,
+        );
+        setState(() {
+          _bottomBarPage = _NowPlayingBottomBarPage.lyrics;
+        });
+      } else {
+        await _bottomBarPageController.animateToPage(
+          0,
+          duration: const Duration(milliseconds: 300),
+          curve: Curves.ease,
+        );
+        setState(() {
+          _bottomBarPage = _NowPlayingBottomBarPage.seekBar;
+        });
+      }
+    } else if (_bottomBarPage == _NowPlayingBottomBarPage.lyrics) {
       await _bottomBarPageController.animateToPage(
         0,
         duration: const Duration(milliseconds: 300),
@@ -92,6 +122,28 @@ class _NowPlayingScreenState extends ConsumerState<NowPlayingScreen> {
     unawaited(context.pushNamed(Routes.nowPlayingMoreOptions.name));
   }
 
+  Future<void> scrollLyrics(double offsetChange) async {
+    if (!_lyricsScrollController.hasClients) {
+      return;
+    }
+
+    final ScrollPosition position = _lyricsScrollController.position;
+    final double targetOffset = (position.pixels + offsetChange).clamp(
+      position.minScrollExtent,
+      position.maxScrollExtent,
+    );
+
+    if (targetOffset == position.pixels) {
+      return;
+    }
+
+    await _lyricsScrollController.animateTo(
+      targetOffset,
+      duration: const Duration(milliseconds: 200),
+      curve: Curves.easeOut,
+    );
+  }
+
   void startVolumeTimer() {
     if (_lastVolumeChangeTimer.isActive) {
       _lastVolumeChangeTimer.cancel();
@@ -122,6 +174,9 @@ class _NowPlayingScreenState extends ConsumerState<NowPlayingScreen> {
           .read(nowPlayingDetailsProvider.notifier)
           .increaseCurrentMetadataRating();
       return;
+    } else if (_bottomBarPage == _NowPlayingBottomBarPage.lyrics) {
+      await scrollLyrics(60);
+      return;
     }
     setState(() {
       _bottomBarPage = _NowPlayingBottomBarPage.volumeBar;
@@ -146,6 +201,9 @@ class _NowPlayingScreenState extends ConsumerState<NowPlayingScreen> {
           .read(nowPlayingDetailsProvider.notifier)
           .decreaseCurrentMetadataRating();
       return;
+    } else if (_bottomBarPage == _NowPlayingBottomBarPage.lyrics) {
+      await scrollLyrics(-60);
+      return;
     }
     setState(() {
       _bottomBarPage = _NowPlayingBottomBarPage.volumeBar;
@@ -203,6 +261,7 @@ class _NowPlayingScreenState extends ConsumerState<NowPlayingScreen> {
   void dispose() {
     _lastVolumeChangeTimer.cancel();
     _bottomBarPageController.dispose();
+    _lyricsScrollController.dispose();
     super.dispose();
   }
 
@@ -249,6 +308,34 @@ class _NowPlayingScreenState extends ConsumerState<NowPlayingScreen> {
   @override
   Widget build(BuildContext context) {
     final nowPlayingDetails = ref.watch(nowPlayingDetailsProvider);
+    final String? lyrics = nowPlayingDetails.currentMetadata?.lyrics;
+    final bool hasLyrics = lyrics != null && lyrics.trim().isNotEmpty;
+    final int? currentLyricsSongIndex =
+        nowPlayingDetails.currentMetadata?.originalSongIndex;
+
+    if (_lastLyricsSongIndex != currentLyricsSongIndex) {
+      _lastLyricsSongIndex = currentLyricsSongIndex;
+      WidgetsBinding.instance.addPostFrameCallback((_) {
+        if (!_lyricsScrollController.hasClients) {
+          return;
+        }
+        _lyricsScrollController.jumpTo(0);
+      });
+    }
+
+    if (!hasLyrics && _bottomBarPage == _NowPlayingBottomBarPage.lyrics) {
+      WidgetsBinding.instance.addPostFrameCallback((_) {
+        if (!mounted) {
+          return;
+        }
+        if (_bottomBarPageController.hasClients) {
+          _bottomBarPageController.jumpToPage(0);
+        }
+        setState(() {
+          _bottomBarPage = _NowPlayingBottomBarPage.seekBar;
+        });
+      });
+    }
 
     ref.listen(deviceButtonsServiceProvider, deviceControlHandler);
 
@@ -305,7 +392,23 @@ class _NowPlayingScreenState extends ConsumerState<NowPlayingScreen> {
               onLongPress: onSelectLongPress,
               child: Padding(
                 padding: const EdgeInsets.only(left: 10),
-                child: NowPlayingWidget(nowPlayingDetails: nowPlayingDetails),
+                child: AnimatedSwitcher(
+                  duration: const Duration(milliseconds: 300),
+                  child:
+                      (_bottomBarPage == _NowPlayingBottomBarPage.lyrics &&
+                          hasLyrics)
+                      ? LyricsView(
+                          key: ValueKey(
+                            'lyrics-view-${nowPlayingDetails.currentMetadata?.originalSongIndex ?? 0}',
+                          ),
+                          lyrics: lyrics,
+                          scrollController: _lyricsScrollController,
+                        )
+                      : NowPlayingWidget(
+                          key: const ValueKey('now-playing-view'),
+                          nowPlayingDetails: nowPlayingDetails,
+                        ),
+                ),
               ),
             ),
           ),
@@ -360,6 +463,7 @@ class _NowPlayingScreenState extends ConsumerState<NowPlayingScreen> {
                                   .setCurrentMetadataRating(val ?? 0);
                             },
                           ),
+                          if (hasLyrics) const SizedBox(height: 10),
                         ],
                       ),
               ),

lib/features/now_playing/widgets/lyrics_view.dart

@@ -0,0 +1,34 @@
+import 'package:flutter/cupertino.dart';
+
+class LyricsView extends StatelessWidget {
+  final String lyrics;
+  final ScrollController scrollController;
+
+  const LyricsView({
+    super.key,
+    required this.lyrics,
+    required this.scrollController,
+  });
+
+  @override
+  Widget build(BuildContext context) {
+    return SizedBox(
+      width: double.infinity,
+      child: CupertinoScrollbar(
+        controller: scrollController,
+        child: SingleChildScrollView(
+          controller: scrollController,
+          padding: const EdgeInsets.only(right: 10),
+          child: Text(
+            lyrics,
+            style: const TextStyle(
+              fontSize: 16,
+              height: 1.4,
+              fontWeight: FontWeight.bold,
+            ),
+          ),
+        ),
+      ),
+    );
+  }
+}

lib/hive/hive_adapters.g.dart

@@ -13,7 +13,7 @@ types:
         index: 2
   MusicMetadata:
     typeId: 2
-    nextIndex: 17
+    nextIndex: 18
     fields:
       trackName:
         index: 0
@@ -49,6 +49,8 @@ types:
         index: 15
       rating:
         index: 16
+      lyrics:
+        index: 17
   ExcludeDirectoryModel:
     typeId: 3
     nextIndex: 2

lib/hive/hive_adapters.g.yaml

@@ -149,10 +149,10 @@ packages:
     dependency: "direct dev"
     description:
       name: build_runner
-      sha256: "8cd45bdd6217138f4cfbaf6286c93f270ae4b3e2e281e69c904bd00cdf8aa626"
+      sha256: a9461b8e586bf018dd4afd2e13b49b08c6a844a4b226c8d1d10f3a723cdd78c3
       url: "https://pub.dev"
     source: hosted
-    version: "2.10.0"
+    version: "2.10.1"
   built_collection:
     dependency: transitive
     description:
@@ -1578,4 +1578,4 @@ packages:
     version: "2.1.0"
 sdks:
   dart: ">=3.9.2 <4.0.0"
-  flutter: "3.35.6"
+  flutter: "3.35.7"

pubspec.lock

@@ -7,7 +7,7 @@ version: 1.11.0+24
 
 environment:
   sdk: ^3.9.2
-  flutter: 3.35.6
+  flutter: 3.35.7
 
 dependencies:
   audio_metadata_reader: ^1.4.2
@@ -50,7 +50,7 @@ dependencies:
   volume_controller: ^3.4.0
 
 dev_dependencies:
-  build_runner: ^2.10.0
+  build_runner: ^2.10.1
   custom_lint: ^0.8.1
   flutter_lints: ^6.0.0
   flutter_test: