src/wx/film_viewer.cc

   1 /*
   2     Copyright (C) 2012-2014 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/scaler.h"
  30 #include "lib/exceptions.h"
  31 #include "lib/examine_content_job.h"
  32 #include "lib/filter.h"
  33 #include "lib/player.h"
  34 #include "lib/player_video.h"
  35 #include "lib/video_content.h"
  36 #include "lib/video_decoder.h"
  37 #include "lib/timer.h"
  38 #include "lib/log.h"
  39 #include "film_viewer.h"
  40 #include "wx_util.h"
  41 #include <dcp/exceptions.h>
  42 #include <wx/tglbtn.h>
  43 #include <iostream>
  44 #include <iomanip>
  45
  46 using std::string;
  47 using std::pair;
  48 using std::min;
  49 using std::max;
  50 using std::cout;
  51 using std::list;
  52 using std::bad_alloc;
  53 using std::make_pair;
  54 using std::exception;
  55 using boost::shared_ptr;
  56 using boost::dynamic_pointer_cast;
  57 using boost::weak_ptr;
  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> f)
 125 {
 126         if (_film == f) {
 127                 return;
 128         }
 129
 130         _film = f;
 131
 132         _frame.reset ();
 133
 134         _slider->SetValue (0);
 135         set_position_text ();
 136
 137         if (!_film) {
 138                 return;
 139         }
 140
 141         try {
 142                 _player = f->make_player ();
 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         _film_connection = _film->Changed.connect (boost::bind (&FilmViewer::film_changed, this, _1));
 150
 151         _player->set_approximate_size ();
 152         _player_connection = _player->Changed.connect (boost::bind (&FilmViewer::player_changed, this, _1));
 153
 154         calculate_sizes ();
 155         get (_position, _last_get_accurate);
 156
 157         setup_sensitivity ();
 158 }
 159
 160 void
 161 FilmViewer::refresh_panel ()
 162 {
 163         _panel->Refresh ();
 164         _panel->Update ();
 165 }
 166
 167 void
 168 FilmViewer::get (DCPTime p, bool accurate)
 169 {
 170         if (!_player) {
 171                 return;
 172         }
 173
 174         list<shared_ptr<PlayerVideo> > pvf;
 175         try {
 176                 pvf = _player->get_video (p, accurate);
 177         } catch (exception& e) {
 178                 error_dialog (this, wxString::Format (_("Could not get video for view (%s)"), std_to_wx(e.what()).data()));
 179         }
 180
 181         if (!pvf.empty ()) {
 182                 try {
 183                         _frame = pvf.front()->image (PIX_FMT_RGB24, true, boost::bind (&Log::dcp_log, _film->log().get(), _1, _2));
 184                         _frame = _frame->scale (_frame->size(), Scaler::from_id ("fastbilinear"), PIX_FMT_RGB24, false);
 185                         _position = pvf.front()->time ();
 186                         _inter_position = pvf.front()->inter_position ();
 187                         _inter_size = pvf.front()->inter_size ();
 188                 } catch (dcp::DCPReadError& e) {
 189                         /* This can happen on the following sequence of events:
 190                          * - load encrypted DCP
 191                          * - add KDM
 192                          * - DCP is examined again, which sets its "playable" flag to 1
 193                          * - as a side effect of the exam, the viewer is updated using the old pieces
 194                          * - the DCPDecoder in the old piece gives us an encrypted frame
 195                          * - then, the pieces are re-made (but too late).
 196                          *
 197                          * I hope there's a better way to handle this ...
 198                          */
 199                         _frame.reset ();
 200                         _position = p;
 201                 }
 202         } else {
 203                 _frame.reset ();
 204                 _position = p;
 205         }
 206
 207         set_position_text ();
 208         refresh_panel ();
 209
 210         _last_get_accurate = accurate;
 211 }
 212
 213 void
 214 FilmViewer::timer ()
 215 {
 216         get (_position + DCPTime::from_frames (1, _film->video_frame_rate ()), true);
 217
 218         DCPTime const len = _film->length ();
 219
 220         if (len.get ()) {
 221                 int const new_slider_position = 4096 * _position.get() / len.get();
 222                 if (new_slider_position != _slider->GetValue()) {
 223                         _slider->SetValue (new_slider_position);
 224                 }
 225         }
 226 }
 227
 228
 229 void
 230 FilmViewer::paint_panel ()
 231 {
 232         wxPaintDC dc (_panel);
 233
 234         if (!_frame || !_film || !_out_size.width || !_out_size.height) {
 235                 dc.Clear ();
 236                 return;
 237         }
 238
 239         wxImage frame (_out_size.width, _out_size.height, _frame->data()[0], true);
 240         wxBitmap frame_bitmap (frame);
 241         dc.DrawBitmap (frame_bitmap, 0, 0);
 242
 243         if (_out_size.width < _panel_size.width) {
 244                 wxPen p (GetBackgroundColour ());
 245                 wxBrush b (GetBackgroundColour ());
 246                 dc.SetPen (p);
 247                 dc.SetBrush (b);
 248                 dc.DrawRectangle (_out_size.width, 0, _panel_size.width - _out_size.width, _panel_size.height);
 249         }
 250
 251         if (_out_size.height < _panel_size.height) {
 252                 wxPen p (GetBackgroundColour ());
 253                 wxBrush b (GetBackgroundColour ());
 254                 dc.SetPen (p);
 255                 dc.SetBrush (b);
 256                 dc.DrawRectangle (0, _out_size.height, _panel_size.width, _panel_size.height - _out_size.height);
 257         }
 258
 259         if (_outline_content->GetValue ()) {
 260                 wxPen p (wxColour (255, 0, 0), 2);
 261                 dc.SetPen (p);
 262                 dc.SetBrush (*wxTRANSPARENT_BRUSH);
 263                 dc.DrawRectangle (_inter_position.x, _inter_position.y, _inter_size.width, _inter_size.height);
 264         }
 265 }
 266
 267 void
 268 FilmViewer::slider_moved ()
 269 {
 270         if (!_film) {
 271                 return;
 272         }
 273
 274         DCPTime t (_slider->GetValue() * _film->length().get() / 4096);
 275         /* Ensure that we hit the end of the film at the end of the slider */
 276         if (t >= _film->length ()) {
 277                 t = _film->length() - DCPTime::from_frames (1, _film->video_frame_rate ());
 278         }
 279         get (t, false);
 280 }
 281
 282 void
 283 FilmViewer::panel_sized (wxSizeEvent& ev)
 284 {
 285         _panel_size.width = ev.GetSize().GetWidth();
 286         _panel_size.height = ev.GetSize().GetHeight();
 287
 288         calculate_sizes ();
 289         get (_position, _last_get_accurate);
 290 }
 291
 292 void
 293 FilmViewer::calculate_sizes ()
 294 {
 295         if (!_film || !_player) {
 296                 return;
 297         }
 298
 299         Ratio const * container = _film->container ();
 300
 301         float const panel_ratio = _panel_size.ratio ();
 302         float const film_ratio = container ? container->ratio () : 1.78;
 303
 304         if (panel_ratio < film_ratio) {
 305                 /* panel is less widscreen than the film; clamp width */
 306                 _out_size.width = _panel_size.width;
 307                 _out_size.height = rint (_out_size.width / film_ratio);
 308         } else {
 309                 /* panel is more widescreen than the film; clamp height */
 310                 _out_size.height = _panel_size.height;
 311                 _out_size.width = rint (_out_size.height * film_ratio);
 312         }
 313
 314         /* Catch silly values */
 315         _out_size.width = max (64, _out_size.width);
 316         _out_size.height = max (64, _out_size.height);
 317
 318         /* The player will round its image size down to the next lowest 4 pixels
 319            to speed up its scale, so do similar here to avoid black borders
 320            around things.  This is a bit of a hack.
 321         */
 322         _out_size.width &= ~3;
 323         _out_size.height &= ~3;
 324
 325         _player->set_video_container_size (_out_size);
 326 }
 327
 328 void
 329 FilmViewer::play_clicked ()
 330 {
 331         check_play_state ();
 332 }
 333
 334 void
 335 FilmViewer::check_play_state ()
 336 {
 337         if (!_film || _film->video_frame_rate() == 0) {
 338                 return;
 339         }
 340
 341         if (_play_button->GetValue()) {
 342                 _timer.Start (1000 / _film->video_frame_rate());
 343         } else {
 344                 _timer.Stop ();
 345         }
 346 }
 347
 348 void
 349 FilmViewer::set_position_text ()
 350 {
 351         if (!_film) {
 352                 _frame_number->SetLabel ("0");
 353                 _timecode->SetLabel ("0:0:0.0");
 354                 return;
 355         }
 356
 357         double const fps = _film->video_frame_rate ();
 358         /* Count frame number from 1 ... not sure if this is the best idea */
 359         _frame_number->SetLabel (wxString::Format (wxT("%d"), int (rint (_position.seconds() * fps)) + 1));
 360
 361         double w = _position.seconds ();
 362         int const h = (w / 3600);
 363         w -= h * 3600;
 364         int const m = (w / 60);
 365         w -= m * 60;
 366         int const s = floor (w);
 367         w -= s;
 368         int const f = rint (w * fps);
 369         _timecode->SetLabel (wxString::Format (wxT("%02d:%02d:%02d.%02d"), h, m, s, f));
 370 }
 371
 372 void
 373 FilmViewer::active_jobs_changed (bool a)
 374 {
 375         if (a) {
 376                 list<shared_ptr<Job> > jobs = JobManager::instance()->get ();
 377                 list<shared_ptr<Job> >::iterator i = jobs.begin ();
 378                 while (i != jobs.end() && boost::dynamic_pointer_cast<ExamineContentJob> (*i) == 0) {
 379                         ++i;
 380                 }
 381
 382                 if (i == jobs.end() || (*i)->finished()) {
 383                         /* no examine content job running, so we're ok to use the viewer */
 384                         a = false;
 385                 }
 386         }
 387
 388         _slider->Enable (!a);
 389         _play_button->Enable (!a);
 390 }
 391
 392 void
 393 FilmViewer::back_clicked ()
 394 {
 395         DCPTime p = _position - DCPTime::from_frames (1, _film->video_frame_rate ());
 396         if (p < DCPTime ()) {
 397                 p = DCPTime ();
 398         }
 399
 400         get (p, true);
 401 }
 402
 403 void
 404 FilmViewer::forward_clicked ()
 405 {
 406         get (_position + DCPTime::from_frames (1, _film->video_frame_rate ()), true);
 407 }
 408
 409 void
 410 FilmViewer::player_changed (bool frequent)
 411 {
 412         if (frequent) {
 413                 return;
 414         }
 415
 416         calculate_sizes ();
 417         get (_position, _last_get_accurate);
 418 }
 419
 420 void
 421 FilmViewer::setup_sensitivity ()
 422 {
 423         bool const c = _film && !_film->content().empty ();
 424
 425         _slider->Enable (c);
 426         _back_button->Enable (c);
 427         _forward_button->Enable (c);
 428         _play_button->Enable (c);
 429         _outline_content->Enable (c);
 430         _frame_number->Enable (c);
 431         _timecode->Enable (c);
 432 }
 433
 434 void
 435 FilmViewer::film_changed (Film::Property p)
 436 {
 437         if (p == Film::CONTENT) {
 438                 setup_sensitivity ();
 439         }
 440 }