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