src/wx/film_viewer.cc

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