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