src/wx/film_viewer.cc

   1 /*
   2     Copyright (C) 2012-2017 Carl Hetherington <cth@carlh.net>
   3
   4     This file is part of DCP-o-matic.
   5
   6     DCP-o-matic is free software; you can redistribute it and/or modify
   7     it under the terms of the GNU General Public License as published by
   8     the Free Software Foundation; either version 2 of the License, or
   9     (at your option) any later version.
  10
  11     DCP-o-matic is distributed in the hope that it will be useful,
  12     but WITHOUT ANY WARRANTY; without even the implied warranty of
  13     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14     GNU General Public License for more details.
  15
  16     You should have received a copy of the GNU General Public License
  17     along with DCP-o-matic.  If not, see <http://www.gnu.org/licenses/>.
  18
  19 */
  20
  21 /** @file  src/film_viewer.cc
  22  *  @brief A wx widget to view a preview of a Film.
  23  */
  24
  25 #include "film_viewer.h"
  26 #include "playhead_to_timecode_dialog.h"
  27 #include "playhead_to_frame_dialog.h"
  28 #include "wx_util.h"
  29 #include "closed_captions_dialog.h"
  30 #include "lib/film.h"
  31 #include "lib/ratio.h"
  32 #include "lib/util.h"
  33 #include "lib/job_manager.h"
  34 #include "lib/image.h"
  35 #include "lib/exceptions.h"
  36 #include "lib/examine_content_job.h"
  37 #include "lib/filter.h"
  38 #include "lib/player.h"
  39 #include "lib/player_video.h"
  40 #include "lib/video_content.h"
  41 #include "lib/video_decoder.h"
  42 #include "lib/timer.h"
  43 #include "lib/butler.h"
  44 #include "lib/log.h"
  45 #include "lib/config.h"
  46 extern "C" {
  47 #include <libavutil/pixfmt.h>
  48 }
  49 #include <dcp/exceptions.h>
  50 #include <wx/tglbtn.h>
  51 #include <iostream>
  52 #include <iomanip>
  53
  54 using std::string;
  55 using std::pair;
  56 using std::min;
  57 using std::max;
  58 using std::cout;
  59 using std::list;
  60 using std::bad_alloc;
  61 using std::make_pair;
  62 using std::exception;
  63 using boost::shared_ptr;
  64 using boost::dynamic_pointer_cast;
  65 using boost::weak_ptr;
  66 using boost::optional;
  67 using dcp::Size;
  68
  69 static
  70 int
  71 rtaudio_callback (void* out, void *, unsigned int frames, double, RtAudioStreamStatus, void* data)
  72 {
  73         return reinterpret_cast<FilmViewer*>(data)->audio_callback (out, frames);
  74 }
  75
  76 FilmViewer::FilmViewer (wxWindow* p, bool outline_content, bool jump_to_selected)
  77         : wxPanel (p)
  78         , _panel (new wxPanel (this))
  79         , _outline_content (0)
  80         , _eye (0)
  81         , _jump_to_selected (0)
  82         , _slider (new wxSlider (this, wxID_ANY, 0, 0, 4096))
  83         , _rewind_button (new wxButton (this, wxID_ANY, wxT("|<")))
  84         , _back_button (new wxButton (this, wxID_ANY, wxT("<")))
  85         , _forward_button (new wxButton (this, wxID_ANY, wxT(">")))
  86         , _frame_number (new wxStaticText (this, wxID_ANY, wxT("")))
  87         , _timecode (new wxStaticText (this, wxID_ANY, wxT("")))
  88         , _play_button (new wxToggleButton (this, wxID_ANY, _("Play")))
  89         , _coalesce_player_changes (false)
  90         , _slider_being_moved (false)
  91         , _was_running_before_slider (false)
  92         , _audio (DCPOMATIC_RTAUDIO_API)
  93         , _audio_channels (0)
  94         , _audio_block_size (1024)
  95         , _playing (false)
  96         , _latency_history_count (0)
  97         , _dropped (0)
  98         , _closed_captions_dialog (new ClosedCaptionsDialog(GetParent()))
  99 {
 100 #ifndef __WXOSX__
 101         _panel->SetDoubleBuffered (true);
 102 #endif
 103
 104         _panel->SetBackgroundStyle (wxBG_STYLE_PAINT);
 105
 106         _v_sizer = new wxBoxSizer (wxVERTICAL);
 107         SetSizer (_v_sizer);
 108
 109         _v_sizer->Add (_panel, 1, wxEXPAND);
 110
 111         wxBoxSizer* view_options = new wxBoxSizer (wxHORIZONTAL);
 112         if (outline_content) {
 113                 _outline_content = new wxCheckBox (this, wxID_ANY, _("Outline content"));
 114                 view_options->Add (_outline_content, 0, wxRIGHT | wxALIGN_CENTER_VERTICAL, DCPOMATIC_SIZER_GAP);
 115         }
 116
 117         _eye = new wxChoice (this, wxID_ANY);
 118         _eye->Append (_("Left"));
 119         _eye->Append (_("Right"));
 120         _eye->SetSelection (0);
 121         view_options->Add (_eye, 0, wxLEFT | wxRIGHT | wxALIGN_CENTER_VERTICAL, DCPOMATIC_SIZER_GAP);
 122
 123         if (jump_to_selected) {
 124                 _jump_to_selected = new wxCheckBox (this, wxID_ANY, _("Jump to selected content"));
 125                 view_options->Add (_jump_to_selected, 0, wxLEFT | wxRIGHT | wxALIGN_CENTER_VERTICAL, DCPOMATIC_SIZER_GAP);
 126         }
 127
 128         _v_sizer->Add (view_options, 0, wxALL, DCPOMATIC_SIZER_GAP);
 129
 130         wxBoxSizer* h_sizer = new wxBoxSizer (wxHORIZONTAL);
 131
 132         wxBoxSizer* time_sizer = new wxBoxSizer (wxVERTICAL);
 133         time_sizer->Add (_frame_number, 0, wxEXPAND);
 134         time_sizer->Add (_timecode, 0, wxEXPAND);
 135
 136         h_sizer->Add (_rewind_button, 0, wxALL, 2);
 137         h_sizer->Add (_back_button, 0, wxALL, 2);
 138         h_sizer->Add (time_sizer, 0, wxEXPAND);
 139         h_sizer->Add (_forward_button, 0, wxALL, 2);
 140         h_sizer->Add (_play_button, 0, wxEXPAND);
 141         h_sizer->Add (_slider, 1, wxEXPAND);
 142
 143         _v_sizer->Add (h_sizer, 0, wxEXPAND | wxALL, 6);
 144
 145         _frame_number->SetMinSize (wxSize (84, -1));
 146         _rewind_button->SetMinSize (wxSize (32, -1));
 147         _back_button->SetMinSize (wxSize (32, -1));
 148         _forward_button->SetMinSize (wxSize (32, -1));
 149
 150         _panel->Bind            (wxEVT_PAINT,               boost::bind (&FilmViewer::paint_panel,     this));
 151         _panel->Bind            (wxEVT_SIZE,                boost::bind (&FilmViewer::panel_sized,     this, _1));
 152         if (_outline_content) {
 153                 _outline_content->Bind  (wxEVT_CHECKBOX,    boost::bind (&FilmViewer::refresh_panel,   this));
 154         }
 155         _eye->Bind              (wxEVT_CHOICE,              boost::bind (&FilmViewer::slow_refresh,    this));
 156         _slider->Bind           (wxEVT_SCROLL_THUMBTRACK,   boost::bind (&FilmViewer::slider_moved,    this, false));
 157         _slider->Bind           (wxEVT_SCROLL_PAGEUP,       boost::bind (&FilmViewer::slider_moved,    this, true));
 158         _slider->Bind           (wxEVT_SCROLL_PAGEDOWN,     boost::bind (&FilmViewer::slider_moved,    this, true));
 159         _slider->Bind           (wxEVT_SCROLL_THUMBRELEASE, boost::bind (&FilmViewer::slider_released, this));
 160         _play_button->Bind      (wxEVT_TOGGLEBUTTON,        boost::bind (&FilmViewer::play_clicked,    this));
 161         _timer.Bind             (wxEVT_TIMER,               boost::bind (&FilmViewer::timer,           this));
 162         _rewind_button->Bind    (wxEVT_LEFT_DOWN,           boost::bind (&FilmViewer::rewind_clicked,  this, _1));
 163         _back_button->Bind      (wxEVT_LEFT_DOWN,           boost::bind (&FilmViewer::back_clicked,    this, _1));
 164         _forward_button->Bind   (wxEVT_LEFT_DOWN,           boost::bind (&FilmViewer::forward_clicked, this, _1));
 165         _frame_number->Bind     (wxEVT_LEFT_DOWN,           boost::bind (&FilmViewer::frame_number_clicked, this));
 166         _timecode->Bind         (wxEVT_LEFT_DOWN,           boost::bind (&FilmViewer::timecode_clicked, this));
 167         if (_jump_to_selected) {
 168                 _jump_to_selected->Bind (wxEVT_CHECKBOX, boost::bind (&FilmViewer::jump_to_selected_clicked, this));
 169                 _jump_to_selected->SetValue (Config::instance()->jump_to_selected ());
 170         }
 171
 172         set_film (shared_ptr<Film> ());
 173
 174         JobManager::instance()->ActiveJobsChanged.connect (
 175                 bind (&FilmViewer::active_jobs_changed, this, _2)
 176                 );
 177
 178         setup_sensitivity ();
 179
 180         _config_changed_connection = Config::instance()->Changed.connect (bind (&FilmViewer::config_changed, this, _1));
 181         config_changed (Config::SOUND_OUTPUT);
 182 }
 183
 184 FilmViewer::~FilmViewer ()
 185 {
 186         stop ();
 187 }
 188
 189 void
 190 FilmViewer::set_film (shared_ptr<Film> film)
 191 {
 192         if (_film == film) {
 193                 return;
 194         }
 195
 196         _film = film;
 197
 198         _frame.reset ();
 199         _closed_captions_dialog->clear ();
 200
 201         update_position_slider ();
 202         update_position_label ();
 203
 204         if (!_film) {
 205                 _player.reset ();
 206                 recreate_butler ();
 207                 _frame.reset ();
 208                 refresh_panel ();
 209                 return;
 210         }
 211
 212         try {
 213                 _player.reset (new Player (_film, _film->playlist ()));
 214                 _player->set_fast ();
 215                 if (_dcp_decode_reduction) {
 216                         _player->set_dcp_decode_reduction (_dcp_decode_reduction);
 217                 }
 218         } catch (bad_alloc) {
 219                 error_dialog (this, _("There is not enough free memory to do that."));
 220                 _film.reset ();
 221                 return;
 222         }
 223
 224         _player->set_always_burn_open_subtitles ();
 225         _player->set_play_referenced ();
 226
 227         _film->Changed.connect (boost::bind (&FilmViewer::film_changed, this, _1));
 228         _player->Changed.connect (boost::bind (&FilmViewer::player_changed, this, _1, _2));
 229
 230         /* Keep about 1 second's worth of history samples */
 231         _latency_history_count = _film->audio_frame_rate() / _audio_block_size;
 232
 233         recreate_butler ();
 234
 235         calculate_sizes ();
 236         slow_refresh ();
 237
 238         setup_sensitivity ();
 239 }
 240
 241 void
 242 FilmViewer::recreate_butler ()
 243 {
 244         bool const was_running = stop ();
 245         _butler.reset ();
 246
 247         if (!_film) {
 248                 return;
 249         }
 250
 251         AudioMapping map = AudioMapping (_film->audio_channels(), _audio_channels);
 252
 253         if (_audio_channels != 2 || _film->audio_channels() < 3) {
 254                 for (int i = 0; i < min (_film->audio_channels(), _audio_channels); ++i) {
 255                         map.set (i, i, 1);
 256                 }
 257         } else {
 258                 /* Special case: stereo output, at least 3 channel input.
 259                    Map so that Lt = L(-3dB) + Ls(-3dB) + C(-6dB) + Lfe(-10dB)
 260                                Rt = R(-3dB) + Rs(-3dB) + C(-6dB) + Lfe(-10dB)
 261                 */
 262                 map.set (dcp::LEFT,   0, 1 / sqrt(2)); // L -> Lt
 263                 map.set (dcp::RIGHT,  1, 1 / sqrt(2)); // R -> Rt
 264                 map.set (dcp::CENTRE, 0, 1 / 2.0); // C -> Lt
 265                 map.set (dcp::CENTRE, 1, 1 / 2.0); // C -> Rt
 266                 map.set (dcp::LFE,    0, 1 / sqrt(10)); // Lfe -> Lt
 267                 map.set (dcp::LFE,    1, 1 / sqrt(10)); // Lfe -> Rt
 268                 map.set (dcp::LS,     0, 1 / sqrt(2)); // Ls -> Lt
 269                 map.set (dcp::RS,     1, 1 / sqrt(2)); // Rs -> Rt
 270         }
 271
 272         _butler.reset (new Butler (_player, _film->log(), map, _audio_channels));
 273         if (!Config::instance()->sound() && !_audio.isStreamOpen()) {
 274                 _butler->disable_audio ();
 275         }
 276
 277         _closed_captions_dialog->set_butler (_butler);
 278
 279         if (was_running) {
 280                 start ();
 281         }
 282 }
 283
 284 void
 285 FilmViewer::refresh_panel ()
 286 {
 287         _panel->Refresh ();
 288         _panel->Update ();
 289 }
 290
 291 void
 292 FilmViewer::get ()
 293 {
 294         DCPOMATIC_ASSERT (_butler);
 295
 296         do {
 297                 _player_video = _butler->get_video ();
 298         } while (
 299                 _film->three_d() &&
 300                 ((_eye->GetSelection() == 0 && _player_video.first->eyes() == EYES_RIGHT) || (_eye->GetSelection() == 1 && _player_video.first->eyes() == EYES_LEFT))
 301                 );
 302
 303         _butler->rethrow ();
 304
 305         display_player_video ();
 306 }
 307
 308 void
 309 FilmViewer::display_player_video ()
 310 {
 311         if (!_player_video.first) {
 312                 _frame.reset ();
 313                 refresh_panel ();
 314                 return;
 315         }
 316
 317         if (_playing && (time() - _player_video.second) > one_video_frame()) {
 318                 /* Too late; just drop this frame before we try to get its image (which will be the time-consuming
 319                    part if this frame is J2K).
 320                 */
 321                 _video_position = _player_video.second;
 322                 ++_dropped;
 323                 return;
 324         }
 325
 326         /* In an ideal world, what we would do here is:
 327          *
 328          * 1. convert to XYZ exactly as we do in the DCP creation path.
 329          * 2. convert back to RGB for the preview display, compensating
 330          *    for the monitor etc. etc.
 331          *
 332          * but this is inefficient if the source is RGB.  Since we don't
 333          * (currently) care too much about the precise accuracy of the preview's
 334          * colour mapping (and we care more about its speed) we try to short-
 335          * circuit this "ideal" situation in some cases.
 336          *
 337          * The content's specified colour conversion indicates the colourspace
 338          * which the content is in (according to the user).
 339          *
 340          * PlayerVideo::image (bound to PlayerVideo::always_rgb) will take the source
 341          * image and convert it (from whatever the user has said it is) to RGB.
 342          */
 343
 344         _frame = _player_video.first->image (
 345                 bind (&Log::dcp_log, _film->log().get(), _1, _2),
 346                 bind (&PlayerVideo::always_rgb, _1),
 347                 false, true
 348                 );
 349
 350         ImageChanged (_player_video.first);
 351
 352         _video_position = _player_video.second;
 353         _inter_position = _player_video.first->inter_position ();
 354         _inter_size = _player_video.first->inter_size ();
 355
 356         refresh_panel ();
 357
 358         _closed_captions_dialog->update (time());
 359 }
 360
 361 void
 362 FilmViewer::timer ()
 363 {
 364         if (!_film || !_playing) {
 365                 return;
 366         }
 367
 368         get ();
 369         update_position_label ();
 370         update_position_slider ();
 371         DCPTime const next = _video_position + one_video_frame();
 372
 373         if (next >= _film->length()) {
 374                 stop ();
 375         }
 376
 377         _timer.Start (max ((next.seconds() - time().seconds()) * 1000, 1.0), wxTIMER_ONE_SHOT);
 378
 379         if (_butler) {
 380                 _butler->rethrow ();
 381         }
 382 }
 383
 384 void
 385 FilmViewer::paint_panel ()
 386 {
 387         wxPaintDC dc (_panel);
 388
 389         if (!_frame || !_film || !_out_size.width || !_out_size.height || _out_size != _frame->size()) {
 390                 dc.Clear ();
 391                 return;
 392         }
 393
 394         wxImage frame (_out_size.width, _out_size.height, _frame->data()[0], true);
 395         wxBitmap frame_bitmap (frame);
 396         dc.DrawBitmap (frame_bitmap, 0, 0);
 397
 398         if (_out_size.width < _panel_size.width) {
 399                 wxPen p (GetBackgroundColour ());
 400                 wxBrush b (GetBackgroundColour ());
 401                 dc.SetPen (p);
 402                 dc.SetBrush (b);
 403                 dc.DrawRectangle (_out_size.width, 0, _panel_size.width - _out_size.width, _panel_size.height);
 404         }
 405
 406         if (_out_size.height < _panel_size.height) {
 407                 wxPen p (GetBackgroundColour ());
 408                 wxBrush b (GetBackgroundColour ());
 409                 dc.SetPen (p);
 410                 dc.SetBrush (b);
 411                 dc.DrawRectangle (0, _out_size.height, _panel_size.width, _panel_size.height - _out_size.height);
 412         }
 413
 414         if (_outline_content && _outline_content->GetValue ()) {
 415                 wxPen p (wxColour (255, 0, 0), 2);
 416                 dc.SetPen (p);
 417                 dc.SetBrush (*wxTRANSPARENT_BRUSH);
 418                 dc.DrawRectangle (_inter_position.x, _inter_position.y, _inter_size.width, _inter_size.height);
 419         }
 420 }
 421
 422 /** @param page true if this was a PAGEUP/PAGEDOWN event for which we won't receive a THUMBRELEASE */
 423 void
 424 FilmViewer::slider_moved (bool page)
 425 {
 426         if (!_film) {
 427                 return;
 428         }
 429
 430         if (!page && !_slider_being_moved) {
 431                 /* This is the first event of a drag; stop playback for the duration of the drag */
 432                 _was_running_before_slider = stop ();
 433                 _slider_being_moved = true;
 434         }
 435
 436         DCPTime t (_slider->GetValue() * _film->length().get() / 4096);
 437         t = t.round (_film->video_frame_rate());
 438         /* Ensure that we hit the end of the film at the end of the slider */
 439         if (t >= _film->length ()) {
 440                 t = _film->length() - one_video_frame();
 441         }
 442         seek (t, false);
 443         update_position_label ();
 444 }
 445
 446 void
 447 FilmViewer::slider_released ()
 448 {
 449         if (_was_running_before_slider) {
 450                 /* Restart after a drag */
 451                 start ();
 452         }
 453         _slider_being_moved = false;
 454 }
 455
 456 void
 457 FilmViewer::panel_sized (wxSizeEvent& ev)
 458 {
 459         _panel_size.width = ev.GetSize().GetWidth();
 460         _panel_size.height = ev.GetSize().GetHeight();
 461
 462         calculate_sizes ();
 463         if (!quick_refresh()) {
 464                 slow_refresh ();
 465         }
 466         update_position_label ();
 467         update_position_slider ();
 468 }
 469
 470 void
 471 FilmViewer::calculate_sizes ()
 472 {
 473         if (!_film || !_player) {
 474                 return;
 475         }
 476
 477         Ratio const * container = _film->container ();
 478
 479         float const panel_ratio = _panel_size.ratio ();
 480         float const film_ratio = container ? container->ratio () : 1.78;
 481
 482         if (panel_ratio < film_ratio) {
 483                 /* panel is less widscreen than the film; clamp width */
 484                 _out_size.width = _panel_size.width;
 485                 _out_size.height = lrintf (_out_size.width / film_ratio);
 486         } else {
 487                 /* panel is more widescreen than the film; clamp height */
 488                 _out_size.height = _panel_size.height;
 489                 _out_size.width = lrintf (_out_size.height * film_ratio);
 490         }
 491
 492         /* Catch silly values */
 493         _out_size.width = max (64, _out_size.width);
 494         _out_size.height = max (64, _out_size.height);
 495
 496         _player->set_video_container_size (_out_size);
 497 }
 498
 499 void
 500 FilmViewer::play_clicked ()
 501 {
 502         check_play_state ();
 503 }
 504
 505 void
 506 FilmViewer::check_play_state ()
 507 {
 508         if (!_film || _film->video_frame_rate() == 0) {
 509                 return;
 510         }
 511
 512         if (_play_button->GetValue()) {
 513                 start ();
 514         } else {
 515                 stop ();
 516         }
 517 }
 518
 519 void
 520 FilmViewer::start ()
 521 {
 522         if (!_film) {
 523                 return;
 524         }
 525
 526         if (_audio.isStreamOpen()) {
 527                 _audio.setStreamTime (_video_position.seconds());
 528                 _audio.startStream ();
 529         }
 530
 531         _playing = true;
 532         _dropped = 0;
 533         timer ();
 534         _play_button->SetValue (true);
 535 }
 536
 537 bool
 538 FilmViewer::stop ()
 539 {
 540         if (_audio.isStreamRunning()) {
 541                 /* stop stream and discard any remaining queued samples */
 542                 _audio.abortStream ();
 543         }
 544
 545         if (!_playing) {
 546                 return false;
 547         }
 548
 549         _playing = false;
 550         _play_button->SetValue (false);
 551         return true;
 552 }
 553
 554 void
 555 FilmViewer::update_position_slider ()
 556 {
 557         if (!_film) {
 558                 _slider->SetValue (0);
 559                 return;
 560         }
 561
 562         DCPTime const len = _film->length ();
 563
 564         if (len.get ()) {
 565                 int const new_slider_position = 4096 * _video_position.get() / len.get();
 566                 if (new_slider_position != _slider->GetValue()) {
 567                         _slider->SetValue (new_slider_position);
 568                 }
 569         }
 570 }
 571
 572 void
 573 FilmViewer::update_position_label ()
 574 {
 575         if (!_film) {
 576                 _frame_number->SetLabel ("0");
 577                 _timecode->SetLabel ("0:0:0.0");
 578                 return;
 579         }
 580
 581         double const fps = _film->video_frame_rate ();
 582         /* Count frame number from 1 ... not sure if this is the best idea */
 583         _frame_number->SetLabel (wxString::Format (wxT("%ld"), lrint (_video_position.seconds() * fps) + 1));
 584         _timecode->SetLabel (time_to_timecode (_video_position, fps));
 585 }
 586
 587 void
 588 FilmViewer::active_jobs_changed (optional<string> j)
 589 {
 590         /* examine content is the only job which stops the viewer working */
 591         bool const a = !j || *j != "examine_content";
 592         _slider->Enable (a);
 593         _play_button->Enable (a);
 594 }
 595
 596 DCPTime
 597 FilmViewer::nudge_amount (wxKeyboardState& ev)
 598 {
 599         DCPTime amount = one_video_frame ();
 600
 601         if (ev.ShiftDown() && !ev.ControlDown()) {
 602                 amount = DCPTime::from_seconds (1);
 603         } else if (!ev.ShiftDown() && ev.ControlDown()) {
 604                 amount = DCPTime::from_seconds (10);
 605         } else if (ev.ShiftDown() && ev.ControlDown()) {
 606                 amount = DCPTime::from_seconds (60);
 607         }
 608
 609         return amount;
 610 }
 611
 612 void
 613 FilmViewer::go_to (DCPTime t)
 614 {
 615         if (t < DCPTime ()) {
 616                 t = DCPTime ();
 617         }
 618
 619         if (t >= _film->length ()) {
 620                 t = _film->length ();
 621         }
 622
 623         seek (t, true);
 624         update_position_label ();
 625         update_position_slider ();
 626 }
 627
 628 void
 629 FilmViewer::rewind_clicked (wxMouseEvent& ev)
 630 {
 631         go_to(DCPTime());
 632         ev.Skip();
 633 }
 634
 635 void
 636 FilmViewer::back_frame ()
 637 {
 638         if (!_film) {
 639                 return;
 640         }
 641
 642         go_to (_video_position - one_video_frame());
 643 }
 644
 645 void
 646 FilmViewer::forward_frame ()
 647 {
 648         if (!_film) {
 649                 return;
 650         }
 651
 652         go_to (_video_position + one_video_frame());
 653 }
 654
 655 void
 656 FilmViewer::back_clicked (wxKeyboardState& ev)
 657 {
 658         go_to (_video_position - nudge_amount (ev));
 659 }
 660
 661 void
 662 FilmViewer::forward_clicked (wxKeyboardState& ev)
 663 {
 664         go_to (_video_position + nudge_amount (ev));
 665 }
 666
 667 void
 668 FilmViewer::player_changed (int property, bool frequent)
 669 {
 670         if (frequent) {
 671                 return;
 672         }
 673
 674         if (_coalesce_player_changes) {
 675                 _pending_player_changes.push_back (property);
 676                 return;
 677         }
 678
 679         calculate_sizes ();
 680         bool refreshed = false;
 681         if (
 682                 property == VideoContentProperty::CROP ||
 683                 property == VideoContentProperty::SCALE ||
 684                 property == VideoContentProperty::FADE_IN ||
 685                 property == VideoContentProperty::FADE_OUT ||
 686                 property == VideoContentProperty::COLOUR_CONVERSION ||
 687                 property == PlayerProperty::VIDEO_CONTAINER_SIZE ||
 688                 property == PlayerProperty::FILM_CONTAINER
 689                 ) {
 690                 refreshed = quick_refresh ();
 691         }
 692
 693         if (!refreshed) {
 694                 slow_refresh ();
 695         }
 696         update_position_label ();
 697         update_position_slider ();
 698 }
 699
 700 void
 701 FilmViewer::setup_sensitivity ()
 702 {
 703         bool const c = _film && !_film->content().empty ();
 704
 705         _slider->Enable (c);
 706         _rewind_button->Enable (c);
 707         _back_button->Enable (c);
 708         _forward_button->Enable (c);
 709         _play_button->Enable (c);
 710         if (_outline_content) {
 711                 _outline_content->Enable (c);
 712         }
 713         _frame_number->Enable (c);
 714         _timecode->Enable (c);
 715         if (_jump_to_selected) {
 716                 _jump_to_selected->Enable (c);
 717         }
 718
 719         _eye->Enable (c && _film->three_d ());
 720 }
 721
 722 void
 723 FilmViewer::film_changed (Film::Property p)
 724 {
 725         if (p == Film::CONTENT || p == Film::THREE_D) {
 726                 setup_sensitivity ();
 727         } else if (p == Film::AUDIO_CHANNELS) {
 728                 recreate_butler ();
 729         }
 730 }
 731
 732 /** Re-get the current frame slowly by seeking */
 733 void
 734 FilmViewer::slow_refresh ()
 735 {
 736         seek (_video_position, true);
 737 }
 738
 739 /** Try to re-get the current frame quickly by resetting the metadata
 740  *  in the PlayerVideo that we used last time.
 741  *  @return true if this was possible, false if not.
 742  */
 743 bool
 744 FilmViewer::quick_refresh ()
 745 {
 746         if (!_player_video.first) {
 747                 return false;
 748         }
 749
 750         if (!_player_video.first->reset_metadata (_player->video_container_size(), _film->frame_size())) {
 751                 return false;
 752         }
 753
 754         display_player_video ();
 755         return true;
 756 }
 757
 758 void
 759 FilmViewer::set_position (DCPTime p)
 760 {
 761         _video_position = p;
 762         seek (p, true);
 763         update_position_label ();
 764         update_position_slider ();
 765 }
 766
 767 void
 768 FilmViewer::set_position (shared_ptr<Content> content, ContentTime t)
 769 {
 770         optional<DCPTime> dt = _player->content_time_to_dcp (content, t);
 771         if (dt) {
 772                 set_position (*dt);
 773         }
 774 }
 775
 776 void
 777 FilmViewer::set_coalesce_player_changes (bool c)
 778 {
 779         _coalesce_player_changes = c;
 780
 781         if (!c) {
 782                 BOOST_FOREACH (int i, _pending_player_changes) {
 783                         player_changed (i, false);
 784                 }
 785                 _pending_player_changes.clear ();
 786         }
 787 }
 788
 789 void
 790 FilmViewer::timecode_clicked ()
 791 {
 792         PlayheadToTimecodeDialog* dialog = new PlayheadToTimecodeDialog (this, _film->video_frame_rate ());
 793         if (dialog->ShowModal() == wxID_OK) {
 794                 go_to (dialog->get ());
 795         }
 796         dialog->Destroy ();
 797 }
 798
 799 void
 800 FilmViewer::frame_number_clicked ()
 801 {
 802         PlayheadToFrameDialog* dialog = new PlayheadToFrameDialog (this, _film->video_frame_rate ());
 803         if (dialog->ShowModal() == wxID_OK) {
 804                 go_to (dialog->get ());
 805         }
 806         dialog->Destroy ();
 807 }
 808
 809 void
 810 FilmViewer::jump_to_selected_clicked ()
 811 {
 812         Config::instance()->set_jump_to_selected (_jump_to_selected->GetValue ());
 813 }
 814
 815 void
 816 FilmViewer::seek (DCPTime t, bool accurate)
 817 {
 818         if (!_butler) {
 819                 return;
 820         }
 821
 822         bool const was_running = stop ();
 823
 824         _closed_captions_dialog->clear ();
 825         _butler->seek (t, accurate);
 826         get ();
 827
 828         if (was_running) {
 829                 start ();
 830         }
 831 }
 832
 833 void
 834 FilmViewer::config_changed (Config::Property p)
 835 {
 836         if (p != Config::SOUND && p != Config::SOUND_OUTPUT) {
 837                 return;
 838         }
 839
 840         if (_audio.isStreamOpen ()) {
 841                 _audio.closeStream ();
 842         }
 843
 844         if (Config::instance()->sound() && _audio.getDeviceCount() > 0) {
 845                 unsigned int st = 0;
 846                 if (Config::instance()->sound_output()) {
 847                         while (st < _audio.getDeviceCount()) {
 848                                 if (_audio.getDeviceInfo(st).name == Config::instance()->sound_output().get()) {
 849                                         break;
 850                                 }
 851                                 ++st;
 852                         }
 853                         if (st == _audio.getDeviceCount()) {
 854                                 st = _audio.getDefaultOutputDevice();
 855                         }
 856                 } else {
 857                         st = _audio.getDefaultOutputDevice();
 858                 }
 859
 860                 _audio_channels = _audio.getDeviceInfo(st).outputChannels;
 861
 862                 RtAudio::StreamParameters sp;
 863                 sp.deviceId = st;
 864                 sp.nChannels = _audio_channels;
 865                 sp.firstChannel = 0;
 866                 try {
 867                         _audio.openStream (&sp, 0, RTAUDIO_FLOAT32, 48000, &_audio_block_size, &rtaudio_callback, this);
 868 #ifdef DCPOMATIC_USE_RTERROR
 869                 } catch (RtError& e) {
 870 #else
 871                 } catch (RtAudioError& e) {
 872 #endif
 873                         error_dialog (
 874                                 this,
 875                                 _("Could not set up audio output.  There will be no audio during the preview."), std_to_wx(e.what())
 876                                 );
 877                 }
 878                 recreate_butler ();
 879
 880         } else {
 881                 _audio_channels = 0;
 882                 recreate_butler ();
 883         }
 884 }
 885
 886 DCPTime
 887 FilmViewer::uncorrected_time () const
 888 {
 889         if (_audio.isStreamRunning ()) {
 890                 return DCPTime::from_seconds (const_cast<RtAudio*>(&_audio)->getStreamTime());
 891         }
 892
 893         return _video_position;
 894 }
 895
 896 DCPTime
 897 FilmViewer::time () const
 898 {
 899         if (_audio.isStreamRunning ()) {
 900                 return DCPTime::from_seconds (const_cast<RtAudio*>(&_audio)->getStreamTime ()) -
 901                         DCPTime::from_frames (average_latency(), _film->audio_frame_rate());
 902         }
 903
 904         return _video_position;
 905 }
 906
 907 int
 908 FilmViewer::audio_callback (void* out_p, unsigned int frames)
 909 {
 910         while (true) {
 911                 optional<DCPTime> t = _butler->get_audio (reinterpret_cast<float*> (out_p), frames);
 912                 if (!t || DCPTime(uncorrected_time() - *t) < one_video_frame()) {
 913                         /* There was an underrun or this audio is on time; carry on */
 914                         break;
 915                 }
 916                 /* The audio we just got was (very) late; drop it and get some more. */
 917         }
 918
 919         boost::mutex::scoped_lock lm (_latency_history_mutex, boost::try_to_lock);
 920         if (lm) {
 921                 _latency_history.push_back (_audio.getStreamLatency ());
 922                 if (_latency_history.size() > static_cast<size_t> (_latency_history_count)) {
 923                         _latency_history.pop_front ();
 924                 }
 925         }
 926
 927         return 0;
 928 }
 929
 930 Frame
 931 FilmViewer::average_latency () const
 932 {
 933         boost::mutex::scoped_lock lm (_latency_history_mutex);
 934         if (_latency_history.empty()) {
 935                 return 0;
 936         }
 937
 938         Frame total = 0;
 939         BOOST_FOREACH (Frame i, _latency_history) {
 940                 total += i;
 941         }
 942
 943         return total / _latency_history.size();
 944 }
 945
 946 void
 947 FilmViewer::set_dcp_decode_reduction (optional<int> reduction)
 948 {
 949         _dcp_decode_reduction = reduction;
 950         if (_player) {
 951                 _player->set_dcp_decode_reduction (reduction);
 952         }
 953 }
 954
 955 optional<int>
 956 FilmViewer::dcp_decode_reduction () const
 957 {
 958         return _dcp_decode_reduction;
 959 }
 960
 961 DCPTime
 962 FilmViewer::one_video_frame () const
 963 {
 964         return DCPTime::from_frames (1, _film->video_frame_rate());
 965 }
 966
 967 void
 968 FilmViewer::show_closed_captions ()
 969 {
 970         _closed_captions_dialog->Show();
 971 }