2 Copyright (C) 2012-2018 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 A wx widget to view `thumbnails' of a Film.
26 #include "lib/config.h"
27 #include "lib/player_text.h"
34 class RGBPlusAlphaImage;
38 class ClosedCaptionsDialog;
41 * @brief A wx widget to view a preview of a Film.
43 class FilmViewer : public wxPanel
46 FilmViewer (wxWindow *, bool outline_content = true, bool jump_to_selected = true);
49 void set_film (boost::shared_ptr<Film>);
50 boost::shared_ptr<Film> film () const {
54 /** @return our `playhead' position; this may not lie exactly on a frame boundary */
55 DCPTime position () const {
56 return _video_position;
59 void set_position (DCPTime p);
60 void set_position (boost::shared_ptr<Content> content, ContentTime p);
61 void set_coalesce_player_changes (bool c);
62 void set_dcp_decode_reduction (boost::optional<int> reduction);
63 boost::optional<int> dcp_decode_reduction () const;
66 bool quick_refresh ();
68 int dropped () const {
74 bool playing () const {
79 void forward_frame ();
81 int audio_callback (void* out, unsigned int frames);
83 void show_closed_captions ();
85 boost::signals2::signal<void (boost::weak_ptr<PlayerVideo>)> ImageChanged;
89 void panel_sized (wxSizeEvent &);
90 void slider_moved (bool page);
91 void slider_released ();
94 void calculate_sizes ();
95 void check_play_state ();
96 void active_jobs_changed (boost::optional<std::string>);
97 void rewind_clicked (wxMouseEvent &);
98 void back_clicked (wxKeyboardState& s);
99 void forward_clicked (wxKeyboardState &);
100 void player_change (ChangeType type, int, bool);
101 void update_position_label ();
102 void update_position_slider ();
104 void display_player_video ();
105 void seek (DCPTime t, bool accurate);
106 void refresh_panel ();
107 void setup_sensitivity ();
108 void film_change (ChangeType, Film::Property);
109 DCPTime nudge_amount (wxKeyboardState &);
110 void timecode_clicked ();
111 void frame_number_clicked ();
112 void go_to (DCPTime t);
113 void jump_to_selected_clicked ();
114 void recreate_butler ();
115 void config_changed (Config::Property);
116 DCPTime time () const;
117 DCPTime uncorrected_time () const;
118 Frame average_latency () const;
119 DCPTime one_video_frame () const;
121 boost::shared_ptr<Film> _film;
122 boost::shared_ptr<Player> _player;
125 /** The area that we put our image in */
127 wxCheckBox* _outline_content;
129 wxCheckBox* _jump_to_selected;
131 wxButton* _rewind_button;
132 wxButton* _back_button;
133 wxButton* _forward_button;
134 wxStaticText* _frame_number;
135 wxStaticText* _timecode;
136 wxToggleButton* _play_button;
138 bool _coalesce_player_changes;
139 std::list<int> _pending_player_changes;
140 bool _slider_being_moved;
141 bool _was_running_before_slider;
143 std::pair<boost::shared_ptr<PlayerVideo>, DCPTime> _player_video;
144 boost::shared_ptr<const Image> _frame;
145 DCPTime _video_position;
146 Position<int> _inter_position;
147 dcp::Size _inter_size;
149 /** Size of our output (including padding if we have any) */
151 /** Size of the panel that we have available */
152 dcp::Size _panel_size;
156 unsigned int _audio_block_size;
158 boost::shared_ptr<Butler> _butler;
160 std::list<Frame> _latency_history;
161 /** Mutex to protect _latency_history */
162 mutable boost::mutex _latency_history_mutex;
163 int _latency_history_count;
166 boost::optional<int> _dcp_decode_reduction;
168 ClosedCaptionsDialog* _closed_captions_dialog;
170 boost::signals2::scoped_connection _config_changed_connection;