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