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