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/still_image_content.h"
  40 #include "lib/video_decoder.h"
  41 #include "film_viewer.h"
  42 #include "wx_util.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         _slider->SetValue (0);
 126         set_position_text (0);
 127
 128         if (!_film) {
 129                 return;
 130         }
 131
 132         _player = f->make_player ();
 133         _player->disable_audio ();
 134         _player->Video.connect (boost::bind (&FilmViewer::process_video, this, _1, _3));
 135         _player->Changed.connect (boost::bind (&FilmViewer::player_changed, this, _1));
 136
 137         calculate_sizes ();
 138         fetch_current_frame_again ();
 139 }
 140
 141 void
 142 FilmViewer::fetch_current_frame_again ()
 143 {
 144         if (!_player) {
 145                 return;
 146         }
 147
 148         /* Player::video_position is the time after the last frame that we received.
 149            We want to see it again, so seek back one frame.
 150         */
 151
 152         Time p = _player->video_position() - _film->video_frames_to_time (1);
 153         if (p < 0) {
 154                 p = 0;
 155         }
 156
 157         _player->seek (p, true);
 158         fetch_next_frame ();
 159 }
 160
 161 void
 162 FilmViewer::timer (wxTimerEvent &)
 163 {
 164         if (!_player) {
 165                 return;
 166         }
 167
 168         fetch_next_frame ();
 169
 170         Time const len = _film->length ();
 171
 172         if (len) {
 173                 int const new_slider_position = 4096 * _player->video_position() / len;
 174                 if (new_slider_position != _slider->GetValue()) {
 175                         _slider->SetValue (new_slider_position);
 176                 }
 177         }
 178 }
 179
 180
 181 void
 182 FilmViewer::paint_panel (wxPaintEvent &)
 183 {
 184         wxPaintDC dc (_panel);
 185
 186         if (!_frame || !_film || !_out_size.width || !_out_size.height) {
 187                 dc.Clear ();
 188                 return;
 189         }
 190
 191         shared_ptr<Image> packed_frame (new Image (_frame, false));
 192
 193         wxImage frame (_out_size.width, _out_size.height, packed_frame->data()[0], true);
 194         wxBitmap frame_bitmap (frame);
 195         dc.DrawBitmap (frame_bitmap, 0, 0);
 196
 197         if (_out_size.width < _panel_size.width) {
 198                 wxPen p (GetBackgroundColour ());
 199                 wxBrush b (GetBackgroundColour ());
 200                 dc.SetPen (p);
 201                 dc.SetBrush (b);
 202                 dc.DrawRectangle (_out_size.width, 0, _panel_size.width - _out_size.width, _panel_size.height);
 203         }
 204
 205         if (_out_size.height < _panel_size.height) {
 206                 wxPen p (GetBackgroundColour ());
 207                 wxBrush b (GetBackgroundColour ());
 208                 dc.SetPen (p);
 209                 dc.SetBrush (b);
 210                 dc.DrawRectangle (0, _out_size.height, _panel_size.width, _panel_size.height - _out_size.height);
 211         }
 212 }
 213
 214
 215 void
 216 FilmViewer::slider_moved (wxScrollEvent &)
 217 {
 218         if (_film && _player) {
 219                 _player->seek (_slider->GetValue() * _film->length() / 4096, false);
 220                 fetch_next_frame ();
 221         }
 222 }
 223
 224 void
 225 FilmViewer::panel_sized (wxSizeEvent& ev)
 226 {
 227         _panel_size.width = ev.GetSize().GetWidth();
 228         _panel_size.height = ev.GetSize().GetHeight();
 229         calculate_sizes ();
 230         fetch_current_frame_again ();
 231 }
 232
 233 void
 234 FilmViewer::calculate_sizes ()
 235 {
 236         if (!_film || !_player) {
 237                 return;
 238         }
 239
 240         Ratio const * container = _film->container ();
 241
 242         float const panel_ratio = static_cast<float> (_panel_size.width) / _panel_size.height;
 243         float const film_ratio = container ? container->ratio () : 1.78;
 244
 245         if (panel_ratio < film_ratio) {
 246                 /* panel is less widscreen than the film; clamp width */
 247                 _out_size.width = _panel_size.width;
 248                 _out_size.height = _out_size.width / film_ratio;
 249         } else {
 250                 /* panel is more widescreen than the film; clamp height */
 251                 _out_size.height = _panel_size.height;
 252                 _out_size.width = _out_size.height * film_ratio;
 253         }
 254
 255         /* Catch silly values */
 256         _out_size.width = max (64, _out_size.width);
 257         _out_size.height = max (64, _out_size.height);
 258
 259         _player->set_video_container_size (_out_size);
 260 }
 261
 262 void
 263 FilmViewer::play_clicked (wxCommandEvent &)
 264 {
 265         check_play_state ();
 266 }
 267
 268 void
 269 FilmViewer::check_play_state ()
 270 {
 271         if (!_film || _film->dcp_video_frame_rate() == 0) {
 272                 return;
 273         }
 274
 275         if (_play_button->GetValue()) {
 276                 _timer.Start (1000 / _film->dcp_video_frame_rate());
 277         } else {
 278                 _timer.Stop ();
 279         }
 280 }
 281
 282 void
 283 FilmViewer::process_video (shared_ptr<const Image> image, Time t)
 284 {
 285         if (_got_frame) {
 286                 /* This is an additional frame emitted by a single pass.  Store it. */
 287                 _queue.push_front (make_pair (image, t));
 288                 return;
 289         }
 290
 291         _frame = image;
 292         _got_frame = true;
 293
 294         set_position_text (t);
 295 }
 296
 297 void
 298 FilmViewer::set_position_text (Time t)
 299 {
 300         if (!_film) {
 301                 _frame_number->SetLabel ("0");
 302                 _timecode->SetLabel ("0:0:0.0");
 303                 return;
 304         }
 305
 306         double const fps = _film->dcp_video_frame_rate ();
 307         /* Count frame number from 1 ... not sure if this is the best idea */
 308         _frame_number->SetLabel (wxString::Format (wxT("%d"), int (rint (t * fps / TIME_HZ)) + 1));
 309
 310         double w = static_cast<double>(t) / TIME_HZ;
 311         int const h = (w / 3600);
 312         w -= h * 3600;
 313         int const m = (w / 60);
 314         w -= m * 60;
 315         int const s = floor (w);
 316         w -= s;
 317         int const f = rint (w * fps);
 318         _timecode->SetLabel (wxString::Format (wxT("%02d:%02d:%02d.%02d"), h, m, s, f));
 319 }
 320
 321 /** Ask the player to emit its next frame, then update our display */
 322 void
 323 FilmViewer::fetch_next_frame ()
 324 {
 325         /* Clear our frame in case we don't get a new one */
 326         _frame.reset ();
 327
 328         if (!_player) {
 329                 return;
 330         }
 331
 332         _got_frame = false;
 333
 334         if (!_queue.empty ()) {
 335                 process_video (_queue.back().first, _queue.back().second);
 336                 _queue.pop_back ();
 337         } else {
 338                 try {
 339                         while (!_got_frame && !_player->pass ()) {}
 340                 } catch (DecodeError& e) {
 341                         _play_button->SetValue (false);
 342                         check_play_state ();
 343                         error_dialog (this, wxString::Format (_("Could not decode video for view (%s)"), std_to_wx(e.what()).data()));
 344                 }
 345         }
 346
 347         _panel->Refresh ();
 348         _panel->Update ();
 349 }
 350
 351 void
 352 FilmViewer::active_jobs_changed (bool a)
 353 {
 354         if (a) {
 355                 list<shared_ptr<Job> > jobs = JobManager::instance()->get ();
 356                 list<shared_ptr<Job> >::iterator i = jobs.begin ();
 357                 while (i != jobs.end() && boost::dynamic_pointer_cast<ExamineContentJob> (*i) == 0) {
 358                         ++i;
 359                 }
 360
 361                 if (i == jobs.end() || (*i)->finished()) {
 362                         /* no examine content job running, so we're ok to use the viewer */
 363                         a = false;
 364                 }
 365         }
 366
 367         _slider->Enable (!a);
 368         _play_button->Enable (!a);
 369 }
 370
 371 void
 372 FilmViewer::back_clicked (wxCommandEvent &)
 373 {
 374         if (!_player) {
 375                 return;
 376         }
 377
 378         /* Player::video_position is the time after the last frame that we received.
 379            We want to see the one before it, so we need to go back 2.
 380         */
 381
 382         _player->seek (_player->video_position() - _film->video_frames_to_time(2), true);
 383         fetch_next_frame ();
 384 }
 385
 386 void
 387 FilmViewer::forward_clicked (wxCommandEvent &)
 388 {
 389         if (!_player) {
 390                 return;
 391         }
 392
 393         fetch_next_frame ();
 394 }
 395
 396 void
 397 FilmViewer::player_changed (bool frequent)
 398 {
 399         if (frequent) {
 400                 return;
 401         }
 402
 403         calculate_sizes ();
 404         fetch_current_frame_again ();
 405 }