Fix memory leak issue (#169)

* fixed dart deprecation warning

added the missing async await to some platform methods

* fix memory leak issues

* added isDisposed var to android part

* updated readme

* updated readme

* updated example code

* fix android deprecated warning issue

Author: alr2413

README.md

@@ -124,10 +124,11 @@ class _MyHomePageState extends State<MyHomePage> {
   }
 
   @override
-  void dispose() {
-    _videoPlayerController.stopRendererScanning();
-    _videoPlayerController.removeListener(() {});
+  void dispose() async {
     super.dispose();
+    _videoPlayerController.removeListener(() {});
+    await _videoPlayerController.stopRendererScanning();
+    await _videoViewController.dispose();
   }
 
   @override

flutter_vlc_player/README.md

@@ -123,10 +123,10 @@ class _MyHomePageState extends State<MyHomePage> {
   }
 
   @override
-  void dispose() {
-    _videoPlayerController.stopRendererScanning();
-    _videoPlayerController.removeListener(() {});
+  void dispose() async {
     super.dispose();
+    await _videoPlayerController.stopRendererScanning();
+    await _videoViewController.dispose();
   }
 
   @override

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

@@ -52,13 +52,35 @@ final class FlutterVlcPlayer implements PlatformView {
     private MediaPlayer mediaPlayer;
     private List<RendererDiscoverer> rendererDiscoverers;
     private List<RendererItem> rendererItems;
+    private boolean isDisposed = false;
 
     // Platform view
     @Override
     public View getView() {
         return textureView;
     }
 
+    @Override
+    public void dispose() {
+        if (isDisposed)
+            return;
+        //
+        textureEntry.release();
+        mediaEventChannel.setStreamHandler(null);
+        rendererEventChannel.setStreamHandler(null);
+        if (mediaPlayer != null) {
+            mediaPlayer.stop();
+            mediaPlayer.getVLCVout().detachViews();
+            mediaPlayer.release();
+            mediaPlayer = null;
+        }
+        if (libVLC != null) {
+            libVLC.release();
+            libVLC = null;
+        }
+        isDisposed = true;
+    }
+
     // VLC Player
     FlutterVlcPlayer(int viewId, Context context, BinaryMessenger binaryMessenger, TextureRegistry textureRegistry) {
         this.context = context;
@@ -536,10 +558,12 @@ public void onEvent(RendererDiscoverer.Event event) {
     }
 
     void stopRendererScanning() {
+        if (isDisposed)
+            return;
+        //
         for (RendererDiscoverer rendererDiscoverer : rendererDiscoverers) {
             rendererDiscoverer.stop();
             rendererDiscoverer.setEventListener(null);
-
         }
         rendererDiscoverers.clear();
         rendererItems.clear();
@@ -571,6 +595,9 @@ HashMap<String, String> getRendererDevices() {
     }
 
     void castToRenderer(String rendererDevice) {
+        if(isDisposed)
+            return;
+        //
         boolean isPlaying = mediaPlayer.isPlaying();
         if (isPlaying)
             mediaPlayer.pause();
@@ -596,19 +623,6 @@ String getSnapshot() {
         return Base64.encodeToString(outputStream.toByteArray(), Base64.DEFAULT);
     }
 
-    public void dispose() {
-        textureEntry.release();
-        mediaEventChannel.setStreamHandler(null);
-        rendererEventChannel.setStreamHandler(null);
-        if (mediaPlayer != null) {
-            mediaPlayer.stop();
-            mediaPlayer.getVLCVout().detachViews();
-            mediaPlayer.release();
-        }
-        if (libVLC != null)
-            libVLC.release();
-    }
-
     private void log(String message) {
         if (debug) {
             Log.d(TAG, message);

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

@@ -82,8 +82,7 @@ public void create(Messages.CreateMessage arg) {
 
     @Override
     public void dispose(Messages.TextureMessage arg) {
-        FlutterVlcPlayer player = vlcPlayers.get(arg.getTextureId());
-        player.dispose();
+        // the player has been already disposed by platform we just remove it from players list
         vlcPlayers.remove(arg.getTextureId());
     }
 

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

@@ -9,8 +9,6 @@
 import io.flutter.embedding.engine.plugins.FlutterPlugin;
 import io.flutter.embedding.engine.plugins.activity.ActivityAware;
 import io.flutter.embedding.engine.plugins.activity.ActivityPluginBinding;
-import io.flutter.plugin.common.PluginRegistry;
-import io.flutter.view.FlutterNativeView;
 
 public class FlutterVlcPlayerPlugin implements FlutterPlugin, ActivityAware {
 
@@ -22,6 +20,7 @@ public class FlutterVlcPlayerPlugin implements FlutterPlugin, ActivityAware {
     public FlutterVlcPlayerPlugin() {
     }
 
+    @SuppressWarnings("deprecation")
     public static void registerWith(io.flutter.plugin.common.PluginRegistry.Registrar registrar) {
         flutterVlcPlayerFactory =
                 new FlutterVlcPlayerFactory(
@@ -36,12 +35,9 @@ public static void registerWith(io.flutter.plugin.common.PluginRegistry.Registra
                         VIEW_TYPE,
                         flutterVlcPlayerFactory
                 );
-        registrar.addViewDestroyListener(new PluginRegistry.ViewDestroyListener() {
-            @Override
-            public boolean onViewDestroy(FlutterNativeView view) {
-                stopListening();
-                return false;
-            }
+        registrar.addViewDestroyListener(view -> {
+            stopListening();
+            return false;
         });
         //
         startListening();

flutter_vlc_player/example/ios/Flutter/Debug.xcconfig

@@ -1,2 +1,3 @@
+#include? "Pods/Target Support Files/Pods-Runner/Pods-Runner.debug.xcconfig"
 #include "Pods/Target Support Files/Pods-Runner/Pods-Runner.debug.xcconfig"
 #include "Generated.xcconfig"

flutter_vlc_player/example/ios/Flutter/Release.xcconfig

@@ -1,2 +1,3 @@
+#include? "Pods/Target Support Files/Pods-Runner/Pods-Runner.release.xcconfig"
 #include "Pods/Target Support Files/Pods-Runner/Pods-Runner.release.xcconfig"
 #include "Generated.xcconfig"

flutter_vlc_player/example/lib/multiple_tab.dart

@@ -64,11 +64,11 @@ class _MultipleTabState extends State<MultipleTab> {
   }
 
   @override
-  void dispose() {
-    for (var i = 0; i < controllers.length; i++) {
-      controllers[i].stopRendererScanning();
-      controllers[i].removeListener(() {});
-    }
+  void dispose() async {
     super.dispose();
+    for (final controller in controllers) {
+      await controller.stopRendererScanning();
+      await controller.dispose();
+    }
   }
 }

flutter_vlc_player/example/lib/single_tab.dart

@@ -18,6 +18,7 @@ class SingleTab extends StatefulWidget {
 class _SingleTabState extends State<SingleTab> {
   VlcPlayerController _controller;
   final _key = GlobalKey<VlcPlayerWithControlsState>();
+
   //
   List<VideoData> listVideos;
   int selectedVideoIndex;
@@ -221,9 +222,9 @@ class _SingleTabState extends State<SingleTab> {
   }
 
   @override
-  void dispose() {
-    _controller.stopRendererScanning();
-    _controller.removeListener(() {});
+  void dispose() async {
     super.dispose();
+    await _controller.stopRendererScanning();
+    await _controller.dispose();
   }
 }