2 Copyright (C) 2019-2021 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/>.
22 #ifndef DCPOMATIC_VIDEO_VIEW_H
23 #define DCPOMATIC_VIDEO_VIEW_H
26 #include "lib/dcpomatic_time.h"
27 #include "lib/exception_store.h"
28 #include "lib/signaller.h"
29 #include "lib/timer.h"
30 #include "lib/types.h"
31 #include <dcp/warnings.h>
32 #include <dcp/types.h>
33 LIBDCP_DISABLE_WARNINGS
35 LIBDCP_ENABLE_WARNINGS
36 #include <boost/signals2.hpp>
37 #include <boost/thread.hpp>
47 class VideoView : public ExceptionStore, public Signaller
50 VideoView (FilmViewer* viewer);
51 virtual ~VideoView () {}
53 VideoView (VideoView const&) = delete;
54 VideoView& operator= (VideoView const&) = delete;
56 /** @return the thing displaying the image */
57 virtual wxWindow* get () const = 0;
58 /** Re-make and display the image from the current _player_video */
59 virtual void update () = 0;
60 /** Called when playback starts */
61 virtual void start ();
62 /** Called when playback stops */
63 virtual void stop () {}
65 enum NextFrameResult {
71 /** Get the next frame and display it; used after seek */
72 virtual NextFrameResult display_next_frame (bool) = 0;
75 bool reset_metadata (std::shared_ptr<const Film> film, dcp::Size player_video_container_size);
77 /** Emitted from the GUI thread when our display changes in size */
78 boost::signals2::signal<void()> Sized;
79 /** Emitted from the GUI thread when a lot of frames are being dropped */
80 boost::signals2::signal<void()> TooManyDropped;
83 /* Accessors for FilmViewer */
85 int dropped () const {
86 boost::mutex::scoped_lock lm (_mutex);
90 int errored () const {
91 boost::mutex::scoped_lock lm (_mutex);
96 boost::mutex::scoped_lock lm (_mutex);
100 StateTimer const & state_timer () const {
104 dcpomatic::DCPTime position () const {
105 boost::mutex::scoped_lock lm (_mutex);
106 return _player_video.second;
110 /* Setters for FilmViewer so it can tell us our state and
111 * we can then use (thread) safely.
114 void set_video_frame_rate (int r) {
115 boost::mutex::scoped_lock lm (_mutex);
116 _video_frame_rate = r;
119 void set_length (dcpomatic::DCPTime len) {
120 boost::mutex::scoped_lock lm (_mutex);
124 void set_eyes (Eyes eyes) {
125 boost::mutex::scoped_lock lm (_mutex);
129 void set_three_d (bool t) {
130 boost::mutex::scoped_lock lm (_mutex);
134 void set_optimise_for_j2k (bool o) {
135 _optimise_for_j2k = o;
139 NextFrameResult get_next_frame (bool non_blocking);
140 boost::optional<int> time_until_next_frame () const;
141 dcpomatic::DCPTime one_video_frame () const;
143 wxColour pad_colour () const;
145 wxColour outline_content_colour () const {
146 return wxColour(255, 0, 0);
149 wxColour outline_subtitles_colour () const {
150 return wxColour(0, 255, 0);
153 wxColour crop_guess_colour () const {
154 return wxColour(0, 0, 255);
157 int video_frame_rate () const {
158 boost::mutex::scoped_lock lm (_mutex);
159 return _video_frame_rate;
162 dcpomatic::DCPTime length () const {
163 boost::mutex::scoped_lock lm (_mutex);
167 std::pair<std::shared_ptr<PlayerVideo>, dcpomatic::DCPTime> player_video () const {
168 boost::mutex::scoped_lock lm (_mutex);
169 return _player_video;
175 boost::mutex::scoped_lock lm (_mutex);
181 StateTimer _state_timer;
183 bool _optimise_for_j2k = false;
186 /** Mutex protecting all the state in this class */
187 mutable boost::mutex _mutex;
189 std::pair<std::shared_ptr<PlayerVideo>, dcpomatic::DCPTime> _player_video;
190 int _video_frame_rate = 0;
191 /** length of the film we are playing, or 0 if there is none */
192 dcpomatic::DCPTime _length;
193 Eyes _eyes = Eyes::LEFT;
194 bool _three_d = false;
197 struct timeval _dropped_check_period_start;