src/wx/film_viewer.cc

   1 /*
   2     Copyright (C) 2012-2015 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         , _slider (new wxSlider (this, wxID_ANY, 0, 0, 4096))
  68         , _back_button (new wxButton (this, wxID_ANY, wxT("<")))
  69         , _forward_button (new wxButton (this, wxID_ANY, wxT(">")))
  70         , _frame_number (new wxStaticText (this, wxID_ANY, wxT("")))
  71         , _timecode (new wxStaticText (this, wxID_ANY, wxT("")))
  72         , _play_button (new wxToggleButton (this, wxID_ANY, _("Play")))
  73         , _ignore_player_changes (false)
  74         , _last_get_accurate (true)
  75 {
  76 #ifndef __WXOSX__
  77         _panel->SetDoubleBuffered (true);
  78 #endif
  79
  80         _panel->SetBackgroundStyle (wxBG_STYLE_PAINT);
  81
  82         _v_sizer = new wxBoxSizer (wxVERTICAL);
  83         SetSizer (_v_sizer);
  84
  85         _v_sizer->Add (_panel, 1, wxEXPAND);
  86
  87         _v_sizer->Add (_outline_content, 0, wxALL, DCPOMATIC_SIZER_GAP);
  88
  89         wxBoxSizer* h_sizer = new wxBoxSizer (wxHORIZONTAL);
  90
  91         wxBoxSizer* time_sizer = new wxBoxSizer (wxVERTICAL);
  92         time_sizer->Add (_frame_number, 0, wxEXPAND);
  93         time_sizer->Add (_timecode, 0, wxEXPAND);
  94
  95         h_sizer->Add (_back_button, 0, wxALL, 2);
  96         h_sizer->Add (time_sizer, 0, wxEXPAND);
  97         h_sizer->Add (_forward_button, 0, wxALL, 2);
  98         h_sizer->Add (_play_button, 0, wxEXPAND);
  99         h_sizer->Add (_slider, 1, wxEXPAND);
 100
 101         _v_sizer->Add (h_sizer, 0, wxEXPAND | wxALL, 6);
 102
 103         _frame_number->SetMinSize (wxSize (84, -1));
 104         _back_button->SetMinSize (wxSize (32, -1));
 105         _forward_button->SetMinSize (wxSize (32, -1));
 106
 107         _panel->Bind          (wxEVT_PAINT,                        boost::bind (&FilmViewer::paint_panel,     this));
 108         _panel->Bind          (wxEVT_SIZE,                         boost::bind (&FilmViewer::panel_sized,     this, _1));
 109         _outline_content->Bind(wxEVT_COMMAND_CHECKBOX_CLICKED,     boost::bind (&FilmViewer::refresh_panel,   this));
 110         _slider->Bind         (wxEVT_SCROLL_THUMBTRACK,            boost::bind (&FilmViewer::slider_moved,    this));
 111         _slider->Bind         (wxEVT_SCROLL_PAGEUP,                boost::bind (&FilmViewer::slider_moved,    this));
 112         _slider->Bind         (wxEVT_SCROLL_PAGEDOWN,              boost::bind (&FilmViewer::slider_moved,    this));
 113         _play_button->Bind    (wxEVT_COMMAND_TOGGLEBUTTON_CLICKED, boost::bind (&FilmViewer::play_clicked,    this));
 114         _timer.Bind           (wxEVT_TIMER,                        boost::bind (&FilmViewer::timer,           this));
 115         _back_button->Bind    (wxEVT_COMMAND_BUTTON_CLICKED,       boost::bind (&FilmViewer::back_clicked,    this));
 116         _forward_button->Bind (wxEVT_COMMAND_BUTTON_CLICKED,       boost::bind (&FilmViewer::forward_clicked, this));
 117
 118         set_film (shared_ptr<Film> ());
 119
 120         JobManager::instance()->ActiveJobsChanged.connect (
 121                 bind (&FilmViewer::active_jobs_changed, this, _2)
 122                 );
 123
 124         setup_sensitivity ();
 125 }
 126
 127 void
 128 FilmViewer::set_film (shared_ptr<Film> film)
 129 {
 130         if (_film == film) {
 131                 return;
 132         }
 133
 134         _film = film;
 135
 136         _frame.reset ();
 137
 138         update_position_slider ();
 139         update_position_label ();
 140
 141         if (!_film) {
 142                 return;
 143         }
 144
 145         try {
 146                 _player.reset (new Player (_film, _film->playlist ()));
 147         } catch (bad_alloc) {
 148                 error_dialog (this, _("There is not enough free memory to do that."));
 149                 _film.reset ();
 150                 return;
 151         }
 152
 153         /* Always burn in subtitles, even if content is set not to, otherwise we won't see them
 154            in the preview.
 155         */
 156         _player->set_always_burn_subtitles (true);
 157         _player->set_ignore_audio ();
 158         _player->set_play_referenced ();
 159
 160         _film_connection = _film->Changed.connect (boost::bind (&FilmViewer::film_changed, this, _1));
 161
 162         _player_connection = _player->Changed.connect (boost::bind (&FilmViewer::player_changed, this, _1));
 163
 164         calculate_sizes ();
 165         refresh ();
 166
 167         setup_sensitivity ();
 168 }
 169
 170 void
 171 FilmViewer::refresh_panel ()
 172 {
 173         _panel->Refresh ();
 174         _panel->Update ();
 175 }
 176
 177 void
 178 FilmViewer::get (DCPTime p, bool accurate)
 179 {
 180         if (!_player) {
 181                 return;
 182         }
 183
 184         list<shared_ptr<PlayerVideo> > pvf;
 185         try {
 186                 pvf = _player->get_video (p, accurate);
 187         } catch (exception& e) {
 188                 error_dialog (this, wxString::Format (_("Could not get video for view (%s)"), std_to_wx(e.what()).data()));
 189         }
 190
 191         if (!pvf.empty ()) {
 192                 try {
 193                         /* XXX: this could now give us a 48-bit image, which is a bit wasteful,
 194                            or a XYZ image, which the code below will currently rely on FFmpeg
 195                            to colourspace-convert.
 196                         */
 197                         _frame = pvf.front()->image (boost::bind (&Log::dcp_log, _film->log().get(), _1, _2));
 198                         ImageChanged (pvf.front ());
 199
 200                         dcp::YUVToRGB yuv_to_rgb = dcp::YUV_TO_RGB_REC601;
 201                         if (pvf.front()->colour_conversion()) {
 202                                 yuv_to_rgb = pvf.front()->colour_conversion().get().yuv_to_rgb();
 203                         }
 204
 205                         _frame = _frame->scale (_frame->size(), yuv_to_rgb, AV_PIX_FMT_RGB24, false);
 206                         _position = pvf.front()->time ();
 207                         _inter_position = pvf.front()->inter_position ();
 208                         _inter_size = pvf.front()->inter_size ();
 209                 } catch (dcp::DCPReadError& e) {
 210                         /* This can happen on the following sequence of events:
 211                          * - load encrypted DCP
 212                          * - add KDM
 213                          * - DCP is examined again, which sets its "playable" flag to 1
 214                          * - as a side effect of the exam, the viewer is updated using the old pieces
 215                          * - the DCPDecoder in the old piece gives us an encrypted frame
 216                          * - then, the pieces are re-made (but too late).
 217                          *
 218                          * I hope there's a better way to handle this ...
 219                          */
 220                         _frame.reset ();
 221                         _position = p;
 222                 }
 223         } else {
 224                 _frame.reset ();
 225                 _position = p;
 226         }
 227
 228         refresh_panel ();
 229
 230         _last_get_accurate = accurate;
 231 }
 232
 233 void
 234 FilmViewer::timer ()
 235 {
 236         DCPTime const frame = DCPTime::from_frames (1, _film->video_frame_rate ());
 237
 238         if ((_position + frame) >= _film->length ()) {
 239                 _play_button->SetValue (false);
 240                 check_play_state ();
 241         } else {
 242                 get (_position + frame, true);
 243         }
 244
 245         update_position_label ();
 246         update_position_slider ();
 247 }
 248
 249 void
 250 FilmViewer::paint_panel ()
 251 {
 252         wxPaintDC dc (_panel);
 253
 254         if (!_frame || !_film || !_out_size.width || !_out_size.height) {
 255                 dc.Clear ();
 256                 return;
 257         }
 258
 259         wxImage frame (_out_size.width, _out_size.height, _frame->data()[0], true);
 260         wxBitmap frame_bitmap (frame);
 261         dc.DrawBitmap (frame_bitmap, 0, 0);
 262
 263         if (_out_size.width < _panel_size.width) {
 264                 wxPen p (GetBackgroundColour ());
 265                 wxBrush b (GetBackgroundColour ());
 266                 dc.SetPen (p);
 267                 dc.SetBrush (b);
 268                 dc.DrawRectangle (_out_size.width, 0, _panel_size.width - _out_size.width, _panel_size.height);
 269         }
 270
 271         if (_out_size.height < _panel_size.height) {
 272                 wxPen p (GetBackgroundColour ());
 273                 wxBrush b (GetBackgroundColour ());
 274                 dc.SetPen (p);
 275                 dc.SetBrush (b);
 276                 dc.DrawRectangle (0, _out_size.height, _panel_size.width, _panel_size.height - _out_size.height);
 277         }
 278
 279         if (_outline_content->GetValue ()) {
 280                 wxPen p (wxColour (255, 0, 0), 2);
 281                 dc.SetPen (p);
 282                 dc.SetBrush (*wxTRANSPARENT_BRUSH);
 283                 dc.DrawRectangle (_inter_position.x, _inter_position.y, _inter_size.width, _inter_size.height);
 284         }
 285 }
 286
 287 void
 288 FilmViewer::slider_moved ()
 289 {
 290         if (!_film) {
 291                 return;
 292         }
 293
 294         DCPTime t (_slider->GetValue() * _film->length().get() / 4096);
 295         /* Ensure that we hit the end of the film at the end of the slider */
 296         if (t >= _film->length ()) {
 297                 t = _film->length() - DCPTime::from_frames (1, _film->video_frame_rate ());
 298         }
 299         get (t, false);
 300         update_position_label ();
 301 }
 302
 303 void
 304 FilmViewer::panel_sized (wxSizeEvent& ev)
 305 {
 306         _panel_size.width = ev.GetSize().GetWidth();
 307         _panel_size.height = ev.GetSize().GetHeight();
 308
 309         calculate_sizes ();
 310         refresh ();
 311         update_position_label ();
 312         update_position_slider ();
 313 }
 314
 315 void
 316 FilmViewer::calculate_sizes ()
 317 {
 318         if (!_film || !_player) {
 319                 return;
 320         }
 321
 322         Ratio const * container = _film->container ();
 323
 324         float const panel_ratio = _panel_size.ratio ();
 325         float const film_ratio = container ? container->ratio () : 1.78;
 326
 327         if (panel_ratio < film_ratio) {
 328                 /* panel is less widscreen than the film; clamp width */
 329                 _out_size.width = _panel_size.width;
 330                 _out_size.height = lrintf (_out_size.width / film_ratio);
 331         } else {
 332                 /* panel is more widescreen than the film; clamp height */
 333                 _out_size.height = _panel_size.height;
 334                 _out_size.width = lrintf (_out_size.height * film_ratio);
 335         }
 336
 337         /* Catch silly values */
 338         _out_size.width = max (64, _out_size.width);
 339         _out_size.height = max (64, _out_size.height);
 340
 341         _player->set_video_container_size (_out_size);
 342 }
 343
 344 void
 345 FilmViewer::play_clicked ()
 346 {
 347         check_play_state ();
 348 }
 349
 350 void
 351 FilmViewer::check_play_state ()
 352 {
 353         if (!_film || _film->video_frame_rate() == 0) {
 354                 return;
 355         }
 356
 357         if (_play_button->GetValue()) {
 358                 _timer.Start (1000 / _film->video_frame_rate());
 359         } else {
 360                 _timer.Stop ();
 361         }
 362 }
 363
 364 void
 365 FilmViewer::update_position_slider ()
 366 {
 367         if (!_film) {
 368                 _slider->SetValue (0);
 369                 return;
 370         }
 371
 372         DCPTime const len = _film->length ();
 373
 374         if (len.get ()) {
 375                 int const new_slider_position = 4096 * _position.get() / len.get();
 376                 if (new_slider_position != _slider->GetValue()) {
 377                         _slider->SetValue (new_slider_position);
 378                 }
 379         }
 380 }
 381
 382 void
 383 FilmViewer::update_position_label ()
 384 {
 385         if (!_film) {
 386                 _frame_number->SetLabel ("0");
 387                 _timecode->SetLabel ("0:0:0.0");
 388                 return;
 389         }
 390
 391         double const fps = _film->video_frame_rate ();
 392         /* Count frame number from 1 ... not sure if this is the best idea */
 393         _frame_number->SetLabel (wxString::Format (wxT("%ld"), lrint (_position.seconds() * fps) + 1));
 394         _timecode->SetLabel (time_to_timecode (_position, fps));
 395 }
 396
 397 void
 398 FilmViewer::active_jobs_changed (optional<string> j)
 399 {
 400         /* examine content is the only job which stops the viewer working */
 401         bool const a = !j || *j != "examine_content";
 402         _slider->Enable (a);
 403         _play_button->Enable (a);
 404 }
 405
 406 void
 407 FilmViewer::back_clicked ()
 408 {
 409         DCPTime p = _position - DCPTime::from_frames (1, _film->video_frame_rate ());
 410         if (p < DCPTime ()) {
 411                 p = DCPTime ();
 412         }
 413
 414         get (p, true);
 415         update_position_label ();
 416         update_position_slider ();
 417 }
 418
 419 void
 420 FilmViewer::forward_clicked ()
 421 {
 422         DCPTime p = _position + DCPTime::from_frames (1, _film->video_frame_rate ());
 423         if (p >= _film->length ()) {
 424                 p = _position;
 425         }
 426
 427         get (p, true);
 428         update_position_label ();
 429         update_position_slider ();
 430 }
 431
 432 void
 433 FilmViewer::player_changed (bool frequent)
 434 {
 435         if (frequent || _ignore_player_changes) {
 436                 return;
 437         }
 438
 439         calculate_sizes ();
 440         refresh ();
 441         update_position_label ();
 442         update_position_slider ();
 443 }
 444
 445 void
 446 FilmViewer::setup_sensitivity ()
 447 {
 448         bool const c = _film && !_film->content().empty ();
 449
 450         _slider->Enable (c);
 451         _back_button->Enable (c);
 452         _forward_button->Enable (c);
 453         _play_button->Enable (c);
 454         _outline_content->Enable (c);
 455         _frame_number->Enable (c);
 456         _timecode->Enable (c);
 457 }
 458
 459 void
 460 FilmViewer::film_changed (Film::Property p)
 461 {
 462         if (p == Film::CONTENT) {
 463                 setup_sensitivity ();
 464         }
 465 }
 466
 467 /** Re-get the current frame */
 468 void
 469 FilmViewer::refresh ()
 470 {
 471         get (_position, _last_get_accurate);
 472 }
 473
 474 void
 475 FilmViewer::set_position (DCPTime p)
 476 {
 477         _position = p;
 478         get (_position, true);
 479         update_position_label ();
 480         update_position_slider ();
 481 }
 482
 483 void
 484 FilmViewer::set_ignore_player_changes (bool i)
 485 {
 486         _ignore_player_changes = i;
 487 }