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/format.h"
  29 #include "lib/util.h"
  30 #include "lib/job_manager.h"
  31 #include "lib/subtitle.h"
  32 #include "lib/image.h"
  33 #include "lib/scaler.h"
  34 #include "lib/exceptions.h"
  35 #include "lib/examine_content_job.h"
  36 #include "lib/filter.h"
  37 #include "lib/player.h"
  38 #include "lib/video_content.h"
  39 #include "lib/ffmpeg_content.h"
  40 #include "lib/imagemagick_content.h"
  41 #include "film_viewer.h"
  42 #include "wx_util.h"
  43 #include "video_decoder.h"
  44
  45 using std::string;
  46 using std::pair;
  47 using std::max;
  48 using std::cout;
  49 using std::list;
  50 using boost::shared_ptr;
  51 using boost::dynamic_pointer_cast;
  52 using boost::weak_ptr;
  53 using libdcp::Size;
  54
  55 FilmViewer::FilmViewer (shared_ptr<Film> f, wxWindow* p)
  56         : wxPanel (p)
  57         , _panel (new wxPanel (this))
  58         , _slider (new wxSlider (this, wxID_ANY, 0, 0, 4096))
  59         , _back_button (new wxButton (this, wxID_ANY, wxT("<")))
  60         , _forward_button (new wxButton (this, wxID_ANY, wxT(">")))
  61         , _frame (new wxStaticText (this, wxID_ANY, wxT("")))
  62         , _timecode (new wxStaticText (this, wxID_ANY, wxT("")))
  63         , _play_button (new wxToggleButton (this, wxID_ANY, _("Play")))
  64         , _display_frame_x (0)
  65         , _got_frame (false)
  66 {
  67         _panel->SetDoubleBuffered (true);
  68 #if wxMAJOR_VERSION == 2 && wxMINOR_VERSION >= 9
  69         _panel->SetBackgroundStyle (wxBG_STYLE_PAINT);
  70 #endif
  71
  72         _v_sizer = new wxBoxSizer (wxVERTICAL);
  73         SetSizer (_v_sizer);
  74
  75         _v_sizer->Add (_panel, 1, wxEXPAND);
  76
  77         wxBoxSizer* h_sizer = new wxBoxSizer (wxHORIZONTAL);
  78
  79         wxBoxSizer* time_sizer = new wxBoxSizer (wxVERTICAL);
  80         time_sizer->Add (_frame, 0, wxEXPAND);
  81         time_sizer->Add (_timecode, 0, wxEXPAND);
  82
  83         h_sizer->Add (_back_button, 0, wxALL, 2);
  84         h_sizer->Add (time_sizer, 0, wxEXPAND);
  85         h_sizer->Add (_forward_button, 0, wxALL, 2);
  86         h_sizer->Add (_play_button, 0, wxEXPAND);
  87         h_sizer->Add (_slider, 1, wxEXPAND);
  88
  89         _v_sizer->Add (h_sizer, 0, wxEXPAND | wxALL, 6);
  90
  91         _frame->SetMinSize (wxSize (84, -1));
  92         _back_button->SetMinSize (wxSize (32, -1));
  93         _forward_button->SetMinSize (wxSize (32, -1));
  94
  95         _panel->Connect (wxID_ANY, wxEVT_PAINT, wxPaintEventHandler (FilmViewer::paint_panel), 0, this);
  96         _panel->Connect (wxID_ANY, wxEVT_SIZE, wxSizeEventHandler (FilmViewer::panel_sized), 0, this);
  97         _slider->Connect (wxID_ANY, wxEVT_SCROLL_THUMBTRACK, wxScrollEventHandler (FilmViewer::slider_moved), 0, this);
  98         _slider->Connect (wxID_ANY, wxEVT_SCROLL_PAGEUP, wxScrollEventHandler (FilmViewer::slider_moved), 0, this);
  99         _slider->Connect (wxID_ANY, wxEVT_SCROLL_PAGEDOWN, wxScrollEventHandler (FilmViewer::slider_moved), 0, this);
 100         _play_button->Connect (wxID_ANY, wxEVT_COMMAND_TOGGLEBUTTON_CLICKED, wxCommandEventHandler (FilmViewer::play_clicked), 0, this);
 101         _timer.Connect (wxID_ANY, wxEVT_TIMER, wxTimerEventHandler (FilmViewer::timer), 0, this);
 102         _back_button->Connect (wxID_ANY, wxEVT_COMMAND_BUTTON_CLICKED, wxCommandEventHandler (FilmViewer::back_clicked), 0, this);
 103         _forward_button->Connect (wxID_ANY, wxEVT_COMMAND_BUTTON_CLICKED, wxCommandEventHandler (FilmViewer::forward_clicked), 0, this);
 104
 105         set_film (f);
 106
 107         JobManager::instance()->ActiveJobsChanged.connect (
 108                 bind (&FilmViewer::active_jobs_changed, this, _1)
 109                 );
 110 }
 111
 112 void
 113 FilmViewer::film_changed (Film::Property p)
 114 {
 115         switch (p) {
 116         case Film::FORMAT:
 117                 calculate_sizes ();
 118                 update_from_raw ();
 119                 break;
 120         case Film::CONTENT:
 121         {
 122                 calculate_sizes ();
 123                 wxScrollEvent ev;
 124                 slider_moved (ev);
 125                 break;
 126         }
 127         case Film::WITH_SUBTITLES:
 128         case Film::SUBTITLE_OFFSET:
 129         case Film::SUBTITLE_SCALE:
 130                 raw_to_display ();
 131                 _panel->Refresh ();
 132                 _panel->Update ();
 133                 break;
 134         case Film::SCALER:
 135         case Film::FILTERS:
 136         case Film::CROP:
 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, _4));
 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::FORMAT);
 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 || _player->seek (_player->last_video_time ())) {
 184                 return;
 185         }
 186
 187         get_frame ();
 188         _panel->Refresh ();
 189         _panel->Update ();
 190 }
 191
 192 void
 193 FilmViewer::timer (wxTimerEvent &)
 194 {
 195         if (!_player) {
 196                 return;
 197         }
 198
 199         _panel->Refresh ();
 200         _panel->Update ();
 201
 202         get_frame ();
 203
 204         if (_film->video_length()) {
 205                 int const new_slider_position = 4096 * _player->last_video_time() / (_film->video_length() / _film->video_frame_rate());
 206                 if (new_slider_position != _slider->GetValue()) {
 207                         _slider->SetValue (new_slider_position);
 208                 }
 209         }
 210 }
 211
 212
 213 void
 214 FilmViewer::paint_panel (wxPaintEvent &)
 215 {
 216         wxPaintDC dc (_panel);
 217
 218         if (!_display_frame || !_film || !_out_size.width || !_out_size.height) {
 219                 dc.Clear ();
 220                 return;
 221         }
 222
 223         if (_display_frame_x) {
 224                 dc.SetPen(*wxBLACK_PEN);
 225                 dc.SetBrush(*wxBLACK_BRUSH);
 226                 dc.DrawRectangle (0, 0, _display_frame_x, _film_size.height);
 227                 dc.DrawRectangle (_display_frame_x + _film_size.width, 0, _display_frame_x, _film_size.height);
 228         }
 229
 230         wxImage frame (_film_size.width, _film_size.height, _display_frame->data()[0], true);
 231         wxBitmap frame_bitmap (frame);
 232         dc.DrawBitmap (frame_bitmap, _display_frame_x, 0);
 233
 234         if (_film->with_subtitles() && _display_sub) {
 235                 wxImage sub (_display_sub->size().width, _display_sub->size().height, _display_sub->data()[0], _display_sub->alpha(), true);
 236                 wxBitmap sub_bitmap (sub);
 237                 dc.DrawBitmap (sub_bitmap, _display_sub_position.x, _display_sub_position.y);
 238         }
 239
 240         if (_out_size.width < _panel_size.width) {
 241                 wxPen p (GetBackgroundColour ());
 242                 wxBrush b (GetBackgroundColour ());
 243                 dc.SetPen (p);
 244                 dc.SetBrush (b);
 245                 dc.DrawRectangle (_out_size.width, 0, _panel_size.width - _out_size.width, _panel_size.height);
 246         }
 247
 248         if (_out_size.height < _panel_size.height) {
 249                 wxPen p (GetBackgroundColour ());
 250                 wxBrush b (GetBackgroundColour ());
 251                 dc.SetPen (p);
 252                 dc.SetBrush (b);
 253                 dc.DrawRectangle (0, _out_size.height, _panel_size.width, _panel_size.height - _out_size.height);
 254         }
 255 }
 256
 257
 258 void
 259 FilmViewer::slider_moved (wxScrollEvent &)
 260 {
 261         if (!_film || !_player) {
 262                 return;
 263         }
 264
 265         if (_player->seek (_slider->GetValue() * _film->video_length() / (4096 * _film->video_frame_rate()))) {
 266                 return;
 267         }
 268
 269         get_frame ();
 270         _panel->Refresh ();
 271         _panel->Update ();
 272 }
 273
 274 void
 275 FilmViewer::panel_sized (wxSizeEvent& ev)
 276 {
 277         _panel_size.width = ev.GetSize().GetWidth();
 278         _panel_size.height = ev.GetSize().GetHeight();
 279         calculate_sizes ();
 280         update_from_raw ();
 281 }
 282
 283 void
 284 FilmViewer::update_from_raw ()
 285 {
 286         if (!_raw_frame) {
 287                 return;
 288         }
 289
 290         raw_to_display ();
 291
 292         _panel->Refresh ();
 293         _panel->Update ();
 294 }
 295
 296 void
 297 FilmViewer::raw_to_display ()
 298 {
 299         if (!_raw_frame || _out_size.width < 64 || _out_size.height < 64 || !_film) {
 300                 return;
 301         }
 302
 303         shared_ptr<const Image> input = _raw_frame;
 304
 305         pair<string, string> const s = Filter::ffmpeg_strings (_film->filters());
 306         if (!s.second.empty ()) {
 307                 input = input->post_process (s.second, true);
 308         }
 309
 310         /* Get a compacted image as we have to feed it to wxWidgets */
 311         _display_frame = input->scale_and_convert_to_rgb (_film_size, 0, _film->scaler(), false);
 312
 313         if (_raw_sub) {
 314
 315                 /* Our output is already cropped by the decoder, so we need to account for that
 316                    when working out the scale that we are applying.
 317                 */
 318
 319                 Size const cropped_size = _film->cropped_size (_film->video_size ());
 320
 321                 Rect tx = subtitle_transformed_area (
 322                         float (_film_size.width) / cropped_size.width,
 323                         float (_film_size.height) / cropped_size.height,
 324                         _raw_sub->area(), _film->subtitle_offset(), _film->subtitle_scale()
 325                         );
 326
 327                 _display_sub.reset (new RGBPlusAlphaImage (_raw_sub->image()->scale (tx.size(), _film->scaler(), false)));
 328                 _display_sub_position = tx.position();
 329                 _display_sub_position.x += _display_frame_x;
 330         } else {
 331                 _display_sub.reset ();
 332         }
 333 }
 334
 335 void
 336 FilmViewer::calculate_sizes ()
 337 {
 338         if (!_film || !_player) {
 339                 return;
 340         }
 341
 342         Format const * format = _film->format ();
 343
 344         float const panel_ratio = static_cast<float> (_panel_size.width) / _panel_size.height;
 345         float const film_ratio = format ? format->container_ratio () : 1.78;
 346
 347         if (panel_ratio < film_ratio) {
 348                 /* panel is less widscreen than the film; clamp width */
 349                 _out_size.width = _panel_size.width;
 350                 _out_size.height = _out_size.width / film_ratio;
 351         } else {
 352                 /* panel is more widescreen than the film; clamp height */
 353                 _out_size.height = _panel_size.height;
 354                 _out_size.width = _out_size.height * film_ratio;
 355         }
 356
 357         /* Work out how much padding there is in terms of our display; this will be the x position
 358            of our _display_frame.
 359         */
 360         _display_frame_x = 0;
 361         if (format) {
 362                 _display_frame_x = static_cast<float> (format->dcp_padding (_film)) * _out_size.width / format->dcp_size().width;
 363         }
 364
 365         _film_size = _out_size;
 366         _film_size.width -= _display_frame_x * 2;
 367
 368         /* Catch silly values */
 369         if (_out_size.width < 64) {
 370                 _out_size.width = 64;
 371         }
 372 }
 373
 374 void
 375 FilmViewer::play_clicked (wxCommandEvent &)
 376 {
 377         check_play_state ();
 378 }
 379
 380 void
 381 FilmViewer::check_play_state ()
 382 {
 383         if (!_film) {
 384                 return;
 385         }
 386
 387         if (_play_button->GetValue()) {
 388                 _timer.Start (1000 / _film->video_frame_rate());
 389         } else {
 390                 _timer.Stop ();
 391         }
 392 }
 393
 394 void
 395 FilmViewer::process_video (shared_ptr<const Image> image, bool, shared_ptr<Subtitle> sub, double t)
 396 {
 397         _raw_frame = image;
 398         _raw_sub = sub;
 399
 400         raw_to_display ();
 401
 402         _got_frame = true;
 403
 404         double const fps = _film->video_frame_rate ();
 405         _frame->SetLabel (wxString::Format (wxT("%d"), int (rint (t * fps))));
 406
 407         double w = t;
 408         int const h = (w / 3600);
 409         w -= h * 3600;
 410         int const m = (w / 60);
 411         w -= m * 60;
 412         int const s = floor (w);
 413         w -= s;
 414         int const f = rint (w * fps);
 415         _timecode->SetLabel (wxString::Format (wxT("%02d:%02d:%02d:%02d"), h, m, s, f));
 416 }
 417
 418 /** Get a new _raw_frame from the decoder and then do
 419  *  raw_to_display ().
 420  */
 421 void
 422 FilmViewer::get_frame ()
 423 {
 424         /* Clear our raw frame in case we don't get a new one */
 425         _raw_frame.reset ();
 426
 427         if (!_player) {
 428                 _display_frame.reset ();
 429                 return;
 430         }
 431
 432         try {
 433                 _got_frame = false;
 434                 while (!_got_frame) {
 435                         if (_player->pass ()) {
 436                                 /* We didn't get a frame before the decoder gave up,
 437                                    so clear our display frame.
 438                                 */
 439                                 _display_frame.reset ();
 440                                 break;
 441                         }
 442                 }
 443         } catch (DecodeError& e) {
 444                 _play_button->SetValue (false);
 445                 check_play_state ();
 446                 error_dialog (this, wxString::Format (_("Could not decode video for view (%s)"), std_to_wx(e.what()).data()));
 447         }
 448 }
 449
 450 void
 451 FilmViewer::active_jobs_changed (bool a)
 452 {
 453         if (a) {
 454                 list<shared_ptr<Job> > jobs = JobManager::instance()->get ();
 455                 list<shared_ptr<Job> >::iterator i = jobs.begin ();
 456                 while (i != jobs.end() && boost::dynamic_pointer_cast<ExamineContentJob> (*i) == 0) {
 457                         ++i;
 458                 }
 459
 460                 if (i == jobs.end() || (*i)->finished()) {
 461                         /* no examine content job running, so we're ok to use the viewer */
 462                         a = false;
 463                 }
 464         }
 465
 466         _slider->Enable (!a);
 467         _play_button->Enable (!a);
 468 }
 469
 470 void
 471 FilmViewer::film_content_changed (weak_ptr<Content>, int p)
 472 {
 473         if (p == VideoContentProperty::VIDEO_LENGTH) {
 474                 /* Force an update to our frame */
 475                 wxScrollEvent ev;
 476                 slider_moved (ev);
 477         }
 478 }
 479
 480 void
 481 FilmViewer::back_clicked (wxCommandEvent &)
 482 {
 483         if (!_player) {
 484                 return;
 485         }
 486
 487         _player->seek_back ();
 488         get_frame ();
 489         _panel->Refresh ();
 490         _panel->Update ();
 491 }
 492
 493 void
 494 FilmViewer::forward_clicked (wxCommandEvent &)
 495 {
 496         if (!_player) {
 497                 return;
 498         }
 499
 500         _player->seek_forward ();
 501         get_frame ();
 502         _panel->Refresh ();
 503         _panel->Update ();
 504 }