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                 calculate_sizes ();
 122                 get_frame ();
 123                 _panel->Refresh ();
 124                 _v_sizer->Layout ();
 125                 break;
 126         case Film::WITH_SUBTITLES:
 127         case Film::SUBTITLE_OFFSET:
 128         case Film::SUBTITLE_SCALE:
 129                 raw_to_display ();
 130                 _panel->Refresh ();
 131                 _panel->Update ();
 132                 break;
 133         case Film::SCALER:
 134         case Film::FILTERS:
 135         case Film::CROP:
 136                 update_from_decoder ();
 137                 break;
 138         default:
 139                 break;
 140         }
 141 }
 142
 143 void
 144 FilmViewer::set_film (shared_ptr<Film> f)
 145 {
 146         if (_film == f) {
 147                 return;
 148         }
 149
 150         _film = f;
 151
 152         _raw_frame.reset ();
 153         _display_frame.reset ();
 154         _panel->Refresh ();
 155         _panel->Update ();
 156
 157         if (!_film) {
 158                 return;
 159         }
 160
 161         _player = f->player ();
 162         _player->disable_audio ();
 163         /* Don't disable subtitles here as we may need them, and it's nice to be able to turn them
 164            on and off without needing obtain a new Player.
 165         */
 166
 167         _player->Video.connect (bind (&FilmViewer::process_video, this, _1, _2, _3, _4));
 168
 169         _film->Changed.connect (boost::bind (&FilmViewer::film_changed, this, _1));
 170         _film->ContentChanged.connect (boost::bind (&FilmViewer::film_content_changed, this, _1, _2));
 171
 172         film_changed (Film::CONTENT);
 173         film_changed (Film::FORMAT);
 174         film_changed (Film::WITH_SUBTITLES);
 175         film_changed (Film::SUBTITLE_OFFSET);
 176         film_changed (Film::SUBTITLE_SCALE);
 177 }
 178
 179 void
 180 FilmViewer::update_from_decoder ()
 181 {
 182         if (!_player || _player->seek (_player->last_video_time ())) {
 183                 return;
 184         }
 185
 186         get_frame ();
 187         _panel->Refresh ();
 188         _panel->Update ();
 189 }
 190
 191 void
 192 FilmViewer::timer (wxTimerEvent &)
 193 {
 194         if (!_player) {
 195                 return;
 196         }
 197
 198         _panel->Refresh ();
 199         _panel->Update ();
 200
 201         get_frame ();
 202
 203         if (_film->video_length()) {
 204                 int const new_slider_position = 4096 * _player->last_video_time() / (_film->video_length() / _film->video_frame_rate());
 205                 if (new_slider_position != _slider->GetValue()) {
 206                         _slider->SetValue (new_slider_position);
 207                 }
 208         }
 209 }
 210
 211
 212 void
 213 FilmViewer::paint_panel (wxPaintEvent &)
 214 {
 215         wxPaintDC dc (_panel);
 216
 217         if (!_display_frame || !_film || !_out_size.width || !_out_size.height) {
 218                 dc.Clear ();
 219                 return;
 220         }
 221
 222         if (_display_frame_x) {
 223                 dc.SetPen(*wxBLACK_PEN);
 224                 dc.SetBrush(*wxBLACK_BRUSH);
 225                 dc.DrawRectangle (0, 0, _display_frame_x, _film_size.height);
 226                 dc.DrawRectangle (_display_frame_x + _film_size.width, 0, _display_frame_x, _film_size.height);
 227         }
 228
 229         wxImage frame (_film_size.width, _film_size.height, _display_frame->data()[0], true);
 230         wxBitmap frame_bitmap (frame);
 231         dc.DrawBitmap (frame_bitmap, _display_frame_x, 0);
 232
 233         if (_film->with_subtitles() && _display_sub) {
 234                 wxImage sub (_display_sub->size().width, _display_sub->size().height, _display_sub->data()[0], _display_sub->alpha(), true);
 235                 wxBitmap sub_bitmap (sub);
 236                 dc.DrawBitmap (sub_bitmap, _display_sub_position.x, _display_sub_position.y);
 237         }
 238
 239         if (_out_size.width < _panel_size.width) {
 240                 wxPen p (GetBackgroundColour ());
 241                 wxBrush b (GetBackgroundColour ());
 242                 dc.SetPen (p);
 243                 dc.SetBrush (b);
 244                 dc.DrawRectangle (_out_size.width, 0, _panel_size.width - _out_size.width, _panel_size.height);
 245         }
 246
 247         if (_out_size.height < _panel_size.height) {
 248                 wxPen p (GetBackgroundColour ());
 249                 wxBrush b (GetBackgroundColour ());
 250                 dc.SetPen (p);
 251                 dc.SetBrush (b);
 252                 dc.DrawRectangle (0, _out_size.height, _panel_size.width, _panel_size.height - _out_size.height);
 253         }
 254 }
 255
 256
 257 void
 258 FilmViewer::slider_moved (wxScrollEvent &)
 259 {
 260         if (!_film || !_player) {
 261                 return;
 262         }
 263
 264         if (_player->seek (_slider->GetValue() * _film->video_length() / (4096 * _film->video_frame_rate()))) {
 265                 return;
 266         }
 267
 268         get_frame ();
 269         _panel->Refresh ();
 270         _panel->Update ();
 271 }
 272
 273 void
 274 FilmViewer::panel_sized (wxSizeEvent& ev)
 275 {
 276         _panel_size.width = ev.GetSize().GetWidth();
 277         _panel_size.height = ev.GetSize().GetHeight();
 278         calculate_sizes ();
 279         update_from_raw ();
 280 }
 281
 282 void
 283 FilmViewer::update_from_raw ()
 284 {
 285         if (!_raw_frame) {
 286                 return;
 287         }
 288
 289         raw_to_display ();
 290
 291         _panel->Refresh ();
 292         _panel->Update ();
 293 }
 294
 295 void
 296 FilmViewer::raw_to_display ()
 297 {
 298         if (!_raw_frame || _out_size.width < 64 || _out_size.height < 64 || !_film) {
 299                 return;
 300         }
 301
 302         shared_ptr<Image> input = _raw_frame;
 303
 304         pair<string, string> const s = Filter::ffmpeg_strings (_film->filters());
 305         if (!s.second.empty ()) {
 306                 input = input->post_process (s.second, true);
 307         }
 308
 309         /* Get a compacted image as we have to feed it to wxWidgets */
 310         _display_frame = input->scale_and_convert_to_rgb (_film_size, 0, _film->scaler(), false);
 311
 312         if (_raw_sub) {
 313
 314                 /* Our output is already cropped by the decoder, so we need to account for that
 315                    when working out the scale that we are applying.
 316                 */
 317
 318                 Size const cropped_size = _film->cropped_size (_film->video_size ());
 319
 320                 Rect tx = subtitle_transformed_area (
 321                         float (_film_size.width) / cropped_size.width,
 322                         float (_film_size.height) / cropped_size.height,
 323                         _raw_sub->area(), _film->subtitle_offset(), _film->subtitle_scale()
 324                         );
 325
 326                 _display_sub.reset (new RGBPlusAlphaImage (_raw_sub->image()->scale (tx.size(), _film->scaler(), false)));
 327                 _display_sub_position = tx.position();
 328                 _display_sub_position.x += _display_frame_x;
 329         } else {
 330                 _display_sub.reset ();
 331         }
 332 }
 333
 334 void
 335 FilmViewer::calculate_sizes ()
 336 {
 337         if (!_film || !_player) {
 338                 return;
 339         }
 340
 341         Format const * format = _film->format ();
 342
 343         float const panel_ratio = static_cast<float> (_panel_size.width) / _panel_size.height;
 344         float const film_ratio = format ? format->container_ratio () : 1.78;
 345
 346         if (panel_ratio < film_ratio) {
 347                 /* panel is less widscreen than the film; clamp width */
 348                 _out_size.width = _panel_size.width;
 349                 _out_size.height = _out_size.width / film_ratio;
 350         } else {
 351                 /* panel is more widescreen than the film; clamp height */
 352                 _out_size.height = _panel_size.height;
 353                 _out_size.width = _out_size.height * film_ratio;
 354         }
 355
 356         /* Work out how much padding there is in terms of our display; this will be the x position
 357            of our _display_frame.
 358         */
 359         _display_frame_x = 0;
 360         if (format) {
 361                 _display_frame_x = static_cast<float> (format->dcp_padding (_film)) * _out_size.width / format->dcp_size().width;
 362         }
 363
 364         _film_size = _out_size;
 365         _film_size.width -= _display_frame_x * 2;
 366
 367         /* Catch silly values */
 368         if (_out_size.width < 64) {
 369                 _out_size.width = 64;
 370         }
 371 }
 372
 373 void
 374 FilmViewer::play_clicked (wxCommandEvent &)
 375 {
 376         check_play_state ();
 377 }
 378
 379 void
 380 FilmViewer::check_play_state ()
 381 {
 382         if (!_film) {
 383                 return;
 384         }
 385
 386         if (_play_button->GetValue()) {
 387                 _timer.Start (1000 / _film->video_frame_rate());
 388         } else {
 389                 _timer.Stop ();
 390         }
 391 }
 392
 393 void
 394 FilmViewer::process_video (shared_ptr<Image> image, bool, shared_ptr<Subtitle> sub, double t)
 395 {
 396         _raw_frame = image;
 397         _raw_sub = sub;
 398
 399         raw_to_display ();
 400
 401         _got_frame = true;
 402
 403         double const fps = _film->video_frame_rate ();
 404         _frame->SetLabel (wxString::Format (wxT("%d"), int (rint (t * fps))));
 405
 406         double w = t;
 407         int const h = (w / 3600);
 408         w -= h * 3600;
 409         int const m = (w / 60);
 410         w -= m * 60;
 411         int const s = floor (w);
 412         w -= s;
 413         int const f = rint (w * fps);
 414         _timecode->SetLabel (wxString::Format (wxT("%02d:%02d:%02d:%02d"), h, m, s, f));
 415 }
 416
 417 /** Get a new _raw_frame from the decoder and then do
 418  *  raw_to_display ().
 419  */
 420 void
 421 FilmViewer::get_frame ()
 422 {
 423         /* Clear our raw frame in case we don't get a new one */
 424         _raw_frame.reset ();
 425
 426         if (!_player) {
 427                 _display_frame.reset ();
 428                 return;
 429         }
 430
 431         try {
 432                 _got_frame = false;
 433                 while (!_got_frame) {
 434                         if (_player->pass ()) {
 435                                 /* We didn't get a frame before the decoder gave up,
 436                                    so clear our display frame.
 437                                 */
 438                                 _display_frame.reset ();
 439                                 break;
 440                         }
 441                 }
 442         } catch (DecodeError& e) {
 443                 _play_button->SetValue (false);
 444                 check_play_state ();
 445                 error_dialog (this, wxString::Format (_("Could not decode video for view (%s)"), std_to_wx(e.what()).data()));
 446         }
 447 }
 448
 449 void
 450 FilmViewer::active_jobs_changed (bool a)
 451 {
 452         if (a) {
 453                 list<shared_ptr<Job> > jobs = JobManager::instance()->get ();
 454                 list<shared_ptr<Job> >::iterator i = jobs.begin ();
 455                 while (i != jobs.end() && boost::dynamic_pointer_cast<ExamineContentJob> (*i) == 0) {
 456                         ++i;
 457                 }
 458
 459                 if (i == jobs.end() || (*i)->finished()) {
 460                         /* no examine content job running, so we're ok to use the viewer */
 461                         a = false;
 462                 }
 463         }
 464
 465         _slider->Enable (!a);
 466         _play_button->Enable (!a);
 467 }
 468
 469 void
 470 FilmViewer::film_content_changed (weak_ptr<Content>, int p)
 471 {
 472         if (p == VideoContentProperty::VIDEO_LENGTH) {
 473                 /* Force an update to our frame */
 474                 wxScrollEvent ev;
 475                 slider_moved (ev);
 476         }
 477 }
 478
 479 void
 480 FilmViewer::back_clicked (wxCommandEvent &)
 481 {
 482         if (!_player) {
 483                 return;
 484         }
 485
 486         _player->seek_back ();
 487         get_frame ();
 488         _panel->Refresh ();
 489         _panel->Update ();
 490 }
 491
 492 void
 493 FilmViewer::forward_clicked (wxCommandEvent &)
 494 {
 495         if (!_player) {
 496                 return;
 497         }
 498
 499         _player->seek_forward ();
 500         get_frame ();
 501         _panel->Refresh ();
 502         _panel->Update ();
 503 }