You've already forked libopenshot
mirror of
https://github.com/OpenShot/libopenshot.git
synced 2026-03-02 08:53:52 -08:00
3ce85d0fff
It turns out SWIG is a lot pickier than GCC about namespaces, and requires a lot more `openshot::` prefixing in our headers, if we eliminate the `using namespace...` statements from them.
114 lines
3.2 KiB
C++
114 lines
3.2 KiB
C++
/**
|
|
* @file
|
|
* @brief Header file for PlayerBase class
|
|
* @author Jonathan Thomas <jonathan@openshot.org>
|
|
*
|
|
* @ref License
|
|
*/
|
|
|
|
/* LICENSE
|
|
*
|
|
* Copyright (c) 2008-2019 OpenShot Studios, LLC
|
|
* <http://www.openshotstudios.com/>. This file is part of
|
|
* OpenShot Library (libopenshot), an open-source project dedicated to
|
|
* delivering high quality video editing and animation solutions to the
|
|
* world. For more information visit <http://www.openshot.org/>.
|
|
*
|
|
* OpenShot Library (libopenshot) is free software: you can redistribute it
|
|
* and/or modify it under the terms of the GNU Lesser General Public License
|
|
* as published by the Free Software Foundation, either version 3 of the
|
|
* License, or (at your option) any later version.
|
|
*
|
|
* OpenShot Library (libopenshot) 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 Lesser General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Lesser General Public License
|
|
* along with OpenShot Library. If not, see <http://www.gnu.org/licenses/>.
|
|
*/
|
|
|
|
#ifndef OPENSHOT_PLAYER_BASE_H
|
|
#define OPENSHOT_PLAYER_BASE_H
|
|
|
|
#include <iostream>
|
|
#include "ReaderBase.h"
|
|
|
|
namespace openshot
|
|
{
|
|
/**
|
|
* @brief This enumeration determines the mode of the video player (i.e. playing, paused, etc...)
|
|
*
|
|
* A player can be in one of the following modes, which controls how it behaves.
|
|
*/
|
|
enum PlaybackMode
|
|
{
|
|
PLAYBACK_PLAY, ///< Play the video normally
|
|
PLAYBACK_PAUSED, ///< Pause the video (holding the last displayed frame)
|
|
PLAYBACK_LOADING, ///< Loading the video (display a loading animation)
|
|
PLAYBACK_STOPPED, ///< Stop playing the video (clear cache, done with player)
|
|
};
|
|
|
|
/**
|
|
* @brief This is the base class of all Players in libopenshot.
|
|
*
|
|
* Players are responsible for displaying images and playing back audio samples with specific
|
|
* frame rates and sample rates. All Players must be based on this class, and include these
|
|
* methods.
|
|
*/
|
|
class PlayerBase
|
|
{
|
|
protected:
|
|
float speed;
|
|
float volume;
|
|
openshot::ReaderBase *reader;
|
|
PlaybackMode mode;
|
|
|
|
public:
|
|
|
|
/// Display a loading animation
|
|
virtual void Loading() = 0;
|
|
|
|
/// Get the current mode
|
|
virtual PlaybackMode Mode() = 0;
|
|
|
|
/// Play the video
|
|
virtual void Play() = 0;
|
|
|
|
/// Pause the video
|
|
virtual void Pause() = 0;
|
|
|
|
/// Get the current frame number being played
|
|
virtual int Position() = 0;
|
|
|
|
/// Seek to a specific frame in the player
|
|
virtual void Seek(int64_t new_frame) = 0;
|
|
|
|
/// Get the Playback speed
|
|
virtual float Speed() = 0;
|
|
|
|
/// Set the Playback speed (1.0 = normal speed, <1.0 = slower, >1.0 faster)
|
|
virtual void Speed(float new_speed) = 0;
|
|
|
|
/// Stop the video player and clear the cached frames
|
|
virtual void Stop() = 0;
|
|
|
|
/// Get the current reader, such as a FFmpegReader
|
|
virtual ReaderBase* Reader() = 0;
|
|
|
|
/// Set the current reader, such as a FFmpegReader
|
|
virtual void Reader(openshot::ReaderBase *new_reader) = 0;
|
|
|
|
/// Get the Volume
|
|
virtual float Volume() = 0;
|
|
|
|
/// Set the Volume (1.0 = normal volume, <1.0 = quieter, >1.0 louder)
|
|
virtual void Volume(float new_volume) = 0;
|
|
|
|
virtual ~PlayerBase() = default;
|
|
};
|
|
|
|
}
|
|
|
|
#endif
|