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