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