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