src/wx/film_viewer.cc

   1 /*
   2     Copyright (C) 2012-2016 Carl Hetherington <cth@carlh.net>
   3
   4     This file is part of DCP-o-matic.
   5
   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.
  10
  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.
  15
  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/>.
  18
  19 */
  20
  21 /** @file  src/film_viewer.cc
  22  *  @brief A wx widget to view a preview of a Film.
  23  */
  24
  25 #include "film_viewer.h"
  26 #include "playhead_to_timecode_dialog.h"
  27 #include "playhead_to_frame_dialog.h"
  28 #include "wx_util.h"
  29 #include "lib/film.h"
  30 #include "lib/ratio.h"
  31 #include "lib/util.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"
  42 #include "lib/log.h"
  43 #include "lib/config.h"
  44 extern "C" {
  45 #include <libavutil/pixfmt.h>
  46 }
  47 #include <dcp/exceptions.h>
  48 #include <wx/tglbtn.h>
  49 #include <iostream>
  50 #include <iomanip>
  51
  52 using std::string;
  53 using std::pair;
  54 using std::min;
  55 using std::max;
  56 using std::cout;
  57 using std::list;
  58 using std::bad_alloc;
  59 using std::make_pair;
  60 using std::exception;
  61 using boost::shared_ptr;
  62 using boost::dynamic_pointer_cast;
  63 using boost::weak_ptr;
  64 using boost::optional;
  65 using dcp::Size;
  66
  67 FilmViewer::FilmViewer (wxWindow* p)
  68         : wxPanel (p)
  69         , _panel (new wxPanel (this))
  70         , _outline_content (new wxCheckBox (this, wxID_ANY, _("Outline content")))
  71         , _left_eye (new wxRadioButton (this, wxID_ANY, _("Left eye"), wxDefaultPosition, wxDefaultSize, wxRB_GROUP))
  72         , _right_eye (new wxRadioButton (this, wxID_ANY, _("Right eye")))
  73         , _jump_to_selected (new wxCheckBox (this, wxID_ANY, _("Jump to selected content")))
  74         , _slider (new wxSlider (this, wxID_ANY, 0, 0, 4096))
  75         , _back_button (new wxButton (this, wxID_ANY, wxT("<")))
  76         , _forward_button (new wxButton (this, wxID_ANY, wxT(">")))
  77         , _frame_number (new wxStaticText (this, wxID_ANY, wxT("")))
  78         , _timecode (new wxStaticText (this, wxID_ANY, wxT("")))
  79         , _play_button (new wxToggleButton (this, wxID_ANY, _("Play")))
  80         , _coalesce_player_changes (false)
  81         , _pending_player_change (false)
  82         , _last_seek_accurate (true)
  83 {
  84 #ifndef __WXOSX__
  85         _panel->SetDoubleBuffered (true);
  86 #endif
  87
  88         _panel->SetBackgroundStyle (wxBG_STYLE_PAINT);
  89
  90         _v_sizer = new wxBoxSizer (wxVERTICAL);
  91         SetSizer (_v_sizer);
  92
  93         _v_sizer->Add (_panel, 1, wxEXPAND);
  94
  95         wxBoxSizer* view_options = new wxBoxSizer (wxHORIZONTAL);
  96         view_options->Add (_outline_content, 0, wxRIGHT, DCPOMATIC_SIZER_GAP);
  97         view_options->Add (_left_eye, 0, wxLEFT | wxRIGHT, DCPOMATIC_SIZER_GAP);
  98         view_options->Add (_right_eye, 0, wxLEFT | wxRIGHT, DCPOMATIC_SIZER_GAP);
  99         view_options->Add (_jump_to_selected, 0, wxLEFT | wxRIGHT, DCPOMATIC_SIZER_GAP);
 100         _v_sizer->Add (view_options, 0, wxALL, DCPOMATIC_SIZER_GAP);
 101
 102         wxBoxSizer* h_sizer = new wxBoxSizer (wxHORIZONTAL);
 103
 104         wxBoxSizer* time_sizer = new wxBoxSizer (wxVERTICAL);
 105         time_sizer->Add (_frame_number, 0, wxEXPAND);
 106         time_sizer->Add (_timecode, 0, wxEXPAND);
 107
 108         h_sizer->Add (_back_button, 0, wxALL, 2);
 109         h_sizer->Add (time_sizer, 0, wxEXPAND);
 110         h_sizer->Add (_forward_button, 0, wxALL, 2);
 111         h_sizer->Add (_play_button, 0, wxEXPAND);
 112         h_sizer->Add (_slider, 1, wxEXPAND);
 113
 114         _v_sizer->Add (h_sizer, 0, wxEXPAND | wxALL, 6);
 115
 116         _frame_number->SetMinSize (wxSize (84, -1));
 117         _back_button->SetMinSize (wxSize (32, -1));
 118         _forward_button->SetMinSize (wxSize (32, -1));
 119
 120         _panel->Bind            (wxEVT_PAINT,             boost::bind (&FilmViewer::paint_panel,     this));
 121         _panel->Bind            (wxEVT_SIZE,              boost::bind (&FilmViewer::panel_sized,     this, _1));
 122         _outline_content->Bind  (wxEVT_CHECKBOX,          boost::bind (&FilmViewer::refresh_panel,   this));
 123         _left_eye->Bind         (wxEVT_RADIOBUTTON,       boost::bind (&FilmViewer::refresh,         this));
 124         _right_eye->Bind        (wxEVT_RADIOBUTTON,       boost::bind (&FilmViewer::refresh,         this));
 125         _slider->Bind           (wxEVT_SCROLL_THUMBTRACK, boost::bind (&FilmViewer::slider_moved,    this));
 126         _slider->Bind           (wxEVT_SCROLL_PAGEUP,     boost::bind (&FilmViewer::slider_moved,    this));
 127         _slider->Bind           (wxEVT_SCROLL_PAGEDOWN,   boost::bind (&FilmViewer::slider_moved,    this));
 128         _play_button->Bind      (wxEVT_TOGGLEBUTTON,      boost::bind (&FilmViewer::play_clicked,    this));
 129         _timer.Bind             (wxEVT_TIMER,             boost::bind (&FilmViewer::timer,           this));
 130         _back_button->Bind      (wxEVT_LEFT_DOWN,         boost::bind (&FilmViewer::back_clicked,    this, _1));
 131         _forward_button->Bind   (wxEVT_LEFT_DOWN,         boost::bind (&FilmViewer::forward_clicked, this, _1));
 132         _frame_number->Bind     (wxEVT_LEFT_DOWN,         boost::bind (&FilmViewer::frame_number_clicked, this));
 133         _timecode->Bind         (wxEVT_LEFT_DOWN,         boost::bind (&FilmViewer::timecode_clicked, this));
 134         _jump_to_selected->Bind (wxEVT_CHECKBOX,          boost::bind (&FilmViewer::jump_to_selected_clicked, this));
 135
 136         _jump_to_selected->SetValue (Config::instance()->jump_to_selected ());
 137
 138         set_film (shared_ptr<Film> ());
 139
 140         JobManager::instance()->ActiveJobsChanged.connect (
 141                 bind (&FilmViewer::active_jobs_changed, this, _2)
 142                 );
 143
 144         setup_sensitivity ();
 145 }
 146
 147 void
 148 FilmViewer::set_film (shared_ptr<Film> film)
 149 {
 150         if (_film == film) {
 151                 return;
 152         }
 153
 154         _film = film;
 155
 156         _frame.reset ();
 157
 158         update_position_slider ();
 159         update_position_label ();
 160
 161         if (!_film) {
 162                 return;
 163         }
 164
 165         try {
 166                 _player.reset (new Player (_film, _film->playlist ()));
 167                 _player->set_fast ();
 168         } catch (bad_alloc) {
 169                 error_dialog (this, _("There is not enough free memory to do that."));
 170                 _film.reset ();
 171                 return;
 172         }
 173
 174         /* Always burn in subtitles, even if content is set not to, otherwise we won't see them
 175            in the preview.
 176         */
 177         _player->set_always_burn_subtitles (true);
 178         _player->set_ignore_audio ();
 179         _player->set_play_referenced ();
 180
 181         _film_connection = _film->Changed.connect (boost::bind (&FilmViewer::film_changed, this, _1));
 182
 183         _player_connection = _player->Changed.connect (boost::bind (&FilmViewer::player_changed, this, _1));
 184
 185         calculate_sizes ();
 186         refresh ();
 187
 188         setup_sensitivity ();
 189 }
 190
 191 void
 192 FilmViewer::refresh_panel ()
 193 {
 194         _panel->Refresh ();
 195         _panel->Update ();
 196 }
 197
 198 void
 199 FilmViewer::video (shared_ptr<PlayerVideo> pv)
 200 {
 201         if (!_player) {
 202                 return;
 203         }
 204
 205         if (_film->three_d ()) {
 206                 if ((_left_eye->GetValue() && pv->eyes() == EYES_RIGHT) || (_right_eye->GetValue() && pv->eyes() == EYES_LEFT)) {
 207                         return;
 208                 }
 209         }
 210
 211         /* In an ideal world, what we would do here is:
 212          *
 213          * 1. convert to XYZ exactly as we do in the DCP creation path.
 214          * 2. convert back to RGB for the preview display, compensating
 215          *    for the monitor etc. etc.
 216          *
 217          * but this is inefficient if the source is RGB.  Since we don't
 218          * (currently) care too much about the precise accuracy of the preview's
 219          * colour mapping (and we care more about its speed) we try to short-
 220          * circuit this "ideal" situation in some cases.
 221          *
 222          * The content's specified colour conversion indicates the colourspace
 223          * which the content is in (according to the user).
 224          *
 225          * PlayerVideo::image (bound to PlayerVideo::always_rgb) will take the source
 226          * image and convert it (from whatever the user has said it is) to RGB.
 227          */
 228
 229         _frame = pv->image (
 230                 bind (&Log::dcp_log, _film->log().get(), _1, _2),
 231                 bind (&PlayerVideo::always_rgb, _1),
 232                 false, true
 233                 );
 234
 235         ImageChanged (pv);
 236
 237         _position = pv->time ();
 238         _inter_position = pv->inter_position ();
 239         _inter_size = pv->inter_size ();
 240
 241         refresh_panel ();
 242 }
 243
 244 void
 245 FilmViewer::get ()
 246 {
 247         Image const * current = _frame.get ();
 248         while (!_player->pass() && _frame.get() == current) {}
 249 }
 250
 251 void
 252 FilmViewer::timer ()
 253 {
 254         DCPTime const frame = DCPTime::from_frames (1, _film->video_frame_rate ());
 255
 256         if ((_position + frame) >= _film->length ()) {
 257                 _play_button->SetValue (false);
 258                 check_play_state ();
 259         } else {
 260                 get ();
 261         }
 262
 263         update_position_label ();
 264         update_position_slider ();
 265 }
 266
 267 void
 268 FilmViewer::paint_panel ()
 269 {
 270         wxPaintDC dc (_panel);
 271
 272         if (!_frame || !_film || !_out_size.width || !_out_size.height) {
 273                 dc.Clear ();
 274                 return;
 275         }
 276
 277         wxImage frame (_out_size.width, _out_size.height, _frame->data()[0], true);
 278         wxBitmap frame_bitmap (frame);
 279         dc.DrawBitmap (frame_bitmap, 0, 0);
 280
 281         if (_out_size.width < _panel_size.width) {
 282                 wxPen p (GetBackgroundColour ());
 283                 wxBrush b (GetBackgroundColour ());
 284                 dc.SetPen (p);
 285                 dc.SetBrush (b);
 286                 dc.DrawRectangle (_out_size.width, 0, _panel_size.width - _out_size.width, _panel_size.height);
 287         }
 288
 289         if (_out_size.height < _panel_size.height) {
 290                 wxPen p (GetBackgroundColour ());
 291                 wxBrush b (GetBackgroundColour ());
 292                 dc.SetPen (p);
 293                 dc.SetBrush (b);
 294                 dc.DrawRectangle (0, _out_size.height, _panel_size.width, _panel_size.height - _out_size.height);
 295         }
 296
 297         if (_outline_content->GetValue ()) {
 298                 wxPen p (wxColour (255, 0, 0), 2);
 299                 dc.SetPen (p);
 300                 dc.SetBrush (*wxTRANSPARENT_BRUSH);
 301                 dc.DrawRectangle (_inter_position.x, _inter_position.y, _inter_size.width, _inter_size.height);
 302         }
 303 }
 304
 305 void
 306 FilmViewer::slider_moved ()
 307 {
 308         if (!_film) {
 309                 return;
 310         }
 311
 312         DCPTime t (_slider->GetValue() * _film->length().get() / 4096);
 313         /* Ensure that we hit the end of the film at the end of the slider */
 314         if (t >= _film->length ()) {
 315                 t = _film->length() - DCPTime::from_frames (1, _film->video_frame_rate ());
 316         }
 317         seek (t, false);
 318         update_position_label ();
 319 }
 320
 321 void
 322 FilmViewer::panel_sized (wxSizeEvent& ev)
 323 {
 324         _panel_size.width = ev.GetSize().GetWidth();
 325         _panel_size.height = ev.GetSize().GetHeight();
 326
 327         calculate_sizes ();
 328         refresh ();
 329         update_position_label ();
 330         update_position_slider ();
 331 }
 332
 333 void
 334 FilmViewer::calculate_sizes ()
 335 {
 336         if (!_film || !_player) {
 337                 return;
 338         }
 339
 340         Ratio const * container = _film->container ();
 341
 342         float const panel_ratio = _panel_size.ratio ();
 343         float const film_ratio = container ? container->ratio () : 1.78;
 344
 345         if (panel_ratio < film_ratio) {
 346                 /* panel is less widscreen than the film; clamp width */
 347                 _out_size.width = _panel_size.width;
 348                 _out_size.height = lrintf (_out_size.width / film_ratio);
 349         } else {
 350                 /* panel is more widescreen than the film; clamp height */
 351                 _out_size.height = _panel_size.height;
 352                 _out_size.width = lrintf (_out_size.height * film_ratio);
 353         }
 354
 355         /* Catch silly values */
 356         _out_size.width = max (64, _out_size.width);
 357         _out_size.height = max (64, _out_size.height);
 358
 359         _player->set_video_container_size (_out_size);
 360 }
 361
 362 void
 363 FilmViewer::play_clicked ()
 364 {
 365         check_play_state ();
 366 }
 367
 368 void
 369 FilmViewer::check_play_state ()
 370 {
 371         if (!_film || _film->video_frame_rate() == 0) {
 372                 return;
 373         }
 374
 375         if (_play_button->GetValue()) {
 376                 _timer.Start (1000 / _film->video_frame_rate());
 377         } else {
 378                 _timer.Stop ();
 379         }
 380 }
 381
 382 void
 383 FilmViewer::update_position_slider ()
 384 {
 385         if (!_film) {
 386                 _slider->SetValue (0);
 387                 return;
 388         }
 389
 390         DCPTime const len = _film->length ();
 391
 392         if (len.get ()) {
 393                 int const new_slider_position = 4096 * _position.get() / len.get();
 394                 if (new_slider_position != _slider->GetValue()) {
 395                         _slider->SetValue (new_slider_position);
 396                 }
 397         }
 398 }
 399
 400 void
 401 FilmViewer::update_position_label ()
 402 {
 403         if (!_film) {
 404                 _frame_number->SetLabel ("0");
 405                 _timecode->SetLabel ("0:0:0.0");
 406                 return;
 407         }
 408
 409         double const fps = _film->video_frame_rate ();
 410         /* Count frame number from 1 ... not sure if this is the best idea */
 411         _frame_number->SetLabel (wxString::Format (wxT("%ld"), lrint (_position.seconds() * fps) + 1));
 412         _timecode->SetLabel (time_to_timecode (_position, fps));
 413 }
 414
 415 void
 416 FilmViewer::active_jobs_changed (optional<string> j)
 417 {
 418         /* examine content is the only job which stops the viewer working */
 419         bool const a = !j || *j != "examine_content";
 420         _slider->Enable (a);
 421         _play_button->Enable (a);
 422 }
 423
 424 DCPTime
 425 FilmViewer::nudge_amount (wxMouseEvent& ev)
 426 {
 427         DCPTime amount = DCPTime::from_frames (1, _film->video_frame_rate ());
 428
 429         if (ev.ShiftDown() && !ev.ControlDown()) {
 430                 amount = DCPTime::from_seconds (1);
 431         } else if (!ev.ShiftDown() && ev.ControlDown()) {
 432                 amount = DCPTime::from_seconds (10);
 433         } else if (ev.ShiftDown() && ev.ControlDown()) {
 434                 amount = DCPTime::from_seconds (60);
 435         }
 436
 437         return amount;
 438 }
 439
 440 void
 441 FilmViewer::go_to (DCPTime t)
 442 {
 443         if (t < DCPTime ()) {
 444                 t = DCPTime ();
 445         }
 446
 447         if (t >= _film->length ()) {
 448                 t = _film->length ();
 449         }
 450
 451         seek (t, true);
 452         update_position_label ();
 453         update_position_slider ();
 454 }
 455
 456 void
 457 FilmViewer::back_clicked (wxMouseEvent& ev)
 458 {
 459         go_to (_position - nudge_amount (ev));
 460         ev.Skip ();
 461 }
 462
 463 void
 464 FilmViewer::forward_clicked (wxMouseEvent& ev)
 465 {
 466         go_to (_position + nudge_amount (ev));
 467         ev.Skip ();
 468 }
 469
 470 void
 471 FilmViewer::player_changed (bool frequent)
 472 {
 473         if (frequent) {
 474                 return;
 475         }
 476
 477         if (_coalesce_player_changes) {
 478                 _pending_player_change = true;
 479                 return;
 480         }
 481
 482         calculate_sizes ();
 483         refresh ();
 484         update_position_label ();
 485         update_position_slider ();
 486 }
 487
 488 void
 489 FilmViewer::setup_sensitivity ()
 490 {
 491         bool const c = _film && !_film->content().empty ();
 492
 493         _slider->Enable (c);
 494         _back_button->Enable (c);
 495         _forward_button->Enable (c);
 496         _play_button->Enable (c);
 497         _outline_content->Enable (c);
 498         _frame_number->Enable (c);
 499         _timecode->Enable (c);
 500
 501         _left_eye->Enable (c && _film->three_d ());
 502         _right_eye->Enable (c && _film->three_d ());
 503 }
 504
 505 void
 506 FilmViewer::film_changed (Film::Property p)
 507 {
 508         if (p == Film::CONTENT || p == Film::THREE_D) {
 509                 setup_sensitivity ();
 510         }
 511 }
 512
 513 /** Re-get the current frame */
 514 void
 515 FilmViewer::refresh ()
 516 {
 517         seek (_position, _last_seek_accurate);
 518 }
 519
 520 void
 521 FilmViewer::set_position (DCPTime p)
 522 {
 523         _position = p;
 524         seek (p, true);
 525         update_position_label ();
 526         update_position_slider ();
 527 }
 528
 529 void
 530 FilmViewer::set_coalesce_player_changes (bool c)
 531 {
 532         _coalesce_player_changes = c;
 533
 534         if (c) {
 535                 _pending_player_change = false;
 536         } else {
 537                 if (_pending_player_change) {
 538                         player_changed (false);
 539                 }
 540         }
 541 }
 542
 543 void
 544 FilmViewer::timecode_clicked ()
 545 {
 546         PlayheadToTimecodeDialog* dialog = new PlayheadToTimecodeDialog (this, _film->video_frame_rate ());
 547         if (dialog->ShowModal() == wxID_OK) {
 548                 go_to (dialog->get ());
 549         }
 550         dialog->Destroy ();
 551 }
 552
 553 void
 554 FilmViewer::frame_number_clicked ()
 555 {
 556         PlayheadToFrameDialog* dialog = new PlayheadToFrameDialog (this, _film->video_frame_rate ());
 557         if (dialog->ShowModal() == wxID_OK) {
 558                 go_to (dialog->get ());
 559         }
 560         dialog->Destroy ();
 561 }
 562
 563 void
 564 FilmViewer::jump_to_selected_clicked ()
 565 {
 566         Config::instance()->set_jump_to_selected (_jump_to_selected->GetValue ());
 567 }
 568
 569 void
 570 FilmViewer::seek (DCPTime t, bool accurate)
 571 {
 572         _player->seek (t, accurate);
 573         _last_seek_accurate = accurate;
 574         get ();
 575 }