src/wx/film_viewer.cc

   1 /* -*- c-basic-offset: 8; default-tab-width: 8; -*- */
   2
   3 /*
   4     Copyright (C) 2012 Carl Hetherington <cth@carlh.net>
   5
   6     This program is free software; you can redistribute it and/or modify
   7     it under the terms of the GNU General Public License as published by
   8     the Free Software Foundation; either version 2 of the License, or
   9     (at your option) any later version.
  10
  11     This program is distributed in the hope that it will be useful,
  12     but WITHOUT ANY WARRANTY; without even the implied warranty of
  13     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14     GNU General Public License for more details.
  15
  16     You should have received a copy of the GNU General Public License
  17     along with this program; if not, write to the Free Software
  18     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  19
  20 */
  21
  22 /** @file  src/film_viewer.cc
  23  *  @brief A wx widget to view a preview of a Film.
  24  */
  25
  26 #include <iostream>
  27 #include <iomanip>
  28 #include <wx/tglbtn.h>
  29 #include "lib/film.h"
  30 #include "lib/ratio.h"
  31 #include "lib/util.h"
  32 #include "lib/job_manager.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 "lib/player.h"
  39 #include "lib/video_content.h"
  40 #include "lib/ffmpeg_content.h"
  41 #include "lib/imagemagick_content.h"
  42 #include "film_viewer.h"
  43 #include "wx_util.h"
  44 #include "video_decoder.h"
  45
  46 using std::string;
  47 using std::pair;
  48 using std::max;
  49 using std::cout;
  50 using std::list;
  51 using boost::shared_ptr;
  52 using boost::dynamic_pointer_cast;
  53 using boost::weak_ptr;
  54 using libdcp::Size;
  55
  56 FilmViewer::FilmViewer (shared_ptr<Film> f, wxWindow* p)
  57         : wxPanel (p)
  58         , _panel (new wxPanel (this))
  59         , _slider (new wxSlider (this, wxID_ANY, 0, 0, 4096))
  60         , _back_button (new wxButton (this, wxID_ANY, wxT("<")))
  61         , _forward_button (new wxButton (this, wxID_ANY, wxT(">")))
  62         , _frame (new wxStaticText (this, wxID_ANY, wxT("")))
  63         , _timecode (new wxStaticText (this, wxID_ANY, wxT("")))
  64         , _play_button (new wxToggleButton (this, wxID_ANY, _("Play")))
  65         , _display_frame_x (0)
  66         , _got_frame (false)
  67 {
  68         _panel->SetDoubleBuffered (true);
  69 #if wxMAJOR_VERSION == 2 && wxMINOR_VERSION >= 9
  70         _panel->SetBackgroundStyle (wxBG_STYLE_PAINT);
  71 #endif
  72
  73         _v_sizer = new wxBoxSizer (wxVERTICAL);
  74         SetSizer (_v_sizer);
  75
  76         _v_sizer->Add (_panel, 1, wxEXPAND);
  77
  78         wxBoxSizer* h_sizer = new wxBoxSizer (wxHORIZONTAL);
  79
  80         wxBoxSizer* time_sizer = new wxBoxSizer (wxVERTICAL);
  81         time_sizer->Add (_frame, 0, wxEXPAND);
  82         time_sizer->Add (_timecode, 0, wxEXPAND);
  83
  84         h_sizer->Add (_back_button, 0, wxALL, 2);
  85         h_sizer->Add (time_sizer, 0, wxEXPAND);
  86         h_sizer->Add (_forward_button, 0, wxALL, 2);
  87         h_sizer->Add (_play_button, 0, wxEXPAND);
  88         h_sizer->Add (_slider, 1, wxEXPAND);
  89
  90         _v_sizer->Add (h_sizer, 0, wxEXPAND | wxALL, 6);
  91
  92         _frame->SetMinSize (wxSize (84, -1));
  93         _back_button->SetMinSize (wxSize (32, -1));
  94         _forward_button->SetMinSize (wxSize (32, -1));
  95
  96         _panel->Connect (wxID_ANY, wxEVT_PAINT, wxPaintEventHandler (FilmViewer::paint_panel), 0, this);
  97         _panel->Connect (wxID_ANY, wxEVT_SIZE, wxSizeEventHandler (FilmViewer::panel_sized), 0, this);
  98         _slider->Connect (wxID_ANY, wxEVT_SCROLL_THUMBTRACK, wxScrollEventHandler (FilmViewer::slider_moved), 0, this);
  99         _slider->Connect (wxID_ANY, wxEVT_SCROLL_PAGEUP, wxScrollEventHandler (FilmViewer::slider_moved), 0, this);
 100         _slider->Connect (wxID_ANY, wxEVT_SCROLL_PAGEDOWN, wxScrollEventHandler (FilmViewer::slider_moved), 0, this);
 101         _play_button->Connect (wxID_ANY, wxEVT_COMMAND_TOGGLEBUTTON_CLICKED, wxCommandEventHandler (FilmViewer::play_clicked), 0, this);
 102         _timer.Connect (wxID_ANY, wxEVT_TIMER, wxTimerEventHandler (FilmViewer::timer), 0, this);
 103         _back_button->Connect (wxID_ANY, wxEVT_COMMAND_BUTTON_CLICKED, wxCommandEventHandler (FilmViewer::back_clicked), 0, this);
 104         _forward_button->Connect (wxID_ANY, wxEVT_COMMAND_BUTTON_CLICKED, wxCommandEventHandler (FilmViewer::forward_clicked), 0, this);
 105
 106         set_film (f);
 107
 108         JobManager::instance()->ActiveJobsChanged.connect (
 109                 bind (&FilmViewer::active_jobs_changed, this, _1)
 110                 );
 111 }
 112
 113 void
 114 FilmViewer::film_changed (Film::Property p)
 115 {
 116         switch (p) {
 117         case Film::CONTAINER:
 118                 calculate_sizes ();
 119                 update_from_raw ();
 120                 break;
 121         case Film::CONTENT:
 122         {
 123                 calculate_sizes ();
 124                 wxScrollEvent ev;
 125                 slider_moved (ev);
 126                 break;
 127         }
 128         case Film::WITH_SUBTITLES:
 129         case Film::SUBTITLE_OFFSET:
 130         case Film::SUBTITLE_SCALE:
 131                 raw_to_display ();
 132                 _panel->Refresh ();
 133                 _panel->Update ();
 134                 break;
 135         case Film::SCALER:
 136                 update_from_decoder ();
 137                 break;
 138         default:
 139                 break;
 140         }
 141 }
 142
 143 void
 144 FilmViewer::set_film (shared_ptr<Film> f)
 145 {
 146         if (_film == f) {
 147                 return;
 148         }
 149
 150         _film = f;
 151
 152         _raw_frame.reset ();
 153         _display_frame.reset ();
 154         _panel->Refresh ();
 155         _panel->Update ();
 156
 157         if (!_film) {
 158                 return;
 159         }
 160
 161         _player = f->player ();
 162         _player->disable_audio ();
 163         /* Don't disable subtitles here as we may need them, and it's nice to be able to turn them
 164            on and off without needing obtain a new Player.
 165         */
 166
 167         _player->Video.connect (bind (&FilmViewer::process_video, this, _1, _2, _3));
 168
 169         _film->Changed.connect (boost::bind (&FilmViewer::film_changed, this, _1));
 170         _film->ContentChanged.connect (boost::bind (&FilmViewer::film_content_changed, this, _1, _2));
 171
 172         film_changed (Film::CONTENT);
 173         film_changed (Film::CONTAINER);
 174         film_changed (Film::WITH_SUBTITLES);
 175         film_changed (Film::SUBTITLE_OFFSET);
 176         film_changed (Film::SUBTITLE_SCALE);
 177 }
 178
 179 void
 180 FilmViewer::update_from_decoder ()
 181 {
 182         if (!_player) {
 183                 return;
 184         }
 185
 186         _player->seek (_player->position ());
 187         get_frame ();
 188         _panel->Refresh ();
 189         _panel->Update ();
 190 }
 191
 192 void
 193 FilmViewer::timer (wxTimerEvent &)
 194 {
 195         if (!_player) {
 196                 return;
 197         }
 198
 199         _panel->Refresh ();
 200         _panel->Update ();
 201
 202         get_frame ();
 203
 204         if (_film->length()) {
 205                 int const new_slider_position = 4096 * _player->position() / _film->length();
 206                 if (new_slider_position != _slider->GetValue()) {
 207                         _slider->SetValue (new_slider_position);
 208                 }
 209         }
 210 }
 211
 212
 213 void
 214 FilmViewer::paint_panel (wxPaintEvent &)
 215 {
 216         wxPaintDC dc (_panel);
 217
 218         if (!_display_frame || !_film || !_out_size.width || !_out_size.height) {
 219                 dc.Clear ();
 220                 return;
 221         }
 222
 223         if (_display_frame_x) {
 224                 dc.SetPen(*wxBLACK_PEN);
 225                 dc.SetBrush(*wxBLACK_BRUSH);
 226                 dc.DrawRectangle (0, 0, _display_frame_x, _film_size.height);
 227                 dc.DrawRectangle (_display_frame_x + _film_size.width, 0, _display_frame_x, _film_size.height);
 228         }
 229
 230         wxImage frame (_film_size.width, _film_size.height, _display_frame->data()[0], true);
 231         wxBitmap frame_bitmap (frame);
 232         dc.DrawBitmap (frame_bitmap, _display_frame_x, 0);
 233
 234         if (_out_size.width < _panel_size.width) {
 235                 wxPen p (GetBackgroundColour ());
 236                 wxBrush b (GetBackgroundColour ());
 237                 dc.SetPen (p);
 238                 dc.SetBrush (b);
 239                 dc.DrawRectangle (_out_size.width, 0, _panel_size.width - _out_size.width, _panel_size.height);
 240         }
 241
 242         if (_out_size.height < _panel_size.height) {
 243                 wxPen p (GetBackgroundColour ());
 244                 wxBrush b (GetBackgroundColour ());
 245                 dc.SetPen (p);
 246                 dc.SetBrush (b);
 247                 dc.DrawRectangle (0, _out_size.height, _panel_size.width, _panel_size.height - _out_size.height);
 248         }
 249 }
 250
 251
 252 void
 253 FilmViewer::slider_moved (wxScrollEvent &)
 254 {
 255         cout << "slider " << _slider->GetValue() << " " << _film->length() << "\n";
 256
 257         if (_film && _player) {
 258                 _player->seek (_slider->GetValue() * _film->length() / 4096);
 259         }
 260
 261         get_frame ();
 262         _panel->Refresh ();
 263         _panel->Update ();
 264 }
 265
 266 void
 267 FilmViewer::panel_sized (wxSizeEvent& ev)
 268 {
 269         _panel_size.width = ev.GetSize().GetWidth();
 270         _panel_size.height = ev.GetSize().GetHeight();
 271         calculate_sizes ();
 272         update_from_raw ();
 273 }
 274
 275 void
 276 FilmViewer::update_from_raw ()
 277 {
 278         if (!_raw_frame) {
 279                 return;
 280         }
 281
 282         raw_to_display ();
 283
 284         _panel->Refresh ();
 285         _panel->Update ();
 286 }
 287
 288 void
 289 FilmViewer::raw_to_display ()
 290 {
 291         if (!_raw_frame || _out_size.width < 64 || _out_size.height < 64 || !_film) {
 292                 return;
 293         }
 294
 295         /* Get a compacted image as we have to feed it to wxWidgets */
 296         _display_frame = _raw_frame->scale_and_convert_to_rgb (_film_size, _film->scaler(), false);
 297 }
 298
 299 void
 300 FilmViewer::calculate_sizes ()
 301 {
 302         if (!_film || !_player) {
 303                 return;
 304         }
 305
 306         Ratio const * container = _film->container ();
 307
 308         float const panel_ratio = static_cast<float> (_panel_size.width) / _panel_size.height;
 309         float const film_ratio = container ? container->ratio () : 1.78;
 310
 311         if (panel_ratio < film_ratio) {
 312                 /* panel is less widscreen than the film; clamp width */
 313                 _out_size.width = _panel_size.width;
 314                 _out_size.height = _out_size.width / film_ratio;
 315         } else {
 316                 /* panel is more widescreen than the film; clamp height */
 317                 _out_size.height = _panel_size.height;
 318                 _out_size.width = _out_size.height * film_ratio;
 319         }
 320
 321         /* Work out how much padding there is in terms of our display; this will be the x position
 322            of our _display_frame.
 323         */
 324         _display_frame_x = 0;
 325 //      if (format) {
 326 //              _display_frame_x = static_cast<float> (format->dcp_padding (_film)) * _out_size.width / format->dcp_size().width;
 327 //      }
 328
 329         _film_size = _out_size;
 330         _film_size.width -= _display_frame_x * 2;
 331
 332         /* Catch silly values */
 333         if (_out_size.width < 64) {
 334                 _out_size.width = 64;
 335         }
 336 }
 337
 338 void
 339 FilmViewer::play_clicked (wxCommandEvent &)
 340 {
 341         check_play_state ();
 342 }
 343
 344 void
 345 FilmViewer::check_play_state ()
 346 {
 347         if (!_film || _film->dcp_video_frame_rate() == 0) {
 348                 return;
 349         }
 350
 351         if (_play_button->GetValue()) {
 352                 _timer.Start (1000 / _film->dcp_video_frame_rate());
 353         } else {
 354                 _timer.Stop ();
 355         }
 356 }
 357
 358 void
 359 FilmViewer::process_video (shared_ptr<const Image> image, bool, Time t)
 360 {
 361         _raw_frame = image;
 362
 363         raw_to_display ();
 364
 365         _got_frame = true;
 366
 367         double const fps = _film->dcp_video_frame_rate ();
 368         _frame->SetLabel (wxString::Format (wxT("%d"), int (rint (t * fps / TIME_HZ))));
 369
 370         double w = static_cast<double>(t) / TIME_HZ;
 371         int const h = (w / 3600);
 372         w -= h * 3600;
 373         int const m = (w / 60);
 374         w -= m * 60;
 375         int const s = floor (w);
 376         w -= s;
 377         int const f = rint (w * fps);
 378         _timecode->SetLabel (wxString::Format (wxT("%02d:%02d:%02d:%02d"), h, m, s, f));
 379 }
 380
 381 /** Get a new _raw_frame from the decoder and then do
 382  *  raw_to_display ().
 383  */
 384 void
 385 FilmViewer::get_frame ()
 386 {
 387         /* Clear our raw frame in case we don't get a new one */
 388         _raw_frame.reset ();
 389
 390         if (!_player) {
 391                 _display_frame.reset ();
 392                 return;
 393         }
 394
 395         try {
 396                 _got_frame = false;
 397                 while (!_got_frame) {
 398                         if (_player->pass ()) {
 399                                 /* We didn't get a frame before the decoder gave up,
 400                                    so clear our display frame.
 401                                 */
 402                                 _display_frame.reset ();
 403                                 break;
 404                         }
 405                 }
 406         } catch (DecodeError& e) {
 407                 _play_button->SetValue (false);
 408                 check_play_state ();
 409                 error_dialog (this, wxString::Format (_("Could not decode video for view (%s)"), std_to_wx(e.what()).data()));
 410         }
 411 }
 412
 413 void
 414 FilmViewer::active_jobs_changed (bool a)
 415 {
 416         if (a) {
 417                 list<shared_ptr<Job> > jobs = JobManager::instance()->get ();
 418                 list<shared_ptr<Job> >::iterator i = jobs.begin ();
 419                 while (i != jobs.end() && boost::dynamic_pointer_cast<ExamineContentJob> (*i) == 0) {
 420                         ++i;
 421                 }
 422
 423                 if (i == jobs.end() || (*i)->finished()) {
 424                         /* no examine content job running, so we're ok to use the viewer */
 425                         a = false;
 426                 }
 427         }
 428
 429         _slider->Enable (!a);
 430         _play_button->Enable (!a);
 431 }
 432
 433 void
 434 FilmViewer::film_content_changed (weak_ptr<Content>, int p)
 435 {
 436         if (p == ContentProperty::LENGTH) {
 437                 /* Force an update to our frame */
 438                 wxScrollEvent ev;
 439                 slider_moved (ev);
 440         } else if (p == VideoContentProperty::VIDEO_CROP) {
 441                 update_from_decoder ();
 442         }
 443 }
 444
 445 void
 446 FilmViewer::back_clicked (wxCommandEvent &)
 447 {
 448         if (!_player) {
 449                 return;
 450         }
 451
 452         _player->seek_back ();
 453         get_frame ();
 454         _panel->Refresh ();
 455         _panel->Update ();
 456 }
 457
 458 void
 459 FilmViewer::forward_clicked (wxCommandEvent &)
 460 {
 461         if (!_player) {
 462                 return;
 463         }
 464
 465         _player->seek_forward ();
 466         get_frame ();
 467         _panel->Refresh ();
 468         _panel->Update ();
 469 }