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