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                 _decoders = decoder_factory (_film, o);
 105                 if (_decoders.video == 0) {
 106                         break;
 107                 }
 108                 _decoders.video->Video.connect (bind (&FilmViewer::process_video, this, _1, _2, _3));
 109                 _decoders.video->OutputChanged.connect (boost::bind (&FilmViewer::decoder_changed, this));
 110                 _decoders.video->set_subtitle_stream (_film->subtitle_stream());
 111                 calculate_sizes ();
 112                 get_frame ();
 113                 _panel->Refresh ();
 114                 _slider->Show (_film->content_type() == VIDEO);
 115                 _play_button->Show (_film->content_type() == VIDEO);
 116                 _v_sizer->Layout ();
 117                 break;
 118         }
 119         case Film::WITH_SUBTITLES:
 120         case Film::SUBTITLE_OFFSET:
 121         case Film::SUBTITLE_SCALE:
 122         case Film::SCALER:
 123         case Film::FILTERS:
 124                 update_from_raw ();
 125                 break;
 126         case Film::SUBTITLE_STREAM:
 127                 if (_decoders.video) {
 128                         _decoders.video->set_subtitle_stream (_film->subtitle_stream ());
 129                 }
 130                 break;
 131         default:
 132                 break;
 133         }
 134 }
 135
 136 void
 137 FilmViewer::set_film (shared_ptr<Film> f)
 138 {
 139         if (_film == f) {
 140                 return;
 141         }
 142
 143         _film = f;
 144
 145         if (!_film) {
 146                 return;
 147         }
 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         film_changed (Film::SUBTITLE_STREAM);
 157 }
 158
 159 void
 160 FilmViewer::decoder_changed ()
 161 {
 162         if (_decoders.video == 0 || _decoders.video->seek_to_last ()) {
 163                 return;
 164         }
 165
 166         get_frame ();
 167         _panel->Refresh ();
 168         _panel->Update ();
 169 }
 170
 171 void
 172 FilmViewer::timer (wxTimerEvent &)
 173 {
 174         if (!_film || !_decoders.video) {
 175                 return;
 176         }
 177
 178         _panel->Refresh ();
 179         _panel->Update ();
 180
 181         get_frame ();
 182
 183         if (_film->length()) {
 184                 int const new_slider_position = 4096 * _decoders.video->last_source_time() / (_film->length().get() / _film->frames_per_second());
 185                 if (new_slider_position != _slider->GetValue()) {
 186                         _slider->SetValue (new_slider_position);
 187                 }
 188         }
 189 }
 190
 191
 192 void
 193 FilmViewer::paint_panel (wxPaintEvent &)
 194 {
 195         wxPaintDC dc (_panel);
 196
 197         if (_clear_required) {
 198                 dc.Clear ();
 199                 _clear_required = false;
 200         }
 201
 202         if (!_display_frame || !_film || !_out_size.width || !_out_size.height) {
 203                 dc.Clear ();
 204                 return;
 205         }
 206
 207         if (_display_frame_x) {
 208                 dc.SetPen(*wxBLACK_PEN);
 209                 dc.SetBrush(*wxBLACK_BRUSH);
 210                 dc.DrawRectangle (0, 0, _display_frame_x, _film_size.height);
 211                 dc.DrawRectangle (_display_frame_x + _film_size.width, 0, _display_frame_x, _film_size.height);
 212         }
 213
 214         wxImage frame (_film_size.width, _film_size.height, _display_frame->data()[0], true);
 215         wxBitmap frame_bitmap (frame);
 216         dc.DrawBitmap (frame_bitmap, _display_frame_x, 0);
 217
 218         if (_film->with_subtitles() && _display_sub) {
 219                 wxImage sub (_display_sub->size().width, _display_sub->size().height, _display_sub->data()[0], _display_sub->alpha(), true);
 220                 wxBitmap sub_bitmap (sub);
 221                 dc.DrawBitmap (sub_bitmap, _display_sub_position.x, _display_sub_position.y);
 222         }
 223 }
 224
 225
 226 void
 227 FilmViewer::slider_moved (wxScrollEvent &)
 228 {
 229         if (!_film || !_film->length() || !_decoders.video) {
 230                 return;
 231         }
 232
 233         if (_decoders.video->seek (_slider->GetValue() * _film->length().get() / (4096 * _film->frames_per_second()))) {
 234                 return;
 235         }
 236
 237         get_frame ();
 238         _panel->Refresh ();
 239         _panel->Update ();
 240 }
 241
 242 void
 243 FilmViewer::panel_sized (wxSizeEvent& ev)
 244 {
 245         _panel_size.width = ev.GetSize().GetWidth();
 246         _panel_size.height = ev.GetSize().GetHeight();
 247         calculate_sizes ();
 248         update_from_raw ();
 249 }
 250
 251 void
 252 FilmViewer::update_from_raw ()
 253 {
 254         if (!_raw_frame) {
 255                 return;
 256         }
 257
 258         raw_to_display ();
 259
 260         _panel->Refresh ();
 261         _panel->Update ();
 262 }
 263
 264 void
 265 FilmViewer::raw_to_display ()
 266 {
 267         if (!_raw_frame || _out_size.width < 64 || _out_size.height < 64 || !_film) {
 268                 return;
 269         }
 270
 271         libdcp::Size old_size;
 272         if (_display_frame) {
 273                 old_size = _display_frame->size();
 274         }
 275
 276         boost::shared_ptr<Image> input = _raw_frame;
 277
 278         pair<string, string> const s = Filter::ffmpeg_strings (_film->filters());
 279         if (!s.second.empty ()) {
 280                 input = input->post_process (s.second, true);
 281         }
 282
 283         /* Get a compacted image as we have to feed it to wxWidgets */
 284         _display_frame = input->scale_and_convert_to_rgb (_film_size, 0, _film->scaler(), false);
 285
 286         if (old_size != _display_frame->size()) {
 287                 _clear_required = true;
 288         }
 289
 290         if (_raw_sub) {
 291
 292                 /* Our output is already cropped by the decoder, so we need to account for that
 293                    when working out the scale that we are applying.
 294                 */
 295
 296                 Size const cropped_size = _film->cropped_size (_film->size ());
 297
 298                 Rect tx = subtitle_transformed_area (
 299                         float (_film_size.width) / cropped_size.width,
 300                         float (_film_size.height) / cropped_size.height,
 301                         _raw_sub->area(), _film->subtitle_offset(), _film->subtitle_scale()
 302                         );
 303
 304                 _display_sub.reset (new RGBPlusAlphaImage (_raw_sub->image()->scale (tx.size(), _film->scaler(), false)));
 305                 _display_sub_position = tx.position();
 306                 _display_sub_position.x += _display_frame_x;
 307         } else {
 308                 _display_sub.reset ();
 309         }
 310 }
 311
 312 void
 313 FilmViewer::calculate_sizes ()
 314 {
 315         if (!_film) {
 316                 return;
 317         }
 318
 319         Format const * format = _film->format ();
 320
 321         float const panel_ratio = static_cast<float> (_panel_size.width) / _panel_size.height;
 322         float const film_ratio = format ? format->container_ratio_as_float () : 1.78;
 323
 324         if (panel_ratio < film_ratio) {
 325                 /* panel is less widscreen than the film; clamp width */
 326                 _out_size.width = _panel_size.width;
 327                 _out_size.height = _out_size.width / film_ratio;
 328         } else {
 329                 /* panel is more widescreen than the film; clamp height */
 330                 _out_size.height = _panel_size.height;
 331                 _out_size.width = _out_size.height * film_ratio;
 332         }
 333
 334         /* Work out how much padding there is in terms of our display; this will be the x position
 335            of our _display_frame.
 336         */
 337         _display_frame_x = 0;
 338         if (format) {
 339                 _display_frame_x = static_cast<float> (format->dcp_padding (_film)) * _out_size.width / format->dcp_size().width;
 340         }
 341
 342         _film_size = _out_size;
 343         _film_size.width -= _display_frame_x * 2;
 344
 345         /* Catch silly values */
 346         if (_out_size.width < 64) {
 347                 _out_size.width = 64;
 348         }
 349 }
 350
 351 void
 352 FilmViewer::play_clicked (wxCommandEvent &)
 353 {
 354         check_play_state ();
 355 }
 356
 357 void
 358 FilmViewer::check_play_state ()
 359 {
 360         if (!_film) {
 361                 return;
 362         }
 363
 364         if (_play_button->GetValue()) {
 365                 _timer.Start (1000 / _film->frames_per_second());
 366         } else {
 367                 _timer.Stop ();
 368         }
 369 }
 370
 371 void
 372 FilmViewer::process_video (shared_ptr<Image> image, bool, shared_ptr<Subtitle> sub)
 373 {
 374         _raw_frame = image;
 375         _raw_sub = sub;
 376
 377         raw_to_display ();
 378
 379         _got_frame = true;
 380 }
 381
 382 void
 383 FilmViewer::get_frame ()
 384 {
 385         /* Clear our raw frame in case we don't get a new one */
 386         _raw_frame.reset ();
 387
 388         if (_decoders.video == 0) {
 389                 _display_frame.reset ();
 390                 return;
 391         }
 392
 393         try {
 394                 _got_frame = false;
 395                 while (!_got_frame) {
 396                         if (_decoders.video->pass ()) {
 397                                 /* We didn't get a frame before the decoder gave up,
 398                                    so clear our display frame.
 399                                 */
 400                                 _display_frame.reset ();
 401                                 break;
 402                         }
 403                 }
 404         } catch (DecodeError& e) {
 405                 _play_button->SetValue (false);
 406                 check_play_state ();
 407                 error_dialog (this, wxString::Format (_("Could not decode video for view (%s)"), e.what()));
 408         }
 409 }
 410
 411 void
 412 FilmViewer::active_jobs_changed (bool a)
 413 {
 414         if (a) {
 415                 list<shared_ptr<Job> > jobs = JobManager::instance()->get ();
 416                 list<shared_ptr<Job> >::iterator i = jobs.begin ();
 417                 while (i != jobs.end() && boost::dynamic_pointer_cast<ExamineContentJob> (*i) == 0) {
 418                         ++i;
 419                 }
 420
 421                 if (i == jobs.end() || (*i)->finished()) {
 422                         /* no examine content job running, so we're ok to use the viewer */
 423                         a = false;
 424                 }
 425         }
 426
 427         _slider->Enable (!a);
 428         _play_button->Enable (!a);
 429 }
 430