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/ratio.h"
  29 #include "lib/util.h"
  30 #include "lib/job_manager.h"
  31 #include "lib/image.h"
  32 #include "lib/scaler.h"
  33 #include "lib/exceptions.h"
  34 #include "lib/examine_content_job.h"
  35 #include "lib/filter.h"
  36 #include "lib/player.h"
  37 #include "lib/video_content.h"
  38 #include "lib/ffmpeg_content.h"
  39 #include "lib/imagemagick_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 boost::dynamic_pointer_cast;
  51 using boost::weak_ptr;
  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         , _back_button (new wxButton (this, wxID_ANY, wxT("<")))
  59         , _forward_button (new wxButton (this, wxID_ANY, wxT(">")))
  60         , _frame (new wxStaticText (this, wxID_ANY, wxT("")))
  61         , _timecode (new wxStaticText (this, wxID_ANY, wxT("")))
  62         , _play_button (new wxToggleButton (this, wxID_ANY, _("Play")))
  63         , _got_frame (false)
  64 {
  65 #ifndef __WXOSX__
  66         _panel->SetDoubleBuffered (true);
  67 #endif
  68
  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() - _film->video_frames_to_time (1));
 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         get_frame ();
 200
 201         if (_film->length()) {
 202                 int const new_slider_position = 4096 * _player->position() / _film->length();
 203                 if (new_slider_position != _slider->GetValue()) {
 204                         _slider->SetValue (new_slider_position);
 205                 }
 206         }
 207
 208         _panel->Refresh ();
 209         _panel->Update ();
 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         wxImage frame (_out_size.width, _out_size.height, _display_frame->data()[0], true);
 224         wxBitmap frame_bitmap (frame);
 225         dc.DrawBitmap (frame_bitmap, 0, 0);
 226
 227         if (_out_size.width < _panel_size.width) {
 228                 wxPen p (GetBackgroundColour ());
 229                 wxBrush b (GetBackgroundColour ());
 230                 dc.SetPen (p);
 231                 dc.SetBrush (b);
 232                 dc.DrawRectangle (_out_size.width, 0, _panel_size.width - _out_size.width, _panel_size.height);
 233         }
 234
 235         if (_out_size.height < _panel_size.height) {
 236                 wxPen p (GetBackgroundColour ());
 237                 wxBrush b (GetBackgroundColour ());
 238                 dc.SetPen (p);
 239                 dc.SetBrush (b);
 240                 dc.DrawRectangle (0, _out_size.height, _panel_size.width, _panel_size.height - _out_size.height);
 241         }
 242 }
 243
 244
 245 void
 246 FilmViewer::slider_moved (wxScrollEvent &)
 247 {
 248         cout << "slider " << _slider->GetValue() << " " << _film->length() << "\n";
 249
 250         if (_film && _player) {
 251                 _player->seek (_slider->GetValue() * _film->length() / 4096);
 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         /* Get a compacted image as we have to feed it to wxWidgets */
 289         _display_frame.reset (new SimpleImage (_raw_frame, false));
 290 }
 291
 292 void
 293 FilmViewer::calculate_sizes ()
 294 {
 295         if (!_film || !_player) {
 296                 return;
 297         }
 298
 299         Ratio const * container = _film->container ();
 300
 301         float const panel_ratio = static_cast<float> (_panel_size.width) / _panel_size.height;
 302         float const film_ratio = container ? container->ratio () : 1.78;
 303
 304         if (panel_ratio < film_ratio) {
 305                 /* panel is less widscreen than the film; clamp width */
 306                 _out_size.width = _panel_size.width;
 307                 _out_size.height = _out_size.width / film_ratio;
 308         } else {
 309                 /* panel is more widescreen than the film; clamp height */
 310                 _out_size.height = _panel_size.height;
 311                 _out_size.width = _out_size.height * film_ratio;
 312         }
 313
 314         /* Catch silly values */
 315         if (_out_size.width < 64) {
 316                 _out_size.width = 64;
 317         }
 318
 319         _player->set_video_container_size (_out_size);
 320 }
 321
 322 void
 323 FilmViewer::play_clicked (wxCommandEvent &)
 324 {
 325         check_play_state ();
 326 }
 327
 328 void
 329 FilmViewer::check_play_state ()
 330 {
 331         if (!_film || _film->dcp_video_frame_rate() == 0) {
 332                 return;
 333         }
 334
 335         if (_play_button->GetValue()) {
 336                 _timer.Start (1000 / _film->dcp_video_frame_rate());
 337         } else {
 338                 _timer.Stop ();
 339         }
 340 }
 341
 342 void
 343 FilmViewer::process_video (shared_ptr<const Image> image, bool, Time t)
 344 {
 345         _raw_frame = image;
 346
 347         raw_to_display ();
 348
 349         _got_frame = true;
 350
 351         double const fps = _film->dcp_video_frame_rate ();
 352         /* Count frame number from 1 ... not sure if this is the best idea */
 353         _frame->SetLabel (wxString::Format (wxT("%d"), int (rint (t * fps / TIME_HZ)) + 1));
 354
 355         double w = static_cast<double>(t) / TIME_HZ;
 356         int const h = (w / 3600);
 357         w -= h * 3600;
 358         int const m = (w / 60);
 359         w -= m * 60;
 360         int const s = floor (w);
 361         w -= s;
 362         int const f = rint (w * fps);
 363         _timecode->SetLabel (wxString::Format (wxT("%02d:%02d:%02d:%02d"), h, m, s, f));
 364 }
 365
 366 /** Get a new _raw_frame from the decoder and then do
 367  *  raw_to_display ().
 368  */
 369 void
 370 FilmViewer::get_frame ()
 371 {
 372         /* Clear our raw frame in case we don't get a new one */
 373         _raw_frame.reset ();
 374
 375         if (!_player) {
 376                 _display_frame.reset ();
 377                 return;
 378         }
 379
 380         try {
 381                 _got_frame = false;
 382                 while (!_got_frame) {
 383                         if (_player->pass ()) {
 384                                 /* We didn't get a frame before the decoder gave up,
 385                                    so clear our display frame.
 386                                 */
 387                                 _display_frame.reset ();
 388                                 break;
 389                         }
 390                 }
 391         } catch (DecodeError& e) {
 392                 _play_button->SetValue (false);
 393                 check_play_state ();
 394                 error_dialog (this, wxString::Format (_("Could not decode video for view (%s)"), std_to_wx(e.what()).data()));
 395         }
 396 }
 397
 398 void
 399 FilmViewer::active_jobs_changed (bool a)
 400 {
 401         if (a) {
 402                 list<shared_ptr<Job> > jobs = JobManager::instance()->get ();
 403                 list<shared_ptr<Job> >::iterator i = jobs.begin ();
 404                 while (i != jobs.end() && boost::dynamic_pointer_cast<ExamineContentJob> (*i) == 0) {
 405                         ++i;
 406                 }
 407
 408                 if (i == jobs.end() || (*i)->finished()) {
 409                         /* no examine content job running, so we're ok to use the viewer */
 410                         a = false;
 411                 }
 412         }
 413
 414         _slider->Enable (!a);
 415         _play_button->Enable (!a);
 416 }
 417
 418 void
 419 FilmViewer::film_content_changed (weak_ptr<Content>, int p)
 420 {
 421         if (p == ContentProperty::LENGTH) {
 422                 /* Force an update to our frame */
 423                 wxScrollEvent ev;
 424                 slider_moved (ev);
 425         } else if (p == VideoContentProperty::VIDEO_CROP) {
 426                 update_from_decoder ();
 427         }
 428 }
 429
 430 void
 431 FilmViewer::back_clicked (wxCommandEvent &)
 432 {
 433         if (!_player) {
 434                 return;
 435         }
 436
 437         _player->seek_back ();
 438         get_frame ();
 439         _panel->Refresh ();
 440         _panel->Update ();
 441 }
 442
 443 void
 444 FilmViewer::forward_clicked (wxCommandEvent &)
 445 {
 446         if (!_player) {
 447                 return;
 448         }
 449
 450         _player->seek_forward ();
 451         get_frame ();
 452         _panel->Refresh ();
 453         _panel->Update ();
 454 }