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