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 "film_viewer.h"
  38 #include "wx_util.h"
  39 #include "video_decoder.h"
  40
  41 using std::string;
  42 using std::pair;
  43 using std::max;
  44 using std::cout;
  45 using std::list;
  46 using boost::shared_ptr;
  47 using libdcp::Size;
  48
  49 FilmViewer::FilmViewer (shared_ptr<Film> f, wxWindow* p)
  50         : wxPanel (p)
  51         , _panel (new wxPanel (this))
  52         , _slider (new wxSlider (this, wxID_ANY, 0, 0, 4096))
  53         , _play_button (new wxToggleButton (this, wxID_ANY, wxT ("Play")))
  54         , _display_frame_x (0)
  55         , _got_frame (false)
  56         , _clear_required (false)
  57 {
  58         _panel->SetDoubleBuffered (true);
  59 #if wxMAJOR_VERSION == 2 && wxMINOR_VERSION >= 9
  60         _panel->SetBackgroundStyle (wxBG_STYLE_PAINT);
  61 #endif
  62
  63         _v_sizer = new wxBoxSizer (wxVERTICAL);
  64         SetSizer (_v_sizer);
  65
  66         _v_sizer->Add (_panel, 1, wxEXPAND);
  67
  68         wxBoxSizer* h_sizer = new wxBoxSizer (wxHORIZONTAL);
  69         h_sizer->Add (_play_button, 0, wxEXPAND);
  70         h_sizer->Add (_slider, 1, wxEXPAND);
  71
  72         _v_sizer->Add (h_sizer, 0, wxEXPAND);
  73
  74         _panel->Connect (wxID_ANY, wxEVT_PAINT, wxPaintEventHandler (FilmViewer::paint_panel), 0, this);
  75         _panel->Connect (wxID_ANY, wxEVT_SIZE, wxSizeEventHandler (FilmViewer::panel_sized), 0, this);
  76         _slider->Connect (wxID_ANY, wxEVT_SCROLL_THUMBTRACK, wxScrollEventHandler (FilmViewer::slider_moved), 0, this);
  77         _slider->Connect (wxID_ANY, wxEVT_SCROLL_PAGEUP, wxScrollEventHandler (FilmViewer::slider_moved), 0, this);
  78         _slider->Connect (wxID_ANY, wxEVT_SCROLL_PAGEDOWN, wxScrollEventHandler (FilmViewer::slider_moved), 0, this);
  79         _play_button->Connect (wxID_ANY, wxEVT_COMMAND_TOGGLEBUTTON_CLICKED, wxCommandEventHandler (FilmViewer::play_clicked), 0, this);
  80         _timer.Connect (wxID_ANY, wxEVT_TIMER, wxTimerEventHandler (FilmViewer::timer), 0, this);
  81
  82         set_film (f);
  83
  84         JobManager::instance()->ActiveJobsChanged.connect (
  85                 bind (&FilmViewer::active_jobs_changed, this, _1)
  86                 );
  87 }
  88
  89 void
  90 FilmViewer::film_changed (Film::Property p)
  91 {
  92         switch (p) {
  93         case Film::FORMAT:
  94                 calculate_sizes ();
  95                 update_from_raw ();
  96                 break;
  97         case Film::CONTENT:
  98         {
  99                 DecodeOptions o;
 100                 o.decode_audio = false;
 101                 o.decode_subtitles = true;
 102                 o.video_sync = false;
 103                 _decoders = decoder_factory (_film, o, 0);
 104                 _decoders.video->Video.connect (bind (&FilmViewer::process_video, this, _1, _2, _3));
 105                 _decoders.video->OutputChanged.connect (boost::bind (&FilmViewer::decoder_changed, this));
 106                 _decoders.video->set_subtitle_stream (_film->subtitle_stream());
 107                 calculate_sizes ();
 108                 get_frame ();
 109                 _panel->Refresh ();
 110                 _slider->Show (_film->content_type() == VIDEO);
 111                 _play_button->Show (_film->content_type() == VIDEO);
 112                 _v_sizer->Layout ();
 113                 break;
 114         }
 115         case Film::WITH_SUBTITLES:
 116         case Film::SUBTITLE_OFFSET:
 117         case Film::SUBTITLE_SCALE:
 118         case Film::SCALER:
 119                 update_from_raw ();
 120                 break;
 121         case Film::SUBTITLE_STREAM:
 122                 _decoders.video->set_subtitle_stream (_film->subtitle_stream ());
 123                 break;
 124         default:
 125                 break;
 126         }
 127 }
 128
 129 void
 130 FilmViewer::set_film (shared_ptr<Film> f)
 131 {
 132         if (_film == f) {
 133                 return;
 134         }
 135
 136         _film = f;
 137
 138         if (!_film) {
 139                 return;
 140         }
 141
 142         _film->Changed.connect (boost::bind (&FilmViewer::film_changed, this, _1));
 143
 144         film_changed (Film::CONTENT);
 145         film_changed (Film::CROP);
 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 (_decoders.video->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 (!_film) {
 169                 return;
 170         }
 171
 172         _panel->Refresh ();
 173         _panel->Update ();
 174
 175         get_frame ();
 176
 177         if (_film->length()) {
 178                 int const new_slider_position = 4096 * _decoders.video->last_source_time() / (_film->length().get() / _film->frames_per_second());
 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 * 2 + _film_size.width, _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 || !_film->length()) {
 224                 return;
 225         }
 226
 227         if (_decoders.video->seek (_slider->GetValue() * _film->length().get() / (4096 * _film->frames_per_second()))) {
 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         /* Get a compacted image as we have to feed it to wxWidgets */
 271         _display_frame = _raw_frame->scale_and_convert_to_rgb (_film_size, 0, _film->scaler(), false);
 272
 273         if (old_size != _display_frame->size()) {
 274                 _clear_required = true;
 275         }
 276
 277         if (_raw_sub) {
 278                 Rect tx = subtitle_transformed_area (
 279                         float (_film_size.width) / _film->size().width,
 280                         float (_film_size.height) / _film->size().height,
 281                         _raw_sub->area(), _film->subtitle_offset(), _film->subtitle_scale()
 282                         );
 283
 284                 _display_sub.reset (new RGBPlusAlphaImage (_raw_sub->image()->scale (tx.size(), _film->scaler(), false)));
 285                 _display_sub_position = tx.position();
 286                 _display_sub_position.x += _display_frame_x;
 287         } else {
 288                 _display_sub.reset ();
 289         }
 290 }
 291
 292 void
 293 FilmViewer::calculate_sizes ()
 294 {
 295         if (!_film) {
 296                 return;
 297         }
 298
 299         Format const * format = _film->format ();
 300
 301         float const panel_ratio = static_cast<float> (_panel_size.width) / _panel_size.height;
 302         float const film_ratio = format ? format->container_ratio_as_float () : 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         /* Work out how much padding there is in terms of our display; this will be the x position
 315            of our _display_frame.
 316         */
 317         _display_frame_x = 0;
 318         if (format) {
 319                 _display_frame_x = static_cast<float> (format->dcp_padding (_film)) * _out_size.width / format->dcp_size().width;
 320         }
 321
 322         _film_size = _out_size;
 323         _film_size.width -= _display_frame_x * 2;
 324
 325         /* Catch silly values */
 326         if (_out_size.width < 64) {
 327                 _out_size.width = 64;
 328         }
 329 }
 330
 331 void
 332 FilmViewer::play_clicked (wxCommandEvent &)
 333 {
 334         check_play_state ();
 335 }
 336
 337 void
 338 FilmViewer::check_play_state ()
 339 {
 340         if (!_film) {
 341                 return;
 342         }
 343
 344         if (_play_button->GetValue()) {
 345                 _timer.Start (1000 / _film->frames_per_second());
 346         } else {
 347                 _timer.Stop ();
 348         }
 349 }
 350
 351 void
 352 FilmViewer::process_video (shared_ptr<Image> image, bool, shared_ptr<Subtitle> sub)
 353 {
 354         _raw_frame = image;
 355         _raw_sub = sub;
 356
 357         raw_to_display ();
 358
 359         _got_frame = true;
 360 }
 361
 362 void
 363 FilmViewer::get_frame ()
 364 {
 365         /* Clear our raw frame in case we don't get a new one */
 366         _raw_frame.reset ();
 367
 368         try {
 369                 _got_frame = false;
 370                 while (!_got_frame) {
 371                         if (_decoders.video->pass ()) {
 372                                 /* We didn't get a frame before the decoder gave up,
 373                                    so clear our display frame.
 374                                 */
 375                                 _display_frame.reset ();
 376                                 break;
 377                         }
 378                 }
 379         } catch (DecodeError& e) {
 380                 error_dialog (this, String::compose ("Could not decode video for view (%1)", e.what()));
 381         }
 382 }
 383
 384 void
 385 FilmViewer::active_jobs_changed (bool a)
 386 {
 387         if (a) {
 388                 list<shared_ptr<Job> > jobs = JobManager::instance()->get ();
 389                 list<shared_ptr<Job> >::iterator i = jobs.begin ();
 390                 while (i != jobs.end() && boost::dynamic_pointer_cast<ExamineContentJob> (*i) == 0) {
 391                         ++i;
 392                 }
 393
 394                 if (i == jobs.end() || (*i)->finished()) {
 395                         /* no examine content job running, so we're ok to use the viewer */
 396                         a = false;
 397                 }
 398         }
 399
 400         _slider->Enable (!a);
 401         _play_button->Enable (!a);
 402 }
 403