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 <iostream>
  25 #include <iomanip>
  26 #include <wx/tglbtn.h>
  27 #include <dcp/exceptions.h>
  28 #include "lib/film.h"
  29 #include "lib/ratio.h"
  30 #include "lib/util.h"
  31 #include "lib/job_manager.h"
  32 #include "lib/image.h"
  33 #include "lib/scaler.h"
  34 #include "lib/exceptions.h"
  35 #include "lib/examine_content_job.h"
  36 #include "lib/filter.h"
  37 #include "lib/player.h"
  38 #include "lib/player_video.h"
  39 #include "lib/video_content.h"
  40 #include "lib/video_decoder.h"
  41 #include "lib/timer.h"
  42 #include "film_viewer.h"
  43 #include "wx_util.h"
  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 boost::shared_ptr;
  54 using boost::dynamic_pointer_cast;
  55 using boost::weak_ptr;
  56 using dcp::Size;
  57
  58 FilmViewer::FilmViewer (shared_ptr<Film> f, wxWindow* p)
  59         : wxPanel (p)
  60         , _panel (new wxPanel (this))
  61         , _outline_content (new wxCheckBox (this, wxID_ANY, _("Outline content")))
  62         , _slider (new wxSlider (this, wxID_ANY, 0, 0, 4096))
  63         , _back_button (new wxButton (this, wxID_ANY, wxT("<")))
  64         , _forward_button (new wxButton (this, wxID_ANY, wxT(">")))
  65         , _frame_number (new wxStaticText (this, wxID_ANY, wxT("")))
  66         , _timecode (new wxStaticText (this, wxID_ANY, wxT("")))
  67         , _play_button (new wxToggleButton (this, wxID_ANY, _("Play")))
  68         , _last_get_accurate (true)
  69 {
  70 #ifndef __WXOSX__
  71         _panel->SetDoubleBuffered (true);
  72 #endif
  73
  74         _panel->SetBackgroundStyle (wxBG_STYLE_PAINT);
  75
  76         _v_sizer = new wxBoxSizer (wxVERTICAL);
  77         SetSizer (_v_sizer);
  78
  79         _v_sizer->Add (_panel, 1, wxEXPAND);
  80
  81         _v_sizer->Add (_outline_content, 0, wxALL, DCPOMATIC_SIZER_GAP);
  82
  83         wxBoxSizer* h_sizer = new wxBoxSizer (wxHORIZONTAL);
  84
  85         wxBoxSizer* time_sizer = new wxBoxSizer (wxVERTICAL);
  86         time_sizer->Add (_frame_number, 0, wxEXPAND);
  87         time_sizer->Add (_timecode, 0, wxEXPAND);
  88
  89         h_sizer->Add (_back_button, 0, wxALL, 2);
  90         h_sizer->Add (time_sizer, 0, wxEXPAND);
  91         h_sizer->Add (_forward_button, 0, wxALL, 2);
  92         h_sizer->Add (_play_button, 0, wxEXPAND);
  93         h_sizer->Add (_slider, 1, wxEXPAND);
  94
  95         _v_sizer->Add (h_sizer, 0, wxEXPAND | wxALL, 6);
  96
  97         _frame_number->SetMinSize (wxSize (84, -1));
  98         _back_button->SetMinSize (wxSize (32, -1));
  99         _forward_button->SetMinSize (wxSize (32, -1));
 100
 101         _panel->Bind          (wxEVT_PAINT,                        boost::bind (&FilmViewer::paint_panel,     this));
 102         _panel->Bind          (wxEVT_SIZE,                         boost::bind (&FilmViewer::panel_sized,     this, _1));
 103         _outline_content->Bind(wxEVT_COMMAND_CHECKBOX_CLICKED,     boost::bind (&FilmViewer::refresh_panel,   this));
 104         _slider->Bind         (wxEVT_SCROLL_THUMBTRACK,            boost::bind (&FilmViewer::slider_moved,    this));
 105         _slider->Bind         (wxEVT_SCROLL_PAGEUP,                boost::bind (&FilmViewer::slider_moved,    this));
 106         _slider->Bind         (wxEVT_SCROLL_PAGEDOWN,              boost::bind (&FilmViewer::slider_moved,    this));
 107         _play_button->Bind    (wxEVT_COMMAND_TOGGLEBUTTON_CLICKED, boost::bind (&FilmViewer::play_clicked,    this));
 108         _timer.Bind           (wxEVT_TIMER,                        boost::bind (&FilmViewer::timer,           this));
 109         _back_button->Bind    (wxEVT_COMMAND_BUTTON_CLICKED,       boost::bind (&FilmViewer::back_clicked,    this));
 110         _forward_button->Bind (wxEVT_COMMAND_BUTTON_CLICKED,       boost::bind (&FilmViewer::forward_clicked, this));
 111
 112         set_film (f);
 113
 114         JobManager::instance()->ActiveJobsChanged.connect (
 115                 bind (&FilmViewer::active_jobs_changed, this, _1)
 116                 );
 117 }
 118
 119 void
 120 FilmViewer::set_film (shared_ptr<Film> f)
 121 {
 122         if (_film == f) {
 123                 return;
 124         }
 125
 126         _film = f;
 127
 128         _frame.reset ();
 129
 130         _slider->SetValue (0);
 131         set_position_text ();
 132
 133         if (!_film) {
 134                 return;
 135         }
 136
 137         try {
 138                 _player = f->make_player ();
 139         } catch (bad_alloc) {
 140                 error_dialog (this, _("There is not enough free memory to do that."));
 141                 _film.reset ();
 142                 return;
 143         }
 144
 145         _player->set_approximate_size ();
 146         _player->Changed.connect (boost::bind (&FilmViewer::player_changed, this, _1));
 147
 148         calculate_sizes ();
 149         get (_position, _last_get_accurate);
 150 }
 151
 152 void
 153 FilmViewer::refresh_panel ()
 154 {
 155         _panel->Refresh ();
 156         _panel->Update ();
 157 }
 158
 159 void
 160 FilmViewer::get (DCPTime p, bool accurate)
 161 {
 162         if (!_player) {
 163                 return;
 164         }
 165
 166         list<shared_ptr<PlayerVideo> > pvf = _player->get_video (p, accurate);
 167         if (!pvf.empty ()) {
 168                 try {
 169                         _frame = pvf.front()->image (true);
 170                         _frame = _frame->scale (_frame->size(), Scaler::from_id ("fastbilinear"), PIX_FMT_RGB24, false);
 171                         _position = pvf.front()->time ();
 172                         _inter_position = pvf.front()->inter_position ();
 173                         _inter_size = pvf.front()->inter_size ();
 174                 } catch (dcp::DCPReadError& e) {
 175                         /* This can happen on the following sequence of events:
 176                          * - load encrypted DCP
 177                          * - add KDM
 178                          * - DCP is examined again, which sets its "playable" flag to 1
 179                          * - as a side effect of the exam, the viewer is updated using the old pieces
 180                          * - the DCPDecoder in the old piece gives us an encrypted frame
 181                          * - then, the pieces are re-made (but too late).
 182                          *
 183                          * I hope there's a better way to handle this ...
 184                          */
 185                         _frame.reset ();
 186                         _position = p;
 187                 }
 188         } else {
 189                 _frame.reset ();
 190                 _position = p;
 191         }
 192
 193         set_position_text ();
 194         refresh_panel ();
 195
 196         _last_get_accurate = accurate;
 197 }
 198
 199 void
 200 FilmViewer::timer ()
 201 {
 202         get (_position + DCPTime::from_frames (1, _film->video_frame_rate ()), true);
 203
 204         DCPTime const len = _film->length ();
 205
 206         if (len.get ()) {
 207                 int const new_slider_position = 4096 * _position.get() / len.get();
 208                 if (new_slider_position != _slider->GetValue()) {
 209                         _slider->SetValue (new_slider_position);
 210                 }
 211         }
 212 }
 213
 214
 215 void
 216 FilmViewer::paint_panel ()
 217 {
 218         wxPaintDC dc (_panel);
 219
 220         if (!_frame || !_film || !_out_size.width || !_out_size.height) {
 221                 dc.Clear ();
 222                 return;
 223         }
 224
 225         wxImage frame (_out_size.width, _out_size.height, _frame->data()[0], true);
 226         wxBitmap frame_bitmap (frame);
 227         dc.DrawBitmap (frame_bitmap, 0, 0);
 228
 229         if (_out_size.width < _panel_size.width) {
 230                 wxPen p (GetBackgroundColour ());
 231                 wxBrush b (GetBackgroundColour ());
 232                 dc.SetPen (p);
 233                 dc.SetBrush (b);
 234                 dc.DrawRectangle (_out_size.width, 0, _panel_size.width - _out_size.width, _panel_size.height);
 235         }
 236
 237         if (_out_size.height < _panel_size.height) {
 238                 wxPen p (GetBackgroundColour ());
 239                 wxBrush b (GetBackgroundColour ());
 240                 dc.SetPen (p);
 241                 dc.SetBrush (b);
 242                 dc.DrawRectangle (0, _out_size.height, _panel_size.width, _panel_size.height - _out_size.height);
 243         }
 244
 245         if (_outline_content->GetValue ()) {
 246                 wxPen p (wxColour (255, 0, 0), 2);
 247                 dc.SetPen (p);
 248                 dc.SetBrush (*wxTRANSPARENT_BRUSH);
 249                 dc.DrawRectangle (_inter_position.x, _inter_position.y, _inter_size.width, _inter_size.height);
 250         }
 251 }
 252
 253 void
 254 FilmViewer::slider_moved ()
 255 {
 256         if (!_film) {
 257                 return;
 258         }
 259
 260         DCPTime t (_slider->GetValue() * _film->length().get() / 4096);
 261         /* Ensure that we hit the end of the film at the end of the slider */
 262         if (t >= _film->length ()) {
 263                 t = _film->length() - DCPTime::from_frames (1, _film->video_frame_rate ());
 264         }
 265         get (t, false);
 266 }
 267
 268 void
 269 FilmViewer::panel_sized (wxSizeEvent& ev)
 270 {
 271         _panel_size.width = ev.GetSize().GetWidth();
 272         _panel_size.height = ev.GetSize().GetHeight();
 273
 274         calculate_sizes ();
 275         get (_position, _last_get_accurate);
 276 }
 277
 278 void
 279 FilmViewer::calculate_sizes ()
 280 {
 281         if (!_film || !_player) {
 282                 return;
 283         }
 284
 285         Ratio const * container = _film->container ();
 286
 287         float const panel_ratio = _panel_size.ratio ();
 288         float const film_ratio = container ? container->ratio () : 1.78;
 289
 290         if (panel_ratio < film_ratio) {
 291                 /* panel is less widscreen than the film; clamp width */
 292                 _out_size.width = _panel_size.width;
 293                 _out_size.height = rint (_out_size.width / film_ratio);
 294         } else {
 295                 /* panel is more widescreen than the film; clamp height */
 296                 _out_size.height = _panel_size.height;
 297                 _out_size.width = rint (_out_size.height * film_ratio);
 298         }
 299
 300         /* Catch silly values */
 301         _out_size.width = max (64, _out_size.width);
 302         _out_size.height = max (64, _out_size.height);
 303
 304         /* The player will round its image size down to the next lowest 4 pixels
 305            to speed up its scale, so do similar here to avoid black borders
 306            around things.  This is a bit of a hack.
 307         */
 308         _out_size.width &= ~3;
 309         _out_size.height &= ~3;
 310
 311         _player->set_video_container_size (_out_size);
 312 }
 313
 314 void
 315 FilmViewer::play_clicked ()
 316 {
 317         check_play_state ();
 318 }
 319
 320 void
 321 FilmViewer::check_play_state ()
 322 {
 323         if (!_film || _film->video_frame_rate() == 0) {
 324                 return;
 325         }
 326
 327         if (_play_button->GetValue()) {
 328                 _timer.Start (1000 / _film->video_frame_rate());
 329         } else {
 330                 _timer.Stop ();
 331         }
 332 }
 333
 334 void
 335 FilmViewer::set_position_text ()
 336 {
 337         if (!_film) {
 338                 _frame_number->SetLabel ("0");
 339                 _timecode->SetLabel ("0:0:0.0");
 340                 return;
 341         }
 342
 343         double const fps = _film->video_frame_rate ();
 344         /* Count frame number from 1 ... not sure if this is the best idea */
 345         _frame_number->SetLabel (wxString::Format (wxT("%d"), int (rint (_position.seconds() * fps)) + 1));
 346
 347         double w = _position.seconds ();
 348         int const h = (w / 3600);
 349         w -= h * 3600;
 350         int const m = (w / 60);
 351         w -= m * 60;
 352         int const s = floor (w);
 353         w -= s;
 354         int const f = rint (w * fps);
 355         _timecode->SetLabel (wxString::Format (wxT("%02d:%02d:%02d.%02d"), h, m, s, f));
 356 }
 357
 358 void
 359 FilmViewer::active_jobs_changed (bool a)
 360 {
 361         if (a) {
 362                 list<shared_ptr<Job> > jobs = JobManager::instance()->get ();
 363                 list<shared_ptr<Job> >::iterator i = jobs.begin ();
 364                 while (i != jobs.end() && boost::dynamic_pointer_cast<ExamineContentJob> (*i) == 0) {
 365                         ++i;
 366                 }
 367
 368                 if (i == jobs.end() || (*i)->finished()) {
 369                         /* no examine content job running, so we're ok to use the viewer */
 370                         a = false;
 371                 }
 372         }
 373
 374         _slider->Enable (!a);
 375         _play_button->Enable (!a);
 376 }
 377
 378 void
 379 FilmViewer::back_clicked ()
 380 {
 381         DCPTime p = _position - DCPTime::from_frames (1, _film->video_frame_rate ());
 382         if (p < DCPTime ()) {
 383                 p = DCPTime ();
 384         }
 385
 386         get (p, true);
 387 }
 388
 389 void
 390 FilmViewer::forward_clicked ()
 391 {
 392         get (_position + DCPTime::from_frames (1, _film->video_frame_rate ()), true);
 393 }
 394
 395 void
 396 FilmViewer::player_changed (bool frequent)
 397 {
 398         if (frequent) {
 399                 return;
 400         }
 401
 402         calculate_sizes ();
 403         get (_position, _last_get_accurate);
 404 }