2 Copyright (C) 2012-2016 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.cc
22 * @brief A wx widget to view a preview of a Film.
25 #include "film_viewer.h"
26 #include "playhead_to_timecode_dialog.h"
27 #include "playhead_to_frame_dialog.h"
30 #include "lib/ratio.h"
32 #include "lib/job_manager.h"
33 #include "lib/image.h"
34 #include "lib/exceptions.h"
35 #include "lib/examine_content_job.h"
36 #include "lib/filter.h"
37 #include "lib/player.h"
38 #include "lib/player_video.h"
39 #include "lib/video_content.h"
40 #include "lib/video_decoder.h"
41 #include "lib/timer.h"
44 #include <libavutil/pixfmt.h>
46 #include <dcp/exceptions.h>
47 #include <wx/tglbtn.h>
60 using boost::shared_ptr;
61 using boost::dynamic_pointer_cast;
62 using boost::weak_ptr;
63 using boost::optional;
66 FilmViewer::FilmViewer (wxWindow* p)
68 , _panel (new wxPanel (this))
69 , _outline_content (new wxCheckBox (this, wxID_ANY, _("Outline content")))
70 , _left_eye (new wxRadioButton (this, wxID_ANY, _("Left eye"), wxDefaultPosition, wxDefaultSize, wxRB_GROUP))
71 , _right_eye (new wxRadioButton (this, wxID_ANY, _("Right eye")))
72 , _slider (new wxSlider (this, wxID_ANY, 0, 0, 4096))
73 , _back_button (new wxButton (this, wxID_ANY, wxT("<")))
74 , _forward_button (new wxButton (this, wxID_ANY, wxT(">")))
75 , _frame_number (new wxStaticText (this, wxID_ANY, wxT("")))
76 , _timecode (new wxStaticText (this, wxID_ANY, wxT("")))
77 , _play_button (new wxToggleButton (this, wxID_ANY, _("Play")))
78 , _coalesce_player_changes (false)
79 , _pending_player_change (false)
80 , _last_get_accurate (true)
83 _panel->SetDoubleBuffered (true);
86 _panel->SetBackgroundStyle (wxBG_STYLE_PAINT);
88 _v_sizer = new wxBoxSizer (wxVERTICAL);
91 _v_sizer->Add (_panel, 1, wxEXPAND);
93 wxBoxSizer* view_options = new wxBoxSizer (wxHORIZONTAL);
94 view_options->Add (_outline_content, 0, wxRIGHT, DCPOMATIC_SIZER_GAP);
95 view_options->Add (_left_eye, 0, wxLEFT | wxRIGHT, DCPOMATIC_SIZER_GAP);
96 view_options->Add (_right_eye, 0, wxLEFT | wxRIGHT, DCPOMATIC_SIZER_GAP);
97 _v_sizer->Add (view_options, 0, wxALL, DCPOMATIC_SIZER_GAP);
99 wxBoxSizer* h_sizer = new wxBoxSizer (wxHORIZONTAL);
101 wxBoxSizer* time_sizer = new wxBoxSizer (wxVERTICAL);
102 time_sizer->Add (_frame_number, 0, wxEXPAND);
103 time_sizer->Add (_timecode, 0, wxEXPAND);
105 h_sizer->Add (_back_button, 0, wxALL, 2);
106 h_sizer->Add (time_sizer, 0, wxEXPAND);
107 h_sizer->Add (_forward_button, 0, wxALL, 2);
108 h_sizer->Add (_play_button, 0, wxEXPAND);
109 h_sizer->Add (_slider, 1, wxEXPAND);
111 _v_sizer->Add (h_sizer, 0, wxEXPAND | wxALL, 6);
113 _frame_number->SetMinSize (wxSize (84, -1));
114 _back_button->SetMinSize (wxSize (32, -1));
115 _forward_button->SetMinSize (wxSize (32, -1));
117 _panel->Bind (wxEVT_PAINT, boost::bind (&FilmViewer::paint_panel, this));
118 _panel->Bind (wxEVT_SIZE, boost::bind (&FilmViewer::panel_sized, this, _1));
119 _outline_content->Bind(wxEVT_COMMAND_CHECKBOX_CLICKED, boost::bind (&FilmViewer::refresh_panel, this));
120 _left_eye->Bind (wxEVT_COMMAND_RADIOBUTTON_SELECTED, boost::bind (&FilmViewer::refresh, this));
121 _right_eye->Bind (wxEVT_COMMAND_RADIOBUTTON_SELECTED, boost::bind (&FilmViewer::refresh, this));
122 _slider->Bind (wxEVT_SCROLL_THUMBTRACK, boost::bind (&FilmViewer::slider_moved, this));
123 _slider->Bind (wxEVT_SCROLL_PAGEUP, boost::bind (&FilmViewer::slider_moved, this));
124 _slider->Bind (wxEVT_SCROLL_PAGEDOWN, boost::bind (&FilmViewer::slider_moved, this));
125 _play_button->Bind (wxEVT_COMMAND_TOGGLEBUTTON_CLICKED, boost::bind (&FilmViewer::play_clicked, this));
126 _timer.Bind (wxEVT_TIMER, boost::bind (&FilmViewer::timer, this));
127 _back_button->Bind (wxEVT_LEFT_DOWN, boost::bind (&FilmViewer::back_clicked, this, _1));
128 _forward_button->Bind (wxEVT_LEFT_DOWN, boost::bind (&FilmViewer::forward_clicked, this, _1));
129 _frame_number->Bind (wxEVT_LEFT_DOWN, boost::bind (&FilmViewer::frame_number_clicked, this));
130 _timecode->Bind (wxEVT_LEFT_DOWN, boost::bind (&FilmViewer::timecode_clicked, this));
132 set_film (shared_ptr<Film> ());
134 JobManager::instance()->ActiveJobsChanged.connect (
135 bind (&FilmViewer::active_jobs_changed, this, _2)
138 setup_sensitivity ();
142 FilmViewer::set_film (shared_ptr<Film> film)
152 update_position_slider ();
153 update_position_label ();
160 _player.reset (new Player (_film, _film->playlist ()));
161 _player->set_fast ();
162 } catch (bad_alloc) {
163 error_dialog (this, _("There is not enough free memory to do that."));
168 /* Always burn in subtitles, even if content is set not to, otherwise we won't see them
171 _player->set_always_burn_subtitles (true);
172 _player->set_ignore_audio ();
173 _player->set_play_referenced ();
175 _film_connection = _film->Changed.connect (boost::bind (&FilmViewer::film_changed, this, _1));
177 _player_connection = _player->Changed.connect (boost::bind (&FilmViewer::player_changed, this, _1));
182 setup_sensitivity ();
186 FilmViewer::refresh_panel ()
193 FilmViewer::get (DCPTime p, bool accurate)
199 list<shared_ptr<PlayerVideo> > all_pv;
201 all_pv = _player->get_video (p, accurate);
202 } catch (exception& e) {
203 error_dialog (this, wxString::Format (_("Could not get video for view (%s)"), std_to_wx(e.what()).data()));
206 if (!all_pv.empty ()) {
208 shared_ptr<PlayerVideo> pv;
209 if (all_pv.size() == 2) {
210 /* We have 3D; choose the correct eye */
211 if (_left_eye->GetValue()) {
212 if (all_pv.front()->eyes() == EYES_LEFT) {
218 if (all_pv.front()->eyes() == EYES_RIGHT) {
225 /* 2D; no choice to make */
226 pv = all_pv.front ();
229 /* In an ideal world, what we would do here is:
231 * 1. convert to XYZ exactly as we do in the DCP creation path.
232 * 2. convert back to RGB for the preview display, compensating
233 * for the monitor etc. etc.
235 * but this is inefficient if the source is RGB. Since we don't
236 * (currently) care too much about the precise accuracy of the preview's
237 * colour mapping (and we care more about its speed) we try to short-
238 * circuit this "ideal" situation in some cases.
240 * The content's specified colour conversion indicates the colourspace
241 * which the content is in (according to the user).
243 * PlayerVideo::image (bound to PlayerVideo::always_rgb) will take the source
244 * image and convert it (from whatever the user has said it is) to RGB.
248 bind (&Log::dcp_log, _film->log().get(), _1, _2),
249 bind (&PlayerVideo::always_rgb, _1),
255 _position = pv->time ();
256 _inter_position = pv->inter_position ();
257 _inter_size = pv->inter_size ();
258 } catch (dcp::DCPReadError& e) {
259 /* This can happen on the following sequence of events:
260 * - load encrypted DCP
262 * - DCP is examined again, which sets its "playable" flag to 1
263 * - as a side effect of the exam, the viewer is updated using the old pieces
264 * - the DCPDecoder in the old piece gives us an encrypted frame
265 * - then, the pieces are re-made (but too late).
267 * I hope there's a better way to handle this ...
279 _last_get_accurate = accurate;
285 DCPTime const frame = DCPTime::from_frames (1, _film->video_frame_rate ());
287 if ((_position + frame) >= _film->length ()) {
288 _play_button->SetValue (false);
291 get (_position + frame, true);
294 update_position_label ();
295 update_position_slider ();
299 FilmViewer::paint_panel ()
301 wxPaintDC dc (_panel);
303 if (!_frame || !_film || !_out_size.width || !_out_size.height) {
308 wxImage frame (_out_size.width, _out_size.height, _frame->data()[0], true);
309 wxBitmap frame_bitmap (frame);
310 dc.DrawBitmap (frame_bitmap, 0, 0);
312 if (_out_size.width < _panel_size.width) {
313 wxPen p (GetBackgroundColour ());
314 wxBrush b (GetBackgroundColour ());
317 dc.DrawRectangle (_out_size.width, 0, _panel_size.width - _out_size.width, _panel_size.height);
320 if (_out_size.height < _panel_size.height) {
321 wxPen p (GetBackgroundColour ());
322 wxBrush b (GetBackgroundColour ());
325 dc.DrawRectangle (0, _out_size.height, _panel_size.width, _panel_size.height - _out_size.height);
328 if (_outline_content->GetValue ()) {
329 wxPen p (wxColour (255, 0, 0), 2);
331 dc.SetBrush (*wxTRANSPARENT_BRUSH);
332 dc.DrawRectangle (_inter_position.x, _inter_position.y, _inter_size.width, _inter_size.height);
337 FilmViewer::slider_moved ()
343 DCPTime t (_slider->GetValue() * _film->length().get() / 4096);
344 /* Ensure that we hit the end of the film at the end of the slider */
345 if (t >= _film->length ()) {
346 t = _film->length() - DCPTime::from_frames (1, _film->video_frame_rate ());
349 update_position_label ();
353 FilmViewer::panel_sized (wxSizeEvent& ev)
355 _panel_size.width = ev.GetSize().GetWidth();
356 _panel_size.height = ev.GetSize().GetHeight();
360 update_position_label ();
361 update_position_slider ();
365 FilmViewer::calculate_sizes ()
367 if (!_film || !_player) {
371 Ratio const * container = _film->container ();
373 float const panel_ratio = _panel_size.ratio ();
374 float const film_ratio = container ? container->ratio () : 1.78;
376 if (panel_ratio < film_ratio) {
377 /* panel is less widscreen than the film; clamp width */
378 _out_size.width = _panel_size.width;
379 _out_size.height = lrintf (_out_size.width / film_ratio);
381 /* panel is more widescreen than the film; clamp height */
382 _out_size.height = _panel_size.height;
383 _out_size.width = lrintf (_out_size.height * film_ratio);
386 /* Catch silly values */
387 _out_size.width = max (64, _out_size.width);
388 _out_size.height = max (64, _out_size.height);
390 _player->set_video_container_size (_out_size);
394 FilmViewer::play_clicked ()
400 FilmViewer::check_play_state ()
402 if (!_film || _film->video_frame_rate() == 0) {
406 if (_play_button->GetValue()) {
407 _timer.Start (1000 / _film->video_frame_rate());
414 FilmViewer::update_position_slider ()
417 _slider->SetValue (0);
421 DCPTime const len = _film->length ();
424 int const new_slider_position = 4096 * _position.get() / len.get();
425 if (new_slider_position != _slider->GetValue()) {
426 _slider->SetValue (new_slider_position);
432 FilmViewer::update_position_label ()
435 _frame_number->SetLabel ("0");
436 _timecode->SetLabel ("0:0:0.0");
440 double const fps = _film->video_frame_rate ();
441 /* Count frame number from 1 ... not sure if this is the best idea */
442 _frame_number->SetLabel (wxString::Format (wxT("%ld"), lrint (_position.seconds() * fps) + 1));
443 _timecode->SetLabel (time_to_timecode (_position, fps));
447 FilmViewer::active_jobs_changed (optional<string> j)
449 /* examine content is the only job which stops the viewer working */
450 bool const a = !j || *j != "examine_content";
452 _play_button->Enable (a);
456 FilmViewer::nudge_amount (wxMouseEvent& ev)
458 DCPTime amount = DCPTime::from_frames (1, _film->video_frame_rate ());
460 if (ev.ShiftDown() && !ev.ControlDown()) {
461 amount = DCPTime::from_seconds (1);
462 } else if (!ev.ShiftDown() && ev.ControlDown()) {
463 amount = DCPTime::from_seconds (10);
464 } else if (ev.ShiftDown() && ev.ControlDown()) {
465 amount = DCPTime::from_seconds (60);
472 FilmViewer::go_to (DCPTime t)
474 if (t < DCPTime ()) {
478 if (t >= _film->length ()) {
479 t = _film->length ();
483 update_position_label ();
484 update_position_slider ();
488 FilmViewer::back_clicked (wxMouseEvent& ev)
490 go_to (_position - nudge_amount (ev));
495 FilmViewer::forward_clicked (wxMouseEvent& ev)
497 go_to (_position + nudge_amount (ev));
502 FilmViewer::player_changed (bool frequent)
508 if (_coalesce_player_changes) {
509 _pending_player_change = true;
515 update_position_label ();
516 update_position_slider ();
520 FilmViewer::setup_sensitivity ()
522 bool const c = _film && !_film->content().empty ();
525 _back_button->Enable (c);
526 _forward_button->Enable (c);
527 _play_button->Enable (c);
528 _outline_content->Enable (c);
529 _frame_number->Enable (c);
530 _timecode->Enable (c);
532 _left_eye->Enable (c && _film->three_d ());
533 _right_eye->Enable (c && _film->three_d ());
537 FilmViewer::film_changed (Film::Property p)
539 if (p == Film::CONTENT || p == Film::THREE_D) {
540 setup_sensitivity ();
544 /** Re-get the current frame */
546 FilmViewer::refresh ()
548 get (_position, _last_get_accurate);
552 FilmViewer::set_position (DCPTime p)
555 get (_position, true);
556 update_position_label ();
557 update_position_slider ();
561 FilmViewer::set_coalesce_player_changes (bool c)
563 _coalesce_player_changes = c;
566 _pending_player_change = false;
568 if (_pending_player_change) {
569 player_changed (false);
575 FilmViewer::timecode_clicked ()
577 PlayheadToTimecodeDialog* dialog = new PlayheadToTimecodeDialog (this, _film->video_frame_rate ());
578 if (dialog->ShowModal() == wxID_OK) {
579 go_to (dialog->get ());
585 FilmViewer::frame_number_clicked ()
587 PlayheadToFrameDialog* dialog = new PlayheadToFrameDialog (this, _film->video_frame_rate ());
588 if (dialog->ShowModal() == wxID_OK) {
589 go_to (dialog->get ());