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/ratio.h"
  29 #include "lib/util.h"
  30 #include "lib/job_manager.h"
  31 #include "lib/image.h"
  32 #include "lib/scaler.h"
  33 #include "lib/exceptions.h"
  34 #include "lib/examine_content_job.h"
  35 #include "lib/filter.h"
  36 #include "lib/player.h"
  37 #include "lib/video_content.h"
  38 #include "lib/ffmpeg_content.h"
  39 #include "lib/imagemagick_content.h"
  40 #include "film_viewer.h"
  41 #include "wx_util.h"
  42 #include "video_decoder.h"
  43
  44 using std::string;
  45 using std::pair;
  46 using std::min;
  47 using std::max;
  48 using std::cout;
  49 using std::list;
  50 using std::make_pair;
  51 using boost::shared_ptr;
  52 using boost::dynamic_pointer_cast;
  53 using boost::weak_ptr;
  54 using libdcp::Size;
  55
  56 FilmViewer::FilmViewer (shared_ptr<Film> f, wxWindow* p)
  57         : wxPanel (p)
  58         , _panel (new wxPanel (this))
  59         , _slider (new wxSlider (this, wxID_ANY, 0, 0, 4096))
  60         , _back_button (new wxButton (this, wxID_ANY, wxT("<")))
  61         , _forward_button (new wxButton (this, wxID_ANY, wxT(">")))
  62         , _frame_number (new wxStaticText (this, wxID_ANY, wxT("")))
  63         , _timecode (new wxStaticText (this, wxID_ANY, wxT("")))
  64         , _play_button (new wxToggleButton (this, wxID_ANY, _("Play")))
  65         , _got_frame (false)
  66 {
  67 #ifndef __WXOSX__
  68         _panel->SetDoubleBuffered (true);
  69 #endif
  70
  71         _panel->SetBackgroundStyle (wxBG_STYLE_PAINT);
  72
  73         _v_sizer = new wxBoxSizer (wxVERTICAL);
  74         SetSizer (_v_sizer);
  75
  76         _v_sizer->Add (_panel, 1, wxEXPAND);
  77
  78         wxBoxSizer* h_sizer = new wxBoxSizer (wxHORIZONTAL);
  79
  80         wxBoxSizer* time_sizer = new wxBoxSizer (wxVERTICAL);
  81         time_sizer->Add (_frame_number, 0, wxEXPAND);
  82         time_sizer->Add (_timecode, 0, wxEXPAND);
  83
  84         h_sizer->Add (_back_button, 0, wxALL, 2);
  85         h_sizer->Add (time_sizer, 0, wxEXPAND);
  86         h_sizer->Add (_forward_button, 0, wxALL, 2);
  87         h_sizer->Add (_play_button, 0, wxEXPAND);
  88         h_sizer->Add (_slider, 1, wxEXPAND);
  89
  90         _v_sizer->Add (h_sizer, 0, wxEXPAND | wxALL, 6);
  91
  92         _frame_number->SetMinSize (wxSize (84, -1));
  93         _back_button->SetMinSize (wxSize (32, -1));
  94         _forward_button->SetMinSize (wxSize (32, -1));
  95
  96         _panel->Connect (wxID_ANY, wxEVT_PAINT, wxPaintEventHandler (FilmViewer::paint_panel), 0, this);
  97         _panel->Connect (wxID_ANY, wxEVT_SIZE, wxSizeEventHandler (FilmViewer::panel_sized), 0, this);
  98         _slider->Connect (wxID_ANY, wxEVT_SCROLL_THUMBTRACK, wxScrollEventHandler (FilmViewer::slider_moved), 0, this);
  99         _slider->Connect (wxID_ANY, wxEVT_SCROLL_PAGEUP, wxScrollEventHandler (FilmViewer::slider_moved), 0, this);
 100         _slider->Connect (wxID_ANY, wxEVT_SCROLL_PAGEDOWN, wxScrollEventHandler (FilmViewer::slider_moved), 0, this);
 101         _play_button->Connect (wxID_ANY, wxEVT_COMMAND_TOGGLEBUTTON_CLICKED, wxCommandEventHandler (FilmViewer::play_clicked), 0, this);
 102         _timer.Connect (wxID_ANY, wxEVT_TIMER, wxTimerEventHandler (FilmViewer::timer), 0, this);
 103         _back_button->Connect (wxID_ANY, wxEVT_COMMAND_BUTTON_CLICKED, wxCommandEventHandler (FilmViewer::back_clicked), 0, this);
 104         _forward_button->Connect (wxID_ANY, wxEVT_COMMAND_BUTTON_CLICKED, wxCommandEventHandler (FilmViewer::forward_clicked), 0, this);
 105
 106         set_film (f);
 107
 108         JobManager::instance()->ActiveJobsChanged.connect (
 109                 bind (&FilmViewer::active_jobs_changed, this, _1)
 110                 );
 111 }
 112
 113 void
 114 FilmViewer::set_film (shared_ptr<Film> f)
 115 {
 116         if (_film == f) {
 117                 return;
 118         }
 119
 120         _film = f;
 121
 122         _frame.reset ();
 123         _queue.clear ();
 124
 125         if (!_film) {
 126                 return;
 127         }
 128
 129         _player = f->player ();
 130         _player->disable_audio ();
 131         _player->Video.connect (boost::bind (&FilmViewer::process_video, this, _1, _3));
 132         _player->Changed.connect (boost::bind (&FilmViewer::player_changed, this));
 133
 134         calculate_sizes ();
 135         fetch_current_frame_again ();
 136 }
 137
 138 void
 139 FilmViewer::fetch_current_frame_again ()
 140 {
 141         if (!_player) {
 142                 return;
 143         }
 144
 145         /* Player::video_position is the time after the last frame that we received.
 146            We want to see it again, so seek back one frame.
 147         */
 148
 149         Time p = _player->video_position() - _film->video_frames_to_time (1);
 150         if (p < 0) {
 151                 p = 0;
 152         }
 153
 154         _player->seek (p, true);
 155         fetch_next_frame ();
 156 }
 157
 158 void
 159 FilmViewer::timer (wxTimerEvent &)
 160 {
 161         if (!_player) {
 162                 return;
 163         }
 164
 165         fetch_next_frame ();
 166
 167         if (_film->length()) {
 168                 int const new_slider_position = 4096 * _player->video_position() / _film->length();
 169                 if (new_slider_position != _slider->GetValue()) {
 170                         _slider->SetValue (new_slider_position);
 171                 }
 172         }
 173 }
 174
 175
 176 void
 177 FilmViewer::paint_panel (wxPaintEvent &)
 178 {
 179         wxPaintDC dc (_panel);
 180
 181         if (!_frame || !_film || !_out_size.width || !_out_size.height) {
 182                 dc.Clear ();
 183                 return;
 184         }
 185
 186         shared_ptr<Image> packed_frame (new Image (_frame, false));
 187
 188         wxImage frame (_out_size.width, _out_size.height, packed_frame->data()[0], true);
 189         wxBitmap frame_bitmap (frame);
 190         dc.DrawBitmap (frame_bitmap, 0, 0);
 191
 192         if (_out_size.width < _panel_size.width) {
 193                 wxPen p (GetBackgroundColour ());
 194                 wxBrush b (GetBackgroundColour ());
 195                 dc.SetPen (p);
 196                 dc.SetBrush (b);
 197                 dc.DrawRectangle (_out_size.width, 0, _panel_size.width - _out_size.width, _panel_size.height);
 198         }
 199
 200         if (_out_size.height < _panel_size.height) {
 201                 wxPen p (GetBackgroundColour ());
 202                 wxBrush b (GetBackgroundColour ());
 203                 dc.SetPen (p);
 204                 dc.SetBrush (b);
 205                 dc.DrawRectangle (0, _out_size.height, _panel_size.width, _panel_size.height - _out_size.height);
 206         }
 207 }
 208
 209
 210 void
 211 FilmViewer::slider_moved (wxScrollEvent &)
 212 {
 213         if (_film && _player) {
 214                 _player->seek (_slider->GetValue() * _film->length() / 4096, false);
 215                 fetch_next_frame ();
 216         }
 217 }
 218
 219 void
 220 FilmViewer::panel_sized (wxSizeEvent& ev)
 221 {
 222         _panel_size.width = ev.GetSize().GetWidth();
 223         _panel_size.height = ev.GetSize().GetHeight();
 224         calculate_sizes ();
 225         fetch_current_frame_again ();
 226 }
 227
 228 void
 229 FilmViewer::calculate_sizes ()
 230 {
 231         if (!_film || !_player) {
 232                 return;
 233         }
 234
 235         Ratio const * container = _film->container ();
 236
 237         float const panel_ratio = static_cast<float> (_panel_size.width) / _panel_size.height;
 238         float const film_ratio = container ? container->ratio () : 1.78;
 239
 240         if (panel_ratio < film_ratio) {
 241                 /* panel is less widscreen than the film; clamp width */
 242                 _out_size.width = _panel_size.width;
 243                 _out_size.height = _out_size.width / film_ratio;
 244         } else {
 245                 /* panel is more widescreen than the film; clamp height */
 246                 _out_size.height = _panel_size.height;
 247                 _out_size.width = _out_size.height * film_ratio;
 248         }
 249
 250         /* Catch silly values */
 251         _out_size.width = max (64, _out_size.width);
 252         _out_size.height = max (64, _out_size.height);
 253
 254         _player->set_video_container_size (_out_size);
 255 }
 256
 257 void
 258 FilmViewer::play_clicked (wxCommandEvent &)
 259 {
 260         check_play_state ();
 261 }
 262
 263 void
 264 FilmViewer::check_play_state ()
 265 {
 266         if (!_film || _film->dcp_video_frame_rate() == 0) {
 267                 return;
 268         }
 269
 270         if (_play_button->GetValue()) {
 271                 _timer.Start (1000 / _film->dcp_video_frame_rate());
 272         } else {
 273                 _timer.Stop ();
 274         }
 275 }
 276
 277 void
 278 FilmViewer::process_video (shared_ptr<const Image> image, Time t)
 279 {
 280         if (_got_frame) {
 281                 /* This is an additional frame emitted by a single pass.  Store it. */
 282                 _queue.push_front (make_pair (image, t));
 283                 return;
 284         }
 285
 286         _frame = image;
 287         _got_frame = true;
 288
 289         double const fps = _film->dcp_video_frame_rate ();
 290         /* Count frame number from 1 ... not sure if this is the best idea */
 291         _frame_number->SetLabel (wxString::Format (wxT("%d"), int (rint (t * fps / TIME_HZ)) + 1));
 292
 293         double w = static_cast<double>(t) / TIME_HZ;
 294         int const h = (w / 3600);
 295         w -= h * 3600;
 296         int const m = (w / 60);
 297         w -= m * 60;
 298         int const s = floor (w);
 299         w -= s;
 300         int const f = rint (w * fps);
 301         _timecode->SetLabel (wxString::Format (wxT("%02d:%02d:%02d:%02d"), h, m, s, f));
 302 }
 303
 304 /** Ask the player to emit its next frame, then update our display */
 305 void
 306 FilmViewer::fetch_next_frame ()
 307 {
 308         /* Clear our frame in case we don't get a new one */
 309         _frame.reset ();
 310
 311         if (!_player) {
 312                 return;
 313         }
 314
 315         _got_frame = false;
 316
 317         if (!_queue.empty ()) {
 318                 process_video (_queue.back().first, _queue.back().second);
 319                 _queue.pop_back ();
 320         } else {
 321                 try {
 322                         while (!_got_frame && !_player->pass ()) {}
 323                 } catch (DecodeError& e) {
 324                         _play_button->SetValue (false);
 325                         check_play_state ();
 326                         error_dialog (this, wxString::Format (_("Could not decode video for view (%s)"), std_to_wx(e.what()).data()));
 327                 }
 328         }
 329
 330         _panel->Refresh ();
 331         _panel->Update ();
 332 }
 333
 334 void
 335 FilmViewer::active_jobs_changed (bool a)
 336 {
 337         if (a) {
 338                 list<shared_ptr<Job> > jobs = JobManager::instance()->get ();
 339                 list<shared_ptr<Job> >::iterator i = jobs.begin ();
 340                 while (i != jobs.end() && boost::dynamic_pointer_cast<ExamineContentJob> (*i) == 0) {
 341                         ++i;
 342                 }
 343
 344                 if (i == jobs.end() || (*i)->finished()) {
 345                         /* no examine content job running, so we're ok to use the viewer */
 346                         a = false;
 347                 }
 348         }
 349
 350         _slider->Enable (!a);
 351         _play_button->Enable (!a);
 352 }
 353
 354 void
 355 FilmViewer::back_clicked (wxCommandEvent &)
 356 {
 357         if (!_player) {
 358                 return;
 359         }
 360
 361         /* Player::video_position is the time after the last frame that we received.
 362            We want to see the one before it, so we need to go back 2.
 363         */
 364
 365         _player->seek (_player->video_position() - _film->video_frames_to_time(2), true);
 366         fetch_next_frame ();
 367 }
 368
 369 void
 370 FilmViewer::forward_clicked (wxCommandEvent &)
 371 {
 372         if (!_player) {
 373                 return;
 374         }
 375
 376         fetch_next_frame ();
 377 }
 378
 379 void
 380 FilmViewer::player_changed ()
 381 {
 382         calculate_sizes ();
 383         fetch_current_frame_again ();
 384 }