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