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