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.
26 #include "lib/config.h"
27 #include "lib/player_text.h"
28 #include "lib/timer.h"
35 class RGBPlusAlphaImage;
39 class ClosedCaptionsDialog;
42 * @brief A wx widget to view a Film.
47 FilmViewer (wxWindow *);
50 /** @return the panel showing the film's video */
51 wxPanel* panel () const {
55 void show_closed_captions ();
57 void set_film (boost::shared_ptr<Film>);
58 boost::shared_ptr<Film> film () const {
62 void seek (DCPTime t, bool accurate);
63 void seek (boost::shared_ptr<Content> content, ContentTime p, bool accurate);
64 void seek_by (DCPTime by, bool accurate);
65 /** @return our `playhead' position; this may not lie exactly on a frame boundary */
66 DCPTime position () const {
67 return _video_position;
69 DCPTime one_video_frame () const;
73 bool playing () const {
77 void set_coalesce_player_changes (bool c);
78 void set_dcp_decode_reduction (boost::optional<int> reduction);
79 boost::optional<int> dcp_decode_reduction () const;
80 void set_outline_content (bool o);
81 void set_eyes (Eyes e);
82 void set_pad_black (bool p);
86 int dropped () const {
90 int audio_callback (void* out, unsigned int frames);
92 #ifdef DCPOMATIC_VARIANT_SWAROOP
93 void set_background_image (bool b) {
94 _background_image = b;
99 StateTimer const & state_timer () const {
107 boost::signals2::signal<void (boost::weak_ptr<PlayerVideo>)> ImageChanged;
108 boost::signals2::signal<void ()> PositionChanged;
109 boost::signals2::signal<void (DCPTime)> Started;
110 boost::signals2::signal<void (DCPTime)> Stopped;
111 /** While playing back we reached the end of the film (emitted from GUI thread) */
112 boost::signals2::signal<void ()> Finished;
114 boost::signals2::signal<bool ()> PlaybackPermitted;
118 void panel_sized (wxSizeEvent &);
120 void calculate_sizes ();
121 void player_change (ChangeType type, int, bool);
123 void display_player_video ();
124 void film_change (ChangeType, Film::Property);
125 void recreate_butler ();
126 void config_changed (Config::Property);
127 bool maybe_draw_background_image (wxPaintDC& dc);
129 DCPTime time () const;
130 DCPTime uncorrected_time () const;
131 Frame average_latency () const;
133 void refresh_panel ();
134 bool quick_refresh ();
136 boost::shared_ptr<Film> _film;
137 boost::shared_ptr<Player> _player;
139 /** The area that we put our image in */
142 bool _coalesce_player_changes;
143 std::list<int> _pending_player_changes;
145 std::pair<boost::shared_ptr<PlayerVideo>, DCPTime> _player_video;
146 boost::shared_ptr<const Image> _frame;
147 DCPTime _video_position;
148 Position<int> _inter_position;
149 dcp::Size _inter_size;
151 /** Size of our output (including padding if we have any) */
153 /** Size of the panel that we have available */
154 dcp::Size _panel_size;
158 unsigned int _audio_block_size;
160 boost::shared_ptr<Butler> _butler;
162 std::list<Frame> _latency_history;
163 /** Mutex to protect _latency_history */
164 mutable boost::mutex _latency_history_mutex;
165 int _latency_history_count;
168 boost::optional<int> _dcp_decode_reduction;
170 ClosedCaptionsDialog* _closed_captions_dialog;
172 bool _outline_content;
174 /** true to pad the viewer panel with black, false to use
175 the normal window background colour.
179 #ifdef DCPOMATIC_VARIANT_SWAROOP
183 bool _background_image;
186 StateTimer _state_timer;
189 boost::signals2::scoped_connection _config_changed_connection;