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 extern "C" {
  44 #include <libavutil/pixfmt.h>
  45 }
  46 #include <dcp/exceptions.h>
  47 #include <wx/tglbtn.h>
  48 #include <iostream>
  49 #include <iomanip>
  50
  51 using std::string;
  52 using std::pair;
  53 using std::min;
  54 using std::max;
  55 using std::cout;
  56 using std::list;
  57 using std::bad_alloc;
  58 using std::make_pair;
  59 using std::exception;
  60 using boost::shared_ptr;
  61 using boost::dynamic_pointer_cast;
  62 using boost::weak_ptr;
  63 using boost::optional;
  64 using dcp::Size;
  65
  66 FilmViewer::FilmViewer (wxWindow* p)
  67         : wxPanel (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)
  81 {
  82 #ifndef __WXOSX__
  83         _panel->SetDoubleBuffered (true);
  84 #endif
  85
  86         _panel->SetBackgroundStyle (wxBG_STYLE_PAINT);
  87
  88         _v_sizer = new wxBoxSizer (wxVERTICAL);
  89         SetSizer (_v_sizer);
  90
  91         _v_sizer->Add (_panel, 1, wxEXPAND);
  92
  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);
  98
  99         wxBoxSizer* h_sizer = new wxBoxSizer (wxHORIZONTAL);
 100
 101         wxBoxSizer* time_sizer = new wxBoxSizer (wxVERTICAL);
 102         time_sizer->Add (_frame_number, 0, wxEXPAND);
 103         time_sizer->Add (_timecode, 0, wxEXPAND);
 104
 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);
 110
 111         _v_sizer->Add (h_sizer, 0, wxEXPAND | wxALL, 6);
 112
 113         _frame_number->SetMinSize (wxSize (84, -1));
 114         _back_button->SetMinSize (wxSize (32, -1));
 115         _forward_button->SetMinSize (wxSize (32, -1));
 116
 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_CHECKBOX,          boost::bind (&FilmViewer::refresh_panel,   this));
 120         _left_eye->Bind       (wxEVT_RADIOBUTTON,       boost::bind (&FilmViewer::refresh,         this));
 121         _right_eye->Bind      (wxEVT_RADIOBUTTON,       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_TOGGLEBUTTON,      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));
 131
 132         set_film (shared_ptr<Film> ());
 133
 134         JobManager::instance()->ActiveJobsChanged.connect (
 135                 bind (&FilmViewer::active_jobs_changed, this, _2)
 136                 );
 137
 138         setup_sensitivity ();
 139 }
 140
 141 void
 142 FilmViewer::set_film (shared_ptr<Film> film)
 143 {
 144         if (_film == film) {
 145                 return;
 146         }
 147
 148         _film = film;
 149
 150         _frame.reset ();
 151
 152         update_position_slider ();
 153         update_position_label ();
 154
 155         if (!_film) {
 156                 return;
 157         }
 158
 159         try {
 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."));
 164                 _film.reset ();
 165                 return;
 166         }
 167
 168         /* Always burn in subtitles, even if content is set not to, otherwise we won't see them
 169            in the preview.
 170         */
 171         _player->set_always_burn_subtitles (true);
 172         _player->set_ignore_audio ();
 173         _player->set_play_referenced ();
 174
 175         _film_connection = _film->Changed.connect (boost::bind (&FilmViewer::film_changed, this, _1));
 176
 177         _player_connection = _player->Changed.connect (boost::bind (&FilmViewer::player_changed, this, _1));
 178
 179         calculate_sizes ();
 180         refresh ();
 181
 182         setup_sensitivity ();
 183 }
 184
 185 void
 186 FilmViewer::refresh_panel ()
 187 {
 188         _panel->Refresh ();
 189         _panel->Update ();
 190 }
 191
 192 void
 193 FilmViewer::get (DCPTime p, bool accurate)
 194 {
 195         if (!_player) {
 196                 return;
 197         }
 198
 199         list<shared_ptr<PlayerVideo> > all_pv;
 200         try {
 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()));
 204         }
 205
 206         if (!all_pv.empty ()) {
 207                 try {
 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) {
 213                                                 pv = all_pv.front();
 214                                         } else {
 215                                                 pv = all_pv.back();
 216                                         }
 217                                 } else {
 218                                         if (all_pv.front()->eyes() == EYES_RIGHT) {
 219                                                 pv = all_pv.front();
 220                                         } else {
 221                                                 pv = all_pv.back();
 222                                         }
 223                                 }
 224                         } else {
 225                                 /* 2D; no choice to make */
 226                                 pv = all_pv.front ();
 227                         }
 228
 229                         /* In an ideal world, what we would do here is:
 230                          *
 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.
 234                          *
 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.
 239                          *
 240                          * The content's specified colour conversion indicates the colourspace
 241                          * which the content is in (according to the user).
 242                          *
 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.
 245                          */
 246
 247                         _frame = pv->image (
 248                                 bind (&Log::dcp_log, _film->log().get(), _1, _2),
 249                                 bind (&PlayerVideo::always_rgb, _1),
 250                                 false, true
 251                                 );
 252
 253                         ImageChanged (pv);
 254
 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
 261                          * - add KDM
 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).
 266                          *
 267                          * I hope there's a better way to handle this ...
 268                          */
 269                         _frame.reset ();
 270                         _position = p;
 271                 }
 272         } else {
 273                 _frame.reset ();
 274                 _position = p;
 275         }
 276
 277         refresh_panel ();
 278
 279         _last_get_accurate = accurate;
 280 }
 281
 282 void
 283 FilmViewer::timer ()
 284 {
 285         DCPTime const frame = DCPTime::from_frames (1, _film->video_frame_rate ());
 286
 287         if ((_position + frame) >= _film->length ()) {
 288                 _play_button->SetValue (false);
 289                 check_play_state ();
 290         } else {
 291                 get (_position + frame, true);
 292         }
 293
 294         update_position_label ();
 295         update_position_slider ();
 296 }
 297
 298 void
 299 FilmViewer::paint_panel ()
 300 {
 301         wxPaintDC dc (_panel);
 302
 303         if (!_frame || !_film || !_out_size.width || !_out_size.height) {
 304                 dc.Clear ();
 305                 return;
 306         }
 307
 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);
 311
 312         if (_out_size.width < _panel_size.width) {
 313                 wxPen p (GetBackgroundColour ());
 314                 wxBrush b (GetBackgroundColour ());
 315                 dc.SetPen (p);
 316                 dc.SetBrush (b);
 317                 dc.DrawRectangle (_out_size.width, 0, _panel_size.width - _out_size.width, _panel_size.height);
 318         }
 319
 320         if (_out_size.height < _panel_size.height) {
 321                 wxPen p (GetBackgroundColour ());
 322                 wxBrush b (GetBackgroundColour ());
 323                 dc.SetPen (p);
 324                 dc.SetBrush (b);
 325                 dc.DrawRectangle (0, _out_size.height, _panel_size.width, _panel_size.height - _out_size.height);
 326         }
 327
 328         if (_outline_content->GetValue ()) {
 329                 wxPen p (wxColour (255, 0, 0), 2);
 330                 dc.SetPen (p);
 331                 dc.SetBrush (*wxTRANSPARENT_BRUSH);
 332                 dc.DrawRectangle (_inter_position.x, _inter_position.y, _inter_size.width, _inter_size.height);
 333         }
 334 }
 335
 336 void
 337 FilmViewer::slider_moved ()
 338 {
 339         if (!_film) {
 340                 return;
 341         }
 342
 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 ());
 347         }
 348         get (t, false);
 349         update_position_label ();
 350 }
 351
 352 void
 353 FilmViewer::panel_sized (wxSizeEvent& ev)
 354 {
 355         _panel_size.width = ev.GetSize().GetWidth();
 356         _panel_size.height = ev.GetSize().GetHeight();
 357
 358         calculate_sizes ();
 359         refresh ();
 360         update_position_label ();
 361         update_position_slider ();
 362 }
 363
 364 void
 365 FilmViewer::calculate_sizes ()
 366 {
 367         if (!_film || !_player) {
 368                 return;
 369         }
 370
 371         Ratio const * container = _film->container ();
 372
 373         float const panel_ratio = _panel_size.ratio ();
 374         float const film_ratio = container ? container->ratio () : 1.78;
 375
 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);
 380         } else {
 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);
 384         }
 385
 386         /* Catch silly values */
 387         _out_size.width = max (64, _out_size.width);
 388         _out_size.height = max (64, _out_size.height);
 389
 390         _player->set_video_container_size (_out_size);
 391 }
 392
 393 void
 394 FilmViewer::play_clicked ()
 395 {
 396         check_play_state ();
 397 }
 398
 399 void
 400 FilmViewer::check_play_state ()
 401 {
 402         if (!_film || _film->video_frame_rate() == 0) {
 403                 return;
 404         }
 405
 406         if (_play_button->GetValue()) {
 407                 _timer.Start (1000 / _film->video_frame_rate());
 408         } else {
 409                 _timer.Stop ();
 410         }
 411 }
 412
 413 void
 414 FilmViewer::update_position_slider ()
 415 {
 416         if (!_film) {
 417                 _slider->SetValue (0);
 418                 return;
 419         }
 420
 421         DCPTime const len = _film->length ();
 422
 423         if (len.get ()) {
 424                 int const new_slider_position = 4096 * _position.get() / len.get();
 425                 if (new_slider_position != _slider->GetValue()) {
 426                         _slider->SetValue (new_slider_position);
 427                 }
 428         }
 429 }
 430
 431 void
 432 FilmViewer::update_position_label ()
 433 {
 434         if (!_film) {
 435                 _frame_number->SetLabel ("0");
 436                 _timecode->SetLabel ("0:0:0.0");
 437                 return;
 438         }
 439
 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));
 444 }
 445
 446 void
 447 FilmViewer::active_jobs_changed (optional<string> j)
 448 {
 449         /* examine content is the only job which stops the viewer working */
 450         bool const a = !j || *j != "examine_content";
 451         _slider->Enable (a);
 452         _play_button->Enable (a);
 453 }
 454
 455 DCPTime
 456 FilmViewer::nudge_amount (wxMouseEvent& ev)
 457 {
 458         DCPTime amount = DCPTime::from_frames (1, _film->video_frame_rate ());
 459
 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);
 466         }
 467
 468         return amount;
 469 }
 470
 471 void
 472 FilmViewer::go_to (DCPTime t)
 473 {
 474         if (t < DCPTime ()) {
 475                 t = DCPTime ();
 476         }
 477
 478         if (t >= _film->length ()) {
 479                 t = _film->length ();
 480         }
 481
 482         get (t, true);
 483         update_position_label ();
 484         update_position_slider ();
 485 }
 486
 487 void
 488 FilmViewer::back_clicked (wxMouseEvent& ev)
 489 {
 490         go_to (_position - nudge_amount (ev));
 491         ev.Skip ();
 492 }
 493
 494 void
 495 FilmViewer::forward_clicked (wxMouseEvent& ev)
 496 {
 497         go_to (_position + nudge_amount (ev));
 498         ev.Skip ();
 499 }
 500
 501 void
 502 FilmViewer::player_changed (bool frequent)
 503 {
 504         if (frequent) {
 505                 return;
 506         }
 507
 508         if (_coalesce_player_changes) {
 509                 _pending_player_change = true;
 510                 return;
 511         }
 512
 513         calculate_sizes ();
 514         refresh ();
 515         update_position_label ();
 516         update_position_slider ();
 517 }
 518
 519 void
 520 FilmViewer::setup_sensitivity ()
 521 {
 522         bool const c = _film && !_film->content().empty ();
 523
 524         _slider->Enable (c);
 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);
 531
 532         _left_eye->Enable (c && _film->three_d ());
 533         _right_eye->Enable (c && _film->three_d ());
 534 }
 535
 536 void
 537 FilmViewer::film_changed (Film::Property p)
 538 {
 539         if (p == Film::CONTENT || p == Film::THREE_D) {
 540                 setup_sensitivity ();
 541         }
 542 }
 543
 544 /** Re-get the current frame */
 545 void
 546 FilmViewer::refresh ()
 547 {
 548         get (_position, _last_get_accurate);
 549 }
 550
 551 void
 552 FilmViewer::set_position (DCPTime p)
 553 {
 554         _position = p;
 555         get (_position, true);
 556         update_position_label ();
 557         update_position_slider ();
 558 }
 559
 560 void
 561 FilmViewer::set_coalesce_player_changes (bool c)
 562 {
 563         _coalesce_player_changes = c;
 564
 565         if (c) {
 566                 _pending_player_change = false;
 567         } else {
 568                 if (_pending_player_change) {
 569                         player_changed (false);
 570                 }
 571         }
 572 }
 573
 574 void
 575 FilmViewer::timecode_clicked ()
 576 {
 577         PlayheadToTimecodeDialog* dialog = new PlayheadToTimecodeDialog (this, _film->video_frame_rate ());
 578         if (dialog->ShowModal() == wxID_OK) {
 579                 go_to (dialog->get ());
 580         }
 581         dialog->Destroy ();
 582 }
 583
 584 void
 585 FilmViewer::frame_number_clicked ()
 586 {
 587         PlayheadToFrameDialog* dialog = new PlayheadToFrameDialog (this, _film->video_frame_rate ());
 588         if (dialog->ShowModal() == wxID_OK) {
 589                 go_to (dialog->get ());
 590         }
 591         dialog->Destroy ();
 592 }