src/wx/film_viewer.cc

   1 /* -*- c-basic-offset: 8; default-tab-width: 8; -*- */
   2
   3 /*
   4     Copyright (C) 2012 Carl Hetherington <cth@carlh.net>
   5
   6     This program is free software; you can redistribute it and/or modify
   7     it under the terms of the GNU General Public License as published by
   8     the Free Software Foundation; either version 2 of the License, or
   9     (at your option) any later version.
  10
  11     This program is distributed in the hope that it will be useful,
  12     but WITHOUT ANY WARRANTY; without even the implied warranty of
  13     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14     GNU General Public License for more details.
  15
  16     You should have received a copy of the GNU General Public License
  17     along with this program; if not, write to the Free Software
  18     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  19
  20 */
  21
  22 /** @file  src/film_viewer.cc
  23  *  @brief A wx widget to view a preview of a Film.
  24  */
  25
  26 #include <iostream>
  27 #include <iomanip>
  28 #include <wx/tglbtn.h>
  29 #include "lib/film.h"
  30 #include "lib/format.h"
  31 #include "lib/util.h"
  32 #include "lib/job_manager.h"
  33 #include "lib/subtitle.h"
  34 #include "lib/image.h"
  35 #include "lib/scaler.h"
  36 #include "lib/exceptions.h"
  37 #include "lib/examine_content_job.h"
  38 #include "lib/filter.h"
  39 #include "lib/player.h"
  40 #include "lib/video_content.h"
  41 #include "lib/ffmpeg_content.h"
  42 #include "lib/imagemagick_content.h"
  43 #include "film_viewer.h"
  44 #include "wx_util.h"
  45 #include "video_decoder.h"
  46
  47 using std::string;
  48 using std::pair;
  49 using std::max;
  50 using std::cout;
  51 using std::list;
  52 using boost::shared_ptr;
  53 using boost::dynamic_pointer_cast;
  54 using boost::weak_ptr;
  55 using libdcp::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 (new wxStaticText (this, wxID_ANY, wxT("")))
  64         , _timecode (new wxStaticText (this, wxID_ANY, wxT("")))
  65         , _play_button (new wxToggleButton (this, wxID_ANY, _("Play")))
  66         , _display_frame_x (0)
  67         , _got_frame (false)
  68 {
  69         _panel->SetDoubleBuffered (true);
  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::FORMAT:
 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         case Film::FILTERS:
 138         case Film::CROP:
 139                 update_from_decoder ();
 140                 break;
 141         default:
 142                 break;
 143         }
 144 }
 145
 146 void
 147 FilmViewer::set_film (shared_ptr<Film> f)
 148 {
 149         if (_film == f) {
 150                 return;
 151         }
 152
 153         _film = f;
 154
 155         _raw_frame.reset ();
 156         _display_frame.reset ();
 157         _panel->Refresh ();
 158         _panel->Update ();
 159
 160         if (!_film) {
 161                 return;
 162         }
 163
 164         _player = f->player ();
 165         _player->disable_audio ();
 166         /* Don't disable subtitles here as we may need them, and it's nice to be able to turn them
 167            on and off without needing obtain a new Player.
 168         */
 169
 170         _player->Video.connect (bind (&FilmViewer::process_video, this, _1, _2, _3, _4));
 171
 172         _film->Changed.connect (boost::bind (&FilmViewer::film_changed, this, _1));
 173         _film->ContentChanged.connect (boost::bind (&FilmViewer::film_content_changed, this, _1, _2));
 174
 175         film_changed (Film::CONTENT);
 176         film_changed (Film::FORMAT);
 177         film_changed (Film::WITH_SUBTITLES);
 178         film_changed (Film::SUBTITLE_OFFSET);
 179         film_changed (Film::SUBTITLE_SCALE);
 180 }
 181
 182 void
 183 FilmViewer::update_from_decoder ()
 184 {
 185         if (!_player || _player->seek (_player->last_video ())) {
 186                 return;
 187         }
 188
 189         get_frame ();
 190         _panel->Refresh ();
 191         _panel->Update ();
 192 }
 193
 194 void
 195 FilmViewer::timer (wxTimerEvent &)
 196 {
 197         if (!_player) {
 198                 return;
 199         }
 200
 201         _panel->Refresh ();
 202         _panel->Update ();
 203
 204         get_frame ();
 205
 206         if (_film->length()) {
 207                 int const new_slider_position = 4096 * _player->last_video() / _film->length();
 208                 if (new_slider_position != _slider->GetValue()) {
 209                         _slider->SetValue (new_slider_position);
 210                 }
 211         }
 212 }
 213
 214
 215 void
 216 FilmViewer::paint_panel (wxPaintEvent &)
 217 {
 218         wxPaintDC dc (_panel);
 219
 220         if (!_display_frame || !_film || !_out_size.width || !_out_size.height) {
 221                 dc.Clear ();
 222                 return;
 223         }
 224
 225         if (_display_frame_x) {
 226                 dc.SetPen(*wxBLACK_PEN);
 227                 dc.SetBrush(*wxBLACK_BRUSH);
 228                 dc.DrawRectangle (0, 0, _display_frame_x, _film_size.height);
 229                 dc.DrawRectangle (_display_frame_x + _film_size.width, 0, _display_frame_x, _film_size.height);
 230         }
 231
 232         wxImage frame (_film_size.width, _film_size.height, _display_frame->data()[0], true);
 233         wxBitmap frame_bitmap (frame);
 234         dc.DrawBitmap (frame_bitmap, _display_frame_x, 0);
 235
 236         if (_film->with_subtitles() && _display_sub) {
 237                 wxImage sub (_display_sub->size().width, _display_sub->size().height, _display_sub->data()[0], _display_sub->alpha(), true);
 238                 wxBitmap sub_bitmap (sub);
 239                 dc.DrawBitmap (sub_bitmap, _display_sub_position.x, _display_sub_position.y);
 240         }
 241
 242         if (_out_size.width < _panel_size.width) {
 243                 wxPen p (GetBackgroundColour ());
 244                 wxBrush b (GetBackgroundColour ());
 245                 dc.SetPen (p);
 246                 dc.SetBrush (b);
 247                 dc.DrawRectangle (_out_size.width, 0, _panel_size.width - _out_size.width, _panel_size.height);
 248         }
 249
 250         if (_out_size.height < _panel_size.height) {
 251                 wxPen p (GetBackgroundColour ());
 252                 wxBrush b (GetBackgroundColour ());
 253                 dc.SetPen (p);
 254                 dc.SetBrush (b);
 255                 dc.DrawRectangle (0, _out_size.height, _panel_size.width, _panel_size.height - _out_size.height);
 256         }
 257 }
 258
 259
 260 void
 261 FilmViewer::slider_moved (wxScrollEvent &)
 262 {
 263         if (_film && _player) {
 264                 _player->seek (_slider->GetValue() * _film->length() / 4096);
 265         }
 266
 267         get_frame ();
 268         _panel->Refresh ();
 269         _panel->Update ();
 270 }
 271
 272 void
 273 FilmViewer::panel_sized (wxSizeEvent& ev)
 274 {
 275         _panel_size.width = ev.GetSize().GetWidth();
 276         _panel_size.height = ev.GetSize().GetHeight();
 277         calculate_sizes ();
 278         update_from_raw ();
 279 }
 280
 281 void
 282 FilmViewer::update_from_raw ()
 283 {
 284         if (!_raw_frame) {
 285                 return;
 286         }
 287
 288         raw_to_display ();
 289
 290         _panel->Refresh ();
 291         _panel->Update ();
 292 }
 293
 294 void
 295 FilmViewer::raw_to_display ()
 296 {
 297         if (!_raw_frame || _out_size.width < 64 || _out_size.height < 64 || !_film) {
 298                 return;
 299         }
 300
 301         shared_ptr<const Image> input = _raw_frame;
 302
 303         pair<string, string> const s = Filter::ffmpeg_strings (_film->filters());
 304         if (!s.second.empty ()) {
 305                 input = input->post_process (s.second, true);
 306         }
 307
 308         /* Get a compacted image as we have to feed it to wxWidgets */
 309         _display_frame = input->scale_and_convert_to_rgb (_film_size, 0, _film->scaler(), false);
 310
 311         if (_raw_sub) {
 312
 313                 /* Our output is already cropped by the decoder, so we need to account for that
 314                    when working out the scale that we are applying.
 315                 */
 316
 317                 Size const cropped_size = _film->cropped_size (_raw_frame->size ());
 318
 319                 Rect tx = subtitle_transformed_area (
 320                         float (_film_size.width) / cropped_size.width,
 321                         float (_film_size.height) / cropped_size.height,
 322                         _raw_sub->area(), _film->subtitle_offset(), _film->subtitle_scale()
 323                         );
 324
 325                 _display_sub.reset (new RGBPlusAlphaImage (_raw_sub->image()->scale (tx.size(), _film->scaler(), false)));
 326                 _display_sub_position = tx.position();
 327                 _display_sub_position.x += _display_frame_x;
 328         } else {
 329                 _display_sub.reset ();
 330         }
 331 }
 332
 333 void
 334 FilmViewer::calculate_sizes ()
 335 {
 336         if (!_film || !_player) {
 337                 return;
 338         }
 339
 340         Format const * format = _film->format ();
 341
 342         float const panel_ratio = static_cast<float> (_panel_size.width) / _panel_size.height;
 343         float const film_ratio = format ? format->container_ratio () : 1.78;
 344
 345         if (panel_ratio < film_ratio) {
 346                 /* panel is less widscreen than the film; clamp width */
 347                 _out_size.width = _panel_size.width;
 348                 _out_size.height = _out_size.width / film_ratio;
 349         } else {
 350                 /* panel is more widescreen than the film; clamp height */
 351                 _out_size.height = _panel_size.height;
 352                 _out_size.width = _out_size.height * film_ratio;
 353         }
 354
 355         /* Work out how much padding there is in terms of our display; this will be the x position
 356            of our _display_frame.
 357         */
 358         _display_frame_x = 0;
 359         if (format) {
 360                 _display_frame_x = static_cast<float> (format->dcp_padding (_film)) * _out_size.width / format->dcp_size().width;
 361         }
 362
 363         _film_size = _out_size;
 364         _film_size.width -= _display_frame_x * 2;
 365
 366         /* Catch silly values */
 367         if (_out_size.width < 64) {
 368                 _out_size.width = 64;
 369         }
 370 }
 371
 372 void
 373 FilmViewer::play_clicked (wxCommandEvent &)
 374 {
 375         check_play_state ();
 376 }
 377
 378 void
 379 FilmViewer::check_play_state ()
 380 {
 381         if (!_film) {
 382                 return;
 383         }
 384
 385         if (_play_button->GetValue()) {
 386                 _timer.Start (1000 / _film->dcp_video_frame_rate());
 387         } else {
 388                 _timer.Stop ();
 389         }
 390 }
 391
 392 void
 393 FilmViewer::process_video (shared_ptr<const Image> image, bool, shared_ptr<Subtitle> sub, Time t)
 394 {
 395         _raw_frame = image;
 396         _raw_sub = sub;
 397
 398         raw_to_display ();
 399
 400         _got_frame = true;
 401
 402         double const fps = _film->dcp_video_frame_rate ();
 403         _frame->SetLabel (wxString::Format (wxT("%d"), int (rint (t * fps / TIME_HZ))));
 404
 405         double w = static_cast<double>(t) / TIME_HZ;
 406         int const h = (w / 3600);
 407         w -= h * 3600;
 408         int const m = (w / 60);
 409         w -= m * 60;
 410         int const s = floor (w);
 411         w -= s;
 412         int const f = rint (w * fps);
 413         _timecode->SetLabel (wxString::Format (wxT("%02d:%02d:%02d:%02d"), h, m, s, f));
 414 }
 415
 416 /** Get a new _raw_frame from the decoder and then do
 417  *  raw_to_display ().
 418  */
 419 void
 420 FilmViewer::get_frame ()
 421 {
 422         /* Clear our raw frame in case we don't get a new one */
 423         _raw_frame.reset ();
 424
 425         if (!_player) {
 426                 _display_frame.reset ();
 427                 return;
 428         }
 429
 430         try {
 431                 _got_frame = false;
 432                 while (!_got_frame) {
 433                         if (_player->pass ()) {
 434                                 /* We didn't get a frame before the decoder gave up,
 435                                    so clear our display frame.
 436                                 */
 437                                 _display_frame.reset ();
 438                                 break;
 439                         }
 440                 }
 441         } catch (DecodeError& e) {
 442                 _play_button->SetValue (false);
 443                 check_play_state ();
 444                 error_dialog (this, wxString::Format (_("Could not decode video for view (%s)"), std_to_wx(e.what()).data()));
 445         }
 446 }
 447
 448 void
 449 FilmViewer::active_jobs_changed (bool a)
 450 {
 451         if (a) {
 452                 list<shared_ptr<Job> > jobs = JobManager::instance()->get ();
 453                 list<shared_ptr<Job> >::iterator i = jobs.begin ();
 454                 while (i != jobs.end() && boost::dynamic_pointer_cast<ExamineContentJob> (*i) == 0) {
 455                         ++i;
 456                 }
 457
 458                 if (i == jobs.end() || (*i)->finished()) {
 459                         /* no examine content job running, so we're ok to use the viewer */
 460                         a = false;
 461                 }
 462         }
 463
 464         _slider->Enable (!a);
 465         _play_button->Enable (!a);
 466 }
 467
 468 void
 469 FilmViewer::film_content_changed (weak_ptr<Content>, int p)
 470 {
 471         if (p == VideoContentProperty::VIDEO_LENGTH) {
 472                 /* Force an update to our frame */
 473                 wxScrollEvent ev;
 474                 slider_moved (ev);
 475         }
 476 }
 477
 478 void
 479 FilmViewer::back_clicked (wxCommandEvent &)
 480 {
 481         if (!_player) {
 482                 return;
 483         }
 484
 485         _player->seek_back ();
 486         get_frame ();
 487         _panel->Refresh ();
 488         _panel->Update ();
 489 }
 490
 491 void
 492 FilmViewer::forward_clicked (wxCommandEvent &)
 493 {
 494         if (!_player) {
 495                 return;
 496         }
 497
 498         _player->seek_forward ();
 499         get_frame ();
 500         _panel->Refresh ();
 501         _panel->Update ();
 502 }