Introducing custom/native/embed skins

2015-12-22 17:39:04 -06:00
parent f4c3e14d19
commit f2b0dbd2db
16 changed files with 299 additions and 513 deletions
--- a/RCTVideo.m
+++ b/RCTVideo.m
@@ -3,7 +3,6 @@
 #import "RCTBridgeModule.h"
 #import "RCTEventDispatcher.h"
 #import "UIView+React.h"
-#import <AVFoundation/AVFoundation.h>

 static NSString *const statusKeyPath = @"status";
 static NSString *const playbackLikelyToKeepUpKeyPath = @"playbackLikelyToKeepUp";
@@ -14,6 +13,7 @@ static NSString *const playbackLikelyToKeepUpKeyPath = @"playbackLikelyToKeepUp"
  AVPlayerItem *_playerItem;
  BOOL _playerItemObserversSet;
  AVPlayerLayer *_playerLayer;
+  AVPlayerViewController *_playerViewController;
  NSURL *_videoURL;

  /* Required to publish events */
@@ -24,9 +24,9 @@ static NSString *const playbackLikelyToKeepUpKeyPath = @"playbackLikelyToKeepUp"
  float _lastSeekTime;

  /* For sending videoProgress events */
-  id _progressUpdateTimer;
-  int _progressUpdateInterval;
-  NSDate *_prevProgressUpdateTime;
+  Float64 _progressUpdateInterval;
+  BOOL _controls;
+  id _timeObserver;

  /* Keep track of any modifiers, need to be applied after each play */
  float _volume;
@@ -48,6 +48,8 @@ static NSString *const playbackLikelyToKeepUpKeyPath = @"playbackLikelyToKeepUp"
    _pendingSeek = false;
    _pendingSeekTime = 0.0f;
    _lastSeekTime = 0.0f;
+    _progressUpdateInterval = 250;
+    _controls = NO;

    [[NSNotificationCenter defaultCenter] addObserver:self
                                             selector:@selector(applicationWillResignActive:)
@@ -63,6 +65,42 @@ static NSString *const playbackLikelyToKeepUpKeyPath = @"playbackLikelyToKeepUp"
  return self;
 }

+- (AVPlayerViewController*)createPlayerViewController:(AVPlayer*)player withPlayerItem:(AVPlayerItem*)playerItem {
+    AVPlayerViewController* playerLayer= [[AVPlayerViewController alloc] init];
+    playerLayer.view.frame = self.bounds;
+    playerLayer.player = _player;
+    playerLayer.view.frame = self.bounds;
+    return playerLayer;
+}
+
+/* ---------------------------------------------------------
+ **  Get the duration for a AVPlayerItem.
+ ** ------------------------------------------------------- */
+
+- (CMTime)playerItemDuration
+{
+    AVPlayerItem *playerItem = [_player currentItem];
+    if (playerItem.status == AVPlayerItemStatusReadyToPlay)
+    {
+        return([playerItem duration]);
+    }
+    
+    return(kCMTimeInvalid);
+}
+
+
+/* Cancels the previously registered time observer. */
+-(void)removePlayerTimeObserver
+{
+    if (_timeObserver)
+    {
+        [_player removeTimeObserver:_timeObserver];
+        _timeObserver = nil;
+    }
+}
+
+#pragma mark - Progress
+
 - (void)dealloc
 {
  [[NSNotificationCenter defaultCenter] removeObserver:self];
@@ -73,14 +111,13 @@ static NSString *const playbackLikelyToKeepUpKeyPath = @"playbackLikelyToKeepUp"
 - (void)applicationWillResignActive:(NSNotification *)notification
 {
  if (!_paused) {
-    [self stopProgressTimer];
+    [_player pause];
    [_player setRate:0.0];
  }
 }

 - (void)applicationWillEnterForeground:(NSNotification *)notification
 {
-  [self startProgressTimer];
  [self applyModifiers];
 }

@@ -88,18 +125,29 @@ static NSString *const playbackLikelyToKeepUpKeyPath = @"playbackLikelyToKeepUp"

 - (void)sendProgressUpdate
 {
-  AVPlayerItem *video = [_player currentItem];
-  if (video == nil || video.status != AVPlayerItemStatusReadyToPlay) {
-    return;
-  }
+   AVPlayerItem *video = [_player currentItem];
+   if (video == nil || video.status != AVPlayerItemStatusReadyToPlay) {
+     return;
+   }
+    
+   CMTime playerDuration = [self playerItemDuration];
+   if (CMTIME_IS_INVALID(playerDuration)) {
+      return;
+   }

-  if (_prevProgressUpdateTime == nil || (([_prevProgressUpdateTime timeIntervalSinceNow] * -1000.0) >= _progressUpdateInterval)) {
-    [_eventDispatcher sendInputEventWithName:@"onVideoProgress"
-                                        body:@{@"currentTime": [NSNumber numberWithFloat:CMTimeGetSeconds(video.currentTime)],
-                                               @"playableDuration": [self calculatePlayableDuration],
-                                               @"target": self.reactTag}];
-    _prevProgressUpdateTime = [NSDate date];
-  }
+   CMTime currentTime = _player.currentTime;
+   const Float64 duration = CMTimeGetSeconds(playerDuration);
+   const Float64 currentTimeSecs = CMTimeGetSeconds(currentTime);
+   if( currentTimeSecs >= 0 && currentTimeSecs <= duration) {
+        [_eventDispatcher sendInputEventWithName:@"onVideoProgress"
+                                            body:@{
+                                                     @"currentTime": [NSNumber numberWithFloat:CMTimeGetSeconds(currentTime)],
+                                                     @"playableDuration": [self calculatePlayableDuration],
+                                                     @"atValue": [NSNumber numberWithLongLong:currentTime.value],
+                                                     @"atTimescale": [NSNumber numberWithInt:currentTime.timescale],
+                                                     @"target": self.reactTag
+                                                 }];
+   }
 }

 /*!
@@ -127,22 +175,6 @@ static NSString *const playbackLikelyToKeepUpKeyPath = @"playbackLikelyToKeepUp"
  return [NSNumber numberWithInteger:0];
 }

- (void)stopProgressTimer
-{
-  [_progressUpdateTimer invalidate];
-}
-
- (void)startProgressTimer
-{
-  _progressUpdateInterval = 250;
-  _prevProgressUpdateTime = nil;
-
-  [self stopProgressTimer];
-
-  _progressUpdateTimer = [CADisplayLink displayLinkWithTarget:self selector:@selector(sendProgressUpdate)];
-  [_progressUpdateTimer addToRunLoop:[NSRunLoop mainRunLoop] forMode:NSDefaultRunLoopMode];
-}
-
 - (void)addPlayerItemObservers
 {
  [_playerItem addObserver:self forKeyPath:statusKeyPath options:0 context:nil];
@@ -166,25 +198,27 @@ static NSString *const playbackLikelyToKeepUpKeyPath = @"playbackLikelyToKeepUp"

 - (void)setSrc:(NSDictionary *)source
 {
+  [self removePlayerTimeObserver];
  [self removePlayerItemObservers];
  _playerItem = [self playerItemForSource:source];
  [self addPlayerItemObservers];

  [_player pause];
  [_playerLayer removeFromSuperlayer];
+  _playerLayer = nil;
+  [_playerViewController.view removeFromSuperview];
+  _playerViewController = nil;

  _player = [AVPlayer playerWithPlayerItem:_playerItem];
  _player.actionAtItemEnd = AVPlayerActionAtItemEndNone;

-  _playerLayer = [AVPlayerLayer playerLayerWithPlayer:_player];
-  _playerLayer.frame = self.bounds;
-  _playerLayer.needsDisplayOnBoundsChange = YES;
-
-  [self applyModifiers];
-
-  [self.layer addSublayer:_playerLayer];
-  self.layer.needsDisplayOnBoundsChange = YES;
-
+  const Float64 progressUpdateIntervalMS = _progressUpdateInterval / 1000;
+  // @see endScrubbing in AVPlayerDemoPlaybackViewController.m of https://developer.apple.com/library/ios/samplecode/AVPlayerDemo/Introduction/Intro.html
+  __weak RCTVideo *weakSelf = self;
+  _timeObserver = [_player addPeriodicTimeObserverForInterval:CMTimeMakeWithSeconds(progressUpdateIntervalMS, NSEC_PER_SEC)
+                                                        queue:NULL
+                                                   usingBlock:^(CMTime time) { [weakSelf sendProgressUpdate]; }
+                   ];
  [_eventDispatcher sendInputEventWithName:@"onVideoLoadStart"
                                      body:@{@"src": @{
                                                 @"uri": [source objectForKey:@"uri"],
@@ -214,7 +248,7 @@ static NSString *const playbackLikelyToKeepUpKeyPath = @"playbackLikelyToKeepUp"

 - (void)observeValueForKeyPath:(NSString *)keyPath ofObject:(id)object change:(NSDictionary *)change context:(void *)context
 {
-  if (object == _playerItem) {
+   if (object == _playerItem) {

    if ([keyPath isEqualToString:statusKeyPath]) {
      // Handle player item status change.
@@ -236,7 +270,6 @@ static NSString *const playbackLikelyToKeepUpKeyPath = @"playbackLikelyToKeepUp"
                                                   @"canStepForward": [NSNumber numberWithBool:_playerItem.canStepForward],
                                                   @"target": self.reactTag}];

-        [self startProgressTimer];
        [self attachListeners];
        [self applyModifiers];
      } else if(_playerItem.status == AVPlayerItemStatusFailed) {
@@ -253,7 +286,7 @@ static NSString *const playbackLikelyToKeepUpKeyPath = @"playbackLikelyToKeepUp"
      }
    }
  } else {
-    [super observeValueForKeyPath:keyPath ofObject:object change:change context:context];
+      [super observeValueForKeyPath:keyPath ofObject:object change:change context:context];
  }
 }

@@ -281,23 +314,40 @@ static NSString *const playbackLikelyToKeepUpKeyPath = @"playbackLikelyToKeepUp"

 - (void)setResizeMode:(NSString*)mode
 {
+  if( _controls )
+  {
+    _playerViewController.videoGravity = mode;
+  }
+  else
+  {
+    _playerLayer.videoGravity = mode;
+  }
  _resizeMode = mode;
-  _playerLayer.videoGravity = mode;
 }

 - (void)setPaused:(BOOL)paused
 {
  if (paused) {
-    [self stopProgressTimer];
+    [_player pause];
    [_player setRate:0.0];
  } else {
-    [self startProgressTimer];
+    [_player play];
    [_player setRate:_rate];
  }
-
+  
  _paused = paused;
 }

+- (float)getCurrentTime
+{
+  return _playerItem != NULL ? CMTimeGetSeconds(_playerItem.currentTime) : 0;
+}
+
+- (void)setCurrentTime:(float)currentTime
+{
+  [self setSeek: currentTime];
+}
+
 - (void)setSeek:(float)seekTime
 {
  int timeScale = 10000;
@@ -310,7 +360,7 @@ static NSString *const playbackLikelyToKeepUpKeyPath = @"playbackLikelyToKeepUp"
    CMTime current = item.currentTime;
    // TODO figure out a good tolerance level
    CMTime tolerance = CMTimeMake(1000, timeScale);
-
+    
    if (CMTimeCompare(current, cmSeekTime) != 0) {
      [_player seekToTime:cmSeekTime toleranceBefore:tolerance toleranceAfter:tolerance completionHandler:^(BOOL finished) {
        [_eventDispatcher sendInputEventWithName:@"onVideoSeek"
@@ -360,48 +410,126 @@ static NSString *const playbackLikelyToKeepUpKeyPath = @"playbackLikelyToKeepUp"
  [self setResizeMode:_resizeMode];
  [self setRepeat:_repeat];
  [self setPaused:_paused];
+  [self setControls:_controls];
 }

 - (void)setRepeat:(BOOL)repeat {
  _repeat = repeat;
 }

+- (void)usePlayerViewController
+{
+    if( _player )
+    {
+        _playerViewController = [self createPlayerViewController:_player withPlayerItem:_playerItem];
+        [self addSubview:_playerViewController.view];
+    }
+}
+
+- (void)usePlayerLayer
+{
+    if( _player )
+    {
+      _playerLayer = [AVPlayerLayer playerLayerWithPlayer:_player];
+      _playerLayer.frame = self.bounds;
+      _playerLayer.needsDisplayOnBoundsChange = YES;
+    
+      [self.layer addSublayer:_playerLayer];
+      self.layer.needsDisplayOnBoundsChange = YES;
+    }
+}
+
+- (void)setControls:(BOOL)controls
+{
+    if( _controls != controls || (!_playerLayer && !_playerViewController) )
+    {
+        _controls = controls;
+        if( _controls )
+        {
+            [_playerLayer removeFromSuperlayer];
+            _playerLayer = nil;
+            [self usePlayerViewController];
+        }
+        else
+        {
+            [_playerViewController.view removeFromSuperview];
+            _playerViewController = nil;
+            [self usePlayerLayer];
+        }
+    }
+}
+
 #pragma mark - React View Management

 - (void)insertReactSubview:(UIView *)view atIndex:(NSInteger)atIndex
 {
-  RCTLogError(@"video cannot have any subviews");
+  // We are early in the game and somebody wants to set a subview.
+  // That can only be in the context of playerViewController.
+  if( !_controls && !_playerLayer && !_playerViewController )
+  {
+    [self setControls:true];
+  }
+  
+  if( _controls )
+  {
+     view.frame = self.bounds;
+     [_playerViewController.contentOverlayView insertSubview:view atIndex:atIndex];
+  }
+  else
+  {
+     RCTLogError(@"video cannot have any subviews");
+  }
  return;
 }

 - (void)removeReactSubview:(UIView *)subview
 {
-  RCTLogError(@"video cannot have any subviews");
+  if( _controls )
+  {
+      [subview removeFromSuperview];
+  }
+  else
+  {
+    RCTLogError(@"video cannot have any subviews");
+  }
  return;
 }

 - (void)layoutSubviews
 {
  [super layoutSubviews];
-  [CATransaction begin];
-  [CATransaction setAnimationDuration:0];
-  _playerLayer.frame = self.bounds;
-  [CATransaction commit];
+  if( _controls )
+  {
+    _playerViewController.view.frame = self.bounds;
+  
+    // also adjust all subviews of contentOverlayView
+    for (UIView* subview in _playerViewController.contentOverlayView.subviews) {
+      subview.frame = self.bounds;
+    }
+  }
+  else
+  {
+      [CATransaction begin];
+      [CATransaction setAnimationDuration:0];
+      _playerLayer.frame = self.bounds;
+      [CATransaction commit];
+  }
 }

 #pragma mark - Lifecycle

 - (void)removeFromSuperview
 {
-  [_progressUpdateTimer invalidate];
-  _prevProgressUpdateTime = nil;
-
  [_player pause];
  _player = nil;

  [_playerLayer removeFromSuperlayer];
  _playerLayer = nil;
+  
+  [_playerViewController.view removeFromSuperview];
+  _playerViewController = nil;

+  [self removePlayerTimeObserver];
  [self removePlayerItemObservers];

  _eventDispatcher = nil;