6.0.3: Added vlc recording feature (#230)

* updated vlc event handling code

* fix vlc error description

* renamed error const strings

* fixed a minor bug

* Avoid FlutterVlcPlayerFactory new instances onAttachedToActivity (#214)

* Avoid FlutterVlcPlayerFactory new instances onAttachedToActivity

* Avoid FlutterVlcPlayerFactory instances in registerWith

* fix error description docs

* Added onInit & onRenderer listeners

* updated docs

mark onInit & onRendererHandler as deprecated.

* updated documentation

* fix initialization value of renderer variables

* fixed vlc error on adding a local subtitle/audio

* Added recording feature

* fix a minor issue

* updated platform recording methods

* updated ios recording methods

* updated pubspec

* Update flutter_vlc_player/ios/Classes/VlcViewBuilder.swift

Co-authored-by: Yuri Prykhodko <[email protected]>

* Update flutter_vlc_player/example/lib/vlc_player_with_controls.dart

Co-authored-by: Yuri Prykhodko <[email protected]>

* Update flutter_vlc_player/example/lib/single_tab.dart

Co-authored-by: Yuri Prykhodko <[email protected]>

* Update flutter_vlc_player/example/lib/single_tab.dart

Co-authored-by: Yuri Prykhodko <[email protected]>

* Update flutter_vlc_player/example/lib/single_tab.dart

Co-authored-by: Yuri Prykhodko <[email protected]>

* Update flutter_vlc_player/example/lib/vlc_player_with_controls.dart

Co-authored-by: Yuri Prykhodko <[email protected]>

* fixed mentioned issues

migrated from pedantic to lint package
updated readme

* added http options

updated readme

* updated readme

* removed http options

updated readme

Co-authored-by: Guillermo Jeremy De La Cruz Onton <[email protected]>
Co-authored-by: Mitch Ross <[email protected]>
Co-authored-by: Yuri Prykhodko <[email protected]>

Author: 4 people

README.md

@@ -103,6 +103,8 @@ android {
 -keep class org.videolan.libvlc.** { *; }
 ```
 
+<br>
+
 ## Quick Start
 To start using the plugin, copy this code or follow the example project in 'flutter_vlc_player/example'
 
@@ -172,12 +174,12 @@ class _MyHomePageState extends State<MyHomePage> {
   }
 }
 ```
+<br>
 
+### Recording feature
+To start/stop video recording, you have to call the `startRecording(String saveDirectory)` and `stopRecording()` methods, respectively. By calling the stop method you can get the path of recorded file from `vlcPlayerController.value.recordPath`.
 
-
-
-
-
+<hr>
 
 ## Upgrade instructions
 
@@ -203,13 +205,21 @@ If you have some changes made to the iOS app, recreate the app using above metho
 
 Be sure to follow instructions above after 
 
-<hr>
+<br>
 
 ### Breaking Changes (from V4 to V5)
 Entire platform has been refactored in v5. It will require a refactor of your app to follow v5. 
 
 <hr>
 
+## Known Issues
+<b>1)</b> The video recording feature is problematic in iOS/Android: if the video reaches its end while you're recording it, the underlying `vlckit`/`libvlc` library fails to finalize the recording process, and we cannot retrieve the recorded file. 
+The issue is reported and tracked here: 
+<br>
+[https://code.videolan.org/videolan/VLCKit/-/issues/394](https://code.videolan.org/videolan/VLCKit/-/issues/394) (see last comment from September 22, 2020)
+
+<hr>
+
 ## Current issues
 Current issues list [is here](https://github.com/solid-software/flutter_vlc_player/issues).   
 Found a bug? [Open the issue](https://github.com/solid-software/flutter_vlc_player/issues/new).

flutter_vlc_player/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 6.0.3
+* Added Vlc Recording feature
+Credits to Alireza Setayesh (https://github.com/alr2413).
+
 ## 6.0.2
 * Fix issue with vlc error event
 * Added onInit & onRenderer listeners

flutter_vlc_player/README.md

@@ -73,6 +73,36 @@ After that you can access the media/subtitle file by
 
 <hr>
 
+#### Android build configuration
+
+1. In `android/app/build.gradle`:
+```groovy
+android {
+    packagingOptions {
+       // Fixes duplicate libraries build issue, 
+       // when your project uses more than one plugin that depend on C++ libs.
+        pickFirst 'lib/**/libc++_shared.so'
+    }
+   
+   buildTypes {
+      release {
+         minifyEnabled true
+         useProguard true
+         proguardFiles getDefaultProguardFile(
+                 'proguard-android-optimize.txt'),
+                 'proguard-rules.pro'
+      }
+   }
+}
+```
+
+2. Create `android/app/proguard-rules.pro`, add the following lines:
+```proguard
+-keep class org.videolan.libvlc.** { *; }
+```
+
+<br>
+
 ## Quick Start
 To start using the plugin, copy this code or follow the example project in 'flutter_vlc_player/example'
 
@@ -145,11 +175,12 @@ class _MyHomePageState extends State<MyHomePage> {
 
 ```
 
+<br>
 
+### Recording feature
+To start/stop video recording, you have to call the `startRecording(String saveDirectory)` and `stopRecording()` methods, respectively. By calling the stop method you can get the path of recorded file from `vlcPlayerController.value.recordPath`.
 
-
-
-
+<hr>
 
 ## Upgrade instructions
 
@@ -175,13 +206,21 @@ If you have some changes made to the iOS app, recreate the app using above metho
 
 Be sure to follow instructions above after 
 
-<hr>
+<br>
 
 ### Breaking Changes (from V4 to V5)
 Entire platform has been refactored in v5. It will require a refactor of your app to follow v5. 
 
 <hr>
 
+## Known Issues
+<b>1)</b> The video recording feature is problematic in iOS/Android: if the video reaches its end while you're recording it, the underlying `vlckit`/`libvlc` library fails to finalize the recording process, and we cannot retrieve the recorded file. 
+The issue is reported and tracked here: 
+<br>
+[https://code.videolan.org/videolan/VLCKit/-/issues/394](https://code.videolan.org/videolan/VLCKit/-/issues/394) (see last comment from September 22, 2020)
+
+<hr>
+
 ## Current issues
 Current issues list [is here](https://github.com/solid-software/flutter_vlc_player/issues).   
 Found a bug? [Open the issue](https://github.com/solid-software/flutter_vlc_player/issues/new).

flutter_vlc_player/analysis_options.yaml

@@ -1 +1 @@
-include: package:pedantic/analysis_options.yaml
+include: package:flutter_lints/flutter.yaml

flutter_vlc_player/android/build.gradle

@@ -8,7 +8,7 @@ buildscript {
     }
 
     dependencies {
-        classpath 'com.android.tools.build:gradle:4.0.0'
+        classpath 'com.android.tools.build:gradle:4.1.3'
     }
 }
 
@@ -42,5 +42,5 @@ dependencies {
     implementation 'org.videolan.android:libvlc-all:3.3.14'
     implementation 'androidx.appcompat:appcompat:1.2.0'
     implementation 'androidx.legacy:legacy-support-v4:1.0.0'
-    implementation 'androidx.annotation:annotation:1.1.0'
+    implementation 'androidx.annotation:annotation:1.2.0'
 }

flutter_vlc_player/android/src/main/java/software/solid/fluttervlcplayer/FlutterVlcPlayer.java

@@ -50,8 +50,8 @@ final class FlutterVlcPlayer implements PlatformView {
     //
     private LibVLC libVLC;
     private MediaPlayer mediaPlayer;
-    private List<RendererDiscoverer> rendererDiscoverers = new ArrayList<>();;
-    private List<RendererItem> rendererItems = new ArrayList<>();;
+    private List<RendererDiscoverer> rendererDiscoverers = new ArrayList<>();
+    private List<RendererItem> rendererItems = new ArrayList<>();
     private boolean isDisposed = false;
 
     // Platform view
@@ -287,13 +287,19 @@ public void onEvent(MediaPlayer.Event event) {
                                 mediaEventSink.success(eventObject);
                                 break;
 
+                            case MediaPlayer.Event.RecordChanged:
+                                eventObject.put("event", "recording");
+                                eventObject.put("isRecording", event.getRecording());
+                                eventObject.put("recordPath", event.getRecordPath());
+                                mediaEventSink.success(eventObject);
+                                break;
+
                             case MediaPlayer.Event.LengthChanged:
                             case MediaPlayer.Event.MediaChanged:
                             case MediaPlayer.Event.ESAdded:
                             case MediaPlayer.Event.ESDeleted:
                             case MediaPlayer.Event.ESSelected:
                             case MediaPlayer.Event.PausableChanged:
-                            case MediaPlayer.Event.RecordChanged:
                             case MediaPlayer.Event.SeekableChanged:
                             case MediaPlayer.Event.PositionChanged:
                             default:
@@ -426,11 +432,8 @@ long getSpuDelay() {
         return mediaPlayer.getSpuDelay();
     }
 
-    void addSubtitleTrack(String url, boolean isNetworkUrl, boolean isSelected) {
-        if (isNetworkUrl)
-            mediaPlayer.addSlave(Media.Slave.Type.Subtitle, Uri.parse(url), isSelected);
-        else
-            mediaPlayer.addSlave(Media.Slave.Type.Subtitle, url, isSelected);
+    void addSubtitleTrack(String url, boolean isSelected) {
+        mediaPlayer.addSlave(Media.Slave.Type.Subtitle, Uri.parse(url), isSelected);
     }
 
     int getAudioTracksCount() {
@@ -464,11 +467,8 @@ long getAudioDelay() {
         return mediaPlayer.getAudioDelay();
     }
 
-    void addAudioTrack(String url, boolean isNetworkUrl, boolean isSelected) {
-        if (isNetworkUrl)
-            mediaPlayer.addSlave(Media.Slave.Type.Audio, Uri.parse(url), isSelected);
-        else
-            mediaPlayer.addSlave(Media.Slave.Type.Audio, url, isSelected);
+    void addAudioTrack(String url, boolean isSelected) {
+        mediaPlayer.addSlave(Media.Slave.Type.Audio, Uri.parse(url), isSelected);
     }
 
     int getVideoTracksCount() {
@@ -627,6 +627,14 @@ String getSnapshot() {
         return Base64.encodeToString(outputStream.toByteArray(), Base64.NO_WRAP);
     }
 
+    Boolean startRecording(String directory) {
+        return mediaPlayer.record(directory);
+    }
+
+    Boolean stopRecording() {
+        return mediaPlayer.record(null);
+    }
+
     private void log(String message) {
         if (debug) {
             Log.d(TAG, message);

flutter_vlc_player/android/src/main/java/software/solid/fluttervlcplayer/FlutterVlcPlayerBuilder.java

@@ -252,8 +252,7 @@ public Messages.DelayMessage getSpuDelay(Messages.TextureMessage arg) {
     @Override
     public void addSubtitleTrack(Messages.AddSubtitleMessage arg) {
         FlutterVlcPlayer player = vlcPlayers.get(arg.getTextureId());
-        boolean isNetworkUrl = arg.getType() == DataSourceType.NETWORK.getNumericType();
-        player.addSubtitleTrack(arg.getUri(), isNetworkUrl, arg.getIsSelected());
+        player.addSubtitleTrack(arg.getUri(), arg.getIsSelected());
     }
 
     @Override
@@ -303,8 +302,7 @@ public Messages.DelayMessage getAudioDelay(Messages.TextureMessage arg) {
     @Override
     public void addAudioTrack(Messages.AddAudioMessage arg) {
         FlutterVlcPlayer player = vlcPlayers.get(arg.getTextureId());
-        boolean isNetworkUrl = arg.getType() == DataSourceType.NETWORK.getNumericType();
-        player.addAudioTrack(arg.getUri(), isNetworkUrl, arg.getIsSelected());
+        player.addAudioTrack(arg.getUri(), arg.getIsSelected());
     }
 
     @Override
@@ -399,4 +397,21 @@ public void castToRenderer(Messages.RenderDeviceMessage arg) {
         player.castToRenderer(arg.getRendererDevice());
     }
 
+    @Override
+    public Messages.BooleanMessage startRecording(Messages.RecordMessage arg) {
+        FlutterVlcPlayer player = vlcPlayers.get(arg.getTextureId());
+        Boolean result = player.startRecording(arg.getSaveDirectory());
+        Messages.BooleanMessage message = new Messages.BooleanMessage();
+        message.setResult(result);
+        return message;
+    }
+
+    @Override
+    public Messages.BooleanMessage stopRecording(Messages.TextureMessage arg) {
+        FlutterVlcPlayer player = vlcPlayers.get(arg.getTextureId());
+        Boolean result = player.stopRecording();
+        Messages.BooleanMessage message = new Messages.BooleanMessage();
+        message.setResult(result);
+        return message;
+    }
 }