[[ Player ]] Update iOS play command implementation to use AVKit

This patch updates the implementation of the `play` command to replace the MVMoviePlayerController based implementation (removed from iOS 13.2) with one based on AVPlayer

Author: livecodeian

engine/src/mbliphonevideo.mm

@@ -39,8 +39,7 @@
 
 #import <Foundation/Foundation.h>
 #import <UIKit/UIKit.h>
-#import <MediaPlayer/MPMoviePlayerController.h>
-#import <MediaPlayer/MPMoviePlayerViewController.h>
+#import <AVKit/AVKit.h>
 
 ////////////////////////////////////////////////////////////////////////////////
 
@@ -49,56 +48,75 @@
 
 ////////////////////////////////////////////////////////////////////////////////
 
-MPMoviePlayerViewController *g_movie_player = nil;
-
-////////////////////////////////////////////////////////////////////////////////
-
-static NSObject *s_movie_player_delegate = nil;
+static AVPlayerViewController *s_movie_player = nil;
 
 ////////////////////////////////////////////////////////////////////////////////
 
 @interface com_runrev_livecode_MCFullscreenMovieDelegate : NSObject
 {
 bool m_running;
+bool m_looping;
+CMTime m_start_time;
+AVPlayer *m_player;
 UIControl *m_overlay;
 }
 
-- (id)initWithPlayer;
+- (id)initWithPlayer:(AVPlayer*)player startTime:(CMTime)startTime looping:(BOOL)looping;
 - (void)dealloc;
 
 - (void)begin: (bool)p_add_overlay;
 - (void)end;
 - (void)stop;
 - (bool)isRunning;
 
-- (void)movieFinished: (NSNotification *) p_notification;
-- (void)moviePreloadFinished: (NSNotification *) p_notification;
+- (void)observeValueForKeyPath:(NSString *)keyPath ofObject:(id)object change:(NSDictionary<NSKeyValueChangeKey,id> *)change context:(void *)context;
+- (void)playerItemDidPlayToEndTime:(NSNotification*)notification;
+- (void)playerItemFailedToPlayToEndTime:(NSNotification*)notification;
 - (void)movieWindowTouched: (UIControl*) p_sender;
 
 @end
 
+@compatibility_alias MCFullscreenMovieDelegate com_runrev_livecode_MCFullscreenMovieDelegate;
+
+////////////////////////////////////////////////////////////////////////////////
+
+static MCFullscreenMovieDelegate *s_movie_player_delegate = nil;
+
+////////////////////////////////////////////////////////////////////////////////
+
 @implementation com_runrev_livecode_MCFullscreenMovieDelegate
 
 // AL-2014-09-09: [[ Bug 13354 ]] Replace deprecated MPMoviePlayerContentPreloadDidFinishNotification
-- (id)initWithPlayer: (MPMoviePlayerController *)p_player
+- (id)initWithPlayer:(AVPlayer *)p_player startTime:(CMTime)startTime looping:(BOOL)looping
 {
 self = [super init];
 if (self == nil)
 return nil;
 
-[[NSNotificationCenter defaultCenter] addObserver:self 
- selector:@selector(movieFinished:)
- name:MPMoviePlayerPlaybackDidFinishNotification 
- object:nil];
-
-[[NSNotificationCenter defaultCenter] addObserver:self 
- selector:@selector(moviePreloadFinished:)
- name:MPMoviePlayerLoadStateDidChangeNotification 
- object:p_player];
+m_player = [p_player retain];
 
+[m_player.currentItem
+addObserver:self
+forKeyPath:@"status"
+options:NSKeyValueObservingOptionNew | NSKeyValueObservingOptionOld
+context:nil];
+[NSNotificationCenter.defaultCenter
+addObserver:self
+selector:@selector(playerItemDidPlayToEndTime:)
+name:AVPlayerItemDidPlayToEndTimeNotification
+object:m_player.currentItem];
+[NSNotificationCenter.defaultCenter
+addObserver:self
+selector:@selector(playerItemFailedToPlayToEndTime:)
+name:AVPlayerItemFailedToPlayToEndTimeNotification
+object:m_player.currentItem];
+
 m_running = true;
 m_overlay = nil;
 
+m_start_time = startTime;
+m_looping = looping;
+
 s_movie_player_delegate = self;
 
 return self;
@@ -107,7 +125,8 @@ - (id)initWithPlayer: (MPMoviePlayerController *)p_player
 - (void)dealloc
 {
 s_movie_player_delegate = nil;
-[[NSNotificationCenter defaultCenter] removeObserver: self];
+[NSNotificationCenter.defaultCenter removeObserver: self];
+[m_player release];
 [super dealloc];
 }
 
@@ -149,23 +168,37 @@ - (bool)isRunning
 
 //////////
 
-- (void)movieFinished: (NSNotification *) p_notification
+- (void)playerItemDidPlayToEndTime:(NSNotification *)notification
 {
+if (m_looping)
+{
+[m_player seekToTime:m_start_time];
+return;
+}
+
 m_running = false;
 
 // MW-2011-08-16: [[ Wait ]] Tell the wait to exit (our wait has anyevent == True).
 MCscreen -> pingwait();
 }
 
-- (void)moviePreloadFinished: (NSNotification *) p_notification
+- (void)playerItemFailedToPlayToEndTime:(NSNotification *)notification
 {
-// AL-2014-09-09: [[ Bug 13354 ]] Replace deprecated MPMoviePlayerContentPreloadDidFinishNotification
-if ([[p_notification object] loadState] & MPMovieLoadStateUnknown)
+m_running = false;
+MCscreen->pingwait();
+}
+
+- (void)observeValueForKeyPath:(NSString *)keyPath ofObject:(id)object change:(NSDictionary<NSKeyValueChangeKey,id> *)change context:(void *)context
+{
+if ([keyPath isEqualToString:@"status"])
 {
-m_running = false;
-
-// MW-2011-08-16: [[ Wait ]] Tell the wait to exit (our wait has anyevent == True).
-MCscreen -> pingwait();
+if (((AVPlayerItem*)object).status == AVPlayerItemStatusFailed)
+{
+m_running = false;
+
+// MW-2011-08-16: [[ Wait ]] Tell the wait to exit (our wait has anyevent == True).
+MCscreen -> pingwait();
+}
 }
 }
 
@@ -177,25 +210,29 @@ - (void)movieWindowTouched: (UIControl*) p_sender
 
 @end
 
-static void configure_playback_range(MPMoviePlayerController *p_player)
+static void configure_playback_range(AVPlayerViewController *p_player, CMTime &r_start_time)
 {
 if (!MCtemplateplayer -> getflag(F_PLAY_SELECTION))
+{
+r_start_time = kCMTimeZero;
 return;
+}
 
 uint32_t t_start_time, t_end_time;
 t_start_time = MCtemplateplayer -> getstarttime();
 t_end_time = MCtemplateplayer -> getendtime();
-[p_player setInitialPlaybackTime: t_start_time / 1000.0];
-[p_player setEndPlaybackTime: t_end_time / 1000.0];
+p_player.player.currentItem.forwardPlaybackEndTime = CMTimeMake(t_end_time, 1000);
+r_start_time = CMTimeMake(t_start_time, 1000);
 }
 
 struct play_fullscreen_t
 {
 NSURL *url;
 bool looping;
 bool with_controller;
-MPMoviePlayerController *movie_player;
-com_runrev_livecode_MCFullscreenMovieDelegate *delegate;
+AVPlayerViewController *movie_player;
+MCFullscreenMovieDelegate *delegate;
+CMTime start_time;
 };
 
 static void play_fullscreen_movie_prewait(void *p_context)
@@ -205,41 +242,49 @@ static void play_fullscreen_movie_prewait(void *p_context)
 
  // MM-2011-12-09: [[ Bug 9892 ]] Destroy previous movie player. Fixes bug with iOS 5 where 
 //showController is ignored on second running.
- if (g_movie_player != nil)
+ if (s_movie_player != nil)
 {
- [g_movie_player release];
- g_movie_player = nil;
+ [s_movie_player release];
+ s_movie_player = nil;
  }
 
 // Make sure we have a movie player view controller with correct url
-g_movie_player = [[MPMoviePlayerViewController alloc] initWithContentURL: ctxt -> url];
+s_movie_player = [[AVPlayerViewController alloc] init];
+s_movie_player.player = [AVPlayer playerWithURL:ctxt->url];
 
-ctxt -> movie_player = [g_movie_player moviePlayer];
+ctxt->movie_player = s_movie_player;
 
-[[ctxt -> movie_player view] setHidden: NO];
-[[ctxt -> movie_player view] setOpaque: YES];
-[[ctxt -> movie_player view] setAlpha: 1.0f];
-[[ctxt -> movie_player backgroundView] setBackgroundColor: [UIColor blackColor]];
-[ctxt -> movie_player setFullscreen: YES];
-[ctxt -> movie_player setScalingMode: MPMovieScalingModeAspectFit];
-[ctxt -> movie_player setControlStyle: (ctxt -> with_controller ? MPMovieControlStyleFullscreen : MPMovieControlStyleNone)];
-[ctxt -> movie_player setUseApplicationAudioSession: YES];
-[ctxt -> movie_player setInitialPlaybackTime: -1];
-[ctxt -> movie_player setEndPlaybackTime: -1];
-[ctxt -> movie_player setShouldAutoplay: YES];
+ctxt->movie_player.view.hidden = NO;
+ctxt->movie_player.view.opaque = YES;
+ctxt->movie_player.view.alpha = 1.0f;
+ctxt->movie_player.view.backgroundColor = [UIColor blackColor];
+
+ctxt->movie_player.videoGravity = AVLayerVideoGravityResizeAspect;
+ctxt->movie_player.showsPlaybackControls = ctxt->with_controller;
 if (ctxt -> looping)
-[ctxt -> movie_player setRepeatMode: MPMovieRepeatModeOne];
-if (MCmajorosversion >= 430)
-[ctxt -> movie_player setAllowsAirPlay: NO];
+ctxt->movie_player.player.actionAtItemEnd = AVPlayerActionAtItemEndNone;
+
+ctxt->movie_player.allowsPictureInPicturePlayback = NO;
+ctxt->movie_player.player.allowsExternalPlayback = NO;
 
-configure_playback_range(ctxt -> movie_player);
+CMTime t_start_time;
+configure_playback_range(ctxt -> movie_player, t_start_time);
 
-ctxt -> delegate = [[com_runrev_livecode_MCFullscreenMovieDelegate alloc] initWithPlayer:ctxt -> movie_player];
+ctxt -> delegate = [[MCFullscreenMovieDelegate alloc]
+initWithPlayer:ctxt -> movie_player.player
+startTime:t_start_time
+looping:ctxt->looping];
 
 // Present the view controller and get the delegate to setup its overlay
 // if needed.
-[MCIPhoneGetViewController() presentModalViewController: g_movie_player animated: NO];
-[ctxt -> delegate begin: !ctxt -> with_controller];
+[MCIPhoneGetViewController()
+ presentViewController:s_movie_player
+ animated:NO
+ completion:^{
+[s_movie_player.player seekToTime:t_start_time];
+[s_movie_player.player play];
+}];
+[ctxt -> delegate begin: !ctxt -> with_controller];
 }
 
 static void play_fullscreen_movie_postwait(void *p_context)
@@ -249,14 +294,14 @@ static void play_fullscreen_movie_postwait(void *p_context)
 
 // Clear up and overlay and dismiss the controller.
 [ctxt -> delegate end];
-[MCIPhoneGetViewController() dismissModalViewControllerAnimated: NO];
+[MCIPhoneGetViewController() dismissViewControllerAnimated:NO completion:^{}];
 
 // Cleanup the delegate
 [ctxt -> delegate release];
 
 // Make sure we reset the movie player to nothing.
-[ctxt -> movie_player stop];
-[ctxt -> movie_player setContentURL: [NSURL URLWithString: @""]];
+[ctxt->movie_player.player pause];
+[ctxt->movie_player.player replaceCurrentItemWithPlayerItem:[AVPlayerItem playerItemWithURL:[NSURL URLWithString:@""]]];
 }
 
 static bool play_fullscreen_movie_new(NSURL *p_movie, bool p_looping, bool p_with_controller)
@@ -291,19 +336,13 @@ bool MCSystemPlayVideo(MCStringRef p_video)
 if (MCStringBeginsWithCString(p_video, (const char_t *)"http://", kMCStringOptionCompareExact)
 || MCStringBeginsWithCString(p_video, (const char_t *)"https://", kMCStringOptionCompareExact))
 {
-CFStringRef cfstrurl = nil;
-/* UNCHECKED */ MCStringConvertToCFStringRef(p_video, cfstrurl);
-t_url = [NSURL URLWithString: (NSString *)cfstrurl];
-CFRelease(cfstrurl);
+t_url = [NSURL URLWithString:MCStringConvertToAutoreleasedNSString(p_video)];
 }
 else
 {
 MCAutoStringRef t_path;
-CFStringRef cfstrpath = nil;
 /* UNCHECKED */ MCS_resolvepath(p_video, &t_path);
-/* UNCHECKED */ MCStringConvertToCFStringRef(*t_path, cfstrpath);
-t_url = [NSURL fileURLWithPath: (NSString *)cfstrpath];
-CFRelease(cfstrpath);
+t_url = [NSURL fileURLWithPath:MCStringConvertToAutoreleasedNSString(*t_path)];
 }
 
 if (t_url == nil)