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