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