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 "lib/timer.h"
  40 #include "lib/dcp_video.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 {
  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 ();
 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->set_approximate_size ();
 140         _player->Changed.connect (boost::bind (&FilmViewer::player_changed, this, _1));
 141
 142         calculate_sizes ();
 143         get (_position, true);
 144 }
 145
 146 void
 147 FilmViewer::get (DCPTime p, bool accurate)
 148 {
 149         if (!_player) {
 150                 return;
 151         }
 152
 153         list<shared_ptr<DCPVideo> > dcp_video = _player->get_video (p, accurate);
 154         if (!dcp_video.empty ()) {
 155                 _frame = dcp_video.front()->image (PIX_FMT_BGRA, true);
 156                 _frame = _frame->scale (_frame->size(), Scaler::from_id ("fastbilinear"), PIX_FMT_RGB24, false);
 157         } else {
 158                 _frame.reset ();
 159         }
 160
 161         _position = p;
 162
 163         set_position_text ();
 164         _panel->Refresh ();
 165         _panel->Update ();
 166 }
 167
 168 void
 169 FilmViewer::timer ()
 170 {
 171         get (_position + DCPTime::from_frames (1, _film->video_frame_rate ()), true);
 172
 173         DCPTime const len = _film->length ();
 174
 175         if (len.get ()) {
 176                 int const new_slider_position = 4096 * _position.get() / len.get();
 177                 if (new_slider_position != _slider->GetValue()) {
 178                         _slider->SetValue (new_slider_position);
 179                 }
 180         }
 181 }
 182
 183
 184 void
 185 FilmViewer::paint_panel ()
 186 {
 187         wxPaintDC dc (_panel);
 188
 189         if (!_frame || !_film || !_out_size.width || !_out_size.height) {
 190                 dc.Clear ();
 191                 return;
 192         }
 193
 194         wxImage frame (_out_size.width, _out_size.height, _frame->data()[0], true);
 195         wxBitmap frame_bitmap (frame);
 196         dc.DrawBitmap (frame_bitmap, 0, 0);
 197
 198         if (_out_size.width < _panel_size.width) {
 199                 wxPen p (GetBackgroundColour ());
 200                 wxBrush b (GetBackgroundColour ());
 201                 dc.SetPen (p);
 202                 dc.SetBrush (b);
 203                 dc.DrawRectangle (_out_size.width, 0, _panel_size.width - _out_size.width, _panel_size.height);
 204         }
 205
 206         if (_out_size.height < _panel_size.height) {
 207                 wxPen p (GetBackgroundColour ());
 208                 wxBrush b (GetBackgroundColour ());
 209                 dc.SetPen (p);
 210                 dc.SetBrush (b);
 211                 dc.DrawRectangle (0, _out_size.height, _panel_size.width, _panel_size.height - _out_size.height);
 212         }
 213 }
 214
 215
 216 void
 217 FilmViewer::slider_moved ()
 218 {
 219         if (!_film) {
 220                 return;
 221         }
 222
 223         DCPTime t (_slider->GetValue() * _film->length().get() / 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() - DCPTime::from_frames (1, _film->video_frame_rate ());
 227         }
 228         get (t, false);
 229 }
 230
 231 void
 232 FilmViewer::panel_sized (wxSizeEvent& ev)
 233 {
 234         _panel_size.width = ev.GetSize().GetWidth();
 235         _panel_size.height = ev.GetSize().GetHeight();
 236         calculate_sizes ();
 237         get (_position, true);
 238 }
 239
 240 void
 241 FilmViewer::calculate_sizes ()
 242 {
 243         if (!_film || !_player) {
 244                 return;
 245         }
 246
 247         Ratio const * container = _film->container ();
 248
 249         float const panel_ratio = _panel_size.ratio ();
 250         float const film_ratio = container ? container->ratio () : 1.78;
 251
 252         if (panel_ratio < film_ratio) {
 253                 /* panel is less widscreen than the film; clamp width */
 254                 _out_size.width = _panel_size.width;
 255                 _out_size.height = _out_size.width / film_ratio;
 256         } else {
 257                 /* panel is more widescreen than the film; clamp height */
 258                 _out_size.height = _panel_size.height;
 259                 _out_size.width = _out_size.height * film_ratio;
 260         }
 261
 262         /* Catch silly values */
 263         _out_size.width = max (64, _out_size.width);
 264         _out_size.height = max (64, _out_size.height);
 265
 266         /* The player will round its image down to the nearest 4 pixels
 267            to speed up its scale, so do similar here to avoid black borders
 268            around things.  This is a bit of a hack.
 269         */
 270         _out_size.width &= ~3;
 271         _out_size.height &= ~3;
 272
 273         _player->set_video_container_size (_out_size);
 274 }
 275
 276 void
 277 FilmViewer::play_clicked ()
 278 {
 279         check_play_state ();
 280 }
 281
 282 void
 283 FilmViewer::check_play_state ()
 284 {
 285         if (!_film || _film->video_frame_rate() == 0) {
 286                 return;
 287         }
 288
 289         if (_play_button->GetValue()) {
 290                 _timer.Start (1000 / _film->video_frame_rate());
 291         } else {
 292                 _timer.Stop ();
 293         }
 294 }
 295
 296 void
 297 FilmViewer::set_position_text ()
 298 {
 299         if (!_film) {
 300                 _frame_number->SetLabel ("0");
 301                 _timecode->SetLabel ("0:0:0.0");
 302                 return;
 303         }
 304
 305         double const fps = _film->video_frame_rate ();
 306         /* Count frame number from 1 ... not sure if this is the best idea */
 307         _frame_number->SetLabel (wxString::Format (wxT("%d"), int (rint (_position.seconds() * fps)) + 1));
 308
 309         double w = _position.seconds ();
 310         int const h = (w / 3600);
 311         w -= h * 3600;
 312         int const m = (w / 60);
 313         w -= m * 60;
 314         int const s = floor (w);
 315         w -= s;
 316         int const f = rint (w * fps);
 317         _timecode->SetLabel (wxString::Format (wxT("%02d:%02d:%02d.%02d"), h, m, s, f));
 318 }
 319
 320 void
 321 FilmViewer::active_jobs_changed (bool a)
 322 {
 323         if (a) {
 324                 list<shared_ptr<Job> > jobs = JobManager::instance()->get ();
 325                 list<shared_ptr<Job> >::iterator i = jobs.begin ();
 326                 while (i != jobs.end() && boost::dynamic_pointer_cast<ExamineContentJob> (*i) == 0) {
 327                         ++i;
 328                 }
 329
 330                 if (i == jobs.end() || (*i)->finished()) {
 331                         /* no examine content job running, so we're ok to use the viewer */
 332                         a = false;
 333                 }
 334         }
 335
 336         _slider->Enable (!a);
 337         _play_button->Enable (!a);
 338 }
 339
 340 void
 341 FilmViewer::back_clicked ()
 342 {
 343         DCPTime p = _position - DCPTime::from_frames (1, _film->video_frame_rate ());
 344         if (p < DCPTime ()) {
 345                 p = DCPTime ();
 346         }
 347
 348         get (p, true);
 349 }
 350
 351 void
 352 FilmViewer::forward_clicked ()
 353 {
 354         get (_position + DCPTime::from_frames (1, _film->video_frame_rate ()), true);
 355 }
 356
 357 void
 358 FilmViewer::player_changed (bool frequent)
 359 {
 360         if (frequent) {
 361                 return;
 362         }
 363
 364         calculate_sizes ();
 365         get (_position, true);
 366 }