src/wx/film_viewer.cc

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