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