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/container.h"
  31 #include "lib/format.h"
  32 #include "lib/util.h"
  33 #include "lib/job_manager.h"
  34 #include "lib/subtitle.h"
  35 #include "lib/image.h"
  36 #include "lib/scaler.h"
  37 #include "lib/exceptions.h"
  38 #include "lib/examine_content_job.h"
  39 #include "lib/filter.h"
  40 #include "lib/player.h"
  41 #include "lib/video_content.h"
  42 #include "lib/ffmpeg_content.h"
  43 #include "lib/imagemagick_content.h"
  44 #include "film_viewer.h"
  45 #include "wx_util.h"
  46 #include "video_decoder.h"
  47
  48 using std::string;
  49 using std::pair;
  50 using std::max;
  51 using std::cout;
  52 using std::list;
  53 using boost::shared_ptr;
  54 using boost::dynamic_pointer_cast;
  55 using boost::weak_ptr;
  56 using libdcp::Size;
  57
  58 FilmViewer::FilmViewer (shared_ptr<Film> f, wxWindow* p)
  59         : wxPanel (p)
  60         , _panel (new wxPanel (this))
  61         , _slider (new wxSlider (this, wxID_ANY, 0, 0, 4096))
  62         , _back_button (new wxButton (this, wxID_ANY, wxT("<")))
  63         , _forward_button (new wxButton (this, wxID_ANY, wxT(">")))
  64         , _frame (new wxStaticText (this, wxID_ANY, wxT("")))
  65         , _timecode (new wxStaticText (this, wxID_ANY, wxT("")))
  66         , _play_button (new wxToggleButton (this, wxID_ANY, _("Play")))
  67         , _display_frame_x (0)
  68         , _got_frame (false)
  69 {
  70         _panel->SetDoubleBuffered (true);
  71 #if wxMAJOR_VERSION == 2 && wxMINOR_VERSION >= 9
  72         _panel->SetBackgroundStyle (wxBG_STYLE_PAINT);
  73 #endif
  74
  75         _v_sizer = new wxBoxSizer (wxVERTICAL);
  76         SetSizer (_v_sizer);
  77
  78         _v_sizer->Add (_panel, 1, wxEXPAND);
  79
  80         wxBoxSizer* h_sizer = new wxBoxSizer (wxHORIZONTAL);
  81
  82         wxBoxSizer* time_sizer = new wxBoxSizer (wxVERTICAL);
  83         time_sizer->Add (_frame, 0, wxEXPAND);
  84         time_sizer->Add (_timecode, 0, wxEXPAND);
  85
  86         h_sizer->Add (_back_button, 0, wxALL, 2);
  87         h_sizer->Add (time_sizer, 0, wxEXPAND);
  88         h_sizer->Add (_forward_button, 0, wxALL, 2);
  89         h_sizer->Add (_play_button, 0, wxEXPAND);
  90         h_sizer->Add (_slider, 1, wxEXPAND);
  91
  92         _v_sizer->Add (h_sizer, 0, wxEXPAND | wxALL, 6);
  93
  94         _frame->SetMinSize (wxSize (84, -1));
  95         _back_button->SetMinSize (wxSize (32, -1));
  96         _forward_button->SetMinSize (wxSize (32, -1));
  97
  98         _panel->Connect (wxID_ANY, wxEVT_PAINT, wxPaintEventHandler (FilmViewer::paint_panel), 0, this);
  99         _panel->Connect (wxID_ANY, wxEVT_SIZE, wxSizeEventHandler (FilmViewer::panel_sized), 0, this);
 100         _slider->Connect (wxID_ANY, wxEVT_SCROLL_THUMBTRACK, wxScrollEventHandler (FilmViewer::slider_moved), 0, this);
 101         _slider->Connect (wxID_ANY, wxEVT_SCROLL_PAGEUP, wxScrollEventHandler (FilmViewer::slider_moved), 0, this);
 102         _slider->Connect (wxID_ANY, wxEVT_SCROLL_PAGEDOWN, wxScrollEventHandler (FilmViewer::slider_moved), 0, this);
 103         _play_button->Connect (wxID_ANY, wxEVT_COMMAND_TOGGLEBUTTON_CLICKED, wxCommandEventHandler (FilmViewer::play_clicked), 0, this);
 104         _timer.Connect (wxID_ANY, wxEVT_TIMER, wxTimerEventHandler (FilmViewer::timer), 0, this);
 105         _back_button->Connect (wxID_ANY, wxEVT_COMMAND_BUTTON_CLICKED, wxCommandEventHandler (FilmViewer::back_clicked), 0, this);
 106         _forward_button->Connect (wxID_ANY, wxEVT_COMMAND_BUTTON_CLICKED, wxCommandEventHandler (FilmViewer::forward_clicked), 0, this);
 107
 108         set_film (f);
 109
 110         JobManager::instance()->ActiveJobsChanged.connect (
 111                 bind (&FilmViewer::active_jobs_changed, this, _1)
 112                 );
 113 }
 114
 115 void
 116 FilmViewer::film_changed (Film::Property p)
 117 {
 118         switch (p) {
 119         case Film::CONTAINER:
 120                 calculate_sizes ();
 121                 update_from_raw ();
 122                 break;
 123         case Film::CONTENT:
 124         {
 125                 calculate_sizes ();
 126                 wxScrollEvent ev;
 127                 slider_moved (ev);
 128                 break;
 129         }
 130         case Film::WITH_SUBTITLES:
 131         case Film::SUBTITLE_OFFSET:
 132         case Film::SUBTITLE_SCALE:
 133                 raw_to_display ();
 134                 _panel->Refresh ();
 135                 _panel->Update ();
 136                 break;
 137         case Film::SCALER:
 138                 update_from_decoder ();
 139                 break;
 140         default:
 141                 break;
 142         }
 143 }
 144
 145 void
 146 FilmViewer::set_film (shared_ptr<Film> f)
 147 {
 148         if (_film == f) {
 149                 return;
 150         }
 151
 152         _film = f;
 153
 154         _raw_frame.reset ();
 155         _display_frame.reset ();
 156         _panel->Refresh ();
 157         _panel->Update ();
 158
 159         if (!_film) {
 160                 return;
 161         }
 162
 163         _player = f->player ();
 164         _player->disable_audio ();
 165         /* Don't disable subtitles here as we may need them, and it's nice to be able to turn them
 166            on and off without needing obtain a new Player.
 167         */
 168
 169         _player->Video.connect (bind (&FilmViewer::process_video, this, _1, _2, _3, _4));
 170
 171         _film->Changed.connect (boost::bind (&FilmViewer::film_changed, this, _1));
 172         _film->ContentChanged.connect (boost::bind (&FilmViewer::film_content_changed, this, _1, _2));
 173
 174         film_changed (Film::CONTENT);
 175         film_changed (Film::CONTAINER);
 176         film_changed (Film::WITH_SUBTITLES);
 177         film_changed (Film::SUBTITLE_OFFSET);
 178         film_changed (Film::SUBTITLE_SCALE);
 179 }
 180
 181 void
 182 FilmViewer::update_from_decoder ()
 183 {
 184         if (!_player) {
 185                 return;
 186         }
 187
 188         _player->seek (_player->position ());
 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->position() / _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         cout << "slider " << _slider->GetValue() << " " << _film->length() << "\n";
 264
 265         if (_film && _player) {
 266                 _player->seek (_slider->GetValue() * _film->length() / 4096);
 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         /* Get a compacted image as we have to feed it to wxWidgets */
 304         _display_frame = _raw_frame->scale_and_convert_to_rgb (_film_size, 0, _film->scaler(), false);
 305
 306         if (_raw_sub) {
 307
 308                 /* Our output is already cropped by the decoder, so we need to account for that
 309                    when working out the scale that we are applying.
 310                 */
 311
 312                 /* XXX */
 313                 Size const cropped_size = _raw_frame->size ();//_film->cropped_size (_raw_frame->size ());
 314
 315                 Rect tx = subtitle_transformed_area (
 316                         float (_film_size.width) / cropped_size.width,
 317                         float (_film_size.height) / cropped_size.height,
 318                         _raw_sub->area(), _film->subtitle_offset(), _film->subtitle_scale()
 319                         );
 320
 321                 _display_sub.reset (new RGBPlusAlphaImage (_raw_sub->image()->scale (tx.size(), _film->scaler(), false)));
 322                 _display_sub_position = tx.position();
 323                 _display_sub_position.x += _display_frame_x;
 324         } else {
 325                 _display_sub.reset ();
 326         }
 327 }
 328
 329 void
 330 FilmViewer::calculate_sizes ()
 331 {
 332         if (!_film || !_player) {
 333                 return;
 334         }
 335
 336         Container const * container = _film->container ();
 337
 338         float const panel_ratio = static_cast<float> (_panel_size.width) / _panel_size.height;
 339         float const film_ratio = container ? container->ratio () : 1.78;
 340
 341         if (panel_ratio < film_ratio) {
 342                 /* panel is less widscreen than the film; clamp width */
 343                 _out_size.width = _panel_size.width;
 344                 _out_size.height = _out_size.width / film_ratio;
 345         } else {
 346                 /* panel is more widescreen than the film; clamp height */
 347                 _out_size.height = _panel_size.height;
 348                 _out_size.width = _out_size.height * film_ratio;
 349         }
 350
 351         /* Work out how much padding there is in terms of our display; this will be the x position
 352            of our _display_frame.
 353         */
 354         _display_frame_x = 0;
 355 //      if (format) {
 356 //              _display_frame_x = static_cast<float> (format->dcp_padding (_film)) * _out_size.width / format->dcp_size().width;
 357 //      }
 358
 359         _film_size = _out_size;
 360         _film_size.width -= _display_frame_x * 2;
 361
 362         /* Catch silly values */
 363         if (_out_size.width < 64) {
 364                 _out_size.width = 64;
 365         }
 366 }
 367
 368 void
 369 FilmViewer::play_clicked (wxCommandEvent &)
 370 {
 371         check_play_state ();
 372 }
 373
 374 void
 375 FilmViewer::check_play_state ()
 376 {
 377         if (!_film || _film->dcp_video_frame_rate() == 0) {
 378                 return;
 379         }
 380
 381         if (_play_button->GetValue()) {
 382                 _timer.Start (1000 / _film->dcp_video_frame_rate());
 383         } else {
 384                 _timer.Stop ();
 385         }
 386 }
 387
 388 void
 389 FilmViewer::process_video (shared_ptr<const Image> image, bool, shared_ptr<Subtitle> sub, Time t)
 390 {
 391         _raw_frame = image;
 392         _raw_sub = sub;
 393
 394         raw_to_display ();
 395
 396         _got_frame = true;
 397
 398         double const fps = _film->dcp_video_frame_rate ();
 399         _frame->SetLabel (wxString::Format (wxT("%d"), int (rint (t * fps / TIME_HZ))));
 400
 401         double w = static_cast<double>(t) / TIME_HZ;
 402         int const h = (w / 3600);
 403         w -= h * 3600;
 404         int const m = (w / 60);
 405         w -= m * 60;
 406         int const s = floor (w);
 407         w -= s;
 408         int const f = rint (w * fps);
 409         _timecode->SetLabel (wxString::Format (wxT("%02d:%02d:%02d:%02d"), h, m, s, f));
 410 }
 411
 412 /** Get a new _raw_frame from the decoder and then do
 413  *  raw_to_display ().
 414  */
 415 void
 416 FilmViewer::get_frame ()
 417 {
 418         /* Clear our raw frame in case we don't get a new one */
 419         _raw_frame.reset ();
 420
 421         if (!_player) {
 422                 _display_frame.reset ();
 423                 return;
 424         }
 425
 426         try {
 427                 _got_frame = false;
 428                 while (!_got_frame) {
 429                         if (_player->pass ()) {
 430                                 /* We didn't get a frame before the decoder gave up,
 431                                    so clear our display frame.
 432                                 */
 433                                 _display_frame.reset ();
 434                                 break;
 435                         }
 436                 }
 437         } catch (DecodeError& e) {
 438                 _play_button->SetValue (false);
 439                 check_play_state ();
 440                 error_dialog (this, wxString::Format (_("Could not decode video for view (%s)"), std_to_wx(e.what()).data()));
 441         }
 442 }
 443
 444 void
 445 FilmViewer::active_jobs_changed (bool a)
 446 {
 447         if (a) {
 448                 list<shared_ptr<Job> > jobs = JobManager::instance()->get ();
 449                 list<shared_ptr<Job> >::iterator i = jobs.begin ();
 450                 while (i != jobs.end() && boost::dynamic_pointer_cast<ExamineContentJob> (*i) == 0) {
 451                         ++i;
 452                 }
 453
 454                 if (i == jobs.end() || (*i)->finished()) {
 455                         /* no examine content job running, so we're ok to use the viewer */
 456                         a = false;
 457                 }
 458         }
 459
 460         _slider->Enable (!a);
 461         _play_button->Enable (!a);
 462 }
 463
 464 void
 465 FilmViewer::film_content_changed (weak_ptr<Content>, int p)
 466 {
 467         if (p == VideoContentProperty::VIDEO_LENGTH) {
 468                 /* Force an update to our frame */
 469                 wxScrollEvent ev;
 470                 slider_moved (ev);
 471         } else if (p == VideoContentProperty::VIDEO_CROP) {
 472                 update_from_decoder ();
 473         }
 474 }
 475
 476 void
 477 FilmViewer::back_clicked (wxCommandEvent &)
 478 {
 479         if (!_player) {
 480                 return;
 481         }
 482
 483         _player->seek_back ();
 484         get_frame ();
 485         _panel->Refresh ();
 486         _panel->Update ();
 487 }
 488
 489 void
 490 FilmViewer::forward_clicked (wxCommandEvent &)
 491 {
 492         if (!_player) {
 493                 return;
 494         }
 495
 496         _player->seek_forward ();
 497         get_frame ();
 498         _panel->Refresh ();
 499         _panel->Update ();
 500 }