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, _1)
 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
 155         _film_connection = _film->Changed.connect (boost::bind (&FilmViewer::film_changed, this, _1));
 156
 157         _player_connection = _player->Changed.connect (boost::bind (&FilmViewer::player_changed, this, _1));
 158
 159         calculate_sizes ();
 160         refresh ();
 161
 162         setup_sensitivity ();
 163 }
 164
 165 void
 166 FilmViewer::refresh_panel ()
 167 {
 168         _panel->Refresh ();
 169         _panel->Update ();
 170 }
 171
 172 void
 173 FilmViewer::get (DCPTime p, bool accurate)
 174 {
 175         if (!_player) {
 176                 return;
 177         }
 178
 179         list<shared_ptr<PlayerVideo> > pvf;
 180         try {
 181                 pvf = _player->get_video (p, accurate);
 182         } catch (exception& e) {
 183                 error_dialog (this, wxString::Format (_("Could not get video for view (%s)"), std_to_wx(e.what()).data()));
 184         }
 185
 186         if (!pvf.empty ()) {
 187                 try {
 188                         _frame = pvf.front()->image (PIX_FMT_RGB24, boost::bind (&Log::dcp_log, _film->log().get(), _1, _2));
 189                         ImageChanged (pvf.front ());
 190
 191                         dcp::YUVToRGB yuv_to_rgb = dcp::YUV_TO_RGB_REC601;
 192                         if (pvf.front()->colour_conversion()) {
 193                                 yuv_to_rgb = pvf.front()->colour_conversion().get().yuv_to_rgb();
 194                         }
 195
 196                         _frame = _frame->scale (_frame->size(), yuv_to_rgb, PIX_FMT_RGB24, false);
 197                         _position = pvf.front()->time ();
 198                         _inter_position = pvf.front()->inter_position ();
 199                         _inter_size = pvf.front()->inter_size ();
 200                 } catch (dcp::DCPReadError& e) {
 201                         /* This can happen on the following sequence of events:
 202                          * - load encrypted DCP
 203                          * - add KDM
 204                          * - DCP is examined again, which sets its "playable" flag to 1
 205                          * - as a side effect of the exam, the viewer is updated using the old pieces
 206                          * - the DCPDecoder in the old piece gives us an encrypted frame
 207                          * - then, the pieces are re-made (but too late).
 208                          *
 209                          * I hope there's a better way to handle this ...
 210                          */
 211                         _frame.reset ();
 212                         _position = p;
 213                 }
 214         } else {
 215                 _frame.reset ();
 216                 _position = p;
 217         }
 218
 219         refresh_panel ();
 220
 221         _last_get_accurate = accurate;
 222 }
 223
 224 void
 225 FilmViewer::timer ()
 226 {
 227         DCPTime const frame = DCPTime::from_frames (1, _film->video_frame_rate ());
 228
 229         if ((_position + frame) >= _film->length ()) {
 230                 _play_button->SetValue (false);
 231                 check_play_state ();
 232         } else {
 233                 get (_position + frame, true);
 234         }
 235
 236         update_position_label ();
 237         update_position_slider ();
 238 }
 239
 240 void
 241 FilmViewer::paint_panel ()
 242 {
 243         wxPaintDC dc (_panel);
 244
 245         if (!_frame || !_film || !_out_size.width || !_out_size.height) {
 246                 dc.Clear ();
 247                 return;
 248         }
 249
 250         wxImage frame (_out_size.width, _out_size.height, _frame->data()[0], true);
 251         wxBitmap frame_bitmap (frame);
 252         dc.DrawBitmap (frame_bitmap, 0, 0);
 253
 254         if (_out_size.width < _panel_size.width) {
 255                 wxPen p (GetBackgroundColour ());
 256                 wxBrush b (GetBackgroundColour ());
 257                 dc.SetPen (p);
 258                 dc.SetBrush (b);
 259                 dc.DrawRectangle (_out_size.width, 0, _panel_size.width - _out_size.width, _panel_size.height);
 260         }
 261
 262         if (_out_size.height < _panel_size.height) {
 263                 wxPen p (GetBackgroundColour ());
 264                 wxBrush b (GetBackgroundColour ());
 265                 dc.SetPen (p);
 266                 dc.SetBrush (b);
 267                 dc.DrawRectangle (0, _out_size.height, _panel_size.width, _panel_size.height - _out_size.height);
 268         }
 269
 270         if (_outline_content->GetValue ()) {
 271                 wxPen p (wxColour (255, 0, 0), 2);
 272                 dc.SetPen (p);
 273                 dc.SetBrush (*wxTRANSPARENT_BRUSH);
 274                 dc.DrawRectangle (_inter_position.x, _inter_position.y, _inter_size.width, _inter_size.height);
 275         }
 276 }
 277
 278 void
 279 FilmViewer::slider_moved ()
 280 {
 281         if (!_film) {
 282                 return;
 283         }
 284
 285         DCPTime t (_slider->GetValue() * _film->length().get() / 4096);
 286         /* Ensure that we hit the end of the film at the end of the slider */
 287         if (t >= _film->length ()) {
 288                 t = _film->length() - DCPTime::from_frames (1, _film->video_frame_rate ());
 289         }
 290         get (t, false);
 291         update_position_label ();
 292 }
 293
 294 void
 295 FilmViewer::panel_sized (wxSizeEvent& ev)
 296 {
 297         _panel_size.width = ev.GetSize().GetWidth();
 298         _panel_size.height = ev.GetSize().GetHeight();
 299
 300         calculate_sizes ();
 301         refresh ();
 302         update_position_label ();
 303         update_position_slider ();
 304 }
 305
 306 void
 307 FilmViewer::calculate_sizes ()
 308 {
 309         if (!_film || !_player) {
 310                 return;
 311         }
 312
 313         Ratio const * container = _film->container ();
 314
 315         float const panel_ratio = _panel_size.ratio ();
 316         float const film_ratio = container ? container->ratio () : 1.78;
 317
 318         if (panel_ratio < film_ratio) {
 319                 /* panel is less widscreen than the film; clamp width */
 320                 _out_size.width = _panel_size.width;
 321                 _out_size.height = lrintf (_out_size.width / film_ratio);
 322         } else {
 323                 /* panel is more widescreen than the film; clamp height */
 324                 _out_size.height = _panel_size.height;
 325                 _out_size.width = lrintf (_out_size.height * film_ratio);
 326         }
 327
 328         /* Catch silly values */
 329         _out_size.width = max (64, _out_size.width);
 330         _out_size.height = max (64, _out_size.height);
 331
 332         _player->set_video_container_size (_out_size);
 333 }
 334
 335 void
 336 FilmViewer::play_clicked ()
 337 {
 338         check_play_state ();
 339 }
 340
 341 void
 342 FilmViewer::check_play_state ()
 343 {
 344         if (!_film || _film->video_frame_rate() == 0) {
 345                 return;
 346         }
 347
 348         if (_play_button->GetValue()) {
 349                 _timer.Start (1000 / _film->video_frame_rate());
 350         } else {
 351                 _timer.Stop ();
 352         }
 353 }
 354
 355 void
 356 FilmViewer::update_position_slider ()
 357 {
 358         if (!_film) {
 359                 _slider->SetValue (0);
 360                 return;
 361         }
 362
 363         DCPTime const len = _film->length ();
 364
 365         if (len.get ()) {
 366                 int const new_slider_position = 4096 * _position.get() / len.get();
 367                 if (new_slider_position != _slider->GetValue()) {
 368                         _slider->SetValue (new_slider_position);
 369                 }
 370         }
 371 }
 372
 373 void
 374 FilmViewer::update_position_label ()
 375 {
 376         if (!_film) {
 377                 _frame_number->SetLabel ("0");
 378                 _timecode->SetLabel ("0:0:0.0");
 379                 return;
 380         }
 381
 382         double const fps = _film->video_frame_rate ();
 383         /* Count frame number from 1 ... not sure if this is the best idea */
 384         _frame_number->SetLabel (wxString::Format (wxT("%ld"), lrint (_position.seconds() * fps) + 1));
 385         _timecode->SetLabel (time_to_timecode (_position, fps));
 386 }
 387
 388 void
 389 FilmViewer::active_jobs_changed (optional<string> j)
 390 {
 391         /* examine content is the only job which stops the viewer working */
 392         bool const a = !j || *j != "examine_content";
 393         _slider->Enable (a);
 394         _play_button->Enable (a);
 395 }
 396
 397 void
 398 FilmViewer::back_clicked ()
 399 {
 400         DCPTime p = _position - DCPTime::from_frames (1, _film->video_frame_rate ());
 401         if (p < DCPTime ()) {
 402                 p = DCPTime ();
 403         }
 404
 405         get (p, true);
 406         update_position_label ();
 407         update_position_slider ();
 408 }
 409
 410 void
 411 FilmViewer::forward_clicked ()
 412 {
 413         DCPTime p = _position + DCPTime::from_frames (1, _film->video_frame_rate ());
 414         if (p >= _film->length ()) {
 415                 p = _position;
 416         }
 417
 418         get (p, true);
 419         update_position_label ();
 420         update_position_slider ();
 421 }
 422
 423 void
 424 FilmViewer::player_changed (bool frequent)
 425 {
 426         if (frequent) {
 427                 return;
 428         }
 429
 430         calculate_sizes ();
 431         refresh ();
 432         update_position_label ();
 433         update_position_slider ();
 434 }
 435
 436 void
 437 FilmViewer::setup_sensitivity ()
 438 {
 439         bool const c = _film && !_film->content().empty ();
 440
 441         _slider->Enable (c);
 442         _back_button->Enable (c);
 443         _forward_button->Enable (c);
 444         _play_button->Enable (c);
 445         _outline_content->Enable (c);
 446         _frame_number->Enable (c);
 447         _timecode->Enable (c);
 448 }
 449
 450 void
 451 FilmViewer::film_changed (Film::Property p)
 452 {
 453         if (p == Film::CONTENT) {
 454                 setup_sensitivity ();
 455         }
 456 }
 457
 458 /** Re-get the current frame */
 459 void
 460 FilmViewer::refresh ()
 461 {
 462         get (_position, _last_get_accurate);
 463 }