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