fix(performance): remove total duration functionality from the plugin

Author: codinronan

examples/audio-service.ts

@@ -1,33 +1,33 @@
-/**	
-* This is an example Angular + Ionic 3 service to wrap the Cordova audio player plugin.	
-* Simply drop this into your app, make sure you have the plugin installed,	
-* add the service to your app.module.ts and import it wherever you need.	
-*	
-* An example of such usage might be:	
-*	
-* constructor(	
-*   private cdvAudioPlayer: CordovaAudioPlayerService,	
-*  ) {	
-*   this.cdvAudioPlayer.setOptions({ verbose: true, resetStreamOnPause: true })	
-*     .then(() => {	
-*       this.cdvAudioPlayer.setPlaylistItems([	
-*         { trackId: '12345', assetUrl: testUrls[0], albumArt: testImgs[0], artist: 'Awesome', album: 'Test Files', title: 'Test 1' },	
-*         { trackId: '678900', assetUrl: testUrls[1], albumArt: testImgs[1], artist: 'Awesome', album: 'Test Files', title: 'Test 2' },	
-*         { trackId: 'a1b2c3d4', assetUrl: testUrls[2], albumArt: testImgs[2], artist: 'Awesome', album: 'Test Files', title: 'Test 3' },	
-*         { trackId: 'a1bSTREAM', assetUrl: testUrls[3], albumArt: testImgs[3], artist: 'Awesome', album: 'Streams', title: 'The Stream', isStream: true },	
-*       ])	
-*       .then(() => {	
-*         this.cdvAudioPlayer.play();	
-*       }).catch((err) => console.log('YourService, cdvAudioPlayer setPlaylistItems error: ', err));	
-*     }).catch((err) => console.log('YourService, cdvAudioPlayer init error: ', err));	
-*	
+/**
+* This is an example Angular + Ionic 3 service to wrap the Cordova audio player plugin.
+* Simply drop this into your app, make sure you have the plugin installed,
+* add the service to your app.module.ts and import it wherever you need.
+*
+* An example of such usage might be:
+*
+* constructor(
+*   private cdvAudioPlayer: CordovaAudioPlayerService,
+*  ) {
+*   this.cdvAudioPlayer.setOptions({ verbose: true, resetStreamOnPause: true })
+*     .then(() => {
+*       this.cdvAudioPlayer.setPlaylistItems([
+*         { trackId: '12345', assetUrl: testUrls[0], albumArt: testImgs[0], artist: 'Awesome', album: 'Test Files', title: 'Test 1' },
+*         { trackId: '678900', assetUrl: testUrls[1], albumArt: testImgs[1], artist: 'Awesome', album: 'Test Files', title: 'Test 2' },
+*         { trackId: 'a1b2c3d4', assetUrl: testUrls[2], albumArt: testImgs[2], artist: 'Awesome', album: 'Test Files', title: 'Test 3' },
+*         { trackId: 'a1bSTREAM', assetUrl: testUrls[3], albumArt: testImgs[3], artist: 'Awesome', album: 'Streams', title: 'The Stream', isStream: true },
+*       ])
+*       .then(() => {
+*         this.cdvAudioPlayer.play();
+*       }).catch((err) => console.log('YourService, cdvAudioPlayer setPlaylistItems error: ', err));
+*     }).catch((err) => console.log('YourService, cdvAudioPlayer init error: ', err));
+*
 *   this.cdvAudioPlayer.setOptions({ verbose: true, resetStreamOnPause: true });
 *   this.cdvAudioPlayer.setVolume(0.5);
 *
-*   this.cdvAudioPlayer.onStatus.subscribe((status) => {	
-*     console.log('YourService: Got RmxAudioPlayer onStatus: ', status);	
-*   });	
-* }	
+*   this.cdvAudioPlayer.onStatus.subscribe((status) => {
+*     console.log('YourService: Got RmxAudioPlayer onStatus: ', status);
+*   });
+* }
 */
 import { Injectable, NgZone } from '@angular/core';
 import { Platform } from 'ionic-angular';
@@ -250,12 +250,6 @@ export class CordovaAudioPlayerService {
     }).catch((ex) => console.warn(ex));
   }
 
-  getTotalDuration = () => {
-    return this.wrapPromise('getTotalDuration', (resolve, reject) => {
-      this.AudioPlayer.getTotalDuration(this.getSuccessCb(resolve), this.getErrorCb(reject));
-    }).catch((ex) => console.warn(ex));
-  }
-
   getQueuePosition = () => {
     return this.wrapPromise('getQueuePosition', (resolve, reject) => {
       this.AudioPlayer.getQueuePosition(this.getSuccessCb(resolve), this.getErrorCb(reject));
@@ -285,10 +279,10 @@ export class CordovaAudioPlayerService {
           this.Log.log(`AudioPlayerSuccessCb [${name}]:`, data);
           return data;
         })
-        .catch((err) => {
-          this.Log.warn(`AudioPlayerSuccessCb [${name}]:`, err);
-          throw err;
-        });
+          .catch((err) => {
+            this.Log.warn(`AudioPlayerSuccessCb [${name}]:`, err);
+            throw err;
+          });
       }
 
       return executor;

src/android/java/AudioPlayerPlugin.java

@@ -312,15 +312,6 @@ public void run() {
       return true;
     }
 
-    if (GET_TOTAL_DURATION.equals(action)) {
-      // Not yet implemented on android. I'm not sure how to, since the tracks haven't loaded yet.
-      // On iOS, the AVQueuePlayer gets the metadata for all tracks immediately, that's why that works there.
-      float totalDuration = 0f;
-      PluginResult result = new PluginResult(PluginResult.Status.OK, totalDuration);
-      new PluginCallback(callbackContext).send(result);
-      return true;
-    }
-
     if (GET_QUEUE_POSITION.equals(action)) {
       // Not yet implemented on android. I'm not sure how to, since the tracks haven't loaded yet.
       // On iOS, the AVQueuePlayer gets the metadata for all tracks immediately, that's why that works there.

src/android/java/RmxConstants.java

@@ -34,7 +34,6 @@ public interface RmxConstants {
   String GET_PLAYBACK_VOLUME    = "getPlaybackVolume";
   String GET_PLAYBACK_POSITION  = "getPlaybackPosition";
   String GET_BUFFER_STATUS      = "getCurrentBuffer";
-  String GET_TOTAL_DURATION     = "getTotalDuration";
   String GET_QUEUE_POSITION     = "getQueuePosition";
 
   String RELEASE = "release";

src/ios/AVBidirectionalQueuePlayer.h

@@ -33,7 +33,6 @@
 -(BOOL)isAtEnd;
 -(BOOL)isPlaying;
 
--(CMTime)estimatedTotalDuration;
 -(CMTime)currentTimeOffsetInQueue;
 -(void)seekToTimeInQueue:(CMTime)time completionHandler:(void (^)(BOOL))completionHandler;
 -(void)setCurrentIndex:(NSUInteger)currentIndex completionHandler:(void (^)(BOOL)) completionHandler;

src/ios/AVBidirectionalQueuePlayer.m

@@ -13,7 +13,6 @@
 
 @implementation AVBidirectionalQueuePlayer {
     NSMutableArray * _itemsForPlayer;
-    // CMTime _estimatedDuration;
 }
 
 -(NSMutableArray *)itemsForPlayer {
@@ -36,7 +35,6 @@ -(id)init {
     self = [super init];
     if (self) {
         self.itemsForPlayer = [NSMutableArray new];
-        // _estimatedDuration = kCMTimeZero;
     }
     return self;
 }
@@ -47,7 +45,6 @@ -(id)initWithItems:(NSArray *)items
     self = [super initWithItems:items];
     if (self){
         self.itemsForPlayer = [NSMutableArray arrayWithArray:items];
-        // _estimatedDuration = kCMTimeInvalid;
     }
     return self;
 }
@@ -185,7 +182,6 @@ -(void)removeAllItems
 {
     // This does the same thing as the normal AVQueuePlayer removeAllItems, but clears our collection copy
     [super removeAllItems];
-    // _estimatedDuration = kCMTimeZero;
     [_itemsForPlayer removeAllObjects];
 
     [[NSNotificationCenter defaultCenter] postNotificationName:AVBidirectionalQueueCleared object:self userInfo:nil];
@@ -200,10 +196,6 @@ -(void)removeItem:(AVPlayerItem *)item
     // array before the current value.
     [super removeItem:item];
 
-    // if (CMTIME_IS_VALID(item.duration)) {
-    //     _estimatedDuration = CMTimeSubtract(_estimatedDuration, item.duration);
-    // }
-
     [_itemsForPlayer removeObject:item];
     [[NSNotificationCenter defaultCenter] postNotificationName:AVBidirectionalQueueRemovedItem object:self  userInfo:@{@"item":item}];
 }
@@ -214,19 +206,6 @@ -(void)insertItem:(AVPlayerItem *)item afterItem:(AVPlayerItem *)afterItem
     // proper location in the itemsForPlayer array and increments the nowPlayingIndex if necessary.
     [super insertItem:item afterItem:afterItem];
 
-    // https://github.com/Rolamix/cordova-plugin-playlist/issues/19
-    // This causes some pretty bad performance so I am going to remove it for now.
-    // You should be maintaining a database of your tracks, not using their metadata characteristics
-    // at load time to decide what their duration is..
-
-    // if (CMTIME_IS_NUMERIC(item.duration)) {
-    //     NSLog(@"duration: %5.2f", (double) CMTimeGetSeconds(item.duration));
-    //     if (CMTimeCompare(_estimatedDuration, kCMTimeZero) == 0)
-    //         _estimatedDuration = item.duration;
-    //     else
-    //         _estimatedDuration = CMTimeAdd(_estimatedDuration, item.duration);
-    // }
-
     if ([_itemsForPlayer containsObject:afterItem]){ // AfterItem is non-nil
         if ([_itemsForPlayer indexOfObject:afterItem] < [_itemsForPlayer count] - 1){
             [_itemsForPlayer insertObject:item atIndex:[_itemsForPlayer indexOfObject:afterItem] + 1];
@@ -248,20 +227,6 @@ -(void)insertAllItems:(NSMutableArray *)itemsForPlayer {
     [center postNotificationName:AVBidirectionalQueueAddedAllItems object:self userInfo:@{@"items":itemsForPlayer}];
 }
 
--(CMTime)estimatedTotalDuration {
-    // if (!CMTIME_IS_VALID(self->_estimatedDuration)) {
-    //     //NSTimeInterval dur  = 0.0;
-    //     CMTime duration = kCMTimeZero;
-    //     for (AVPlayerItem * item in _itemsForPlayer) {
-    //         if (CMTIME_IS_VALID(item.duration))
-    //             duration = CMTimeAdd(duration, item.duration);
-    //     }
-    //     self->_estimatedDuration = duration;
-    // }
-    // return self->_estimatedDuration;
-    return kCMTimeZero;
-}
-
 -(CMTime)currentTimeOffsetInQueue {
     CMTime timeOffset = kCMTimeZero;
     NSUInteger currentIndex = self.currentIndex;

src/ios/RmxAudioPlayer.h

@@ -55,7 +55,6 @@
 - (void) getPlaybackVolume:(CDVInvokedUrlCommand *) command;
 - (void) getPlaybackPosition:(CDVInvokedUrlCommand *) command;
 - (void) getCurrentBuffer:(CDVInvokedUrlCommand *) command;
-- (void) getTotalDuration:(CDVInvokedUrlCommand *) command;
 - (void) getQueuePosition:(CDVInvokedUrlCommand *) command;
 
 // Cleanup

src/ios/RmxAudioPlayer.m

@@ -29,7 +29,6 @@ @interface RmxAudioPlayer() {
 @property (nonatomic) BOOL isAtEnd;
 @property (nonatomic) BOOL isAtBeginning;
 @property (nonatomic) BOOL isPlaying;
-@property (nonatomic) float estimatedDuration;
 @property (nonatomic) float queuePosition;
 @end
 
@@ -374,15 +373,6 @@ - (void) getCurrentBuffer:(CDVInvokedUrlCommand *) command {
 }
 
 
-- (void) getTotalDuration:(CDVInvokedUrlCommand *) command {
-    float duration = self.estimatedDuration;
-    NSLog(@"RmxAudioPlayer.execute=getTotalDuration, %f", duration);
-
-    CDVPluginResult* result = [CDVPluginResult resultWithStatus:CDVCommandStatus_OK messageAsDouble:duration];
-    [self.commandDelegate sendPluginResult:result callbackId:command.callbackId];
-}
-
-
 - (void) getQueuePosition:(CDVInvokedUrlCommand *) command {
     float position = self.queuePosition;
     NSLog(@"RmxAudioPlayer.execute=getQueuePosition, %f", position);
@@ -1185,10 +1175,6 @@ - (BOOL) isPlaying {
     return [self avQueuePlayer].isPlaying;
 }
 
-- (float) estimatedDuration {
-    return CMTimeGetSeconds([self avQueuePlayer].estimatedTotalDuration);
-}
-
 - (float) queuePosition {
     return CMTimeGetSeconds([self avQueuePlayer].currentTimeOffsetInQueue);
 }

src/js/RmxAudioPlayer.ts

@@ -137,9 +137,9 @@ export class RmxAudioPlayer {
    * Player interface
    */
 
-   /**
-    * Returns a promise that resolves when the plugin is ready.
-    */
+  /**
+   * Returns a promise that resolves when the plugin is ready.
+   */
   ready = () => {
     return this._initPromise;
   }
@@ -168,31 +168,31 @@ export class RmxAudioPlayer {
     };
 
     exec(onNativeStatus, error, 'RmxAudioPlayer', 'initialize', []);
-      // channel.initializationComplete('onRmxAudioPlayerReady');
+    // channel.initializationComplete('onRmxAudioPlayerReady');
     // });
 
     return this._initPromise;
   }
 
-   /**
-    * Sets the player options. This can be called at any time and is not required before playback can be initiated.
-    */
+  /**
+   * Sets the player options. This can be called at any time and is not required before playback can be initiated.
+   */
   setOptions = (successCallback: SuccessCallback, errorCallback: ErrorCallback, options: AudioPlayerOptions) => {
-    this.options = {...this.options, ...options};
+    this.options = { ...this.options, ...options };
     exec(successCallback, errorCallback, 'RmxAudioPlayer', 'setOptions', [options]);
   }
 
   /**
    * Playlist item management
    */
 
-   /**
-    * Sets the entire list of tracks to be played by the playlist.
-    * This will clear all previous items from the playlist.
-    * If you pass options.retainPosition = true, the current playback position will be
-    * recorded and used when playback restarts. This can be used, for example, to set the
-    * playlist to a new set of tracks, but retain the currently-playing item to avoid skipping.
-    */
+  /**
+   * Sets the entire list of tracks to be played by the playlist.
+   * This will clear all previous items from the playlist.
+   * If you pass options.retainPosition = true, the current playback position will be
+   * recorded and used when playback restarts. This can be used, for example, to set the
+   * playlist to a new set of tracks, but retain the currently-playing item to avoid skipping.
+   */
   setPlaylistItems = (successCallback: SuccessCallback, errorCallback: ErrorCallback, items: AudioTrack[], options?: PlaylistItemOptions) => {
     exec(successCallback, errorCallback, 'RmxAudioPlayer', 'setPlaylistItems', [this.validateTracks(items), options || {}]);
   }
@@ -241,9 +241,9 @@ export class RmxAudioPlayer {
    * Playback management
    */
 
-   /**
-    * Begin playback. If no tracks have been added, this has no effect.
-    */
+  /**
+   * Begin playback. If no tracks have been added, this has no effect.
+   */
   play = (successCallback: SuccessCallback, errorCallback: ErrorCallback) => {
     exec(successCallback, errorCallback, 'RmxAudioPlayer', 'play', []);
   }
@@ -328,9 +328,9 @@ export class RmxAudioPlayer {
    * Get accessors
    */
 
-   /**
-    * Reports the current playback rate.
-    */
+  /**
+   * Reports the current playback rate.
+   */
   getPlaybackRate = (successCallback: SuccessCallback, errorCallback: ErrorCallback) => {
     exec(successCallback, errorCallback, 'RmxAudioPlayer', 'getPlaybackRate', []);
   }
@@ -358,14 +358,6 @@ export class RmxAudioPlayer {
     exec(successCallback, errorCallback, 'RmxAudioPlayer', 'getCurrentBuffer', []);
   }
 
-  /**
-   * (iOS only): Reports the duration of the entire playlist, in seconds (e.g. 4500 seconds for the entire playlist)
-   * Not implemented on Android since durations are not known ahead of time.
-   */
-  getTotalDuration = (successCallback: SuccessCallback, errorCallback: ErrorCallback) => {
-    exec(successCallback, errorCallback, 'RmxAudioPlayer', 'getTotalDuration', []);
-  }
-
   /**
    * (iOS only): Gets the overall playback position in the entire queue, in seconds (e.g. 1047 seconds).
    * Not implemented on Android since durations are not known ahead of time.
@@ -379,11 +371,11 @@ export class RmxAudioPlayer {
    * Status event handling
    */
 
-   /**
-    * @internal
-    * Call this function to emit an onStatus event via the on('status') handler.
-    * Internal use only, to raise events received from the native interface.
-    */
+  /**
+   * @internal
+   * Call this function to emit an onStatus event via the on('status') handler.
+   * Internal use only, to raise events received from the native interface.
+   */
   protected onStatus(trackId: string, type: RmxAudioStatusMessage, value: OnStatusCallbackUpdateData | OnStatusTrackChangedData | OnStatusErrorCallbackData) {
     const status = { type, trackId, value };
     if (this.options.verbose) {