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