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"
36 class RGBPlusAlphaImage;
40 class ClosedCaptionsDialog;
43 * @brief A wx widget to view a Film.
48 FilmViewer (wxWindow *);
51 /** @return the window showing the film's video */
52 wxWindow* panel () const {
53 return _video_view->get();
56 VideoView const * video_view () const {
60 void show_closed_captions ();
62 void set_film (boost::shared_ptr<Film>);
63 boost::shared_ptr<Film> film () const {
67 void seek (dcpomatic::DCPTime t, bool accurate);
68 void seek (boost::shared_ptr<Content> content, dcpomatic::ContentTime p, bool accurate);
69 void seek_by (dcpomatic::DCPTime by, bool accurate);
70 /** @return our `playhead' position; this may not lie exactly on a frame boundary */
71 dcpomatic::DCPTime position () const {
72 return _video_position;
74 dcpomatic::DCPTime one_video_frame () const;
78 bool playing () const {
82 void set_coalesce_player_changes (bool c);
83 void set_dcp_decode_reduction (boost::optional<int> reduction);
84 boost::optional<int> dcp_decode_reduction () const;
85 void set_outline_content (bool o);
86 void set_eyes (Eyes e);
87 void set_pad_black (bool p);
91 int dropped () const {
95 int audio_callback (void* out, unsigned int frames);
97 #ifdef DCPOMATIC_VARIANT_SWAROOP
98 void set_background_image (bool b) {
99 _background_image = b;
103 bool background_image () const {
104 return _background_image;
108 StateTimer const & state_timer () const {
112 StateTimer& state_timer () {
120 /* Some accessors that VideoView classes need */
121 dcp::Size out_size () const {
124 dcp::Size inter_size () const {
127 Position<int> inter_position () const {
128 return _inter_position;
130 bool outline_content () const {
131 return _outline_content;
133 bool pad_black () const {
136 dcpomatic::DCPTime video_position () const {
137 return _video_position;
140 boost::signals2::signal<void (boost::weak_ptr<PlayerVideo>)> ImageChanged;
141 boost::signals2::signal<void ()> PositionChanged;
142 boost::signals2::signal<void (dcpomatic::DCPTime)> Started;
143 boost::signals2::signal<void (dcpomatic::DCPTime)> Stopped;
144 /** While playing back we reached the end of the film (emitted from GUI thread) */
145 boost::signals2::signal<void ()> Finished;
147 boost::signals2::signal<bool ()> PlaybackPermitted;
150 void video_view_sized ();
152 void calculate_sizes ();
153 void player_change (ChangeType type, int, bool);
154 bool get (bool lazy);
155 void idle_handler ();
156 void request_idle_get ();
157 void display_player_video ();
158 void film_change (ChangeType, Film::Property);
159 void recreate_butler ();
160 void config_changed (Config::Property);
162 dcpomatic::DCPTime time () const;
163 dcpomatic::DCPTime uncorrected_time () const;
164 Frame average_latency () const;
166 void refresh_view ();
167 bool quick_refresh ();
169 boost::shared_ptr<Film> _film;
170 boost::shared_ptr<Player> _player;
172 VideoView* _video_view;
174 bool _coalesce_player_changes;
175 std::list<int> _pending_player_changes;
177 std::pair<boost::shared_ptr<PlayerVideo>, dcpomatic::DCPTime> _player_video;
178 dcpomatic::DCPTime _video_position;
179 Position<int> _inter_position;
180 dcp::Size _inter_size;
182 /** Size of our output (including padding if we have any) */
187 unsigned int _audio_block_size;
189 boost::shared_ptr<Butler> _butler;
191 std::list<Frame> _latency_history;
192 /** Mutex to protect _latency_history */
193 mutable boost::mutex _latency_history_mutex;
194 int _latency_history_count;
197 boost::optional<int> _dcp_decode_reduction;
199 ClosedCaptionsDialog* _closed_captions_dialog;
201 bool _outline_content;
203 /** true to pad the viewer panel with black, false to use
204 the normal window background colour.
208 #ifdef DCPOMATIC_VARIANT_SWAROOP
209 bool _background_image;
212 StateTimer _state_timer;
215 /** true if an get() is required next time we are idle */
218 boost::signals2::scoped_connection _config_changed_connection;