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