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.h"
  38 #include "lib/video_content.h"
  39 #include "lib/video_decoder.h"
  40 #include "lib/timer.h"
  41 #include "film_viewer.h"
  42 #include "wx_util.h"
  43
  44 using std::string;
  45 using std::pair;
  46 using std::min;
  47 using std::max;
  48 using std::cout;
  49 using std::list;
  50 using std::bad_alloc;
  51 using std::make_pair;
  52 using boost::shared_ptr;
  53 using boost::dynamic_pointer_cast;
  54 using boost::weak_ptr;
  55 using dcp::Size;
  56
  57 FilmViewer::FilmViewer (shared_ptr<Film> f, wxWindow* p)
  58         : wxPanel (p)
  59         , _panel (new wxPanel (this))
  60         , _slider (new wxSlider (this, wxID_ANY, 0, 0, 4096))
  61         , _back_button (new wxButton (this, wxID_ANY, wxT("<")))
  62         , _forward_button (new wxButton (this, wxID_ANY, wxT(">")))
  63         , _frame_number (new wxStaticText (this, wxID_ANY, wxT("")))
  64         , _timecode (new wxStaticText (this, wxID_ANY, wxT("")))
  65         , _play_button (new wxToggleButton (this, wxID_ANY, _("Play")))
  66         , _last_get_accurate (true)
  67 {
  68 #ifndef __WXOSX__
  69         _panel->SetDoubleBuffered (true);
  70 #endif
  71
  72         _panel->SetBackgroundStyle (wxBG_STYLE_PAINT);
  73
  74         _v_sizer = new wxBoxSizer (wxVERTICAL);
  75         SetSizer (_v_sizer);
  76
  77         _v_sizer->Add (_panel, 1, wxEXPAND);
  78
  79         wxBoxSizer* h_sizer = new wxBoxSizer (wxHORIZONTAL);
  80
  81         wxBoxSizer* time_sizer = new wxBoxSizer (wxVERTICAL);
  82         time_sizer->Add (_frame_number, 0, wxEXPAND);
  83         time_sizer->Add (_timecode, 0, wxEXPAND);
  84
  85         h_sizer->Add (_back_button, 0, wxALL, 2);
  86         h_sizer->Add (time_sizer, 0, wxEXPAND);
  87         h_sizer->Add (_forward_button, 0, wxALL, 2);
  88         h_sizer->Add (_play_button, 0, wxEXPAND);
  89         h_sizer->Add (_slider, 1, wxEXPAND);
  90
  91         _v_sizer->Add (h_sizer, 0, wxEXPAND | wxALL, 6);
  92
  93         _frame_number->SetMinSize (wxSize (84, -1));
  94         _back_button->SetMinSize (wxSize (32, -1));
  95         _forward_button->SetMinSize (wxSize (32, -1));
  96
  97         _panel->Bind          (wxEVT_PAINT,                        boost::bind (&FilmViewer::paint_panel,     this));
  98         _panel->Bind          (wxEVT_SIZE,                         boost::bind (&FilmViewer::panel_sized,     this, _1));
  99         _slider->Bind         (wxEVT_SCROLL_THUMBTRACK,            boost::bind (&FilmViewer::slider_moved,    this));
 100         _slider->Bind         (wxEVT_SCROLL_PAGEUP,                boost::bind (&FilmViewer::slider_moved,    this));
 101         _slider->Bind         (wxEVT_SCROLL_PAGEDOWN,              boost::bind (&FilmViewer::slider_moved,    this));
 102         _play_button->Bind    (wxEVT_COMMAND_TOGGLEBUTTON_CLICKED, boost::bind (&FilmViewer::play_clicked,    this));
 103         _timer.Bind           (wxEVT_TIMER,                        boost::bind (&FilmViewer::timer,           this));
 104         _back_button->Bind    (wxEVT_COMMAND_BUTTON_CLICKED,       boost::bind (&FilmViewer::back_clicked,    this));
 105         _forward_button->Bind (wxEVT_COMMAND_BUTTON_CLICKED,       boost::bind (&FilmViewer::forward_clicked, this));
 106
 107         set_film (f);
 108
 109         JobManager::instance()->ActiveJobsChanged.connect (
 110                 bind (&FilmViewer::active_jobs_changed, this, _1)
 111                 );
 112 }
 113
 114 void
 115 FilmViewer::set_film (shared_ptr<Film> f)
 116 {
 117         if (_film == f) {
 118                 return;
 119         }
 120
 121         _film = f;
 122
 123         _frame.reset ();
 124
 125         _slider->SetValue (0);
 126         set_position_text ();
 127
 128         if (!_film) {
 129                 return;
 130         }
 131
 132         try {
 133                 _player = f->make_player ();
 134         } catch (bad_alloc) {
 135                 error_dialog (this, _("There is not enough free memory to do that."));
 136                 _film.reset ();
 137                 return;
 138         }
 139
 140         _player->set_approximate_size ();
 141         _player->Changed.connect (boost::bind (&FilmViewer::player_changed, this, _1));
 142
 143         calculate_sizes ();
 144         get (_position, _last_get_accurate);
 145 }
 146
 147 void
 148 FilmViewer::get (DCPTime p, bool accurate)
 149 {
 150         if (!_player) {
 151                 return;
 152         }
 153
 154         list<shared_ptr<PlayerVideo> > pvf = _player->get_video (p, accurate);
 155         if (!pvf.empty ()) {
 156                 _frame = pvf.front()->image (true);
 157                 _frame = _frame->scale (_frame->size(), Scaler::from_id ("fastbilinear"), PIX_FMT_RGB24, false);
 158                 _position = pvf.front()->time ();
 159         } else {
 160                 _frame.reset ();
 161                 _position = p;
 162         }
 163
 164         set_position_text ();
 165         _panel->Refresh ();
 166         _panel->Update ();
 167
 168         _last_get_accurate = accurate;
 169 }
 170
 171 void
 172 FilmViewer::timer ()
 173 {
 174         get (_position + DCPTime::from_frames (1, _film->video_frame_rate ()), true);
 175
 176         DCPTime const len = _film->length ();
 177
 178         if (len.get ()) {
 179                 int const new_slider_position = 4096 * _position.get() / len.get();
 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) {
 223                 return;
 224         }
 225
 226         DCPTime t (_slider->GetValue() * _film->length().get() / 4096);
 227         /* Ensure that we hit the end of the film at the end of the slider */
 228         if (t >= _film->length ()) {
 229                 t = _film->length() - DCPTime::from_frames (1, _film->video_frame_rate ());
 230         }
 231         get (t, false);
 232 }
 233
 234 void
 235 FilmViewer::panel_sized (wxSizeEvent& ev)
 236 {
 237         _panel_size.width = ev.GetSize().GetWidth();
 238         _panel_size.height = ev.GetSize().GetHeight();
 239         calculate_sizes ();
 240         get (_position, _last_get_accurate);
 241 }
 242
 243 void
 244 FilmViewer::calculate_sizes ()
 245 {
 246         if (!_film || !_player) {
 247                 return;
 248         }
 249
 250         Ratio const * container = _film->container ();
 251
 252         float const panel_ratio = _panel_size.ratio ();
 253         float const film_ratio = container ? container->ratio () : 1.78;
 254
 255         if (panel_ratio < film_ratio) {
 256                 /* panel is less widscreen than the film; clamp width */
 257                 _out_size.width = _panel_size.width;
 258                 _out_size.height = _out_size.width / film_ratio;
 259         } else {
 260                 /* panel is more widescreen than the film; clamp height */
 261                 _out_size.height = _panel_size.height;
 262                 _out_size.width = _out_size.height * film_ratio;
 263         }
 264
 265         /* Catch silly values */
 266         _out_size.width = max (64, _out_size.width);
 267         _out_size.height = max (64, _out_size.height);
 268
 269         /* The player will round its image down to the nearest 4 pixels
 270            to speed up its scale, so do similar here to avoid black borders
 271            around things.  This is a bit of a hack.
 272         */
 273         _out_size.width &= ~3;
 274         _out_size.height &= ~3;
 275
 276         _player->set_video_container_size (_out_size);
 277 }
 278
 279 void
 280 FilmViewer::play_clicked ()
 281 {
 282         check_play_state ();
 283 }
 284
 285 void
 286 FilmViewer::check_play_state ()
 287 {
 288         if (!_film || _film->video_frame_rate() == 0) {
 289                 return;
 290         }
 291
 292         if (_play_button->GetValue()) {
 293                 _timer.Start (1000 / _film->video_frame_rate());
 294         } else {
 295                 _timer.Stop ();
 296         }
 297 }
 298
 299 void
 300 FilmViewer::set_position_text ()
 301 {
 302         if (!_film) {
 303                 _frame_number->SetLabel ("0");
 304                 _timecode->SetLabel ("0:0:0.0");
 305                 return;
 306         }
 307
 308         double const fps = _film->video_frame_rate ();
 309         /* Count frame number from 1 ... not sure if this is the best idea */
 310         _frame_number->SetLabel (wxString::Format (wxT("%d"), int (rint (_position.seconds() * fps)) + 1));
 311
 312         double w = _position.seconds ();
 313         int const h = (w / 3600);
 314         w -= h * 3600;
 315         int const m = (w / 60);
 316         w -= m * 60;
 317         int const s = floor (w);
 318         w -= s;
 319         int const f = rint (w * fps);
 320         _timecode->SetLabel (wxString::Format (wxT("%02d:%02d:%02d.%02d"), h, m, s, f));
 321 }
 322
 323 void
 324 FilmViewer::active_jobs_changed (bool a)
 325 {
 326         if (a) {
 327                 list<shared_ptr<Job> > jobs = JobManager::instance()->get ();
 328                 list<shared_ptr<Job> >::iterator i = jobs.begin ();
 329                 while (i != jobs.end() && boost::dynamic_pointer_cast<ExamineContentJob> (*i) == 0) {
 330                         ++i;
 331                 }
 332
 333                 if (i == jobs.end() || (*i)->finished()) {
 334                         /* no examine content job running, so we're ok to use the viewer */
 335                         a = false;
 336                 }
 337         }
 338
 339         _slider->Enable (!a);
 340         _play_button->Enable (!a);
 341 }
 342
 343 void
 344 FilmViewer::back_clicked ()
 345 {
 346         DCPTime p = _position - DCPTime::from_frames (1, _film->video_frame_rate ());
 347         if (p < DCPTime ()) {
 348                 p = DCPTime ();
 349         }
 350
 351         get (p, true);
 352 }
 353
 354 void
 355 FilmViewer::forward_clicked ()
 356 {
 357         get (_position + DCPTime::from_frames (1, _film->video_frame_rate ()), true);
 358 }
 359
 360 void
 361 FilmViewer::player_changed (bool frequent)
 362 {
 363         if (frequent) {
 364                 return;
 365         }
 366
 367         calculate_sizes ();
 368         get (_position, _last_get_accurate);
 369 }