Merge pull request #2 from Crazelu/feat/duration-sync

Crazelu · web-flow · commit 934a1136f983 · 2025-10-17T23:14:59.000+01:00
FEAT: Duration sync
diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml
@@ -0,0 +1,42 @@
+name: CI
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+env:
+  flutter_version: "3.29.3"
+  java_version: "17.x"
+
+jobs:
+  format-and-lint:
+    name: Linting and tests
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v1
+      - uses: actions/setup-java@v1
+        with:
+          java-version: ${{ env.java_version }}
+      - name: Cache Flutter dependencies
+        uses: actions/cache@v3
+        with:
+          path: /opt/hostedtoolcache/flutter
+          key: ${{ runner.OS }}-flutter-install-cache-${{ env.flutter_version }}
+      - uses: subosito/flutter-action@v2
+        with:
+          flutter-version: ${{ env.flutter_version }}
+      - name: Install dependencies
+        run: flutter pub get
+      - name: Format code
+        run: dart format . --set-exit-if-changed
+      - name: Lint analysis
+        run: flutter analyze --no-pub
+      - name: Run tests
+        run: flutter test --coverage
+      - name: Upload coverage to codecov
+        uses: codecov/codecov-action@v4.0.1
+        with:
+          file: ./coverage/lcov.info
+          token: ${{ secrets.CODECOV_TOKEN }}
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,3 @@
-## 0.0.1
+## 1.0.0
 
-- Initial pre-release version.
+- Initial release version.
diff --git a/README.md b/README.md
@@ -1,21 +1,28 @@
 # Subtitle Player
-A Flutter package for synchronizing subtitles with video and audio playback.
+
+<p align="center">
+  <a href="https://pub.dev/packages/subtitle_player/score"><img src="https://img.shields.io/pub/likes/subtitle_player" alt="likes"></a>
+  <a href="https://pub.dev/packages/subtitle_player/score"><img src="https://img.shields.io/pub/points/subtitle_player" alt="pub points"></a>
+  <a href="https://codecov.io/gh/crazelu/subtitle_player"><img src="https://codecov.io/gh/crazelu/subtitle_player/graph/badge.svg" alt="code coverage"/></a>
+</p>
+
+
+A library for synchronizing subtitles with video and audio playback.
+
 
 ## Features 📦
 
-- [x] Load SubRip, WebVTT and LRC subtitles
+- [x] Load SubRip, WebVTT and LRC formats
 - [x] Play, pause and seek support
 - [x] Adjust playback speed
 
 ## Install 🚀
 
-In the `pubspec.yaml` of your flutter project, add the `subtitle_player` dependency:
+In the `pubspec.yaml` of your Flutter/Dart project, add the `subtitle_player` dependency:
 
 ```yaml
 dependencies:
-    subtitle_player:
-        git:
-            url: https://github.com/Crazelu/subtitle_player.git
+    subtitle_player: ^1.0.0
 ```
 
 ## Import the package in your project 📥
@@ -77,6 +84,21 @@ Subscribe to `SubtitleController` for changes using `ValuelistenableBuilder`, `L
 )
 ```
 
+Alternatively, you can attach a listener to the audio/video playback's position and call the `sync` method whenever the position changes.
+
+```dart
+// Example with JustAudio
+
+final player = AudioPlayer();
+final positionStream = player.createPositionStream();
+
+final streamSubscription = positionStream.listen((position) {
+    subtitleController.sync(position);
+});
+
+// make sure to cancel the stream subscription when ready to release resources
+```
+
 Check the [example project](https://github.com/Crazelu/subtitle_player/tree/main/example) for more detailed usage examples both for video and audio playing.
 
 ## Demo 📷
diff --git a/example/.gitignore b/example/.gitignore
@@ -5,9 +5,11 @@
 *.swp
 .DS_Store
 .atom/
+.build/
 .buildlog/
 .history
 .svn/
+.swiftpm/
 migrate_working_dir/
 
 # IntelliJ related
diff --git a/example/android/.gitignore b/example/android/.gitignore
@@ -11,3 +11,4 @@ GeneratedPluginRegistrant.java
 key.properties
 **/*.keystore
 **/*.jks
+app/.cxx/
diff --git a/example/android/app/build.gradle b/example/android/app/build.gradle
@@ -25,7 +25,7 @@ if (flutterVersionName == null) {
 android {
     namespace "com.example.example"
     compileSdk flutter.compileSdkVersion
-    ndkVersion flutter.ndkVersion
+    ndkVersion "27.0.12077973"
 
     compileOptions {
         sourceCompatibility JavaVersion.VERSION_1_8
diff --git a/example/android/gradle/wrapper/gradle-wrapper.properties b/example/android/gradle/wrapper/gradle-wrapper.properties
@@ -2,4 +2,4 @@ distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-7.6.3-all.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-8.9-all.zip
diff --git a/example/android/settings.gradle b/example/android/settings.gradle
@@ -19,8 +19,8 @@ pluginManagement {
 
 plugins {
     id "dev.flutter.flutter-plugin-loader" version "1.0.0"
-    id "com.android.application" version "7.3.0" apply false
-    id "org.jetbrains.kotlin.android" version "1.7.10" apply false
+    id "com.android.application" version "8.7.1" apply false
+    id "org.jetbrains.kotlin.android" version "1.9.0" apply false
 }
 
 include ":app"
diff --git a/example/ios/Podfile.lock b/example/ios/Podfile.lock
@@ -4,6 +4,7 @@ PODS:
   - Flutter (1.0.0)
   - just_audio (0.0.1):
     - Flutter
+    - FlutterMacOS
   - path_provider_foundation (0.0.1):
     - Flutter
     - FlutterMacOS
@@ -14,7 +15,7 @@ PODS:
 DEPENDENCIES:
   - audio_session (from `.symlinks/plugins/audio_session/ios`)
   - Flutter (from `Flutter`)
-  - just_audio (from `.symlinks/plugins/just_audio/ios`)
+  - just_audio (from `.symlinks/plugins/just_audio/darwin`)
   - path_provider_foundation (from `.symlinks/plugins/path_provider_foundation/darwin`)
   - video_player_avfoundation (from `.symlinks/plugins/video_player_avfoundation/darwin`)
 
@@ -24,19 +25,19 @@ EXTERNAL SOURCES:
   Flutter:
     :path: Flutter
   just_audio:
-    :path: ".symlinks/plugins/just_audio/ios"
+    :path: ".symlinks/plugins/just_audio/darwin"
   path_provider_foundation:
     :path: ".symlinks/plugins/path_provider_foundation/darwin"
   video_player_avfoundation:
     :path: ".symlinks/plugins/video_player_avfoundation/darwin"
 
 SPEC CHECKSUMS:
-  audio_session: 088d2483ebd1dc43f51d253d4a1c517d9a2e7207
+  audio_session: 9bb7f6c970f21241b19f5a3658097ae459681ba0
   Flutter: e0871f40cf51350855a761d2e70bf5af5b9b5de7
-  just_audio: baa7252489dbcf47a4c7cc9ca663e9661c99aafa
-  path_provider_foundation: 3784922295ac71e43754bd15e0653ccfd36a147c
-  video_player_avfoundation: 2b4384f3b157206b5e150a0083cdc0c905d260d3
+  just_audio: 4e391f57b79cad2b0674030a00453ca5ce817eed
+  path_provider_foundation: 080d55be775b7414fd5a5ef3ac137b97b097e564
+  video_player_avfoundation: 2cef49524dd1f16c5300b9cd6efd9611ce03639b
 
 PODFILE CHECKSUM: 819463e6a0290f5a72f145ba7cde16e8b6ef0796
 
-COCOAPODS: 1.14.3
+COCOAPODS: 1.16.2
diff --git a/example/ios/Runner.xcodeproj/xcshareddata/xcschemes/Runner.xcscheme b/example/ios/Runner.xcodeproj/xcshareddata/xcschemes/Runner.xcscheme
@@ -59,6 +59,7 @@
       ignoresPersistentStateOnLaunch = "NO"
       debugDocumentVersioning = "YES"
       debugServiceExtension = "internal"
+      enableGPUValidationMode = "1"
       allowLocationSimulation = "YES">
       <BuildableProductRunnable
          runnableDebuggingMode = "0">
diff --git a/example/ios/Runner/AppDelegate.swift b/example/ios/Runner/AppDelegate.swift
@@ -1,7 +1,7 @@
 import UIKit
 import Flutter
 
-@UIApplicationMain
+@main
 @objc class AppDelegate: FlutterAppDelegate {
   override func application(
     _ application: UIApplication,
diff --git a/example/lib/audio_player_screen.dart b/example/lib/audio_player_screen.dart
@@ -52,14 +52,14 @@ class AudioPlayerScreenState extends State<AudioPlayerScreen>
       }
     }, onError: (Object e, StackTrace stackTrace) {
       // Listen to errors during playback.
-      print('A stream error occurred: $e');
+      debugPrint('A stream error occurred: $e');
     });
     // Try to load audio from a source and catch any errors.
     try {
       // AAC example: https://dl.espressif.com/dl/audio/ff-16b-2c-44100hz.aac
       await _player.setAudioSource(AudioSource.asset('assets/demo.mp3'));
     } on PlayerException catch (e) {
-      print("Error loading audio source: $e");
+      debugPrint("Error loading audio source: $e");
     }
 
     _player.setLoopMode(LoopMode.all);
diff --git a/example/lib/lyrics_bottom_sheet.dart b/example/lib/lyrics_bottom_sheet.dart
@@ -139,7 +139,7 @@ class LyricsWidget extends StatelessWidget {
             style: TextStyle(
               fontSize: 24,
               fontWeight: active ? FontWeight.bold : FontWeight.w700,
-              color: active ? Colors.black : Colors.black.withOpacity(0.4),
+              color: active ? Colors.black : Colors.black.withValues(alpha: .4),
             ),
           ),
         ),
diff --git a/example/lib/video_player_screen.dart b/example/lib/video_player_screen.dart
@@ -77,7 +77,7 @@ class VideoPlayerScreenState extends State<VideoPlayerScreen> {
                       margin: const EdgeInsets.only(bottom: 8),
                       decoration: BoxDecoration(
                         borderRadius: BorderRadius.circular(4),
-                        color: Colors.black.withOpacity(0.65),
+                        color: Colors.black.withValues(alpha: 0.65),
                       ),
                       child: Text(
                         subtitleValue.currentSubtitle,
diff --git a/example/test/widget_test.dart b/example/test/widget_test.dart
@@ -13,26 +13,32 @@ void main() {
 
     expect(find.byType(TextButton), findsNWidgets(2));
   });
-  testWidgets('Test navigation to audio player example',
-      (WidgetTester tester) async {
-    await tester.pumpWidget(const MyApp());
 
-    await tester.tap(find.byType(TextButton).last);
-    await tester.pumpAndSettle();
+  testWidgets(
+    'Test navigation to audio player example',
+    (WidgetTester tester) async {
+      await tester.pumpWidget(const MyApp());
 
-    expect(find.byType(AudioPlayerScreen), findsOneWidget);
-  });
-  testWidgets('Test navigation to video player example',
-      (WidgetTester tester) async {
-    VideoPlayerPlatform.instance = MockVideoPlatform();
-    await tester.pumpWidget(const MyApp());
+      await tester.tap(find.byType(TextButton).last);
+      await tester.pumpAndSettle();
 
-    await tester.tap(find.byType(TextButton).first);
-    await tester.pump();
-    await tester.pump();
+      expect(find.byType(AudioPlayerScreen), findsOneWidget);
+    },
+  );
 
-    expect(find.byType(VideoPlayerScreen), findsOneWidget);
-  });
+  testWidgets(
+    'Test navigation to video player example',
+    (WidgetTester tester) async {
+      VideoPlayerPlatform.instance = MockVideoPlatform();
+      await tester.pumpWidget(const MyApp());
+
+      await tester.tap(find.byType(TextButton).first);
+      await tester.pump();
+      await tester.pump();
+
+      expect(find.byType(VideoPlayerScreen), findsOneWidget);
+    },
+  );
 }
 
 class MockVideoPlatform
@@ -107,4 +113,19 @@ class MockVideoPlatform
   Stream<VideoEvent> videoEventsFor(int textureId) {
     return const Stream.empty();
   }
+
+  @override
+  Widget buildViewWithOptions(VideoViewOptions options) {
+    return const SizedBox.shrink();
+  }
+
+  @override
+  Future<int?> createWithOptions(VideoCreationOptions options) {
+    return Future.value(1);
+  }
+
+  @override
+  Future<void> setAllowBackgroundPlayback(bool allowBackgroundPlayback) {
+    return Future.value();
+  }
 }
diff --git a/lib/src/subtitle_controller.dart b/lib/src/subtitle_controller.dart
diff --git a/pubspec.yaml b/pubspec.yaml
diff --git a/test/subtitle_controller_test.dart b/test/subtitle_controller_test.dart
diff --git a/test/subtitle_test.dart b/test/subtitle_test.dart

Original file line number	Diff line number	Diff line change
`@@ -19,8 +19,8 @@ pluginManagement {`
`19`	`19`
`20`	`20`	`plugins {`
`21`	`21`	`id "dev.flutter.flutter-plugin-loader" version "1.0.0"`
`22`		`- id "com.android.application" version "7.3.0" apply false`
`23`		`- id "org.jetbrains.kotlin.android" version "1.7.10" apply false`
	`22`	`+ id "com.android.application" version "8.7.1" apply false`
	`23`	`+ id "org.jetbrains.kotlin.android" version "1.9.0" apply false`
`24`	`24`	`}`
`25`	`25`
`26`	`26`	`include ":app"`