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/player_video_frame.h"
  38 #include "lib/video_content.h"
  39 #include "lib/video_decoder.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 libdcp::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 (0);
 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->Video.connect (boost::bind (&FilmViewer::process_video, this, _1, _3));
 141         _player->Changed.connect (boost::bind (&FilmViewer::player_changed, this, _1));
 142
 143         calculate_sizes ();
 144         fetch_next_frame ();
 145 }
 146
 147 void
 148 FilmViewer::fetch_current_frame_again ()
 149 {
 150         if (!_player) {
 151                 return;
 152         }
 153
 154         /* We could do this with a seek and a fetch_next_frame, but this is
 155            a shortcut to make it quicker.
 156         */
 157
 158         _got_frame = false;
 159         if (!_player->repeat_last_video ()) {
 160                 fetch_next_frame ();
 161         }
 162
 163         _panel->Refresh ();
 164         _panel->Update ();
 165 }
 166
 167 void
 168 FilmViewer::timer ()
 169 {
 170         if (!_player) {
 171                 return;
 172         }
 173
 174         fetch_next_frame ();
 175
 176         Time const len = _film->length ();
 177
 178         if (len) {
 179                 int const new_slider_position = 4096 * _player->video_position() / len;
 180                 if (new_slider_position != _slider->GetValue()) {
 181                         _slider->SetValue (new_slider_position);
 182                 }
 183         }
 184 }
 185
 186
 187 void
 188 FilmViewer::paint_panel ()
 189 {
 190         wxPaintDC dc (_panel);
 191
 192         if (!_frame || !_film || !_out_size.width || !_out_size.height) {
 193                 dc.Clear ();
 194                 return;
 195         }
 196
 197         wxImage frame (_out_size.width, _out_size.height, _frame->data()[0], true);
 198         wxBitmap frame_bitmap (frame);
 199         dc.DrawBitmap (frame_bitmap, 0, 0);
 200
 201         if (_out_size.width < _panel_size.width) {
 202                 wxPen p (GetBackgroundColour ());
 203                 wxBrush b (GetBackgroundColour ());
 204                 dc.SetPen (p);
 205                 dc.SetBrush (b);
 206                 dc.DrawRectangle (_out_size.width, 0, _panel_size.width - _out_size.width, _panel_size.height);
 207         }
 208
 209         if (_out_size.height < _panel_size.height) {
 210                 wxPen p (GetBackgroundColour ());
 211                 wxBrush b (GetBackgroundColour ());
 212                 dc.SetPen (p);
 213                 dc.SetBrush (b);
 214                 dc.DrawRectangle (0, _out_size.height, _panel_size.width, _panel_size.height - _out_size.height);
 215         }
 216 }
 217
 218
 219 void
 220 FilmViewer::slider_moved ()
 221 {
 222         if (_film && _player) {
 223                 Time t = _slider->GetValue() * _film->length() / 4096;
 224                 /* Ensure that we hit the end of the film at the end of the slider */
 225                 if (t >= _film->length ()) {
 226                         t = _film->length() - _film->video_frames_to_time (1);
 227                 }
 228                 _player->seek (t, false);
 229                 fetch_next_frame ();
 230         }
 231 }
 232
 233 void
 234 FilmViewer::panel_sized (wxSizeEvent& ev)
 235 {
 236         _panel_size.width = ev.GetSize().GetWidth();
 237         _panel_size.height = ev.GetSize().GetHeight();
 238         calculate_sizes ();
 239         fetch_current_frame_again ();
 240 }
 241
 242 void
 243 FilmViewer::calculate_sizes ()
 244 {
 245         if (!_film || !_player) {
 246                 return;
 247         }
 248
 249         Ratio const * container = _film->container ();
 250
 251         float const panel_ratio = _panel_size.ratio ();
 252         float const film_ratio = container ? container->ratio () : 1.78;
 253
 254         if (panel_ratio < film_ratio) {
 255                 /* panel is less widscreen than the film; clamp width */
 256                 _out_size.width = _panel_size.width;
 257                 _out_size.height = _out_size.width / film_ratio;
 258         } else {
 259                 /* panel is more widescreen than the film; clamp height */
 260                 _out_size.height = _panel_size.height;
 261                 _out_size.width = _out_size.height * film_ratio;
 262         }
 263
 264         /* Catch silly values */
 265         _out_size.width = max (64, _out_size.width);
 266         _out_size.height = max (64, _out_size.height);
 267
 268         _player->set_video_container_size (_out_size);
 269 }
 270
 271 void
 272 FilmViewer::play_clicked ()
 273 {
 274         check_play_state ();
 275 }
 276
 277 void
 278 FilmViewer::check_play_state ()
 279 {
 280         if (!_film || _film->video_frame_rate() == 0) {
 281                 return;
 282         }
 283
 284         if (_play_button->GetValue()) {
 285                 _timer.Start (1000 / _film->video_frame_rate());
 286         } else {
 287                 _timer.Stop ();
 288         }
 289 }
 290
 291 void
 292 FilmViewer::process_video (shared_ptr<PlayerVideoFrame> pvf, Time t)
 293 {
 294         if (pvf->eyes() == EYES_RIGHT) {
 295                 return;
 296         }
 297
 298         _frame = pvf->image ();
 299         _got_frame = true;
 300
 301         set_position_text (t);
 302 }
 303
 304 void
 305 FilmViewer::set_position_text (Time t)
 306 {
 307         if (!_film) {
 308                 _frame_number->SetLabel ("0");
 309                 _timecode->SetLabel ("0:0:0.0");
 310                 return;
 311         }
 312
 313         double const fps = _film->video_frame_rate ();
 314         /* Count frame number from 1 ... not sure if this is the best idea */
 315         _frame_number->SetLabel (wxString::Format (wxT("%d"), int (rint (t * fps / TIME_HZ)) + 1));
 316
 317         double w = static_cast<double>(t) / TIME_HZ;
 318         int const h = (w / 3600);
 319         w -= h * 3600;
 320         int const m = (w / 60);
 321         w -= m * 60;
 322         int const s = floor (w);
 323         w -= s;
 324         int const f = rint (w * fps);
 325         _timecode->SetLabel (wxString::Format (wxT("%02d:%02d:%02d.%02d"), h, m, s, f));
 326 }
 327
 328 /** Ask the player to emit its next frame, then update our display */
 329 void
 330 FilmViewer::fetch_next_frame ()
 331 {
 332         /* Clear our frame in case we don't get a new one */
 333         _frame.reset ();
 334
 335         if (!_player) {
 336                 return;
 337         }
 338
 339         _got_frame = false;
 340
 341         try {
 342                 while (!_got_frame && !_player->pass ()) {}
 343         } catch (DecodeError& e) {
 344                 _play_button->SetValue (false);
 345                 check_play_state ();
 346                 error_dialog (this, wxString::Format (_("Could not decode video for view (%s)"), std_to_wx(e.what()).data()));
 347         } catch (OpenFileError& e) {
 348                 /* There was a problem opening a content file; we'll let this slide as it
 349                    probably means a missing content file, which we're already taking care of.
 350                 */
 351         }
 352
 353         _panel->Refresh ();
 354         _panel->Update ();
 355 }
 356
 357 void
 358 FilmViewer::active_jobs_changed (bool a)
 359 {
 360         if (a) {
 361                 list<shared_ptr<Job> > jobs = JobManager::instance()->get ();
 362                 list<shared_ptr<Job> >::iterator i = jobs.begin ();
 363                 while (i != jobs.end() && boost::dynamic_pointer_cast<ExamineContentJob> (*i) == 0) {
 364                         ++i;
 365                 }
 366
 367                 if (i == jobs.end() || (*i)->finished()) {
 368                         /* no examine content job running, so we're ok to use the viewer */
 369                         a = false;
 370                 }
 371         }
 372
 373         _slider->Enable (!a);
 374         _play_button->Enable (!a);
 375 }
 376
 377 void
 378 FilmViewer::back_clicked ()
 379 {
 380         if (!_player) {
 381                 return;
 382         }
 383
 384         /* Player::video_position is the time after the last frame that we received.
 385            We want to see the one before it, so we need to go back 2.
 386         */
 387
 388         Time p = _player->video_position() - _film->video_frames_to_time (2);
 389         if (p < 0) {
 390                 p = 0;
 391         }
 392
 393         _player->seek (p, true);
 394         fetch_next_frame ();
 395 }
 396
 397 void
 398 FilmViewer::forward_clicked ()
 399 {
 400         if (!_player) {
 401                 return;
 402         }
 403
 404         fetch_next_frame ();
 405 }
 406
 407 void
 408 FilmViewer::player_changed (bool frequent)
 409 {
 410         if (frequent) {
 411                 return;
 412         }
 413
 414         calculate_sizes ();
 415         fetch_current_frame_again ();
 416 }