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