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