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