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