2 Copyright (C) 2012-2015 Carl Hetherington <cth@carlh.net>
4 This program is free software; you can redistribute it and/or modify
5 it under the terms of the GNU General Public License as published by
6 the Free Software Foundation; either version 2 of the License, or
7 (at your option) any later version.
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 GNU General Public License for more details.
14 You should have received a copy of the GNU General Public License
15 along with this program; if not, write to the Free Software
16 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
20 /** @file src/film_viewer.cc
21 * @brief A wx widget to view a preview of a Film.
25 #include "lib/ratio.h"
27 #include "lib/job_manager.h"
28 #include "lib/image.h"
29 #include "lib/exceptions.h"
30 #include "lib/examine_content_job.h"
31 #include "lib/filter.h"
32 #include "lib/player.h"
33 #include "lib/player_video.h"
34 #include "lib/video_content.h"
35 #include "lib/video_decoder.h"
36 #include "lib/timer.h"
38 #include "film_viewer.h"
40 #include <dcp/exceptions.h>
41 #include <wx/tglbtn.h>
54 using boost::shared_ptr;
55 using boost::dynamic_pointer_cast;
56 using boost::weak_ptr;
59 FilmViewer::FilmViewer (wxWindow* p)
61 , _panel (new wxPanel (this))
62 , _outline_content (new wxCheckBox (this, wxID_ANY, _("Outline content")))
63 , _slider (new wxSlider (this, wxID_ANY, 0, 0, 4096))
64 , _back_button (new wxButton (this, wxID_ANY, wxT("<")))
65 , _forward_button (new wxButton (this, wxID_ANY, wxT(">")))
66 , _frame_number (new wxStaticText (this, wxID_ANY, wxT("")))
67 , _timecode (new wxStaticText (this, wxID_ANY, wxT("")))
68 , _play_button (new wxToggleButton (this, wxID_ANY, _("Play")))
69 , _last_get_accurate (true)
72 _panel->SetDoubleBuffered (true);
75 _panel->SetBackgroundStyle (wxBG_STYLE_PAINT);
77 _v_sizer = new wxBoxSizer (wxVERTICAL);
80 _v_sizer->Add (_panel, 1, wxEXPAND);
82 _v_sizer->Add (_outline_content, 0, wxALL, DCPOMATIC_SIZER_GAP);
84 wxBoxSizer* h_sizer = new wxBoxSizer (wxHORIZONTAL);
86 wxBoxSizer* time_sizer = new wxBoxSizer (wxVERTICAL);
87 time_sizer->Add (_frame_number, 0, wxEXPAND);
88 time_sizer->Add (_timecode, 0, wxEXPAND);
90 h_sizer->Add (_back_button, 0, wxALL, 2);
91 h_sizer->Add (time_sizer, 0, wxEXPAND);
92 h_sizer->Add (_forward_button, 0, wxALL, 2);
93 h_sizer->Add (_play_button, 0, wxEXPAND);
94 h_sizer->Add (_slider, 1, wxEXPAND);
96 _v_sizer->Add (h_sizer, 0, wxEXPAND | wxALL, 6);
98 _frame_number->SetMinSize (wxSize (84, -1));
99 _back_button->SetMinSize (wxSize (32, -1));
100 _forward_button->SetMinSize (wxSize (32, -1));
102 _panel->Bind (wxEVT_PAINT, boost::bind (&FilmViewer::paint_panel, this));
103 _panel->Bind (wxEVT_SIZE, boost::bind (&FilmViewer::panel_sized, this, _1));
104 _outline_content->Bind(wxEVT_COMMAND_CHECKBOX_CLICKED, boost::bind (&FilmViewer::refresh_panel, this));
105 _slider->Bind (wxEVT_SCROLL_THUMBTRACK, boost::bind (&FilmViewer::slider_moved, this));
106 _slider->Bind (wxEVT_SCROLL_PAGEUP, boost::bind (&FilmViewer::slider_moved, this));
107 _slider->Bind (wxEVT_SCROLL_PAGEDOWN, boost::bind (&FilmViewer::slider_moved, this));
108 _play_button->Bind (wxEVT_COMMAND_TOGGLEBUTTON_CLICKED, boost::bind (&FilmViewer::play_clicked, this));
109 _timer.Bind (wxEVT_TIMER, boost::bind (&FilmViewer::timer, this));
110 _back_button->Bind (wxEVT_COMMAND_BUTTON_CLICKED, boost::bind (&FilmViewer::back_clicked, this));
111 _forward_button->Bind (wxEVT_COMMAND_BUTTON_CLICKED, boost::bind (&FilmViewer::forward_clicked, this));
113 set_film (shared_ptr<Film> ());
115 JobManager::instance()->ActiveJobsChanged.connect (
116 bind (&FilmViewer::active_jobs_changed, this, _1)
119 setup_sensitivity ();
123 FilmViewer::set_film (shared_ptr<Film> f)
133 update_position_slider ();
134 update_position_label ();
141 _player = f->make_player ();
142 } catch (bad_alloc) {
143 error_dialog (this, _("There is not enough free memory to do that."));
148 /* Always burn in subtitles, even if we are set not to, otherwise we won't see them
151 _player->set_burn_subtitles (true);
153 _film_connection = _film->Changed.connect (boost::bind (&FilmViewer::film_changed, this, _1));
155 _player_connection = _player->Changed.connect (boost::bind (&FilmViewer::player_changed, this, _1));
158 get (_position, _last_get_accurate);
160 setup_sensitivity ();
164 FilmViewer::refresh_panel ()
171 FilmViewer::get (DCPTime p, bool accurate)
177 list<shared_ptr<PlayerVideo> > pvf;
179 pvf = _player->get_video (p, accurate);
180 } catch (exception& e) {
181 error_dialog (this, wxString::Format (_("Could not get video for view (%s)"), std_to_wx(e.what()).data()));
186 _frame = pvf.front()->image (PIX_FMT_RGB24, true, boost::bind (&Log::dcp_log, _film->log().get(), _1, _2));
188 dcp::YUVToRGB yuv_to_rgb = dcp::YUV_TO_RGB_REC601;
189 if (pvf.front()->colour_conversion()) {
190 yuv_to_rgb = pvf.front()->colour_conversion().get().yuv_to_rgb();
193 _frame = _frame->scale (_frame->size(), yuv_to_rgb, PIX_FMT_RGB24, false);
194 _position = pvf.front()->time ();
195 _inter_position = pvf.front()->inter_position ();
196 _inter_size = pvf.front()->inter_size ();
197 } catch (dcp::DCPReadError& e) {
198 /* This can happen on the following sequence of events:
199 * - load encrypted DCP
201 * - DCP is examined again, which sets its "playable" flag to 1
202 * - as a side effect of the exam, the viewer is updated using the old pieces
203 * - the DCPDecoder in the old piece gives us an encrypted frame
204 * - then, the pieces are re-made (but too late).
206 * I hope there's a better way to handle this ...
218 _last_get_accurate = accurate;
224 get (_position + DCPTime::from_frames (1, _film->video_frame_rate ()), true);
225 update_position_label ();
226 update_position_slider ();
230 FilmViewer::paint_panel ()
232 wxPaintDC dc (_panel);
234 if (!_frame || !_film || !_out_size.width || !_out_size.height) {
239 wxImage frame (_out_size.width, _out_size.height, _frame->data()[0], true);
240 wxBitmap frame_bitmap (frame);
241 dc.DrawBitmap (frame_bitmap, 0, 0);
243 if (_out_size.width < _panel_size.width) {
244 wxPen p (GetBackgroundColour ());
245 wxBrush b (GetBackgroundColour ());
248 dc.DrawRectangle (_out_size.width, 0, _panel_size.width - _out_size.width, _panel_size.height);
251 if (_out_size.height < _panel_size.height) {
252 wxPen p (GetBackgroundColour ());
253 wxBrush b (GetBackgroundColour ());
256 dc.DrawRectangle (0, _out_size.height, _panel_size.width, _panel_size.height - _out_size.height);
259 if (_outline_content->GetValue ()) {
260 wxPen p (wxColour (255, 0, 0), 2);
262 dc.SetBrush (*wxTRANSPARENT_BRUSH);
263 dc.DrawRectangle (_inter_position.x, _inter_position.y, _inter_size.width, _inter_size.height);
268 FilmViewer::slider_moved ()
274 DCPTime t (_slider->GetValue() * _film->length().get() / 4096);
275 /* Ensure that we hit the end of the film at the end of the slider */
276 if (t >= _film->length ()) {
277 t = _film->length() - DCPTime::from_frames (1, _film->video_frame_rate ());
280 update_position_label ();
284 FilmViewer::panel_sized (wxSizeEvent& ev)
286 _panel_size.width = ev.GetSize().GetWidth();
287 _panel_size.height = ev.GetSize().GetHeight();
290 get (_position, _last_get_accurate);
291 update_position_label ();
292 update_position_slider ();
296 FilmViewer::calculate_sizes ()
298 if (!_film || !_player) {
302 Ratio const * container = _film->container ();
304 float const panel_ratio = _panel_size.ratio ();
305 float const film_ratio = container ? container->ratio () : 1.78;
307 if (panel_ratio < film_ratio) {
308 /* panel is less widscreen than the film; clamp width */
309 _out_size.width = _panel_size.width;
310 _out_size.height = rint (_out_size.width / film_ratio);
312 /* panel is more widescreen than the film; clamp height */
313 _out_size.height = _panel_size.height;
314 _out_size.width = rint (_out_size.height * film_ratio);
317 /* Catch silly values */
318 _out_size.width = max (64, _out_size.width);
319 _out_size.height = max (64, _out_size.height);
321 _player->set_video_container_size (_out_size);
325 FilmViewer::play_clicked ()
331 FilmViewer::check_play_state ()
333 if (!_film || _film->video_frame_rate() == 0) {
337 if (_play_button->GetValue()) {
338 _timer.Start (1000 / _film->video_frame_rate());
345 FilmViewer::update_position_slider ()
348 _slider->SetValue (0);
352 DCPTime const len = _film->length ();
355 int const new_slider_position = 4096 * _position.get() / len.get();
356 if (new_slider_position != _slider->GetValue()) {
357 _slider->SetValue (new_slider_position);
363 FilmViewer::update_position_label ()
366 _frame_number->SetLabel ("0");
367 _timecode->SetLabel ("0:0:0.0");
371 double const fps = _film->video_frame_rate ();
372 /* Count frame number from 1 ... not sure if this is the best idea */
373 _frame_number->SetLabel (wxString::Format (wxT("%d"), int (rint (_position.seconds() * fps)) + 1));
374 _timecode->SetLabel (time_to_timecode (_position, fps));
378 FilmViewer::active_jobs_changed (bool a)
381 list<shared_ptr<Job> > jobs = JobManager::instance()->get ();
382 list<shared_ptr<Job> >::iterator i = jobs.begin ();
383 while (i != jobs.end() && boost::dynamic_pointer_cast<ExamineContentJob> (*i) == 0) {
387 if (i == jobs.end() || (*i)->finished()) {
388 /* no examine content job running, so we're ok to use the viewer */
393 _slider->Enable (!a);
394 _play_button->Enable (!a);
398 FilmViewer::back_clicked ()
400 DCPTime p = _position - DCPTime::from_frames (1, _film->video_frame_rate ());
401 if (p < DCPTime ()) {
406 update_position_label ();
407 update_position_slider ();
411 FilmViewer::forward_clicked ()
413 get (_position + DCPTime::from_frames (1, _film->video_frame_rate ()), true);
414 update_position_label ();
415 update_position_slider ();
419 FilmViewer::player_changed (bool frequent)
426 get (_position, _last_get_accurate);
427 update_position_label ();
428 update_position_slider ();
432 FilmViewer::setup_sensitivity ()
434 bool const c = _film && !_film->content().empty ();
437 _back_button->Enable (c);
438 _forward_button->Enable (c);
439 _play_button->Enable (c);
440 _outline_content->Enable (c);
441 _frame_number->Enable (c);
442 _timecode->Enable (c);
446 FilmViewer::film_changed (Film::Property p)
448 if (p == Film::CONTENT) {
449 setup_sensitivity ();