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