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 "lib/film.h"
  28 #include "lib/ratio.h"
  29 #include "lib/util.h"
  30 #include "lib/job_manager.h"
  31 #include "lib/image.h"
  32 #include "lib/scaler.h"
  33 #include "lib/exceptions.h"
  34 #include "lib/examine_content_job.h"
  35 #include "lib/filter.h"
  36 #include "lib/player.h"
  37 #include "lib/video_content.h"
  38 #include "lib/video_decoder.h"
  39 #include "lib/timer.h"
  40 #include "film_viewer.h"
  41 #include "wx_util.h"
  42
  43 using std::string;
  44 using std::pair;
  45 using std::min;
  46 using std::max;
  47 using std::cout;
  48 using std::list;
  49 using std::bad_alloc;
  50 using std::make_pair;
  51 using boost::shared_ptr;
  52 using boost::dynamic_pointer_cast;
  53 using boost::weak_ptr;
  54 using dcp::Size;
  55
  56 FilmViewer::FilmViewer (shared_ptr<Film> f, wxWindow* p)
  57         : wxPanel (p)
  58         , _panel (new wxPanel (this))
  59         , _slider (new wxSlider (this, wxID_ANY, 0, 0, 4096))
  60         , _back_button (new wxButton (this, wxID_ANY, wxT("<")))
  61         , _forward_button (new wxButton (this, wxID_ANY, wxT(">")))
  62         , _frame_number (new wxStaticText (this, wxID_ANY, wxT("")))
  63         , _timecode (new wxStaticText (this, wxID_ANY, wxT("")))
  64         , _play_button (new wxToggleButton (this, wxID_ANY, _("Play")))
  65         , _got_frame (false)
  66 {
  67 #ifndef __WXOSX__
  68         _panel->SetDoubleBuffered (true);
  69 #endif
  70
  71         _panel->SetBackgroundStyle (wxBG_STYLE_PAINT);
  72
  73         _v_sizer = new wxBoxSizer (wxVERTICAL);
  74         SetSizer (_v_sizer);
  75
  76         _v_sizer->Add (_panel, 1, wxEXPAND);
  77
  78         wxBoxSizer* h_sizer = new wxBoxSizer (wxHORIZONTAL);
  79
  80         wxBoxSizer* time_sizer = new wxBoxSizer (wxVERTICAL);
  81         time_sizer->Add (_frame_number, 0, wxEXPAND);
  82         time_sizer->Add (_timecode, 0, wxEXPAND);
  83
  84         h_sizer->Add (_back_button, 0, wxALL, 2);
  85         h_sizer->Add (time_sizer, 0, wxEXPAND);
  86         h_sizer->Add (_forward_button, 0, wxALL, 2);
  87         h_sizer->Add (_play_button, 0, wxEXPAND);
  88         h_sizer->Add (_slider, 1, wxEXPAND);
  89
  90         _v_sizer->Add (h_sizer, 0, wxEXPAND | wxALL, 6);
  91
  92         _frame_number->SetMinSize (wxSize (84, -1));
  93         _back_button->SetMinSize (wxSize (32, -1));
  94         _forward_button->SetMinSize (wxSize (32, -1));
  95
  96         _panel->Bind          (wxEVT_PAINT,                        boost::bind (&FilmViewer::paint_panel,     this));
  97         _panel->Bind          (wxEVT_SIZE,                         boost::bind (&FilmViewer::panel_sized,     this, _1));
  98         _slider->Bind         (wxEVT_SCROLL_THUMBTRACK,            boost::bind (&FilmViewer::slider_moved,    this));
  99         _slider->Bind         (wxEVT_SCROLL_PAGEUP,                boost::bind (&FilmViewer::slider_moved,    this));
 100         _slider->Bind         (wxEVT_SCROLL_PAGEDOWN,              boost::bind (&FilmViewer::slider_moved,    this));
 101         _play_button->Bind    (wxEVT_COMMAND_TOGGLEBUTTON_CLICKED, boost::bind (&FilmViewer::play_clicked,    this));
 102         _timer.Bind           (wxEVT_TIMER,                        boost::bind (&FilmViewer::timer,           this));
 103         _back_button->Bind    (wxEVT_COMMAND_BUTTON_CLICKED,       boost::bind (&FilmViewer::back_clicked,    this));
 104         _forward_button->Bind (wxEVT_COMMAND_BUTTON_CLICKED,       boost::bind (&FilmViewer::forward_clicked, this));
 105
 106         set_film (f);
 107
 108         JobManager::instance()->ActiveJobsChanged.connect (
 109                 bind (&FilmViewer::active_jobs_changed, this, _1)
 110                 );
 111 }
 112
 113 void
 114 FilmViewer::set_film (shared_ptr<Film> f)
 115 {
 116         if (_film == f) {
 117                 return;
 118         }
 119
 120         _film = f;
 121
 122         _frame.reset ();
 123
 124         _slider->SetValue (0);
 125         set_position_text (DCPTime ());
 126
 127         if (!_film) {
 128                 return;
 129         }
 130
 131         try {
 132                 _player = f->make_player ();
 133         } catch (bad_alloc) {
 134                 error_dialog (this, _("There is not enough free memory to do that."));
 135                 _film.reset ();
 136                 return;
 137         }
 138
 139         _player->disable_audio ();
 140         _player->set_approximate_size ();
 141         _player->Video.connect (boost::bind (&FilmViewer::process_video, this, _1, _2, _5));
 142         _player->Changed.connect (boost::bind (&FilmViewer::player_changed, this, _1));
 143
 144         calculate_sizes ();
 145         fetch_next_frame ();
 146 }
 147
 148 void
 149 FilmViewer::fetch_current_frame_again ()
 150 {
 151         if (!_player) {
 152                 return;
 153         }
 154
 155         /* We could do this with a seek and a fetch_next_frame, but this is
 156            a shortcut to make it quicker.
 157         */
 158
 159         _got_frame = false;
 160         if (!_player->repeat_last_video ()) {
 161                 fetch_next_frame ();
 162         }
 163
 164         _panel->Refresh ();
 165         _panel->Update ();
 166 }
 167
 168 void
 169 FilmViewer::timer ()
 170 {
 171         if (!_player) {
 172                 return;
 173         }
 174
 175         fetch_next_frame ();
 176
 177         DCPTime const len = _film->length ();
 178
 179         if (len.get ()) {
 180                 int const new_slider_position = 4096 * _player->video_position().get() / len.get();
 181                 if (new_slider_position != _slider->GetValue()) {
 182                         _slider->SetValue (new_slider_position);
 183                 }
 184         }
 185 }
 186
 187
 188 void
 189 FilmViewer::paint_panel ()
 190 {
 191         wxPaintDC dc (_panel);
 192
 193         if (!_frame || !_film || !_out_size.width || !_out_size.height) {
 194                 dc.Clear ();
 195                 return;
 196         }
 197
 198         wxImage frame (_out_size.width, _out_size.height, _frame->data()[0], true);
 199         wxBitmap frame_bitmap (frame);
 200         dc.DrawBitmap (frame_bitmap, 0, 0);
 201
 202         if (_out_size.width < _panel_size.width) {
 203                 wxPen p (GetBackgroundColour ());
 204                 wxBrush b (GetBackgroundColour ());
 205                 dc.SetPen (p);
 206                 dc.SetBrush (b);
 207                 dc.DrawRectangle (_out_size.width, 0, _panel_size.width - _out_size.width, _panel_size.height);
 208         }
 209
 210         if (_out_size.height < _panel_size.height) {
 211                 wxPen p (GetBackgroundColour ());
 212                 wxBrush b (GetBackgroundColour ());
 213                 dc.SetPen (p);
 214                 dc.SetBrush (b);
 215                 dc.DrawRectangle (0, _out_size.height, _panel_size.width, _panel_size.height - _out_size.height);
 216         }
 217 }
 218
 219
 220 void
 221 FilmViewer::slider_moved ()
 222 {
 223         if (_film && _player) {
 224                 try {
 225                         Time t = _slider->GetValue() * _film->length() / 4096;
 226                         /* Ensure that we hit the end of the film at the end of the slider */
 227                         if (t >= _film->length ()) {
 228                                 t = _film->length() - _film->video_frames_to_time (1);
 229                         }
 230                         _player->seek (DCPTime (_film->length().get() * _slider->GetValue() / 4096), false);
 231                         fetch_next_frame ();
 232                 } catch (OpenFileError& e) {
 233                         /* There was a problem opening a content file; we'll let this slide as it
 234                            probably means a missing content file, which we're already taking care of.
 235                         */
 236                 }
 237         }
 238 }
 239
 240 void
 241 FilmViewer::panel_sized (wxSizeEvent& ev)
 242 {
 243         _panel_size.width = ev.GetSize().GetWidth();
 244         _panel_size.height = ev.GetSize().GetHeight();
 245         calculate_sizes ();
 246         fetch_current_frame_again ();
 247 }
 248
 249 void
 250 FilmViewer::calculate_sizes ()
 251 {
 252         if (!_film || !_player) {
 253                 return;
 254         }
 255
 256         Ratio const * container = _film->container ();
 257
 258         float const panel_ratio = _panel_size.ratio ();
 259         float const film_ratio = container ? container->ratio () : 1.78;
 260
 261         if (panel_ratio < film_ratio) {
 262                 /* panel is less widscreen than the film; clamp width */
 263                 _out_size.width = _panel_size.width;
 264                 _out_size.height = _out_size.width / film_ratio;
 265         } else {
 266                 /* panel is more widescreen than the film; clamp height */
 267                 _out_size.height = _panel_size.height;
 268                 _out_size.width = _out_size.height * film_ratio;
 269         }
 270
 271         /* Catch silly values */
 272         _out_size.width = max (64, _out_size.width);
 273         _out_size.height = max (64, _out_size.height);
 274
 275         /* The player will round its image down to the nearest 4 pixels
 276            to speed up its scale, so do similar here to avoid black borders
 277            around things.  This is a bit of a hack.
 278         */
 279         _out_size.width &= ~3;
 280         _out_size.height &= ~3;
 281
 282         _player->set_video_container_size (_out_size);
 283 }
 284
 285 void
 286 FilmViewer::play_clicked ()
 287 {
 288         check_play_state ();
 289 }
 290
 291 void
 292 FilmViewer::check_play_state ()
 293 {
 294         if (!_film || _film->video_frame_rate() == 0) {
 295                 return;
 296         }
 297
 298         if (_play_button->GetValue()) {
 299                 _timer.Start (1000 / _film->video_frame_rate());
 300         } else {
 301                 _timer.Stop ();
 302         }
 303 }
 304
 305 void
 306 FilmViewer::process_video (shared_ptr<PlayerImage> image, Eyes eyes, DCPTime t)
 307 {
 308         if (eyes == EYES_RIGHT) {
 309                 return;
 310         }
 311
 312         /* Going via BGRA here makes the scaler faster then using RGB24 directly (about
 313            twice on x86 Linux).
 314         */
 315         shared_ptr<Image> im = image->image (PIX_FMT_BGRA, true);
 316         _frame = im->scale (im->size(), Scaler::from_id ("fastbilinear"), PIX_FMT_RGB24, false);
 317         _got_frame = true;
 318
 319         set_position_text (t);
 320 }
 321
 322 void
 323 FilmViewer::set_position_text (DCPTime t)
 324 {
 325         if (!_film) {
 326                 _frame_number->SetLabel ("0");
 327                 _timecode->SetLabel ("0:0:0.0");
 328                 return;
 329         }
 330
 331         double const fps = _film->video_frame_rate ();
 332         /* Count frame number from 1 ... not sure if this is the best idea */
 333         _frame_number->SetLabel (wxString::Format (wxT("%d"), int (rint (t.seconds() * fps)) + 1));
 334
 335         double w = t.seconds ();
 336         int const h = (w / 3600);
 337         w -= h * 3600;
 338         int const m = (w / 60);
 339         w -= m * 60;
 340         int const s = floor (w);
 341         w -= s;
 342         int const f = rint (w * fps);
 343         _timecode->SetLabel (wxString::Format (wxT("%02d:%02d:%02d.%02d"), h, m, s, f));
 344 }
 345
 346 /** Ask the player to emit its next frame, then update our display */
 347 void
 348 FilmViewer::fetch_next_frame ()
 349 {
 350         /* Clear our frame in case we don't get a new one */
 351         _frame.reset ();
 352
 353         if (!_player) {
 354                 return;
 355         }
 356
 357         _got_frame = false;
 358
 359         try {
 360                 while (!_got_frame && !_player->pass ()) {}
 361         } catch (DecodeError& e) {
 362                 _play_button->SetValue (false);
 363                 check_play_state ();
 364                 error_dialog (this, wxString::Format (_("Could not decode video for view (%s)"), std_to_wx(e.what()).data()));
 365         } catch (OpenFileError& e) {
 366                 /* There was a problem opening a content file; we'll let this slide as it
 367                    probably means a missing content file, which we're already taking care of.
 368                 */
 369         }
 370
 371         _panel->Refresh ();
 372         _panel->Update ();
 373 }
 374
 375 void
 376 FilmViewer::active_jobs_changed (bool a)
 377 {
 378         if (a) {
 379                 list<shared_ptr<Job> > jobs = JobManager::instance()->get ();
 380                 list<shared_ptr<Job> >::iterator i = jobs.begin ();
 381                 while (i != jobs.end() && boost::dynamic_pointer_cast<ExamineContentJob> (*i) == 0) {
 382                         ++i;
 383                 }
 384
 385                 if (i == jobs.end() || (*i)->finished()) {
 386                         /* no examine content job running, so we're ok to use the viewer */
 387                         a = false;
 388                 }
 389         }
 390
 391         _slider->Enable (!a);
 392         _play_button->Enable (!a);
 393 }
 394
 395 void
 396 FilmViewer::back_clicked ()
 397 {
 398         if (!_player) {
 399                 return;
 400         }
 401
 402         /* Player::video_position is the time after the last frame that we received.
 403            We want to see the one before it, so we need to go back 2.
 404         */
 405
 406         DCPTime p = _player->video_position() - DCPTime::from_frames (2, _film->video_frame_rate ());
 407         if (p < DCPTime ()) {
 408                 p = DCPTime ();
 409         }
 410
 411         try {
 412                 _player->seek (p, true);
 413                 fetch_next_frame ();
 414         } catch (OpenFileError& e) {
 415                 /* There was a problem opening a content file; we'll let this slide as it
 416                    probably means a missing content file, which we're already taking care of.
 417                 */
 418         }
 419 }
 420
 421 void
 422 FilmViewer::forward_clicked ()
 423 {
 424         if (!_player) {
 425                 return;
 426         }
 427
 428         fetch_next_frame ();
 429 }
 430
 431 void
 432 FilmViewer::player_changed (bool frequent)
 433 {
 434         if (frequent) {
 435                 return;
 436         }
 437
 438         calculate_sizes ();
 439         fetch_current_frame_again ();
 440 }