2 Copyright (C) 2012-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 /** @file src/film_viewer.h
23 * @brief FilmViewer class.
27 #include "video_view.h"
29 #include "lib/config.h"
30 #include "lib/player_text.h"
31 #include "lib/timer.h"
32 #include "lib/signaller.h"
33 #include "lib/warnings.h"
35 DCPOMATIC_DISABLE_WARNINGS
37 DCPOMATIC_ENABLE_WARNINGS
43 class RGBPlusAlphaImage;
47 class ClosedCaptionsDialog;
51 * @brief A wx widget to view a Film.
53 class FilmViewer : public Signaller
56 FilmViewer (wxWindow *);
59 /** @return the window showing the film's video */
60 wxWindow* panel () const {
61 return _video_view->get();
64 std::shared_ptr<const VideoView> video_view () const {
68 void show_closed_captions ();
70 void set_film (std::shared_ptr<Film>);
71 std::shared_ptr<Film> film () const {
75 void seek (dcpomatic::DCPTime t, bool accurate);
76 void seek (std::shared_ptr<Content> content, dcpomatic::ContentTime p, bool accurate);
77 void seek_by (dcpomatic::DCPTime by, bool accurate);
78 /** @return our `playhead' position; this may not lie exactly on a frame boundary */
79 dcpomatic::DCPTime position () const {
80 return _video_view->position();
82 dcpomatic::DCPTime one_video_frame () const;
89 bool playing () const {
93 void set_coalesce_player_changes (bool c);
94 void set_dcp_decode_reduction (boost::optional<int> reduction);
95 boost::optional<int> dcp_decode_reduction () const;
96 void set_outline_content (bool o);
97 void set_outline_subtitles (boost::optional<dcpomatic::Rect<double>>);
98 void set_eyes (Eyes e);
99 void set_pad_black (bool p);
100 void set_optimise_for_j2k (bool o);
102 void slow_refresh ();
104 dcpomatic::DCPTime time () const;
105 boost::optional<dcpomatic::DCPTime> audio_time () const;
107 int dropped () const;
108 int errored () const;
111 int audio_callback (void* out, unsigned int frames);
113 StateTimer const & state_timer () const {
114 return _video_view->state_timer ();
117 /* Some accessors and utility methods that VideoView classes need */
118 bool outline_content () const {
119 return _outline_content;
121 boost::optional<dcpomatic::Rect<double>> outline_subtitles () const {
122 return _outline_subtitles;
124 bool pad_black () const {
127 std::shared_ptr<Butler> butler () const {
130 ClosedCaptionsDialog* closed_captions_dialog () const {
131 return _closed_captions_dialog;
134 void image_changed (std::shared_ptr<PlayerVideo> video);
136 bool pending_idle_get () const {
140 boost::signals2::signal<void (std::shared_ptr<PlayerVideo>)> ImageChanged;
141 boost::signals2::signal<void ()> Started;
142 boost::signals2::signal<void ()> Stopped;
143 /** While playing back we reached the end of the film (emitted from GUI thread) */
144 boost::signals2::signal<void ()> Finished;
145 /** Emitted from the GUI thread when a lot of frames are being dropped */
146 boost::signals2::signal<void()> TooManyDropped;
148 boost::signals2::signal<bool ()> PlaybackPermitted;
152 void video_view_sized ();
153 void calculate_sizes ();
154 void player_change (ChangeType type, int, bool);
155 void player_change (std::vector<int> properties);
156 void idle_handler ();
157 void request_idle_display_next_frame ();
158 void film_change (ChangeType, Film::Property);
159 void recreate_butler ();
160 void config_changed (Config::Property);
161 void film_length_change ();
164 dcpomatic::DCPTime uncorrected_time () const;
165 Frame average_latency () const;
167 bool quick_refresh ();
169 std::shared_ptr<Film> _film;
170 std::shared_ptr<Player> _player;
172 std::shared_ptr<VideoView> _video_view;
173 bool _coalesce_player_changes = false;
174 std::vector<int> _pending_player_changes;
177 int _audio_channels = 0;
178 unsigned int _audio_block_size = 1024;
179 bool _playing = false;
181 std::shared_ptr<Butler> _butler;
183 std::list<Frame> _latency_history;
184 /** Mutex to protect _latency_history */
185 mutable boost::mutex _latency_history_mutex;
186 int _latency_history_count = 0;
188 boost::optional<int> _dcp_decode_reduction;
190 /** true to assume that this viewer is only being used for JPEG2000 sources
191 * so it can optimise accordingly.
193 bool _optimise_for_j2k = false;
195 ClosedCaptionsDialog* _closed_captions_dialog = nullptr;
197 bool _outline_content = false;
198 boost::optional<dcpomatic::Rect<double>> _outline_subtitles;
199 /** true to pad the viewer panel with black, false to use
200 the normal window background colour.
202 bool _pad_black = false;
204 /** true if an get() is required next time we are idle */
205 bool _idle_get = false;
207 boost::signals2::scoped_connection _config_changed_connection;