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