2 Copyright (C) 2012-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 /** @file src/film_viewer.h
22 * @brief FilmViewer class.
25 #include "video_view.h"
27 #include "lib/config.h"
28 #include "lib/player_text.h"
29 #include "lib/timer.h"
30 #include "lib/signaller.h"
37 class RGBPlusAlphaImage;
41 class ClosedCaptionsDialog;
44 * @brief A wx widget to view a Film.
46 class FilmViewer : public Signaller
49 FilmViewer (wxWindow *);
52 /** @return the window showing the film's video */
53 wxWindow* panel () const {
54 return _video_view->get();
57 VideoView const * video_view () const {
61 void show_closed_captions ();
63 void set_film (boost::shared_ptr<Film>);
64 boost::shared_ptr<Film> film () const {
68 void seek (dcpomatic::DCPTime t, bool accurate);
69 void seek (boost::shared_ptr<Content> content, dcpomatic::ContentTime p, bool accurate);
70 void seek_by (dcpomatic::DCPTime by, bool accurate);
71 /** @return our `playhead' position; this may not lie exactly on a frame boundary */
72 dcpomatic::DCPTime position () const {
73 return _video_view->position();
75 dcpomatic::DCPTime one_video_frame () const;
82 bool playing () const {
86 void set_coalesce_player_changes (bool c);
87 void set_dcp_decode_reduction (boost::optional<int> reduction);
88 boost::optional<int> dcp_decode_reduction () const;
89 void set_outline_content (bool o);
90 void set_eyes (Eyes e);
91 void set_pad_black (bool p);
97 int audio_callback (void* out, unsigned int frames);
99 #ifdef DCPOMATIC_VARIANT_SWAROOP
100 void set_background_image (bool b) {
101 _background_image = b;
105 bool background_image () const {
106 return _background_image;
110 StateTimer const & state_timer () const {
114 StateTimer& state_timer () {
122 /* Some accessors and utility methods that VideoView classes need */
123 dcp::Size out_size () const {
126 dcp::Size inter_size () const {
129 Position<int> inter_position () const {
130 return _inter_position;
132 bool outline_content () const {
133 return _outline_content;
135 bool pad_black () const {
138 boost::shared_ptr<Butler> butler () const {
142 boost::signals2::signal<void (boost::weak_ptr<PlayerVideo>)> ImageChanged;
143 boost::signals2::signal<void (dcpomatic::DCPTime)> Started;
144 boost::signals2::signal<void (dcpomatic::DCPTime)> Stopped;
145 /** While playing back we reached the end of the film (emitted from GUI thread) */
146 boost::signals2::signal<void ()> Finished;
147 void emit_finished ();
149 boost::signals2::signal<bool ()> PlaybackPermitted;
153 /* XXX_b: to remove */
154 friend class SimpleVideoView;
155 friend class GLVideoView;
156 friend class VideoView;
158 void video_view_sized ();
159 void calculate_sizes ();
160 void player_change (ChangeType type, int, bool);
161 void idle_handler ();
162 void request_idle_display_next_frame ();
163 void film_change (ChangeType, Film::Property);
164 void recreate_butler ();
165 void config_changed (Config::Property);
166 void film_length_change ();
168 dcpomatic::DCPTime time () const;
169 boost::optional<dcpomatic::DCPTime> audio_time () const;
170 dcpomatic::DCPTime uncorrected_time () const;
171 Frame average_latency () const;
173 void refresh_view ();
174 bool quick_refresh ();
176 boost::shared_ptr<Film> _film;
177 boost::shared_ptr<Player> _player;
179 VideoView* _video_view;
180 bool _coalesce_player_changes;
181 std::list<int> _pending_player_changes;
183 Position<int> _inter_position;
184 dcp::Size _inter_size;
186 /** Size of our output (including padding if we have any) */
191 unsigned int _audio_block_size;
194 boost::shared_ptr<Butler> _butler;
196 std::list<Frame> _latency_history;
197 /** Mutex to protect _latency_history */
198 mutable boost::mutex _latency_history_mutex;
199 int _latency_history_count;
201 boost::optional<int> _dcp_decode_reduction;
203 ClosedCaptionsDialog* _closed_captions_dialog;
205 bool _outline_content;
207 /** true to pad the viewer panel with black, false to use
208 the normal window background colour.
212 #ifdef DCPOMATIC_VARIANT_SWAROOP
213 bool _background_image;
216 StateTimer _state_timer;
219 /** true if an get() is required next time we are idle */
222 boost::signals2::scoped_connection _config_changed_connection;