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->Changed.connect (boost::bind (&FilmViewer::film_changed, this, _1));
 182
 183         _player->Changed.connect (boost::bind (&FilmViewer::player_changed, this, _1));
 184         _player->Video.connect (boost::bind (&FilmViewer::video, this, _1));
 185
 186         calculate_sizes ();
 187         refresh ();
 188
 189         setup_sensitivity ();
 190 }
 191
 192 void
 193 FilmViewer::refresh_panel ()
 194 {
 195         _panel->Refresh ();
 196         _panel->Update ();
 197 }
 198
 199 void
 200 FilmViewer::video (shared_ptr<PlayerVideo> pv)
 201 {
 202         if (!_player) {
 203                 return;
 204         }
 205
 206         if (_film->three_d ()) {
 207                 if ((_left_eye->GetValue() && pv->eyes() == EYES_RIGHT) || (_right_eye->GetValue() && pv->eyes() == EYES_LEFT)) {
 208                         return;
 209                 }
 210         }
 211
 212         /* In an ideal world, what we would do here is:
 213          *
 214          * 1. convert to XYZ exactly as we do in the DCP creation path.
 215          * 2. convert back to RGB for the preview display, compensating
 216          *    for the monitor etc. etc.
 217          *
 218          * but this is inefficient if the source is RGB.  Since we don't
 219          * (currently) care too much about the precise accuracy of the preview's
 220          * colour mapping (and we care more about its speed) we try to short-
 221          * circuit this "ideal" situation in some cases.
 222          *
 223          * The content's specified colour conversion indicates the colourspace
 224          * which the content is in (according to the user).
 225          *
 226          * PlayerVideo::image (bound to PlayerVideo::always_rgb) will take the source
 227          * image and convert it (from whatever the user has said it is) to RGB.
 228          */
 229
 230         _frame = pv->image (
 231                 bind (&Log::dcp_log, _film->log().get(), _1, _2),
 232                 bind (&PlayerVideo::always_rgb, _1),
 233                 false, true
 234                 );
 235
 236         ImageChanged (pv);
 237
 238         _position = pv->time ();
 239         _inter_position = pv->inter_position ();
 240         _inter_size = pv->inter_size ();
 241
 242         refresh_panel ();
 243 }
 244
 245 void
 246 FilmViewer::get ()
 247 {
 248         Image const * current = _frame.get ();
 249         while (!_player->pass() && _frame.get() == current) {}
 250 }
 251
 252 void
 253 FilmViewer::timer ()
 254 {
 255         DCPTime const frame = DCPTime::from_frames (1, _film->video_frame_rate ());
 256
 257         if ((_position + frame) >= _film->length ()) {
 258                 _play_button->SetValue (false);
 259                 check_play_state ();
 260         } else {
 261                 get ();
 262         }
 263
 264         update_position_label ();
 265         update_position_slider ();
 266 }
 267
 268 void
 269 FilmViewer::paint_panel ()
 270 {
 271         wxPaintDC dc (_panel);
 272
 273         if (!_frame || !_film || !_out_size.width || !_out_size.height) {
 274                 dc.Clear ();
 275                 return;
 276         }
 277
 278         wxImage frame (_out_size.width, _out_size.height, _frame->data()[0], true);
 279         wxBitmap frame_bitmap (frame);
 280         dc.DrawBitmap (frame_bitmap, 0, 0);
 281
 282         if (_out_size.width < _panel_size.width) {
 283                 wxPen p (GetBackgroundColour ());
 284                 wxBrush b (GetBackgroundColour ());
 285                 dc.SetPen (p);
 286                 dc.SetBrush (b);
 287                 dc.DrawRectangle (_out_size.width, 0, _panel_size.width - _out_size.width, _panel_size.height);
 288         }
 289
 290         if (_out_size.height < _panel_size.height) {
 291                 wxPen p (GetBackgroundColour ());
 292                 wxBrush b (GetBackgroundColour ());
 293                 dc.SetPen (p);
 294                 dc.SetBrush (b);
 295                 dc.DrawRectangle (0, _out_size.height, _panel_size.width, _panel_size.height - _out_size.height);
 296         }
 297
 298         if (_outline_content->GetValue ()) {
 299                 wxPen p (wxColour (255, 0, 0), 2);
 300                 dc.SetPen (p);
 301                 dc.SetBrush (*wxTRANSPARENT_BRUSH);
 302                 dc.DrawRectangle (_inter_position.x, _inter_position.y, _inter_size.width, _inter_size.height);
 303         }
 304 }
 305
 306 void
 307 FilmViewer::slider_moved ()
 308 {
 309         if (!_film) {
 310                 return;
 311         }
 312
 313         DCPTime t (_slider->GetValue() * _film->length().get() / 4096);
 314         /* Ensure that we hit the end of the film at the end of the slider */
 315         if (t >= _film->length ()) {
 316                 t = _film->length() - DCPTime::from_frames (1, _film->video_frame_rate ());
 317         }
 318         seek (t, false);
 319         update_position_label ();
 320 }
 321
 322 void
 323 FilmViewer::panel_sized (wxSizeEvent& ev)
 324 {
 325         _panel_size.width = ev.GetSize().GetWidth();
 326         _panel_size.height = ev.GetSize().GetHeight();
 327
 328         calculate_sizes ();
 329         refresh ();
 330         update_position_label ();
 331         update_position_slider ();
 332 }
 333
 334 void
 335 FilmViewer::calculate_sizes ()
 336 {
 337         if (!_film || !_player) {
 338                 return;
 339         }
 340
 341         Ratio const * container = _film->container ();
 342
 343         float const panel_ratio = _panel_size.ratio ();
 344         float const film_ratio = container ? container->ratio () : 1.78;
 345
 346         if (panel_ratio < film_ratio) {
 347                 /* panel is less widscreen than the film; clamp width */
 348                 _out_size.width = _panel_size.width;
 349                 _out_size.height = lrintf (_out_size.width / film_ratio);
 350         } else {
 351                 /* panel is more widescreen than the film; clamp height */
 352                 _out_size.height = _panel_size.height;
 353                 _out_size.width = lrintf (_out_size.height * film_ratio);
 354         }
 355
 356         /* Catch silly values */
 357         _out_size.width = max (64, _out_size.width);
 358         _out_size.height = max (64, _out_size.height);
 359
 360         _player->set_video_container_size (_out_size);
 361 }
 362
 363 void
 364 FilmViewer::play_clicked ()
 365 {
 366         check_play_state ();
 367 }
 368
 369 void
 370 FilmViewer::check_play_state ()
 371 {
 372         if (!_film || _film->video_frame_rate() == 0) {
 373                 return;
 374         }
 375
 376         if (_play_button->GetValue()) {
 377                 _timer.Start (1000 / _film->video_frame_rate());
 378         } else {
 379                 _timer.Stop ();
 380         }
 381 }
 382
 383 void
 384 FilmViewer::update_position_slider ()
 385 {
 386         if (!_film) {
 387                 _slider->SetValue (0);
 388                 return;
 389         }
 390
 391         DCPTime const len = _film->length ();
 392
 393         if (len.get ()) {
 394                 int const new_slider_position = 4096 * _position.get() / len.get();
 395                 if (new_slider_position != _slider->GetValue()) {
 396                         _slider->SetValue (new_slider_position);
 397                 }
 398         }
 399 }
 400
 401 void
 402 FilmViewer::update_position_label ()
 403 {
 404         if (!_film) {
 405                 _frame_number->SetLabel ("0");
 406                 _timecode->SetLabel ("0:0:0.0");
 407                 return;
 408         }
 409
 410         double const fps = _film->video_frame_rate ();
 411         /* Count frame number from 1 ... not sure if this is the best idea */
 412         _frame_number->SetLabel (wxString::Format (wxT("%ld"), lrint (_position.seconds() * fps) + 1));
 413         _timecode->SetLabel (time_to_timecode (_position, fps));
 414 }
 415
 416 void
 417 FilmViewer::active_jobs_changed (optional<string> j)
 418 {
 419         /* examine content is the only job which stops the viewer working */
 420         bool const a = !j || *j != "examine_content";
 421         _slider->Enable (a);
 422         _play_button->Enable (a);
 423 }
 424
 425 DCPTime
 426 FilmViewer::nudge_amount (wxMouseEvent& ev)
 427 {
 428         DCPTime amount = DCPTime::from_frames (1, _film->video_frame_rate ());
 429
 430         if (ev.ShiftDown() && !ev.ControlDown()) {
 431                 amount = DCPTime::from_seconds (1);
 432         } else if (!ev.ShiftDown() && ev.ControlDown()) {
 433                 amount = DCPTime::from_seconds (10);
 434         } else if (ev.ShiftDown() && ev.ControlDown()) {
 435                 amount = DCPTime::from_seconds (60);
 436         }
 437
 438         return amount;
 439 }
 440
 441 void
 442 FilmViewer::go_to (DCPTime t)
 443 {
 444         if (t < DCPTime ()) {
 445                 t = DCPTime ();
 446         }
 447
 448         if (t >= _film->length ()) {
 449                 t = _film->length ();
 450         }
 451
 452         seek (t, true);
 453         update_position_label ();
 454         update_position_slider ();
 455 }
 456
 457 void
 458 FilmViewer::back_clicked (wxMouseEvent& ev)
 459 {
 460         go_to (_position - nudge_amount (ev));
 461         ev.Skip ();
 462 }
 463
 464 void
 465 FilmViewer::forward_clicked (wxMouseEvent& ev)
 466 {
 467         go_to (_position + nudge_amount (ev));
 468         ev.Skip ();
 469 }
 470
 471 void
 472 FilmViewer::player_changed (bool frequent)
 473 {
 474         if (frequent) {
 475                 return;
 476         }
 477
 478         if (_coalesce_player_changes) {
 479                 _pending_player_change = true;
 480                 return;
 481         }
 482
 483         calculate_sizes ();
 484         refresh ();
 485         update_position_label ();
 486         update_position_slider ();
 487 }
 488
 489 void
 490 FilmViewer::setup_sensitivity ()
 491 {
 492         bool const c = _film && !_film->content().empty ();
 493
 494         _slider->Enable (c);
 495         _back_button->Enable (c);
 496         _forward_button->Enable (c);
 497         _play_button->Enable (c);
 498         _outline_content->Enable (c);
 499         _frame_number->Enable (c);
 500         _timecode->Enable (c);
 501
 502         _left_eye->Enable (c && _film->three_d ());
 503         _right_eye->Enable (c && _film->three_d ());
 504 }
 505
 506 void
 507 FilmViewer::film_changed (Film::Property p)
 508 {
 509         if (p == Film::CONTENT || p == Film::THREE_D) {
 510                 setup_sensitivity ();
 511         }
 512 }
 513
 514 /** Re-get the current frame */
 515 void
 516 FilmViewer::refresh ()
 517 {
 518         seek (_position, _last_seek_accurate);
 519 }
 520
 521 void
 522 FilmViewer::set_position (DCPTime p)
 523 {
 524         _position = p;
 525         seek (p, true);
 526         update_position_label ();
 527         update_position_slider ();
 528 }
 529
 530 void
 531 FilmViewer::set_coalesce_player_changes (bool c)
 532 {
 533         _coalesce_player_changes = c;
 534
 535         if (c) {
 536                 _pending_player_change = false;
 537         } else {
 538                 if (_pending_player_change) {
 539                         player_changed (false);
 540                 }
 541         }
 542 }
 543
 544 void
 545 FilmViewer::timecode_clicked ()
 546 {
 547         PlayheadToTimecodeDialog* dialog = new PlayheadToTimecodeDialog (this, _film->video_frame_rate ());
 548         if (dialog->ShowModal() == wxID_OK) {
 549                 go_to (dialog->get ());
 550         }
 551         dialog->Destroy ();
 552 }
 553
 554 void
 555 FilmViewer::frame_number_clicked ()
 556 {
 557         PlayheadToFrameDialog* dialog = new PlayheadToFrameDialog (this, _film->video_frame_rate ());
 558         if (dialog->ShowModal() == wxID_OK) {
 559                 go_to (dialog->get ());
 560         }
 561         dialog->Destroy ();
 562 }
 563
 564 void
 565 FilmViewer::jump_to_selected_clicked ()
 566 {
 567         Config::instance()->set_jump_to_selected (_jump_to_selected->GetValue ());
 568 }
 569
 570 void
 571 FilmViewer::seek (DCPTime t, bool accurate)
 572 {
 573         _player->seek (t, accurate);
 574         _last_seek_accurate = accurate;
 575         get ();
 576 }