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         , _got_frame (false)
  55         , _out_width (0)
  56         , _out_height (0)
  57         , _panel_width (0)
  58         , _panel_height (0)
  59         , _clear_required (false)
  60 {
  61         _panel->SetDoubleBuffered (true);
  62 #if wxMAJOR_VERSION == 2 && wxMINOR_VERSION >= 9
  63         _panel->SetBackgroundStyle (wxBG_STYLE_PAINT);
  64 #endif
  65
  66         _v_sizer = new wxBoxSizer (wxVERTICAL);
  67         SetSizer (_v_sizer);
  68
  69         _v_sizer->Add (_panel, 1, wxEXPAND);
  70
  71         wxBoxSizer* h_sizer = new wxBoxSizer (wxHORIZONTAL);
  72         h_sizer->Add (_play_button, 0, wxEXPAND);
  73         h_sizer->Add (_slider, 1, wxEXPAND);
  74
  75         _v_sizer->Add (h_sizer, 0, wxEXPAND);
  76
  77         _panel->Connect (wxID_ANY, wxEVT_PAINT, wxPaintEventHandler (FilmViewer::paint_panel), 0, this);
  78         _panel->Connect (wxID_ANY, wxEVT_SIZE, wxSizeEventHandler (FilmViewer::panel_sized), 0, this);
  79         _slider->Connect (wxID_ANY, wxEVT_SCROLL_THUMBTRACK, wxScrollEventHandler (FilmViewer::slider_moved), 0, this);
  80         _slider->Connect (wxID_ANY, wxEVT_SCROLL_PAGEUP, wxScrollEventHandler (FilmViewer::slider_moved), 0, this);
  81         _slider->Connect (wxID_ANY, wxEVT_SCROLL_PAGEDOWN, wxScrollEventHandler (FilmViewer::slider_moved), 0, this);
  82         _play_button->Connect (wxID_ANY, wxEVT_COMMAND_TOGGLEBUTTON_CLICKED, wxCommandEventHandler (FilmViewer::play_clicked), 0, this);
  83         _timer.Connect (wxID_ANY, wxEVT_TIMER, wxTimerEventHandler (FilmViewer::timer), 0, this);
  84
  85         set_film (f);
  86
  87         JobManager::instance()->ActiveJobsChanged.connect (
  88                 bind (&FilmViewer::active_jobs_changed, this, _1)
  89                 );
  90 }
  91
  92 void
  93 FilmViewer::film_changed (Film::Property p)
  94 {
  95         switch (p) {
  96         case Film::FORMAT:
  97                 calculate_sizes ();
  98                 update_from_raw ();
  99                 break;
 100         case Film::CONTENT:
 101         {
 102                 DecodeOptions o;
 103                 o.decode_audio = false;
 104                 o.decode_subtitles = true;
 105                 o.video_sync = false;
 106                 _decoders = decoder_factory (_film, o, 0);
 107                 _decoders.video->Video.connect (bind (&FilmViewer::process_video, this, _1, _2, _3));
 108                 _decoders.video->OutputChanged.connect (boost::bind (&FilmViewer::decoder_changed, this));
 109                 _decoders.video->set_subtitle_stream (_film->subtitle_stream());
 110                 calculate_sizes ();
 111                 get_frame ();
 112                 _panel->Refresh ();
 113                 _slider->Show (_film->content_type() == VIDEO);
 114                 _play_button->Show (_film->content_type() == VIDEO);
 115                 _v_sizer->Layout ();
 116                 break;
 117         }
 118         case Film::WITH_SUBTITLES:
 119         case Film::SUBTITLE_OFFSET:
 120         case Film::SUBTITLE_SCALE:
 121         case Film::SCALER:
 122                 update_from_raw ();
 123                 break;
 124         case Film::SUBTITLE_STREAM:
 125                 _decoders.video->set_subtitle_stream (_film->subtitle_stream ());
 126                 break;
 127         default:
 128                 break;
 129         }
 130 }
 131
 132 void
 133 FilmViewer::set_film (shared_ptr<Film> f)
 134 {
 135         if (_film == f) {
 136                 return;
 137         }
 138
 139         _film = f;
 140
 141         if (!_film) {
 142                 return;
 143         }
 144
 145         _film->Changed.connect (boost::bind (&FilmViewer::film_changed, this, _1));
 146
 147         film_changed (Film::CONTENT);
 148         film_changed (Film::CROP);
 149         film_changed (Film::FORMAT);
 150         film_changed (Film::WITH_SUBTITLES);
 151         film_changed (Film::SUBTITLE_OFFSET);
 152         film_changed (Film::SUBTITLE_SCALE);
 153         film_changed (Film::SUBTITLE_STREAM);
 154 }
 155
 156 void
 157 FilmViewer::decoder_changed ()
 158 {
 159         if (_decoders.video->seek_to_last ()) {
 160                 return;
 161         }
 162
 163         get_frame ();
 164         _panel->Refresh ();
 165         _panel->Update ();
 166 }
 167
 168 void
 169 FilmViewer::timer (wxTimerEvent &)
 170 {
 171         if (!_film) {
 172                 return;
 173         }
 174
 175         _panel->Refresh ();
 176         _panel->Update ();
 177
 178         get_frame ();
 179
 180         if (_film->length()) {
 181                 int const new_slider_position = 4096 * _decoders.video->last_source_time() / (_film->length().get() / _film->frames_per_second());
 182                 if (new_slider_position != _slider->GetValue()) {
 183                         _slider->SetValue (new_slider_position);
 184                 }
 185         }
 186 }
 187
 188
 189 void
 190 FilmViewer::paint_panel (wxPaintEvent &)
 191 {
 192         wxPaintDC dc (_panel);
 193
 194         if (_clear_required) {
 195                 dc.Clear ();
 196                 _clear_required = false;
 197         }
 198
 199         if (!_display_frame || !_film || !_out_width || !_out_height) {
 200                 dc.Clear ();
 201                 return;
 202         }
 203
 204         wxImage frame (_out_width, _out_height, _display_frame->data()[0], true);
 205         wxBitmap frame_bitmap (frame);
 206         dc.DrawBitmap (frame_bitmap, 0, 0);
 207
 208         if (_film->with_subtitles() && _display_sub) {
 209                 wxImage sub (_display_sub->size().width, _display_sub->size().height, _display_sub->data()[0], _display_sub->alpha(), true);
 210                 wxBitmap sub_bitmap (sub);
 211                 dc.DrawBitmap (sub_bitmap, _display_sub_position.x, _display_sub_position.y);
 212         }
 213 }
 214
 215
 216 void
 217 FilmViewer::slider_moved (wxScrollEvent &)
 218 {
 219         if (!_film || !_film->length()) {
 220                 return;
 221         }
 222
 223         if (_decoders.video->seek (_slider->GetValue() * _film->length().get() / (4096 * _film->frames_per_second()))) {
 224                 return;
 225         }
 226
 227         get_frame ();
 228         _panel->Refresh ();
 229         _panel->Update ();
 230 }
 231
 232 void
 233 FilmViewer::panel_sized (wxSizeEvent& ev)
 234 {
 235         _panel_width = ev.GetSize().GetWidth();
 236         _panel_height = ev.GetSize().GetHeight();
 237         calculate_sizes ();
 238         update_from_raw ();
 239 }
 240
 241 void
 242 FilmViewer::update_from_raw ()
 243 {
 244         if (!_raw_frame) {
 245                 return;
 246         }
 247
 248         raw_to_display ();
 249
 250         _panel->Refresh ();
 251         _panel->Update ();
 252 }
 253
 254 void
 255 FilmViewer::raw_to_display ()
 256 {
 257         if (!_raw_frame || _out_width < 64 || _out_height < 64 || !_film) {
 258                 return;
 259         }
 260
 261         libdcp::Size old_size;
 262         if (_display_frame) {
 263                 old_size = _display_frame->size();
 264         }
 265
 266         /* Get a compacted image as we have to feed it to wxWidgets */
 267         _display_frame = _raw_frame->scale_and_convert_to_rgb (libdcp::Size (_out_width, _out_height), 0, _film->scaler(), false);
 268
 269         if (old_size != _display_frame->size()) {
 270                 _clear_required = true;
 271         }
 272
 273         if (_raw_sub) {
 274                 Rect tx = subtitle_transformed_area (
 275                         float (_out_width) / _film->size().width,
 276                         float (_out_height) / _film->size().height,
 277                         _raw_sub->area(), _film->subtitle_offset(), _film->subtitle_scale()
 278                         );
 279
 280                 _display_sub.reset (new RGBPlusAlphaImage (_raw_sub->image()->scale (tx.size(), _film->scaler(), false)));
 281                 _display_sub_position = tx.position();
 282         } else {
 283                 _display_sub.reset ();
 284         }
 285 }
 286
 287 void
 288 FilmViewer::calculate_sizes ()
 289 {
 290         if (!_film) {
 291                 return;
 292         }
 293
 294         float const panel_ratio = static_cast<float> (_panel_width) / _panel_height;
 295         float const film_ratio = _film->format() ? _film->format()->ratio_as_float(_film) : 1.78;
 296         if (panel_ratio < film_ratio) {
 297                 /* panel is less widscreen than the film; clamp width */
 298                 _out_width = _panel_width;
 299                 _out_height = _out_width / film_ratio;
 300         } else {
 301                 /* panel is more widescreen than the film; clamp heignt */
 302                 _out_height = _panel_height;
 303                 _out_width = _out_height * film_ratio;
 304         }
 305 }
 306
 307 void
 308 FilmViewer::play_clicked (wxCommandEvent &)
 309 {
 310         check_play_state ();
 311 }
 312
 313 void
 314 FilmViewer::check_play_state ()
 315 {
 316         if (!_film) {
 317                 return;
 318         }
 319
 320         if (_play_button->GetValue()) {
 321                 _timer.Start (1000 / _film->frames_per_second());
 322         } else {
 323                 _timer.Stop ();
 324         }
 325 }
 326
 327 void
 328 FilmViewer::process_video (shared_ptr<Image> image, bool, shared_ptr<Subtitle> sub)
 329 {
 330         _raw_frame = image;
 331         _raw_sub = sub;
 332
 333         raw_to_display ();
 334
 335         _got_frame = true;
 336 }
 337
 338 void
 339 FilmViewer::get_frame ()
 340 {
 341         /* Clear our raw frame in case we don't get a new one */
 342         _raw_frame.reset ();
 343
 344         try {
 345                 _got_frame = false;
 346                 while (!_got_frame) {
 347                         if (_decoders.video->pass ()) {
 348                                 /* We didn't get a frame before the decoder gave up,
 349                                    so clear our display frame.
 350                                 */
 351                                 _display_frame.reset ();
 352                                 break;
 353                         }
 354                 }
 355         } catch (DecodeError& e) {
 356                 error_dialog (this, String::compose ("Could not decode video for view (%1)", e.what()));
 357         }
 358 }
 359
 360 void
 361 FilmViewer::active_jobs_changed (bool a)
 362 {
 363         if (a) {
 364                 list<shared_ptr<Job> > jobs = JobManager::instance()->get ();
 365                 list<shared_ptr<Job> >::iterator i = jobs.begin ();
 366                 while (i != jobs.end() && boost::dynamic_pointer_cast<ExamineContentJob> (*i) == 0) {
 367                         ++i;
 368                 }
 369
 370                 if (i == jobs.end() || (*i)->finished()) {
 371                         /* no examine content job running, so we're ok to use the viewer */
 372                         a = false;
 373                 }
 374         }
 375
 376         _slider->Enable (!a);
 377         _play_button->Enable (!a);
 378 }
 379