src/wx/film_viewer.cc

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