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