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