Files
libopenshot/include/QtPlayer.h

126 lines
3.8 KiB
C++

/**
* @file
* @brief Header file for QtPlayer class
* @author Duzy Chan <code@duzy.info>
* @author Jonathan Thomas <jonathan@openshot.org>
*
* @section LICENSE
*
* Copyright (c) 2008-2014 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 Affero 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 Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with OpenShot Library. If not, see <http://www.gnu.org/licenses/>.
*
* Also, if your software can interact with users remotely through a computer
* network, you should also make sure that it provides a way for users to
* get its source. For example, if your program is a web application, its
* interface could display a "Source" link that leads users to an archive
* of the code. There are many ways you could offer source, and different
* solutions will be better for different programs; see section 13 for the
* specific requirements.
*
* You should also get your employer (if you work as a programmer) or school,
* if any, to sign a "copyright disclaimer" for the program, if necessary.
* For more information on this, and how to apply and follow the GNU AGPL, see
* <http://www.gnu.org/licenses/>.
*/
#ifndef OPENSHOT_QT_PLAYER_H
#define OPENSHOT_QT_PLAYER_H
#include <iostream>
#include <vector>
#include "../include/PlayerBase.h"
#include "../include/Qt/PlayerPrivate.h"
#include "../include/RendererBase.h"
using namespace std;
namespace openshot
{
/**
* @brief This class is used to playback a video from a reader.
*
*/
class QtPlayer : public PlayerBase
{
PlayerPrivate *p;
bool threads_started;
public:
/// Default constructor
explicit QtPlayer();
explicit QtPlayer(RendererBase *rb);
/// Default destructor
virtual ~QtPlayer();
/// Play the video
void Play();
/// Display a loading animation
void Loading();
/// Get the current mode
PlaybackMode Mode();
/// Pause the video
void Pause();
/// Get the current frame number being played
int Position();
/// Seek to a specific frame in the player
void Seek(int new_frame);
/// Set the source URL/path of this player (which will create an internal Reader)
void SetSource(const std::string &source);
/// Set the QWidget which will be used as the display (note: QLabel works well). This does not take a
/// normal pointer, but rather a LONG pointer id (and it re-casts the QWidget pointer inside libopenshot).
/// This is required due to SIP and SWIG incompatibility in the Python bindings.
void SetQWidget(long qwidget_address);
/// Get the Renderer pointer address (for Python to cast back into a QObject)
long GetRendererQObject();
/// Get the Playback speed
float Speed();
/// Set the Playback speed (1.0 = normal speed, <1.0 = slower, >1.0 faster)
void Speed(float new_speed);
/// Stop the video player and clear the cached frames
void Stop();
/// Set the current reader
void Reader(ReaderBase *new_reader);
/// Get the current reader, such as a FFmpegReader
ReaderBase* Reader();
/// Get the Volume
float Volume();
/// Set the Volume (1.0 = normal volume, <1.0 = quieter, >1.0 louder)
void Volume(float new_volume);
};
}
#endif