add MediaPlayer.destroy to free all memory (#3432)

* add MediaPlayer.destroy to free all memory

* add myself to authors

Author: andrewagain

AUTHORS.md

@@ -47,3 +47,4 @@
 * @siropeich [Siro Blanco, Epic Labs]
 * @epiclabsDASH [Jesus Oliva, Epic Labs]
 * @adripanico [Adrian Caballero, Epic Labs]
+* @ahfarmer [Andrew Farmer, Rhombus Systems]

src/core/FactoryMaker.js

@@ -35,7 +35,7 @@
 const FactoryMaker = (function () {
 
     let instance;
-    const singletonContexts = [];
+    let singletonContexts = [];
     const singletonFactories = {};
     const classFactories = {};
 
@@ -94,6 +94,17 @@ const FactoryMaker = (function () {
         });
     }
 
+    /**
+     * Use this method to remove all singleton instances associated with a particular context.
+     *
+     * @param {Object} context
+     * @memberof module:FactoryMaker
+     * @instance
+     */
+    function deleteSingletonInstances(context) {
+        singletonContexts = singletonContexts.filter(x => x.context !== context);
+    }
+
     /*------------------------------------------------------------------------------------------*/
 
     // Factories storage Management
@@ -239,6 +250,7 @@ const FactoryMaker = (function () {
         extend: extend,
         getSingletonInstance: getSingletonInstance,
         setSingletonInstance: setSingletonInstance,
+        deleteSingletonInstances: deleteSingletonInstances,
         getSingletonFactory: getSingletonFactory,
         getSingletonFactoryByName: getSingletonFactoryByName,
         updateSingletonFactory: updateSingletonFactory,

src/streaming/MediaPlayer.js

@@ -347,7 +347,8 @@ function MediaPlayer() {
      * Sets the MPD source and the video element to null. You can also reset the MediaPlayer by
      * calling attachSource with a new source file.
      *
-     * Calling this method is all that is necessary to destroy a MediaPlayer instance.
+     * This call does not destroy the MediaPlayer. To destroy the MediaPlayer and free all of its
+     * memory, call destroy().
      *
      * @memberof module:MediaPlayer
      * @instance
@@ -375,6 +376,17 @@ function MediaPlayer() {
         }
     }
 
+    /**
+     * Completely destroys the media player and frees all memory.
+     *
+     * @memberof module:MediaPlayer
+     * @instance
+     */
+    function destroy() {
+        reset();
+        FactoryMaker.deleteSingletonInstances(context);
+    }
+
     /**
      * The ready state of the MediaPlayer based on both the video element and MPD source being defined.
      *
@@ -2303,7 +2315,8 @@ function MediaPlayer() {
         getSettings: getSettings,
         updateSettings: updateSettings,
         resetSettings: resetSettings,
-        reset: reset
+        reset: reset,
+        destroy: destroy
     };
 
     setup();