/* ============================================================================== This file is part of the JUCE library. Copyright (c) 2015 - ROLI Ltd. Permission is granted to use this software under the terms of either: a) the GPL v2 (or any later version) b) the Affero GPL v3 Details of these licenses can be found at: www.gnu.org/licenses JUCE is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. ------------------------------------------------------------------------------ To release a closed-source product which uses JUCE, commercial licenses are available: visit www.juce.com for more information. ============================================================================== */ #ifndef JUCE_VIDEOCOMPONENT_H_INCLUDED #define JUCE_VIDEOCOMPONENT_H_INCLUDED namespace juce { //============================================================================== /** A component that can play a movie. Use the load() method to open a video once you've added this component to a parent (or put it on the desktop). @tags{Video} */ class JUCE_API VideoComponent : public Component, private Timer { public: //============================================================================== /** Creates an empty VideoComponent. Use the loadAsync() or load() method to open a video once you've added this component to a parent (or put it on the desktop). If useNativeControlsIfAvailable is enabled and a target OS has a video view with dedicated controls for transport etc, that view will be used. In opposite case a bare video view without any controls will be presented, allowing you to tailor your own UI. Currently this flag is used on iOS and 64bit macOS. Android, Windows and 32bit macOS will always use plain video views without dedicated controls. */ VideoComponent (bool useNativeControlsIfAvailable); /** Destructor. */ ~VideoComponent(); //============================================================================== /** Tries to load a video from a local file. This function is supported on macOS and Windows. For iOS and Android, use loadAsync() instead. @returns an error if the file failed to be loaded correctly @see loadAsync */ Result load (const File& file); /** Tries to load a video from a URL. This function is supported on macOS and Windows. For iOS and Android, use loadAsync() instead. @returns an error if the file failed to be loaded correctly @see loadAsync */ Result load (const URL& url); /** Tries to load a video from a URL asynchronously. When finished, invokes the callback supplied to the function on the message thread. This is the preferred way of loading content, since it works not only on macOS and Windows, but also on iOS and Android. On Windows, it will internally call load(). @see load */ void loadAsync (const URL& url, std::function loadFinishedCallback); /** Closes the video and resets the component. */ void closeVideo(); /** Returns true if a video is currently open. */ bool isVideoOpen() const; /** Returns the last file that was loaded. If nothing is open, or if it was a URL rather than a file, this will return File(). */ File getCurrentVideoFile() const; /** Returns the last URL that was loaded. If nothing is open, or if it was a file rather than a URL, this will return URL(). */ URL getCurrentVideoURL() const; //============================================================================== /** Returns the length of the video, in seconds. */ double getVideoDuration() const; /** Returns the video's natural size, in pixels. If no video is loaded, an empty rectangle will be returned. */ Rectangle getVideoNativeSize() const; /** Starts the video playing. */ void play(); /** Stops the video playing. */ void stop(); /** Returns true if the video is currently playing. */ bool isPlaying() const; /** Sets the video's position to a given time. */ void setPlayPosition (double newPositionSeconds); /** Returns the current play position of the video. */ double getPlayPosition() const; /** Changes the video playback rate. A value of 1.0 is normal speed, greater values will play faster, smaller values play more slowly. */ void setPlaySpeed (double newSpeed); /** Returns the current play speed of the video. */ double getPlaySpeed() const; /** Changes the video's playback volume. @param newVolume the volume in the range 0 (silent) to 1.0 (full) */ void setAudioVolume (float newVolume); /** Returns the video's playback volume. @returns the volume in the range 0 (silent) to 1.0 (full) */ float getAudioVolume() const; #if JUCE_SYNC_VIDEO_VOLUME_WITH_OS_MEDIA_VOLUME /** Set this callback to be notified whenever OS global media volume changes. Currently used on Android only. */ std::function onGlobalMediaVolumeChanged; #endif /** Set this callback to be notified whenever the playback starts. */ std::function onPlaybackStarted; /** Set this callback to be notified whenever the playback stops. */ std::function onPlaybackStopped; /** Set this callback to be notified whenever an error occurs. Upon error, you may need to load the video again. */ std::function onErrorOccurred; private: //============================================================================== struct Pimpl; std::unique_ptr pimpl; void resized() override; void timerCallback() override; #if JUCE_ANDROID friend void juce_surfaceChangedNativeVideo (int64, void*); friend void juce_surfaceDestroyedNativeVideo (int64, void*); friend void juce_mediaSessionPause (int64); friend void juce_mediaSessionPlay (int64); friend void juce_mediaSessionPlayFromMediaId (int64, void*, void*); friend void juce_mediaSessionSeekTo (int64, int64); friend void juce_mediaSessionStop (int64); friend void juce_mediaControllerAudioInfoChanged (int64, void*); friend void juce_mediaControllerMetadataChanged (int64, void*); friend void juce_mediaControllerPlaybackStateChanged (int64, void*); friend void juce_mediaControllerSessionDestroyed (int64); friend void juce_mediaSessionSystemVolumeChanged (int64); #endif JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (VideoComponent) }; #endif } // namespace juce