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/options.h"
  32 #include "lib/subtitle.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 "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         , _back_button (new wxButton (this, wxID_ANY, wxT("<")))
  55         , _forward_button (new wxButton (this, wxID_ANY, wxT(">")))
  56         , _frame (new wxStaticText (this, wxID_ANY, wxT("")))
  57         , _timecode (new wxStaticText (this, wxID_ANY, wxT("")))
  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
  74         wxBoxSizer* time_sizer = new wxBoxSizer (wxVERTICAL);
  75         time_sizer->Add (_frame, 0, wxEXPAND);
  76         time_sizer->Add (_timecode, 0, wxEXPAND);
  77
  78         h_sizer->Add (_back_button, 0, wxALL, 2);
  79         h_sizer->Add (time_sizer, 0, wxEXPAND);
  80         h_sizer->Add (_forward_button, 0, wxALL, 2);
  81         h_sizer->Add (_play_button, 0, wxEXPAND);
  82         h_sizer->Add (_slider, 1, wxEXPAND);
  83
  84         _v_sizer->Add (h_sizer, 0, wxEXPAND | wxALL, 6);
  85
  86         _frame->SetMinSize (wxSize (84, -1));
  87         _back_button->SetMinSize (wxSize (32, -1));
  88         _forward_button->SetMinSize (wxSize (32, -1));
  89
  90         _panel->Connect (wxID_ANY, wxEVT_PAINT, wxPaintEventHandler (FilmViewer::paint_panel), 0, this);
  91         _panel->Connect (wxID_ANY, wxEVT_SIZE, wxSizeEventHandler (FilmViewer::panel_sized), 0, this);
  92         _slider->Connect (wxID_ANY, wxEVT_SCROLL_THUMBTRACK, wxScrollEventHandler (FilmViewer::slider_moved), 0, this);
  93         _slider->Connect (wxID_ANY, wxEVT_SCROLL_PAGEUP, wxScrollEventHandler (FilmViewer::slider_moved), 0, this);
  94         _slider->Connect (wxID_ANY, wxEVT_SCROLL_PAGEDOWN, wxScrollEventHandler (FilmViewer::slider_moved), 0, this);
  95         _play_button->Connect (wxID_ANY, wxEVT_COMMAND_TOGGLEBUTTON_CLICKED, wxCommandEventHandler (FilmViewer::play_clicked), 0, this);
  96         _timer.Connect (wxID_ANY, wxEVT_TIMER, wxTimerEventHandler (FilmViewer::timer), 0, this);
  97         _back_button->Connect (wxID_ANY, wxEVT_COMMAND_BUTTON_CLICKED, wxCommandEventHandler (FilmViewer::back_clicked), 0, this);
  98         _forward_button->Connect (wxID_ANY, wxEVT_COMMAND_BUTTON_CLICKED, wxCommandEventHandler (FilmViewer::forward_clicked), 0, this);
  99
 100         set_film (f);
 101
 102         JobManager::instance()->ActiveJobsChanged.connect (
 103                 bind (&FilmViewer::active_jobs_changed, this, _1)
 104                 );
 105 }
 106
 107 void
 108 FilmViewer::film_changed (Film::Property p)
 109 {
 110         switch (p) {
 111         case Film::FORMAT:
 112                 calculate_sizes ();
 113                 update_from_raw ();
 114                 break;
 115         case Film::CONTENT:
 116         {
 117                 DecodeOptions o;
 118                 o.decode_audio = false;
 119                 o.decode_subtitles = true;
 120                 o.video_sync = false;
 121
 122                 try {
 123                         _decoders = decoder_factory (_film, o);
 124                 } catch (StringError& e) {
 125                         error_dialog (this, wxString::Format (_("Could not open content file (%s)"), std_to_wx(e.what()).data()));
 126                         return;
 127                 }
 128
 129                 if (_decoders.video == 0) {
 130                         break;
 131                 }
 132                 _decoders.video->Video.connect (bind (&FilmViewer::process_video, this, _1, _2, _3, _4));
 133                 _decoders.video->OutputChanged.connect (boost::bind (&FilmViewer::decoder_changed, this));
 134                 _decoders.video->set_subtitle_stream (_film->subtitle_stream());
 135                 calculate_sizes ();
 136                 get_frame ();
 137                 _panel->Refresh ();
 138                 _slider->Show (_film->content_type() == VIDEO);
 139                 _play_button->Show (_film->content_type() == VIDEO);
 140                 _v_sizer->Layout ();
 141                 break;
 142         }
 143         case Film::WITH_SUBTITLES:
 144         case Film::SUBTITLE_OFFSET:
 145         case Film::SUBTITLE_SCALE:
 146         case Film::SCALER:
 147         case Film::FILTERS:
 148                 update_from_raw ();
 149                 break;
 150         case Film::SUBTITLE_STREAM:
 151                 if (_decoders.video) {
 152                         _decoders.video->set_subtitle_stream (_film->subtitle_stream ());
 153                 }
 154                 break;
 155         default:
 156                 break;
 157         }
 158 }
 159
 160 void
 161 FilmViewer::set_film (shared_ptr<Film> f)
 162 {
 163         if (_film == f) {
 164                 return;
 165         }
 166
 167         _film = f;
 168
 169         _raw_frame.reset ();
 170         _display_frame.reset ();
 171         _panel->Refresh ();
 172         _panel->Update ();
 173
 174         if (!_film) {
 175                 return;
 176         }
 177
 178         _film->Changed.connect (boost::bind (&FilmViewer::film_changed, this, _1));
 179
 180         film_changed (Film::CONTENT);
 181         film_changed (Film::FORMAT);
 182         film_changed (Film::WITH_SUBTITLES);
 183         film_changed (Film::SUBTITLE_OFFSET);
 184         film_changed (Film::SUBTITLE_SCALE);
 185         film_changed (Film::SUBTITLE_STREAM);
 186 }
 187
 188 void
 189 FilmViewer::decoder_changed ()
 190 {
 191         if (_decoders.video == 0 || _decoders.video->seek_to_last ()) {
 192                 return;
 193         }
 194
 195         get_frame ();
 196         _panel->Refresh ();
 197         _panel->Update ();
 198 }
 199
 200 void
 201 FilmViewer::timer (wxTimerEvent &)
 202 {
 203         if (!_film || !_decoders.video) {
 204                 return;
 205         }
 206
 207         _panel->Refresh ();
 208         _panel->Update ();
 209
 210         get_frame ();
 211
 212         if (_film->length()) {
 213                 int const new_slider_position = 4096 * _decoders.video->last_source_time() / (_film->length().get() / _film->source_frame_rate());
 214                 if (new_slider_position != _slider->GetValue()) {
 215                         _slider->SetValue (new_slider_position);
 216                 }
 217         }
 218 }
 219
 220
 221 void
 222 FilmViewer::paint_panel (wxPaintEvent &)
 223 {
 224         wxPaintDC dc (_panel);
 225
 226         if (!_display_frame || !_film || !_out_size.width || !_out_size.height) {
 227                 dc.Clear ();
 228                 return;
 229         }
 230
 231         if (_display_frame_x) {
 232                 dc.SetPen(*wxBLACK_PEN);
 233                 dc.SetBrush(*wxBLACK_BRUSH);
 234                 dc.DrawRectangle (0, 0, _display_frame_x, _film_size.height);
 235                 dc.DrawRectangle (_display_frame_x + _film_size.width, 0, _display_frame_x, _film_size.height);
 236         }
 237
 238         wxImage frame (_film_size.width, _film_size.height, _display_frame->data()[0], true);
 239         wxBitmap frame_bitmap (frame);
 240         dc.DrawBitmap (frame_bitmap, _display_frame_x, 0);
 241
 242         if (_film->with_subtitles() && _display_sub) {
 243                 wxImage sub (_display_sub->size().width, _display_sub->size().height, _display_sub->data()[0], _display_sub->alpha(), true);
 244                 wxBitmap sub_bitmap (sub);
 245                 dc.DrawBitmap (sub_bitmap, _display_sub_position.x, _display_sub_position.y);
 246         }
 247
 248         if (_out_size.width < _panel_size.width) {
 249                 wxPen p (GetBackgroundColour ());
 250                 wxBrush b (GetBackgroundColour ());
 251                 dc.SetPen (p);
 252                 dc.SetBrush (b);
 253                 dc.DrawRectangle (_out_size.width, 0, _panel_size.width - _out_size.width, _panel_size.height);
 254         }
 255
 256         if (_out_size.height < _panel_size.height) {
 257                 wxPen p (GetBackgroundColour ());
 258                 wxBrush b (GetBackgroundColour ());
 259                 dc.SetPen (p);
 260                 dc.SetBrush (b);
 261                 dc.DrawRectangle (0, _out_size.height, _panel_size.width, _panel_size.height - _out_size.height);
 262         }
 263 }
 264
 265
 266 void
 267 FilmViewer::slider_moved (wxScrollEvent &)
 268 {
 269         if (!_film || !_film->length() || !_decoders.video) {
 270                 return;
 271         }
 272
 273         if (_decoders.video->seek (_slider->GetValue() * _film->length().get() / (4096 * _film->source_frame_rate()))) {
 274                 return;
 275         }
 276
 277         get_frame ();
 278         _panel->Refresh ();
 279         _panel->Update ();
 280 }
 281
 282 void
 283 FilmViewer::panel_sized (wxSizeEvent& ev)
 284 {
 285         _panel_size.width = ev.GetSize().GetWidth();
 286         _panel_size.height = ev.GetSize().GetHeight();
 287         calculate_sizes ();
 288         update_from_raw ();
 289 }
 290
 291 void
 292 FilmViewer::update_from_raw ()
 293 {
 294         if (!_raw_frame) {
 295                 return;
 296         }
 297
 298         raw_to_display ();
 299
 300         _panel->Refresh ();
 301         _panel->Update ();
 302 }
 303
 304 void
 305 FilmViewer::raw_to_display ()
 306 {
 307         if (!_raw_frame || _out_size.width < 64 || _out_size.height < 64 || !_film) {
 308                 return;
 309         }
 310
 311         boost::shared_ptr<const Image> input = _raw_frame;
 312
 313         pair<string, string> const s = Filter::ffmpeg_strings (_film->filters());
 314         if (!s.second.empty ()) {
 315                 input = input->post_process (s.second, true);
 316         }
 317
 318         /* Get a compacted image as we have to feed it to wxWidgets */
 319         _display_frame = input->scale_and_convert_to_rgb (_film_size, 0, _film->scaler(), false);
 320
 321         if (_raw_sub) {
 322
 323                 /* Our output is already cropped by the decoder, so we need to account for that
 324                    when working out the scale that we are applying.
 325                 */
 326
 327                 Size const cropped_size = _film->cropped_size (_film->size ());
 328
 329                 Rect tx = subtitle_transformed_area (
 330                         float (_film_size.width) / cropped_size.width,
 331                         float (_film_size.height) / cropped_size.height,
 332                         _raw_sub->area(), _film->subtitle_offset(), _film->subtitle_scale()
 333                         );
 334
 335                 _display_sub.reset (new RGBPlusAlphaImage (_raw_sub->image()->scale (tx.size(), _film->scaler(), false)));
 336                 _display_sub_position = tx.position();
 337                 _display_sub_position.x += _display_frame_x;
 338         } else {
 339                 _display_sub.reset ();
 340         }
 341 }
 342
 343 void
 344 FilmViewer::calculate_sizes ()
 345 {
 346         if (!_film) {
 347                 return;
 348         }
 349
 350         Format const * format = _film->format ();
 351
 352         float const panel_ratio = static_cast<float> (_panel_size.width) / _panel_size.height;
 353         float const film_ratio = format ? format->container_ratio () : 1.78;
 354
 355         if (panel_ratio < film_ratio) {
 356                 /* panel is less widscreen than the film; clamp width */
 357                 _out_size.width = _panel_size.width;
 358                 _out_size.height = _out_size.width / film_ratio;
 359         } else {
 360                 /* panel is more widescreen than the film; clamp height */
 361                 _out_size.height = _panel_size.height;
 362                 _out_size.width = _out_size.height * film_ratio;
 363         }
 364
 365         /* Work out how much padding there is in terms of our display; this will be the x position
 366            of our _display_frame.
 367         */
 368         _display_frame_x = 0;
 369         if (format) {
 370                 _display_frame_x = static_cast<float> (format->dcp_padding (_film)) * _out_size.width / format->dcp_size().width;
 371         }
 372
 373         _film_size = _out_size;
 374         _film_size.width -= _display_frame_x * 2;
 375
 376         /* Catch silly values */
 377         if (_out_size.width < 64) {
 378                 _out_size.width = 64;
 379         }
 380 }
 381
 382 void
 383 FilmViewer::play_clicked (wxCommandEvent &)
 384 {
 385         check_play_state ();
 386 }
 387
 388 void
 389 FilmViewer::check_play_state ()
 390 {
 391         if (!_film) {
 392                 return;
 393         }
 394
 395         if (_play_button->GetValue()) {
 396                 _timer.Start (1000 / _film->source_frame_rate());
 397         } else {
 398                 _timer.Stop ();
 399         }
 400 }
 401
 402 void
 403 FilmViewer::process_video (shared_ptr<const Image> image, bool, shared_ptr<Subtitle> sub, double t)
 404 {
 405         _raw_frame = image;
 406         _raw_sub = sub;
 407
 408         raw_to_display ();
 409
 410         _got_frame = true;
 411
 412         double const fps = _decoders.video->frames_per_second ();
 413         _frame->SetLabel (wxString::Format (wxT("%d"), int (rint (t * fps))));
 414
 415         double w = t;
 416         int const h = (w / 3600);
 417         w -= h * 3600;
 418         int const m = (w / 60);
 419         w -= m * 60;
 420         int const s = floor (w);
 421         w -= s;
 422         int const f = rint (w * fps);
 423         _timecode->SetLabel (wxString::Format (wxT("%02d:%02d:%02d:%02d"), h, m, s, f));
 424 }
 425
 426 void
 427 FilmViewer::get_frame ()
 428 {
 429         /* Clear our raw frame in case we don't get a new one */
 430         _raw_frame.reset ();
 431
 432         if (_decoders.video == 0) {
 433                 _display_frame.reset ();
 434                 return;
 435         }
 436
 437         try {
 438                 _got_frame = false;
 439                 while (!_got_frame) {
 440                         if (_decoders.video->pass ()) {
 441                                 /* We didn't get a frame before the decoder gave up,
 442                                    so clear our display frame.
 443                                 */
 444                                 _display_frame.reset ();
 445                                 break;
 446                         }
 447                 }
 448         } catch (DecodeError& e) {
 449                 _play_button->SetValue (false);
 450                 check_play_state ();
 451                 error_dialog (this, wxString::Format (_("Could not decode video for view (%s)"), std_to_wx(e.what()).data()));
 452         }
 453 }
 454
 455 void
 456 FilmViewer::active_jobs_changed (bool a)
 457 {
 458         if (a) {
 459                 list<shared_ptr<Job> > jobs = JobManager::instance()->get ();
 460                 list<shared_ptr<Job> >::iterator i = jobs.begin ();
 461                 while (i != jobs.end() && boost::dynamic_pointer_cast<ExamineContentJob> (*i) == 0) {
 462                         ++i;
 463                 }
 464
 465                 if (i == jobs.end() || (*i)->finished()) {
 466                         /* no examine content job running, so we're ok to use the viewer */
 467                         a = false;
 468                 }
 469         }
 470
 471         _slider->Enable (!a);
 472         _play_button->Enable (!a);
 473 }
 474
 475 void
 476 FilmViewer::back_clicked (wxCommandEvent &)
 477 {
 478         if (!_decoders.video) {
 479                 return;
 480         }
 481
 482         _decoders.video->seek_back ();
 483         get_frame ();
 484         _panel->Refresh ();
 485         _panel->Update ();
 486 }
 487
 488 void
 489 FilmViewer::forward_clicked (wxCommandEvent &)
 490 {
 491         if (!_decoders.video) {
 492                 return;
 493         }
 494
 495         _decoders.video->seek_forward ();
 496         get_frame ();
 497         _panel->Refresh ();
 498         _panel->Update ();
 499 }