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/ffmpeg_content.h"
  39 #include "lib/imagemagick_content.h"
  40 #include "film_viewer.h"
  41 #include "wx_util.h"
  42 #include "video_decoder.h"
  43
  44 using std::string;
  45 using std::pair;
  46 using std::max;
  47 using std::cout;
  48 using std::list;
  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 (new wxStaticText (this, wxID_ANY, wxT("")))
  61         , _timecode (new wxStaticText (this, wxID_ANY, wxT("")))
  62         , _play_button (new wxToggleButton (this, wxID_ANY, _("Play")))
  63         , _display_frame_x (0)
  64         , _got_frame (false)
  65 {
  66 #ifndef __WXOSX__
  67         _panel->SetDoubleBuffered (true);
  68 #endif
  69
  70 #if wxMAJOR_VERSION == 2 && wxMINOR_VERSION >= 9
  71         _panel->SetBackgroundStyle (wxBG_STYLE_PAINT);
  72 #endif
  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, 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->SetMinSize (wxSize (84, -1));
  94         _back_button->SetMinSize (wxSize (32, -1));
  95         _forward_button->SetMinSize (wxSize (32, -1));
  96
  97         _panel->Connect (wxID_ANY, wxEVT_PAINT, wxPaintEventHandler (FilmViewer::paint_panel), 0, this);
  98         _panel->Connect (wxID_ANY, wxEVT_SIZE, wxSizeEventHandler (FilmViewer::panel_sized), 0, this);
  99         _slider->Connect (wxID_ANY, wxEVT_SCROLL_THUMBTRACK, wxScrollEventHandler (FilmViewer::slider_moved), 0, this);
 100         _slider->Connect (wxID_ANY, wxEVT_SCROLL_PAGEUP, wxScrollEventHandler (FilmViewer::slider_moved), 0, this);
 101         _slider->Connect (wxID_ANY, wxEVT_SCROLL_PAGEDOWN, wxScrollEventHandler (FilmViewer::slider_moved), 0, this);
 102         _play_button->Connect (wxID_ANY, wxEVT_COMMAND_TOGGLEBUTTON_CLICKED, wxCommandEventHandler (FilmViewer::play_clicked), 0, this);
 103         _timer.Connect (wxID_ANY, wxEVT_TIMER, wxTimerEventHandler (FilmViewer::timer), 0, this);
 104         _back_button->Connect (wxID_ANY, wxEVT_COMMAND_BUTTON_CLICKED, wxCommandEventHandler (FilmViewer::back_clicked), 0, this);
 105         _forward_button->Connect (wxID_ANY, wxEVT_COMMAND_BUTTON_CLICKED, wxCommandEventHandler (FilmViewer::forward_clicked), 0, 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::film_changed (Film::Property p)
 116 {
 117         switch (p) {
 118         case Film::CONTAINER:
 119                 calculate_sizes ();
 120                 update_from_raw ();
 121                 break;
 122         case Film::CONTENT:
 123         {
 124                 calculate_sizes ();
 125                 wxScrollEvent ev;
 126                 slider_moved (ev);
 127                 break;
 128         }
 129         case Film::WITH_SUBTITLES:
 130         case Film::SUBTITLE_OFFSET:
 131         case Film::SUBTITLE_SCALE:
 132                 raw_to_display ();
 133                 _panel->Refresh ();
 134                 _panel->Update ();
 135                 break;
 136         case Film::SCALER:
 137                 update_from_decoder ();
 138                 break;
 139         default:
 140                 break;
 141         }
 142 }
 143
 144 void
 145 FilmViewer::set_film (shared_ptr<Film> f)
 146 {
 147         if (_film == f) {
 148                 return;
 149         }
 150
 151         _film = f;
 152
 153         _raw_frame.reset ();
 154         _display_frame.reset ();
 155         _panel->Refresh ();
 156         _panel->Update ();
 157
 158         if (!_film) {
 159                 return;
 160         }
 161
 162         _player = f->player ();
 163         _player->disable_audio ();
 164         /* Don't disable subtitles here as we may need them, and it's nice to be able to turn them
 165            on and off without needing obtain a new Player.
 166         */
 167
 168         _player->Video.connect (bind (&FilmViewer::process_video, this, _1, _2, _3));
 169
 170         _film->Changed.connect (boost::bind (&FilmViewer::film_changed, this, _1));
 171         _film->ContentChanged.connect (boost::bind (&FilmViewer::film_content_changed, this, _1, _2));
 172
 173         film_changed (Film::CONTENT);
 174         film_changed (Film::CONTAINER);
 175         film_changed (Film::WITH_SUBTITLES);
 176         film_changed (Film::SUBTITLE_OFFSET);
 177         film_changed (Film::SUBTITLE_SCALE);
 178 }
 179
 180 void
 181 FilmViewer::update_from_decoder ()
 182 {
 183         if (!_player) {
 184                 return;
 185         }
 186
 187         _player->seek (_player->position() - _film->video_frames_to_time (1));
 188         get_frame ();
 189         _panel->Refresh ();
 190         _panel->Update ();
 191 }
 192
 193 void
 194 FilmViewer::timer (wxTimerEvent &)
 195 {
 196         if (!_player) {
 197                 return;
 198         }
 199
 200         get_frame ();
 201
 202         if (_film->length()) {
 203                 int const new_slider_position = 4096 * _player->position() / _film->length();
 204                 if (new_slider_position != _slider->GetValue()) {
 205                         _slider->SetValue (new_slider_position);
 206                 }
 207         }
 208
 209         _panel->Refresh ();
 210         _panel->Update ();
 211 }
 212
 213
 214 void
 215 FilmViewer::paint_panel (wxPaintEvent &)
 216 {
 217         wxPaintDC dc (_panel);
 218
 219         if (!_display_frame || !_film || !_out_size.width || !_out_size.height) {
 220                 dc.Clear ();
 221                 return;
 222         }
 223
 224         if (_display_frame_x) {
 225                 dc.SetPen(*wxBLACK_PEN);
 226                 dc.SetBrush(*wxBLACK_BRUSH);
 227                 dc.DrawRectangle (0, 0, _display_frame_x, _film_size.height);
 228                 dc.DrawRectangle (_display_frame_x + _film_size.width, 0, _display_frame_x, _film_size.height);
 229         }
 230
 231         wxImage frame (_film_size.width, _film_size.height, _display_frame->data()[0], true);
 232         wxBitmap frame_bitmap (frame);
 233         dc.DrawBitmap (frame_bitmap, _display_frame_x, 0);
 234
 235         if (_out_size.width < _panel_size.width) {
 236                 wxPen p (GetBackgroundColour ());
 237                 wxBrush b (GetBackgroundColour ());
 238                 dc.SetPen (p);
 239                 dc.SetBrush (b);
 240                 dc.DrawRectangle (_out_size.width, 0, _panel_size.width - _out_size.width, _panel_size.height);
 241         }
 242
 243         if (_out_size.height < _panel_size.height) {
 244                 wxPen p (GetBackgroundColour ());
 245                 wxBrush b (GetBackgroundColour ());
 246                 dc.SetPen (p);
 247                 dc.SetBrush (b);
 248                 dc.DrawRectangle (0, _out_size.height, _panel_size.width, _panel_size.height - _out_size.height);
 249         }
 250 }
 251
 252
 253 void
 254 FilmViewer::slider_moved (wxScrollEvent &)
 255 {
 256         cout << "slider " << _slider->GetValue() << " " << _film->length() << "\n";
 257
 258         if (_film && _player) {
 259                 _player->seek (_slider->GetValue() * _film->length() / 4096);
 260         }
 261
 262         get_frame ();
 263         _panel->Refresh ();
 264         _panel->Update ();
 265 }
 266
 267 void
 268 FilmViewer::panel_sized (wxSizeEvent& ev)
 269 {
 270         _panel_size.width = ev.GetSize().GetWidth();
 271         _panel_size.height = ev.GetSize().GetHeight();
 272         calculate_sizes ();
 273         update_from_raw ();
 274 }
 275
 276 void
 277 FilmViewer::update_from_raw ()
 278 {
 279         if (!_raw_frame) {
 280                 return;
 281         }
 282
 283         raw_to_display ();
 284
 285         _panel->Refresh ();
 286         _panel->Update ();
 287 }
 288
 289 void
 290 FilmViewer::raw_to_display ()
 291 {
 292         if (!_raw_frame || _out_size.width < 64 || _out_size.height < 64 || !_film) {
 293                 return;
 294         }
 295
 296         /* Get a compacted image as we have to feed it to wxWidgets */
 297         _display_frame = _raw_frame->scale_and_convert_to_rgb (_film_size, _film->scaler(), false);
 298 }
 299
 300 void
 301 FilmViewer::calculate_sizes ()
 302 {
 303         if (!_film || !_player) {
 304                 return;
 305         }
 306
 307         Ratio const * container = _film->container ();
 308
 309         float const panel_ratio = static_cast<float> (_panel_size.width) / _panel_size.height;
 310         float const film_ratio = container ? container->ratio () : 1.78;
 311
 312         if (panel_ratio < film_ratio) {
 313                 /* panel is less widscreen than the film; clamp width */
 314                 _out_size.width = _panel_size.width;
 315                 _out_size.height = _out_size.width / film_ratio;
 316         } else {
 317                 /* panel is more widescreen than the film; clamp height */
 318                 _out_size.height = _panel_size.height;
 319                 _out_size.width = _out_size.height * film_ratio;
 320         }
 321
 322         /* Work out how much padding there is in terms of our display; this will be the x position
 323            of our _display_frame.
 324         */
 325         _display_frame_x = 0;
 326 //      if (format) {
 327 //              _display_frame_x = static_cast<float> (format->dcp_padding (_film)) * _out_size.width / format->dcp_size().width;
 328 //      }
 329
 330         _film_size = _out_size;
 331         _film_size.width -= _display_frame_x * 2;
 332
 333         /* Catch silly values */
 334         if (_out_size.width < 64) {
 335                 _out_size.width = 64;
 336         }
 337 }
 338
 339 void
 340 FilmViewer::play_clicked (wxCommandEvent &)
 341 {
 342         check_play_state ();
 343 }
 344
 345 void
 346 FilmViewer::check_play_state ()
 347 {
 348         if (!_film || _film->dcp_video_frame_rate() == 0) {
 349                 return;
 350         }
 351
 352         if (_play_button->GetValue()) {
 353                 _timer.Start (1000 / _film->dcp_video_frame_rate());
 354         } else {
 355                 _timer.Stop ();
 356         }
 357 }
 358
 359 void
 360 FilmViewer::process_video (shared_ptr<const Image> image, bool, Time t)
 361 {
 362         _raw_frame = image;
 363
 364         raw_to_display ();
 365
 366         _got_frame = true;
 367
 368         double const fps = _film->dcp_video_frame_rate ();
 369         /* Count frame number from 1 ... not sure if this is the best idea */
 370         _frame->SetLabel (wxString::Format (wxT("%d"), int (rint (t * fps / TIME_HZ)) + 1));
 371
 372         double w = static_cast<double>(t) / TIME_HZ;
 373         int const h = (w / 3600);
 374         w -= h * 3600;
 375         int const m = (w / 60);
 376         w -= m * 60;
 377         int const s = floor (w);
 378         w -= s;
 379         int const f = rint (w * fps);
 380         _timecode->SetLabel (wxString::Format (wxT("%02d:%02d:%02d:%02d"), h, m, s, f));
 381 }
 382
 383 /** Get a new _raw_frame from the decoder and then do
 384  *  raw_to_display ().
 385  */
 386 void
 387 FilmViewer::get_frame ()
 388 {
 389         /* Clear our raw frame in case we don't get a new one */
 390         _raw_frame.reset ();
 391
 392         if (!_player) {
 393                 _display_frame.reset ();
 394                 return;
 395         }
 396
 397         try {
 398                 _got_frame = false;
 399                 while (!_got_frame) {
 400                         if (_player->pass ()) {
 401                                 /* We didn't get a frame before the decoder gave up,
 402                                    so clear our display frame.
 403                                 */
 404                                 _display_frame.reset ();
 405                                 break;
 406                         }
 407                 }
 408         } catch (DecodeError& e) {
 409                 _play_button->SetValue (false);
 410                 check_play_state ();
 411                 error_dialog (this, wxString::Format (_("Could not decode video for view (%s)"), std_to_wx(e.what()).data()));
 412         }
 413 }
 414
 415 void
 416 FilmViewer::active_jobs_changed (bool a)
 417 {
 418         if (a) {
 419                 list<shared_ptr<Job> > jobs = JobManager::instance()->get ();
 420                 list<shared_ptr<Job> >::iterator i = jobs.begin ();
 421                 while (i != jobs.end() && boost::dynamic_pointer_cast<ExamineContentJob> (*i) == 0) {
 422                         ++i;
 423                 }
 424
 425                 if (i == jobs.end() || (*i)->finished()) {
 426                         /* no examine content job running, so we're ok to use the viewer */
 427                         a = false;
 428                 }
 429         }
 430
 431         _slider->Enable (!a);
 432         _play_button->Enable (!a);
 433 }
 434
 435 void
 436 FilmViewer::film_content_changed (weak_ptr<Content>, int p)
 437 {
 438         if (p == ContentProperty::LENGTH) {
 439                 /* Force an update to our frame */
 440                 wxScrollEvent ev;
 441                 slider_moved (ev);
 442         } else if (p == VideoContentProperty::VIDEO_CROP) {
 443                 update_from_decoder ();
 444         }
 445 }
 446
 447 void
 448 FilmViewer::back_clicked (wxCommandEvent &)
 449 {
 450         if (!_player) {
 451                 return;
 452         }
 453
 454         _player->seek_back ();
 455         get_frame ();
 456         _panel->Refresh ();
 457         _panel->Update ();
 458 }
 459
 460 void
 461 FilmViewer::forward_clicked (wxCommandEvent &)
 462 {
 463         if (!_player) {
 464                 return;
 465         }
 466
 467         _player->seek_forward ();
 468         get_frame ();
 469         _panel->Refresh ();
 470         _panel->Update ();
 471 }