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"
32 #include <boost/signals2.hpp>
33 #include <boost/thread.hpp>
43 class VideoView : public ExceptionStore, public Signaller
46 VideoView (FilmViewer* viewer);
47 virtual ~VideoView () {}
49 VideoView (VideoView const&) = delete;
50 VideoView& operator= (VideoView const&) = delete;
52 /** @return the thing displaying the image */
53 virtual wxWindow* get () const = 0;
54 /** Re-make and display the image from the current _player_video */
55 virtual void update () = 0;
56 /** Called when playback starts */
57 virtual void start ();
58 /** Called when playback stops */
59 virtual void stop () {}
61 enum NextFrameResult {
67 /** Get the next frame and display it; used after seek */
68 virtual NextFrameResult display_next_frame (bool) = 0;
71 bool reset_metadata (std::shared_ptr<const Film> film, dcp::Size player_video_container_size);
73 /** Emitted from the GUI thread when our display changes in size */
74 boost::signals2::signal<void()> Sized;
75 /** Emitted from the GUI thread when a lot of frames are being dropped */
76 boost::signals2::signal<void()> TooManyDropped;
79 /* Accessors for FilmViewer */
81 int dropped () const {
82 boost::mutex::scoped_lock lm (_mutex);
86 int errored () const {
87 boost::mutex::scoped_lock lm (_mutex);
92 boost::mutex::scoped_lock lm (_mutex);
96 StateTimer const & state_timer () const {
100 dcpomatic::DCPTime position () const {
101 boost::mutex::scoped_lock lm (_mutex);
102 return _player_video.second;
106 /* Setters for FilmViewer so it can tell us our state and
107 * we can then use (thread) safely.
110 void set_video_frame_rate (int r) {
111 boost::mutex::scoped_lock lm (_mutex);
112 _video_frame_rate = r;
115 void set_length (dcpomatic::DCPTime len) {
116 boost::mutex::scoped_lock lm (_mutex);
120 void set_eyes (Eyes eyes) {
121 boost::mutex::scoped_lock lm (_mutex);
125 void set_three_d (bool t) {
126 boost::mutex::scoped_lock lm (_mutex);
130 void set_optimise_for_j2k (bool o) {
131 _optimise_for_j2k = o;
135 NextFrameResult get_next_frame (bool non_blocking);
136 boost::optional<int> time_until_next_frame () const;
137 dcpomatic::DCPTime one_video_frame () const;
139 wxColour pad_colour () const;
141 wxColour outline_content_colour () const {
142 return wxColour(255, 0, 0);
145 wxColour outline_subtitles_colour () const {
146 return wxColour(0, 255, 0);
149 int video_frame_rate () const {
150 boost::mutex::scoped_lock lm (_mutex);
151 return _video_frame_rate;
154 dcpomatic::DCPTime length () const {
155 boost::mutex::scoped_lock lm (_mutex);
159 std::pair<std::shared_ptr<PlayerVideo>, dcpomatic::DCPTime> player_video () const {
160 boost::mutex::scoped_lock lm (_mutex);
161 return _player_video;
167 boost::mutex::scoped_lock lm (_mutex);
173 StateTimer _state_timer;
175 bool _optimise_for_j2k = false;
178 /** Mutex protecting all the state in this class */
179 mutable boost::mutex _mutex;
181 std::pair<std::shared_ptr<PlayerVideo>, dcpomatic::DCPTime> _player_video;
182 int _video_frame_rate = 0;
183 /** length of the film we are playing, or 0 if there is none */
184 dcpomatic::DCPTime _length;
185 Eyes _eyes = Eyes::LEFT;
186 bool _three_d = false;
189 struct timeval _dropped_check_period_start;