2 Copyright (C) 2019 Carl Hetherington <cth@carlh.net>
4 This file is part of DCP-o-matic.
6 DCP-o-matic is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2 of the License, or
9 (at your option) any later version.
11 DCP-o-matic is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with DCP-o-matic. If not, see <http://www.gnu.org/licenses/>.
21 #ifndef DCPOMATIC_VIDEO_VIEW_H
22 #define DCPOMATIC_VIDEO_VIEW_H
24 #include "lib/dcpomatic_time.h"
25 #include "lib/timer.h"
26 #include "lib/types.h"
27 #include "lib/exception_store.h"
28 #include <boost/shared_ptr.hpp>
29 #include <boost/signals2.hpp>
30 #include <boost/thread.hpp>
31 #include <boost/noncopyable.hpp>
39 class VideoView : public ExceptionStore, public boost::noncopyable
42 VideoView (FilmViewer* viewer);
43 virtual ~VideoView () {}
45 /** @return the thing displaying the image */
46 virtual wxWindow* get () const = 0;
47 /** Re-make and display the image from the current _player_video */
48 virtual void update () = 0;
49 /** Called when playback starts */
50 virtual void start ();
51 /** Called when playback stops */
52 virtual void stop () {}
53 /** Get the next frame and display it; used after seek */
54 virtual bool display_next_frame (bool) = 0;
57 bool reset_metadata (boost::shared_ptr<const Film> film, dcp::Size player_video_container_size);
59 /** Emitted from the GUI thread when our display changes in size */
60 boost::signals2::signal<void()> Sized;
63 /* Accessors for FilmViewer */
65 int dropped () const {
66 boost::mutex::scoped_lock lm (_mutex);
70 int errored () const {
71 boost::mutex::scoped_lock lm (_mutex);
76 boost::mutex::scoped_lock lm (_mutex);
80 StateTimer const & state_timer () const {
84 dcpomatic::DCPTime position () const {
85 boost::mutex::scoped_lock lm (_mutex);
86 return _player_video.second;
90 /* Setters for FilmViewer so it can tell us our state and
91 * we can then use (thread) safely.
94 void set_video_frame_rate (int r) {
95 boost::mutex::scoped_lock lm (_mutex);
96 _video_frame_rate = r;
99 void set_length (dcpomatic::DCPTime len) {
100 boost::mutex::scoped_lock lm (_mutex);
104 void set_eyes (Eyes eyes) {
105 boost::mutex::scoped_lock lm (_mutex);
109 void set_three_d (bool t) {
110 boost::mutex::scoped_lock lm (_mutex);
115 bool get_next_frame (bool non_blocking);
116 boost::optional<int> time_until_next_frame () const;
117 dcpomatic::DCPTime one_video_frame () const;
119 int video_frame_rate () const {
120 boost::mutex::scoped_lock lm (_mutex);
121 return _video_frame_rate;
124 dcpomatic::DCPTime length () const {
125 boost::mutex::scoped_lock lm (_mutex);
129 std::pair<boost::shared_ptr<PlayerVideo>, dcpomatic::DCPTime> player_video () const {
130 boost::mutex::scoped_lock lm (_mutex);
131 return _player_video;
134 void add_dropped () {
135 boost::mutex::scoped_lock lm (_mutex);
140 boost::mutex::scoped_lock lm (_mutex);
146 StateTimer _state_timer;
149 /** Mutex protecting all the state in this class */
150 mutable boost::mutex _mutex;
152 std::pair<boost::shared_ptr<PlayerVideo>, dcpomatic::DCPTime> _player_video;
153 int _video_frame_rate;
154 /** length of the film we are playing, or 0 if there is none */
155 dcpomatic::DCPTime _length;