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