/* ============================================================================== This file is part of the JUCE 7 technical preview. Copyright (c) 2022 - Raw Material Software Limited You may use this code under the terms of the GPL v3 (see www.gnu.org/licenses). For the technical preview this file cannot be licensed commercially. JUCE IS PROVIDED "AS IS" WITHOUT ANY WARRANTY, AND ALL WARRANTIES, WHETHER EXPRESSED OR IMPLIED, INCLUDING MERCHANTABILITY AND FITNESS FOR PURPOSE, ARE DISCLAIMED. ============================================================================== */ #if JUCE_MAC using Base = NSViewComponent; #else using Base = UIViewComponent; #endif struct VideoComponent::Pimpl : public Base { Pimpl (VideoComponent& ownerToUse, bool useNativeControlsIfAvailable) : owner (ownerToUse), playerController (*this, useNativeControlsIfAvailable) { setVisible (true); auto* view = playerController.getView(); setView (view); #if JUCE_MAC [view setNextResponder: [view superview]]; [view setWantsLayer: YES]; #endif } ~Pimpl() { close(); setView (nil); } Result load (const File& file) { auto r = load (createNSURLFromFile (file)); if (r.wasOk()) currentFile = file; return r; } Result load (const URL& url) { auto r = load ([NSURL URLWithString: juceStringToNS (url.toString (true))]); if (r.wasOk()) currentURL = url; return r; } Result load (NSURL* url) { if (url != nil) { close(); return playerController.load (url); } return Result::fail ("Couldn't open movie"); } void loadAsync (const URL& url, std::function callback) { if (url.isEmpty()) { jassertfalse; return; } currentURL = url; jassert (callback != nullptr); loadFinishedCallback = std::move (callback); playerController.loadAsync (url); } void close() { stop(); playerController.close(); currentFile = File(); currentURL = {}; } bool isOpen() const noexcept { return playerController.getPlayer() != nil; } bool isPlaying() const noexcept { return getSpeed() != 0; } void play() noexcept { [playerController.getPlayer() play]; setSpeed (playSpeedMult); } void stop() noexcept { [playerController.getPlayer() pause]; } void setPosition (double newPosition) { if (auto* p = playerController.getPlayer()) { CMTime t = { (CMTimeValue) (100000.0 * newPosition), (CMTimeScale) 100000, kCMTimeFlags_Valid, {} }; [p seekToTime: t toleranceBefore: kCMTimeZero toleranceAfter: kCMTimeZero]; } } double getPosition() const { if (auto* p = playerController.getPlayer()) return toSeconds ([p currentTime]); return 0.0; } void setSpeed (double newSpeed) { playSpeedMult = newSpeed; // Calling non 0.0 speed on a paused player would start it... if (isPlaying()) [playerController.getPlayer() setRate: (float) playSpeedMult]; } double getSpeed() const { if (auto* p = playerController.getPlayer()) return [p rate]; return 0.0; } Rectangle getNativeSize() const { if (auto* p = playerController.getPlayer()) { auto s = [[p currentItem] presentationSize]; return { (int) s.width, (int) s.height }; } return {}; } double getDuration() const { if (auto* p = playerController.getPlayer()) return toSeconds ([[p currentItem] duration]); return 0.0; } void setVolume (float newVolume) { [playerController.getPlayer() setVolume: newVolume]; } float getVolume() const { if (auto* p = playerController.getPlayer()) return [p volume]; return 0.0f; } File currentFile; URL currentURL; private: //============================================================================== template class PlayerControllerBase { public: ~PlayerControllerBase() { // Derived classes must call detachPlayerStatusObserver() before destruction! jassert (! playerStatusObserverAttached); // Derived classes must call detachPlaybackObserver() before destruction! jassert (! playbackObserverAttached); // Note that it's unsafe to call detachPlayerStatusObserver and detachPlaybackObserver // directly here, because those functions call into the derived class, which will have // been destroyed at this point. } protected: //============================================================================== struct JucePlayerStatusObserverClass : public ObjCClass { JucePlayerStatusObserverClass() : ObjCClass ("JucePlayerStatusObserverClass_") { JUCE_BEGIN_IGNORE_WARNINGS_GCC_LIKE ("-Wundeclared-selector") addMethod (@selector (observeValueForKeyPath:ofObject:change:context:), valueChanged); JUCE_END_IGNORE_WARNINGS_GCC_LIKE addIvar ("owner"); registerClass(); } //============================================================================== static PlayerControllerBase& getOwner (id self) { return *getIvar (self, "owner"); } static void setOwner (id self, PlayerControllerBase* p) { object_setInstanceVariable (self, "owner", p); } private: static void valueChanged (id self, SEL, NSString* keyPath, id, NSDictionary* change, void*) { auto& owner = getOwner (self); if ([keyPath isEqualToString: nsStringLiteral ("rate")]) { auto oldRate = [[change objectForKey: NSKeyValueChangeOldKey] floatValue]; auto newRate = [[change objectForKey: NSKeyValueChangeNewKey] floatValue]; if (oldRate == 0 && newRate != 0) owner.playbackStarted(); else if (oldRate != 0 && newRate == 0) owner.playbackStopped(); } else if ([keyPath isEqualToString: nsStringLiteral ("status")]) { auto status = [[change objectForKey: NSKeyValueChangeNewKey] intValue]; if (status == AVPlayerStatusFailed) owner.errorOccurred(); } } }; //============================================================================== struct JucePlayerItemPlaybackStatusObserverClass : public ObjCClass { JucePlayerItemPlaybackStatusObserverClass() : ObjCClass ("JucePlayerItemPlaybackStatusObserverClass_") { JUCE_BEGIN_IGNORE_WARNINGS_GCC_LIKE ("-Wundeclared-selector") addMethod (@selector (processNotification:), notificationReceived); JUCE_END_IGNORE_WARNINGS_GCC_LIKE addIvar ("owner"); registerClass(); } //============================================================================== static PlayerControllerBase& getOwner (id self) { return *getIvar (self, "owner"); } static void setOwner (id self, PlayerControllerBase* p) { object_setInstanceVariable (self, "owner", p); } private: static void notificationReceived (id self, SEL, NSNotification* notification) { if ([notification.name isEqualToString: AVPlayerItemDidPlayToEndTimeNotification]) getOwner (self).playbackReachedEndTime(); } }; //============================================================================== class PlayerAsyncInitialiser { public: PlayerAsyncInitialiser (PlayerControllerBase& ownerToUse) : owner (ownerToUse), assetKeys ([[NSArray alloc] initWithObjects: nsStringLiteral ("duration"), nsStringLiteral ("tracks"), nsStringLiteral ("playable"), nil]) { static JucePlayerItemPreparationStatusObserverClass cls; playerItemPreparationStatusObserver.reset ([cls.createInstance() init]); JucePlayerItemPreparationStatusObserverClass::setOwner (playerItemPreparationStatusObserver.get(), this); } ~PlayerAsyncInitialiser() { detachPreparationStatusObserver(); } void loadAsync (URL url) { auto nsUrl = [NSURL URLWithString: juceStringToNS (url.toString (true))]; asset.reset ([[AVURLAsset alloc] initWithURL: nsUrl options: nil]); [asset.get() loadValuesAsynchronouslyForKeys: assetKeys.get() completionHandler: ^() { checkAllKeysReadyFor (asset.get(), url); }]; } private: //============================================================================== struct JucePlayerItemPreparationStatusObserverClass : public ObjCClass { JucePlayerItemPreparationStatusObserverClass() : ObjCClass ("JucePlayerItemStatusObserverClass_") { JUCE_BEGIN_IGNORE_WARNINGS_GCC_LIKE ("-Wundeclared-selector") addMethod (@selector (observeValueForKeyPath:ofObject:change:context:), valueChanged); JUCE_END_IGNORE_WARNINGS_GCC_LIKE addIvar ("owner"); registerClass(); } //============================================================================== static PlayerAsyncInitialiser& getOwner (id self) { return *getIvar (self, "owner"); } static void setOwner (id self, PlayerAsyncInitialiser* p) { object_setInstanceVariable (self, "owner", p); } private: static void valueChanged (id self, SEL, NSString*, id object, NSDictionary* change, void* context) { auto& owner = getOwner (self); if (context == &owner) { auto* playerItem = (AVPlayerItem*) object; auto* urlAsset = (AVURLAsset*) playerItem.asset; URL url (nsStringToJuce (urlAsset.URL.absoluteString)); auto oldStatus = [[change objectForKey: NSKeyValueChangeOldKey] intValue]; auto newStatus = [[change objectForKey: NSKeyValueChangeNewKey] intValue]; // Ignore spurious notifications if (oldStatus == newStatus) return; if (newStatus == AVPlayerItemStatusFailed) { auto errorMessage = playerItem.error != nil ? nsStringToJuce (playerItem.error.localizedDescription) : String(); owner.notifyOwnerPreparationFinished (url, Result::fail (errorMessage), nullptr); } else if (newStatus == AVPlayerItemStatusReadyToPlay) { owner.notifyOwnerPreparationFinished (url, Result::ok(), owner.player.get()); } else { jassertfalse; } } } }; //============================================================================== PlayerControllerBase& owner; std::unique_ptr asset; std::unique_ptr, NSObjectDeleter> assetKeys; std::unique_ptr playerItem; std::unique_ptr playerItemPreparationStatusObserver; std::unique_ptr player; //============================================================================== void checkAllKeysReadyFor (AVAsset* assetToCheck, const URL& url) { NSError* error = nil; int successCount = 0; for (NSString* key : assetKeys.get()) { switch ([assetToCheck statusOfValueForKey: key error: &error]) { case AVKeyValueStatusLoaded: { ++successCount; break; } case AVKeyValueStatusCancelled: { notifyOwnerPreparationFinished (url, Result::fail ("Loading cancelled"), nullptr); return; } case AVKeyValueStatusFailed: { auto errorMessage = error != nil ? nsStringToJuce (error.localizedDescription) : String(); notifyOwnerPreparationFinished (url, Result::fail (errorMessage), nullptr); return; } case AVKeyValueStatusUnknown: case AVKeyValueStatusLoading: default: break; } } jassert (successCount == (int) [assetKeys.get() count]); preparePlayerItem(); } void preparePlayerItem() { playerItem.reset ([[AVPlayerItem alloc] initWithAsset: asset.get()]); attachPreparationStatusObserver(); player.reset ([[AVPlayer alloc] initWithPlayerItem: playerItem.get()]); } //============================================================================== void attachPreparationStatusObserver() { [playerItem.get() addObserver: playerItemPreparationStatusObserver.get() forKeyPath: nsStringLiteral ("status") options: NSKeyValueObservingOptionOld | NSKeyValueObservingOptionNew context: this]; } void detachPreparationStatusObserver() { if (playerItem != nullptr && playerItemPreparationStatusObserver != nullptr) { [playerItem.get() removeObserver: playerItemPreparationStatusObserver.get() forKeyPath: nsStringLiteral ("status") context: this]; } } //============================================================================== void notifyOwnerPreparationFinished (const URL& url, Result r, AVPlayer* preparedPlayer) { MessageManager::callAsync ([url, preparedPlayer, r, safeThis = WeakReference { this }]() mutable { if (safeThis != nullptr) safeThis->owner.playerPreparationFinished (url, r, preparedPlayer); }); } JUCE_DECLARE_WEAK_REFERENCEABLE (PlayerAsyncInitialiser) }; //============================================================================== Pimpl& owner; bool useNativeControls; PlayerAsyncInitialiser playerAsyncInitialiser; std::unique_ptr playerStatusObserver; std::unique_ptr playerItemPlaybackStatusObserver; //============================================================================== PlayerControllerBase (Pimpl& ownerToUse, bool useNativeControlsIfAvailable) : owner (ownerToUse), useNativeControls (useNativeControlsIfAvailable), playerAsyncInitialiser (*this) { static JucePlayerStatusObserverClass playerObserverClass; playerStatusObserver.reset ([playerObserverClass.createInstance() init]); JucePlayerStatusObserverClass::setOwner (playerStatusObserver.get(), this); static JucePlayerItemPlaybackStatusObserverClass itemObserverClass; playerItemPlaybackStatusObserver.reset ([itemObserverClass.createInstance() init]); JucePlayerItemPlaybackStatusObserverClass::setOwner (playerItemPlaybackStatusObserver.get(), this); } //============================================================================== void attachPlayerStatusObserver() { [crtp().getPlayer() addObserver: playerStatusObserver.get() forKeyPath: nsStringLiteral ("rate") options: NSKeyValueObservingOptionOld | NSKeyValueObservingOptionNew context: this]; [crtp().getPlayer() addObserver: playerStatusObserver.get() forKeyPath: nsStringLiteral ("status") options: NSKeyValueObservingOptionNew context: this]; playerStatusObserverAttached = true; } void detachPlayerStatusObserver() { if (crtp().getPlayer() != nullptr && playerStatusObserver != nullptr) { [crtp().getPlayer() removeObserver: playerStatusObserver.get() forKeyPath: nsStringLiteral ("rate") context: this]; [crtp().getPlayer() removeObserver: playerStatusObserver.get() forKeyPath: nsStringLiteral ("status") context: this]; } playerStatusObserverAttached = false; } void attachPlaybackObserver() { JUCE_BEGIN_IGNORE_WARNINGS_GCC_LIKE ("-Wundeclared-selector") [[NSNotificationCenter defaultCenter] addObserver: playerItemPlaybackStatusObserver.get() selector: @selector (processNotification:) name: AVPlayerItemDidPlayToEndTimeNotification object: [crtp().getPlayer() currentItem]]; JUCE_END_IGNORE_WARNINGS_GCC_LIKE playbackObserverAttached = true; } void detachPlaybackObserver() { JUCE_BEGIN_IGNORE_WARNINGS_GCC_LIKE ("-Wundeclared-selector") [[NSNotificationCenter defaultCenter] removeObserver: playerItemPlaybackStatusObserver.get()]; JUCE_END_IGNORE_WARNINGS_GCC_LIKE playbackObserverAttached = false; } private: //============================================================================== Derived& crtp() { return static_cast (*this); } //============================================================================== void playerPreparationFinished (const URL& url, Result r, AVPlayer* preparedPlayer) { if (preparedPlayer != nil) crtp().setPlayer (preparedPlayer); owner.playerPreparationFinished (url, r); } void playbackReachedEndTime() { MessageManager::callAsync ([safeThis = WeakReference { this }]() mutable { if (safeThis != nullptr) safeThis->owner.playbackReachedEndTime(); }); } //============================================================================== void errorOccurred() { auto errorMessage = (crtp().getPlayer() != nil && crtp().getPlayer().error != nil) ? nsStringToJuce (crtp().getPlayer().error.localizedDescription) : String(); owner.errorOccurred (errorMessage); } void playbackStarted() { owner.playbackStarted(); } void playbackStopped() { owner.playbackStopped(); } bool playerStatusObserverAttached = false, playbackObserverAttached = false; JUCE_DECLARE_WEAK_REFERENCEABLE (PlayerControllerBase) }; #if JUCE_MAC //============================================================================== class PlayerController : public PlayerControllerBase { public: PlayerController (Pimpl& ownerToUse, bool useNativeControlsIfAvailable) : PlayerControllerBase (ownerToUse, useNativeControlsIfAvailable) { wrappedPlayer = [&]() -> std::unique_ptr { if (@available (macOS 10.9, *)) if (useNativeControls) return std::make_unique(); return std::make_unique (); }(); } NSView* getView() { return wrappedPlayer->getView(); } Result load (NSURL* url) { if (auto player = [AVPlayer playerWithURL: url]) { setPlayer (player); return Result::ok(); } return Result::fail ("Couldn't open movie"); } void loadAsync (URL url) { playerAsyncInitialiser.loadAsync (url); } void close() { setPlayer (nil); } void setPlayer (AVPlayer* player) { detachPlayerStatusObserver(); detachPlaybackObserver(); wrappedPlayer->setPlayer (player); if (player != nil) { attachPlayerStatusObserver(); attachPlaybackObserver(); } } AVPlayer* getPlayer() const { return wrappedPlayer->getPlayer(); } private: struct WrappedPlayer { virtual ~WrappedPlayer() = default; virtual NSView* getView() const = 0; virtual AVPlayer* getPlayer() const = 0; virtual void setPlayer (AVPlayer*) = 0; }; class WrappedPlayerLayer : public WrappedPlayer { public: WrappedPlayerLayer () { [view.get() setLayer: playerLayer.get()]; } NSView* getView() const override { return view.get(); } AVPlayer* getPlayer() const override { return [playerLayer.get() player]; } void setPlayer (AVPlayer* player) override { [playerLayer.get() setPlayer: player]; } private: NSUniquePtr view { [[NSView alloc] init] }; NSUniquePtr playerLayer { [[AVPlayerLayer alloc] init] }; }; class API_AVAILABLE (macos (10.9)) WrappedPlayerView : public WrappedPlayer { public: WrappedPlayerView() = default; NSView* getView() const override { return playerView.get(); } AVPlayer* getPlayer() const override { return [playerView.get() player]; } void setPlayer (AVPlayer* player) override { [playerView.get() setPlayer: player]; } private: NSUniquePtr playerView { [[AVPlayerView alloc] init] }; }; std::unique_ptr wrappedPlayer; }; #else //============================================================================== class PlayerController : public PlayerControllerBase { public: PlayerController (Pimpl& ownerToUse, bool useNativeControlsIfAvailable) : PlayerControllerBase (ownerToUse, useNativeControlsIfAvailable) { if (useNativeControls) { playerViewController.reset ([[AVPlayerViewController alloc] init]); } else { static JuceVideoViewerClass cls; playerView.reset ([cls.createInstance() init]); playerLayer.reset ([[AVPlayerLayer alloc] init]); [playerView.get().layer addSublayer: playerLayer.get()]; } } UIView* getView() { if (useNativeControls) return [playerViewController.get() view]; // Should call getView() only once. jassert (playerView != nil); return playerView.release(); } Result load (NSURL*) { jassertfalse; return Result::fail ("Synchronous loading is not supported on iOS, use loadAsync()"); } void loadAsync (URL url) { playerAsyncInitialiser.loadAsync (url); } void close() { setPlayer (nil); } AVPlayer* getPlayer() const { if (useNativeControls) return [playerViewController.get() player]; return [playerLayer.get() player]; } void setPlayer (AVPlayer* playerToUse) { detachPlayerStatusObserver(); detachPlaybackObserver(); if (useNativeControls) [playerViewController.get() setPlayer: playerToUse]; else [playerLayer.get() setPlayer: playerToUse]; if (playerToUse != nil) { attachPlayerStatusObserver(); attachPlaybackObserver(); } } private: //============================================================================== struct JuceVideoViewerClass : public ObjCClass { JuceVideoViewerClass() : ObjCClass ("JuceVideoViewerClass_") { addMethod (@selector (layoutSubviews), layoutSubviews); registerClass(); } private: static void layoutSubviews (id self, SEL) { sendSuperclassMessage (self, @selector (layoutSubviews)); UIView* asUIView = (UIView*) self; if (auto* previewLayer = getPreviewLayer (self)) previewLayer.frame = asUIView.bounds; } static AVPlayerLayer* getPreviewLayer (id self) { UIView* asUIView = (UIView*) self; if (asUIView.layer.sublayers != nil && [asUIView.layer.sublayers count] > 0) if ([asUIView.layer.sublayers[0] isKindOfClass: [AVPlayerLayer class]]) return (AVPlayerLayer*) asUIView.layer.sublayers[0]; return nil; } }; //============================================================================== std::unique_ptr playerViewController; std::unique_ptr playerView; std::unique_ptr playerLayer; }; #endif //============================================================================== VideoComponent& owner; PlayerController playerController; std::function loadFinishedCallback; double playSpeedMult = 1.0; static double toSeconds (const CMTime& t) noexcept { return t.timescale != 0 ? (t.value / (double) t.timescale) : 0.0; } void playerPreparationFinished (const URL& url, Result r) { owner.resized(); loadFinishedCallback (url, r); loadFinishedCallback = nullptr; } void errorOccurred (const String& errorMessage) { if (owner.onErrorOccurred != nullptr) owner.onErrorOccurred (errorMessage); } void playbackStarted() { if (owner.onPlaybackStarted != nullptr) owner.onPlaybackStarted(); } void playbackStopped() { if (owner.onPlaybackStopped != nullptr) owner.onPlaybackStopped(); } void playbackReachedEndTime() { stop(); setPosition (0.0); } JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (Pimpl) };