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