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