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