axmol/core/ui/UIMediaPlayer.h

/****************************************************************************
 Copyright (c) 2014-2016 Chukong Technologies Inc.
 Copyright (c) 2017-2018 Xiamen Yaji Software Co., Ltd.
 Copyright (c) 2022 Bytedance Inc.

 https://axmolengine.github.io/

 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
 in the Software without restriction, including without limitation the rights
 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 copies of the Software, and to permit persons to whom the Software is
 furnished to do so, subject to the following conditions:

 The above copyright notice and this permission notice shall be included in
 all copies or substantial portions of the Software.

 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 THE SOFTWARE.
 ****************************************************************************/
#pragma once

#include "ui/UIWidget.h"

#if AX_TARGET_PLATFORM != AX_PLATFORM_LINUX || defined(AX_ENABLE_VLC_MEDIA)

#    if AX_VIDEOPLAYER_DEBUG_DRAW
#        include "2d/CCDrawNode.h"
#    endif

#    undef ERROR

/**
 * @addtogroup ui
 * @{
 */

NS_AX_BEGIN
namespace ui
{

/**
 * @class MediaPlayer
 * @brief Play a media file.
 *
 * @note MediaPlayer play a media file base on system widget.
 * It's mean MediaPlayer play a media file above all graphical elements of axmol.
 * @js NA
 */
class AX_GUI_DLL MediaPlayer : public ax::ui::Widget
{
public:
    /**
     * Videoplayer play event type.
     */
    enum class EventType
    {
        PLAYING = 0,
        PAUSED,
        STOPPED,
        COMPLETED,
        ERROR
    };

    /**
     * Styles of how the the video player is presented
     * For now only used on iOS to use either MPMovieControlStyleEmbedded (DEFAULT) or
     * MPMovieControlStyleNone (NONE)
     */
    enum class StyleType
    {
        DEFAULT = 0,
        NONE
    };

    /**
     * A callback which will be called after specific MediaPlayer event happens.
     */
    typedef std::function<void(Ref*, MediaPlayer::EventType)> ccVideoPlayerCallback;

    /**
     *Static create method for instancing a MediaPlayer.
     */
    CREATE_FUNC(MediaPlayer);

    /**
     * Sets a file path as a video source for MediaPlayer.
     */
    virtual void setFileName(std::string_view videoPath);

    /**
     * @brief Get the local video file name.
     *
     * @return The video file name.
     */
    virtual std::string_view getFileName() const { return _videoURL; }

    /**
     * Sets a URL as a video source for MediaPlayer.
     */
    virtual void setURL(std::string_view _videoURL);

    /**
     * @brief Get the URL of remoting video source.
     *
     * @return A remoting URL address.
     */
    virtual std::string_view getURL() const { return _videoURL; }

    /**
     * @brief Set if playback is done in loop mode
     *
     * @param looping the video will or not automatically restart at the end
     */
    virtual void setLooping(bool looping);

    /**
     * Set if the player will enable user input for basic pause and resume of video
     *
     * @param enableInput If true, input will be handled for basic functionality (pause/resume)
     */
    virtual void setUserInputEnabled(bool enableInput);

    /**
     * Set the style of the player
     *
     * @param style The corresponding style
     */
    virtual void setStyle(StyleType style);

    /**
     * Sets play rate, currently, only supported by windows
     *
     * @param fRate   the rate for play, default 1.0
     */
    virtual void setPlayRate(float fRate);

    /**
     * Starts playback.
     */
    virtual void play();

    /**
     * Pauses playback.
     */
    virtual void pause() override;

    /**
     * Resumes playback.
     */
    virtual void resume() override;

    /**
     * Stops playback.
     */
    virtual void stop();

    /**
     * Seeks to specified time position.
     *
     * @param sec   The offset in seconds from the start to seek to.
     */
    virtual void seekTo(float sec);

    /**
     * Checks whether the MediaPlayer is playing.
     *
     * @return True if currently playing, false otherwise.
     */
    virtual bool isPlaying() const;

    /**
     * Checks whether the MediaPlayer is set with looping mode.
     *
     * @return true if the videoplayer is set to loop, false otherwise.
     */
    virtual bool isLooping() const;

    /**
     * Checks whether the MediaPlayer is set to listen user input to resume and pause the video
     *
     * @return true if the videoplayer user input is set, false otherwise.
     */
    virtual bool isUserInputEnabled() const;

    /**
     * Causes the video player to keep aspect ratio or no when displaying the video.
     *
     * @param enable    Specify true to keep aspect ratio or false to scale the video until
     * both dimensions fit the visible bounds of the view exactly.
     */
    virtual void setKeepAspectRatioEnabled(bool enable);

    /**
     * Indicates whether the video player keep aspect ratio when displaying the video.
     */
    virtual bool isKeepAspectRatioEnabled() const { return _keepAspectRatioEnabled; }

    /**
     * Causes the video player to enter or exit full-screen mode.
     *
     * @param fullscreen    Specify true to enter full-screen mode or false to exit full-screen mode.
     */
    virtual void setFullScreenEnabled(bool fullscreen);

    /**
     * Indicates whether the video player is in full-screen mode.
     *
     * @return True if the video player is in full-screen mode, false otherwise.
     */
    virtual bool isFullScreenEnabled() const;

    /**
     * Register a callback to be invoked when the video state is updated.
     *
     * @param callback  The callback that will be run.
     */
    virtual void addEventListener(const MediaPlayer::ccVideoPlayerCallback& callback);

    /**
     * @brief A function which will be called when video is playing.
     *
     * @param event @see MediaPlayer::EventType.

     */
    virtual void onPlayEvent(int event);
    virtual void setVisible(bool visible) override;
    virtual void draw(Renderer* renderer, const Mat4& transform, uint32_t flags) override;
    virtual void onEnter() override;
    virtual void onExit() override;

    void setContentSize(const Size& contentSize) override;

    MediaPlayer();
    virtual ~MediaPlayer();

protected:
    virtual ax::ui::Widget* createCloneInstance() override;
    virtual void copySpecialProperties(Widget* model) override;

#    if AX_VIDEOPLAYER_DEBUG_DRAW
    DrawNode* _debugDrawNode;
#    endif

    enum class Source
    {
        FILENAME = 0,
        URL
    };

    bool _isPlaying              = false;
    bool _isLooping              = false;
    bool _isUserInputEnabled     = true;
    bool _fullScreenDirty        = false;
    bool _fullScreenEnabled      = false;
    bool _keepAspectRatioEnabled = false;

    StyleType _styleType = StyleType::DEFAULT;

    std::string _videoURL;
    Source _videoSource;

    int _videoPlayerIndex                = -1;
    ccVideoPlayerCallback _eventCallback = nullptr;

    void* _videoContext = nullptr;
};
using VideoPlayer = MediaPlayer;
}  // namespace ui

NS_AX_END
// end group
/// @}
#endif