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/playlist.h"
  38 #include "lib/video_content.h"
  39 #include "lib/ffmpeg_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 libdcp::Size;
  51
  52 FilmViewer::FilmViewer (shared_ptr<Film> f, wxWindow* p)
  53         : wxPanel (p)
  54         , _panel (new wxPanel (this))
  55         , _slider (new wxSlider (this, wxID_ANY, 0, 0, 4096))
  56         , _play_button (new wxToggleButton (this, wxID_ANY, _("Play")))
  57         , _display_frame_x (0)
  58         , _got_frame (false)
  59         , _clear_required (false)
  60 {
  61         _panel->SetDoubleBuffered (true);
  62 #if wxMAJOR_VERSION == 2 && wxMINOR_VERSION >= 9
  63         _panel->SetBackgroundStyle (wxBG_STYLE_PAINT);
  64 #endif
  65
  66         _v_sizer = new wxBoxSizer (wxVERTICAL);
  67         SetSizer (_v_sizer);
  68
  69         _v_sizer->Add (_panel, 1, wxEXPAND);
  70
  71         wxBoxSizer* h_sizer = new wxBoxSizer (wxHORIZONTAL);
  72         h_sizer->Add (_play_button, 0, wxEXPAND);
  73         h_sizer->Add (_slider, 1, wxEXPAND);
  74
  75         _v_sizer->Add (h_sizer, 0, wxEXPAND | wxALL, 6);
  76
  77         _panel->Connect (wxID_ANY, wxEVT_PAINT, wxPaintEventHandler (FilmViewer::paint_panel), 0, this);
  78         _panel->Connect (wxID_ANY, wxEVT_SIZE, wxSizeEventHandler (FilmViewer::panel_sized), 0, this);
  79         _slider->Connect (wxID_ANY, wxEVT_SCROLL_THUMBTRACK, wxScrollEventHandler (FilmViewer::slider_moved), 0, this);
  80         _slider->Connect (wxID_ANY, wxEVT_SCROLL_PAGEUP, wxScrollEventHandler (FilmViewer::slider_moved), 0, this);
  81         _slider->Connect (wxID_ANY, wxEVT_SCROLL_PAGEDOWN, wxScrollEventHandler (FilmViewer::slider_moved), 0, this);
  82         _play_button->Connect (wxID_ANY, wxEVT_COMMAND_TOGGLEBUTTON_CLICKED, wxCommandEventHandler (FilmViewer::play_clicked), 0, this);
  83         _timer.Connect (wxID_ANY, wxEVT_TIMER, wxTimerEventHandler (FilmViewer::timer), 0, this);
  84
  85         set_film (f);
  86
  87         JobManager::instance()->ActiveJobsChanged.connect (
  88                 bind (&FilmViewer::active_jobs_changed, this, _1)
  89                 );
  90 }
  91
  92 void
  93 FilmViewer::film_changed (Film::Property p)
  94 {
  95         switch (p) {
  96         case Film::FORMAT:
  97                 calculate_sizes ();
  98                 update_from_raw ();
  99                 break;
 100         case Film::CONTENT:
 101         {
 102                 setup_player ();
 103                 calculate_sizes ();
 104                 get_frame ();
 105                 _panel->Refresh ();
 106                 _v_sizer->Layout ();
 107                 break;
 108         }
 109         case Film::WITH_SUBTITLES:
 110         case Film::SUBTITLE_OFFSET:
 111         case Film::SUBTITLE_SCALE:
 112         case Film::SCALER:
 113         case Film::FILTERS:
 114         case Film::CROP:
 115                 update_from_decoder ();
 116                 break;
 117         default:
 118                 break;
 119         }
 120 }
 121
 122 void
 123 FilmViewer::setup_player ()
 124 {
 125         _player = _film->player ();
 126         _player->disable_audio ();
 127         _player->disable_subtitles ();
 128         _player->disable_video_sync ();
 129         _player->Video.connect (bind (&FilmViewer::process_video, this, _1, _2, _3));
 130 }
 131
 132 void
 133 FilmViewer::film_content_changed (int p)
 134 {
 135         if (p == VideoContentProperty::VIDEO_LENGTH || p == VideoContentProperty::VIDEO_SIZE) {
 136                 setup_player ();
 137                 calculate_sizes ();
 138                 get_frame ();
 139                 _panel->Refresh ();
 140                 _v_sizer->Layout ();
 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         if (!_film) {
 154                 return;
 155         }
 156
 157         _film->Changed.connect (boost::bind (&FilmViewer::film_changed, this, _1));
 158         _film->ContentChanged.connect (boost::bind (&FilmViewer::film_content_changed, this, _1));
 159
 160         film_changed (Film::CONTENT);
 161         film_changed (Film::FORMAT);
 162         film_changed (Film::WITH_SUBTITLES);
 163         film_changed (Film::SUBTITLE_OFFSET);
 164         film_changed (Film::SUBTITLE_SCALE);
 165         film_content_changed (FFmpegContentProperty::SUBTITLE_STREAM);
 166 }
 167
 168 void
 169 FilmViewer::update_from_decoder ()
 170 {
 171         if (!_player || _player->seek_to_last ()) {
 172                 return;
 173         }
 174
 175         get_frame ();
 176         _panel->Refresh ();
 177         _panel->Update ();
 178 }
 179
 180 void
 181 FilmViewer::timer (wxTimerEvent &)
 182 {
 183         if (!_player) {
 184                 return;
 185         }
 186
 187         _panel->Refresh ();
 188         _panel->Update ();
 189
 190         get_frame ();
 191
 192         if (_film->video_length()) {
 193                 int const new_slider_position = 4096 * _player->last_video_time() / (_film->video_length() / _film->video_frame_rate());
 194                 if (new_slider_position != _slider->GetValue()) {
 195                         _slider->SetValue (new_slider_position);
 196                 }
 197         }
 198 }
 199
 200
 201 void
 202 FilmViewer::paint_panel (wxPaintEvent &)
 203 {
 204         wxPaintDC dc (_panel);
 205
 206         if (_clear_required) {
 207                 dc.Clear ();
 208                 _clear_required = false;
 209         }
 210
 211         if (!_display_frame || !_film || !_out_size.width || !_out_size.height) {
 212                 dc.Clear ();
 213                 return;
 214         }
 215
 216         if (_display_frame_x) {
 217                 dc.SetPen(*wxBLACK_PEN);
 218                 dc.SetBrush(*wxBLACK_BRUSH);
 219                 dc.DrawRectangle (0, 0, _display_frame_x, _film_size.height);
 220                 dc.DrawRectangle (_display_frame_x + _film_size.width, 0, _display_frame_x, _film_size.height);
 221         }
 222
 223         wxImage frame (_film_size.width, _film_size.height, _display_frame->data()[0], true);
 224         wxBitmap frame_bitmap (frame);
 225         dc.DrawBitmap (frame_bitmap, _display_frame_x, 0);
 226
 227         if (_film->with_subtitles() && _display_sub) {
 228                 wxImage sub (_display_sub->size().width, _display_sub->size().height, _display_sub->data()[0], _display_sub->alpha(), true);
 229                 wxBitmap sub_bitmap (sub);
 230                 dc.DrawBitmap (sub_bitmap, _display_sub_position.x, _display_sub_position.y);
 231         }
 232 }
 233
 234
 235 void
 236 FilmViewer::slider_moved (wxScrollEvent &)
 237 {
 238         if (!_film || !_player) {
 239                 return;
 240         }
 241
 242         if (_player->seek (_slider->GetValue() * _film->video_length() / (4096 * _film->video_frame_rate()))) {
 243                 return;
 244         }
 245
 246         get_frame ();
 247         _panel->Refresh ();
 248         _panel->Update ();
 249 }
 250
 251 void
 252 FilmViewer::panel_sized (wxSizeEvent& ev)
 253 {
 254         _panel_size.width = ev.GetSize().GetWidth();
 255         _panel_size.height = ev.GetSize().GetHeight();
 256         calculate_sizes ();
 257         update_from_raw ();
 258 }
 259
 260 void
 261 FilmViewer::update_from_raw ()
 262 {
 263         if (!_raw_frame) {
 264                 return;
 265         }
 266
 267         raw_to_display ();
 268
 269         _panel->Refresh ();
 270         _panel->Update ();
 271 }
 272
 273 void
 274 FilmViewer::raw_to_display ()
 275 {
 276         if (!_raw_frame || _out_size.width < 64 || _out_size.height < 64 || !_film) {
 277                 return;
 278         }
 279
 280         libdcp::Size old_size;
 281         if (_display_frame) {
 282                 old_size = _display_frame->size();
 283         }
 284
 285         boost::shared_ptr<Image> input = _raw_frame;
 286
 287         pair<string, string> const s = Filter::ffmpeg_strings (_film->filters());
 288         if (!s.second.empty ()) {
 289                 input = input->post_process (s.second, true);
 290         }
 291
 292         /* Get a compacted image as we have to feed it to wxWidgets */
 293         _display_frame = input->scale_and_convert_to_rgb (_film_size, 0, _film->scaler(), false);
 294
 295         if (old_size != _display_frame->size()) {
 296                 _clear_required = true;
 297         }
 298
 299         if (_raw_sub) {
 300
 301                 /* Our output is already cropped by the decoder, so we need to account for that
 302                    when working out the scale that we are applying.
 303                 */
 304
 305                 Size const cropped_size = _film->cropped_size (_film->video_size ());
 306
 307                 Rect tx = subtitle_transformed_area (
 308                         float (_film_size.width) / cropped_size.width,
 309                         float (_film_size.height) / cropped_size.height,
 310                         _raw_sub->area(), _film->subtitle_offset(), _film->subtitle_scale()
 311                         );
 312
 313                 _display_sub.reset (new RGBPlusAlphaImage (_raw_sub->image()->scale (tx.size(), _film->scaler(), false)));
 314                 _display_sub_position = tx.position();
 315                 _display_sub_position.x += _display_frame_x;
 316         } else {
 317                 _display_sub.reset ();
 318         }
 319 }
 320
 321 void
 322 FilmViewer::calculate_sizes ()
 323 {
 324         if (!_film || !_player) {
 325                 return;
 326         }
 327
 328         Format const * format = _film->format ();
 329
 330         float const panel_ratio = static_cast<float> (_panel_size.width) / _panel_size.height;
 331         float const film_ratio = format ? format->container_ratio_as_float () : 1.78;
 332
 333         if (panel_ratio < film_ratio) {
 334                 /* panel is less widscreen than the film; clamp width */
 335                 _out_size.width = _panel_size.width;
 336                 _out_size.height = _out_size.width / film_ratio;
 337         } else {
 338                 /* panel is more widescreen than the film; clamp height */
 339                 _out_size.height = _panel_size.height;
 340                 _out_size.width = _out_size.height * film_ratio;
 341         }
 342
 343         /* Work out how much padding there is in terms of our display; this will be the x position
 344            of our _display_frame.
 345         */
 346         _display_frame_x = 0;
 347         if (format) {
 348                 _display_frame_x = static_cast<float> (format->dcp_padding (_film)) * _out_size.width / format->dcp_size().width;
 349         }
 350
 351         _film_size = _out_size;
 352         _film_size.width -= _display_frame_x * 2;
 353
 354         /* Catch silly values */
 355         if (_out_size.width < 64) {
 356                 _out_size.width = 64;
 357         }
 358 }
 359
 360 void
 361 FilmViewer::play_clicked (wxCommandEvent &)
 362 {
 363         check_play_state ();
 364 }
 365
 366 void
 367 FilmViewer::check_play_state ()
 368 {
 369         if (!_film) {
 370                 return;
 371         }
 372
 373         if (_play_button->GetValue()) {
 374                 _timer.Start (1000 / _film->video_frame_rate());
 375         } else {
 376                 _timer.Stop ();
 377         }
 378 }
 379
 380 void
 381 FilmViewer::process_video (shared_ptr<Image> image, bool, shared_ptr<Subtitle> sub)
 382 {
 383         _raw_frame = image;
 384         _raw_sub = sub;
 385
 386         raw_to_display ();
 387
 388         _got_frame = true;
 389 }
 390
 391 /** Get a new _raw_frame from the decoder and then do
 392  *  raw_to_display ().
 393  */
 394 void
 395 FilmViewer::get_frame ()
 396 {
 397         /* Clear our raw frame in case we don't get a new one */
 398         _raw_frame.reset ();
 399
 400         if (!_player) {
 401                 _display_frame.reset ();
 402                 return;
 403         }
 404
 405         try {
 406                 _got_frame = false;
 407                 while (!_got_frame) {
 408                         if (_player->pass ()) {
 409                                 /* We didn't get a frame before the decoder gave up,
 410                                    so clear our display frame.
 411                                 */
 412                                 _display_frame.reset ();
 413                                 break;
 414                         }
 415                 }
 416         } catch (DecodeError& e) {
 417                 _play_button->SetValue (false);
 418                 check_play_state ();
 419                 error_dialog (this, wxString::Format (_("Could not decode video for view (%s)"), std_to_wx(e.what()).data()));
 420         }
 421 }
 422
 423 void
 424 FilmViewer::active_jobs_changed (bool a)
 425 {
 426         if (a) {
 427                 list<shared_ptr<Job> > jobs = JobManager::instance()->get ();
 428                 list<shared_ptr<Job> >::iterator i = jobs.begin ();
 429                 while (i != jobs.end() && boost::dynamic_pointer_cast<ExamineContentJob> (*i) == 0) {
 430                         ++i;
 431                 }
 432
 433                 if (i == jobs.end() || (*i)->finished()) {
 434                         /* no examine content job running, so we're ok to use the viewer */
 435                         a = false;
 436                 }
 437         }
 438
 439         _slider->Enable (!a);
 440         _play_button->Enable (!a);
 441 }
 442