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