QtPlayer.h
Go to the documentation of this file.
/**
* @file
* @brief Header file for QtPlayer class
* @author Duzy Chan <code@duzy.info>
* @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_QT_PLAYER_H
#define OPENSHOT_QT_PLAYER_H
#include <iostream>
#include <vector>
#include "PlayerBase.h"
#include "Qt/PlayerPrivate.h"
#include "RendererBase.h"
namespace openshot
{
/**
* @brief This class is used to playback a video from a reader.
*
*/
class QtPlayer : public openshot::PlayerBase
{
openshot::PlayerPrivate *p;
bool threads_started;
public:
/// Default constructor
explicit QtPlayer();
explicit QtPlayer(openshot::RendererBase *rb);
/// Default destructor
virtual ~QtPlayer();
/// Close audio device
void CloseAudioDevice();
/// Get Error (if any)
std::string GetError();
/// Get Audio Devices from JUCE
std::vector<openshot::AudioDeviceInfo> GetAudioDeviceNames();
/// Play the video
void Play();
/// Display a loading animation
void Loading();
/// Get the current mode
openshot::PlaybackMode Mode();
/// Pause the video
void Pause();
/// Get the current frame number being played
int64_t Position();
/// Seek to a specific frame in the player
void Seek(int64_t 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(int64_t qwidget_address);
/// Get the Renderer pointer address (for Python to cast back into a QObject)
int64_t 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(openshot::ReaderBase *new_reader);
/// Get the current reader, such as a FFmpegReader
openshot::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
PlayerBase.h
Header file for PlayerBase class.
PlayerPrivate.h
Source file for PlayerPrivate class.
RendererBase.h
Header file for RendererBase class.
openshot::PlayerBase
This is the base class of all Players in libopenshot.
Definition: PlayerBase.h:60
openshot::PlayerPrivate
The private part of QtPlayer class, which contains an audio thread and video thread,...
Definition: PlayerPrivate.h:49
openshot::QtPlayer
This class is used to playback a video from a reader.
Definition: QtPlayer.h:48
openshot::QtPlayer::Loading
void Loading()
Display a loading animation.
Definition: QtPlayer.cpp:117
openshot::QtPlayer::Seek
void Seek(int64_t new_frame)
Seek to a specific frame in the player.
Definition: QtPlayer.cpp:139
openshot::QtPlayer::SetSource
void SetSource(const std::string &source)
Set the source URL/path of this player (which will create an internal Reader)
Definition: QtPlayer.cpp:88
openshot::QtPlayer::Position
int64_t Position()
Get the current frame number being played.
Definition: QtPlayer.cpp:134
openshot::QtPlayer::QtPlayer
QtPlayer()
Default constructor.
Definition: QtPlayer.cpp:42
openshot::QtPlayer::SetQWidget
void SetQWidget(int64_t qwidget_address)
Definition: QtPlayer.cpp:191
openshot::QtPlayer::GetAudioDeviceNames
std::vector< openshot::AudioDeviceInfo > GetAudioDeviceNames()
Get Audio Devices from JUCE.
Definition: QtPlayer.cpp:80
openshot::QtPlayer::GetError
std::string GetError()
Get Error (if any)
Definition: QtPlayer.cpp:70
openshot::QtPlayer::CloseAudioDevice
void CloseAudioDevice()
Close audio device.
Definition: QtPlayer.cpp:63
openshot::QtPlayer::Volume
float Volume()
Get the Volume.
Definition: QtPlayer.cpp:216
openshot::QtPlayer::~QtPlayer
virtual ~QtPlayer()
Default destructor.
Definition: QtPlayer.cpp:55
openshot::QtPlayer::Speed
float Speed()
Get the Playback speed.
Definition: QtPlayer.cpp:202
openshot::QtPlayer::Play
void Play()
Play the video.
Definition: QtPlayer.cpp:104
openshot::QtPlayer::Mode
openshot::PlaybackMode Mode()
Get the current mode.
Definition: QtPlayer.cpp:123
openshot::QtPlayer::Pause
void Pause()
Pause the video.
Definition: QtPlayer.cpp:128
openshot::QtPlayer::Reader
openshot::ReaderBase * Reader()
Get the current reader, such as a FFmpegReader.
Definition: QtPlayer.cpp:186
openshot::QtPlayer::GetRendererQObject
int64_t GetRendererQObject()
Get the Renderer pointer address (for Python to cast back into a QObject)
Definition: QtPlayer.cpp:197
openshot::QtPlayer::Stop
void Stop()
Stop the video player and clear the cached frames.
Definition: QtPlayer.cpp:157
openshot::ReaderBase
This abstract class is the base class, used by all readers in libopenshot.
Definition: ReaderBase.h:98
openshot::RendererBase
This is the base class of all Renderers in libopenshot.
Definition: RendererBase.h:49
openshot
This namespace is the default namespace for all code in the openshot library.
Definition: AudioBufferSource.h:39
openshot::PlaybackMode
PlaybackMode
This enumeration determines the mode of the video player (i.e. playing, paused, etc....
Definition: PlayerBase.h:45