src/wx/film_viewer.cc

   1 /*
   2     Copyright (C) 2012-2019 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 "gl_video_view.h"
  31 #include "simple_video_view.h"
  32 #include "lib/film.h"
  33 #include "lib/ratio.h"
  34 #include "lib/util.h"
  35 #include "lib/job_manager.h"
  36 #include "lib/image.h"
  37 #include "lib/exceptions.h"
  38 #include "lib/examine_content_job.h"
  39 #include "lib/filter.h"
  40 #include "lib/player.h"
  41 #include "lib/player_video.h"
  42 #include "lib/video_content.h"
  43 #include "lib/video_decoder.h"
  44 #include "lib/timer.h"
  45 #include "lib/butler.h"
  46 #include "lib/log.h"
  47 #include "lib/config.h"
  48 #include "lib/compose.hpp"
  49 #include "lib/dcpomatic_log.h"
  50 extern "C" {
  51 #include <libavutil/pixfmt.h>
  52 }
  53 #include <dcp/exceptions.h>
  54 #include <wx/tglbtn.h>
  55 #include <iostream>
  56 #include <iomanip>
  57
  58 using std::string;
  59 using std::pair;
  60 using std::min;
  61 using std::max;
  62 using std::cout;
  63 using std::list;
  64 using std::bad_alloc;
  65 using std::make_pair;
  66 using std::exception;
  67 using boost::shared_ptr;
  68 using boost::dynamic_pointer_cast;
  69 using boost::weak_ptr;
  70 using boost::optional;
  71 using dcp::Size;
  72 using namespace dcpomatic;
  73
  74 static
  75 int
  76 rtaudio_callback (void* out, void *, unsigned int frames, double, RtAudioStreamStatus, void* data)
  77 {
  78         return reinterpret_cast<FilmViewer*>(data)->audio_callback (out, frames);
  79 }
  80
  81 FilmViewer::FilmViewer (wxWindow* p)
  82         : _coalesce_player_changes (false)
  83         , _audio (DCPOMATIC_RTAUDIO_API)
  84         , _audio_channels (0)
  85         , _audio_block_size (1024)
  86         , _playing (false)
  87         , _latency_history_count (0)
  88         , _dropped (0)
  89         , _closed_captions_dialog (new ClosedCaptionsDialog(p, this))
  90         , _outline_content (false)
  91         , _eyes (EYES_LEFT)
  92         , _pad_black (false)
  93 #ifdef DCPOMATIC_VARIANT_SWAROOP
  94         , _background_image (false)
  95 #endif
  96         , _state_timer ("viewer")
  97         , _gets (0)
  98 {
  99         switch (Config::instance()->video_view_type()) {
 100         case Config::VIDEO_VIEW_OPENGL:
 101                 _video_view = new GLVideoView (this, p);
 102                 break;
 103         case Config::VIDEO_VIEW_SIMPLE:
 104                 _video_view = new SimpleVideoView (this, p);
 105                 break;
 106         }
 107
 108         _video_view->Sized.connect (boost::bind(&FilmViewer::video_view_sized, this));
 109         _timer.Bind (wxEVT_TIMER, boost::bind(&FilmViewer::timer, this));
 110
 111         set_film (shared_ptr<Film> ());
 112
 113         _config_changed_connection = Config::instance()->Changed.connect (bind (&FilmViewer::config_changed, this, _1));
 114         config_changed (Config::SOUND_OUTPUT);
 115 }
 116
 117 FilmViewer::~FilmViewer ()
 118 {
 119         stop ();
 120 }
 121
 122 void
 123 FilmViewer::set_film (shared_ptr<Film> film)
 124 {
 125         if (_film == film) {
 126                 return;
 127         }
 128
 129         _film = film;
 130         _video_position = DCPTime ();
 131         _player_video.first.reset ();
 132         _player_video.second = DCPTime ();
 133
 134         _video_view->set_image (shared_ptr<Image>());
 135         _closed_captions_dialog->clear ();
 136
 137         if (!_film) {
 138                 _player.reset ();
 139                 recreate_butler ();
 140                 refresh_view ();
 141                 return;
 142         }
 143
 144         try {
 145                 _player.reset (new Player (_film, _film->playlist ()));
 146                 _player->set_fast ();
 147                 if (_dcp_decode_reduction) {
 148                         _player->set_dcp_decode_reduction (_dcp_decode_reduction);
 149                 }
 150         } catch (bad_alloc &) {
 151                 error_dialog (_video_view->get(), _("There is not enough free memory to do that."));
 152                 _film.reset ();
 153                 return;
 154         }
 155
 156         _player->set_always_burn_open_subtitles ();
 157         _player->set_play_referenced ();
 158
 159         _film->Change.connect (boost::bind (&FilmViewer::film_change, this, _1, _2));
 160         _player->Change.connect (boost::bind (&FilmViewer::player_change, this, _1, _2, _3));
 161
 162         /* Keep about 1 second's worth of history samples */
 163         _latency_history_count = _film->audio_frame_rate() / _audio_block_size;
 164
 165         recreate_butler ();
 166
 167         calculate_sizes ();
 168         slow_refresh ();
 169 }
 170
 171 void
 172 FilmViewer::recreate_butler ()
 173 {
 174         bool const was_running = stop ();
 175         _butler.reset ();
 176
 177         if (!_film) {
 178                 return;
 179         }
 180
 181         AudioMapping map = AudioMapping (_film->audio_channels(), _audio_channels);
 182
 183         if (_audio_channels != 2 || _film->audio_channels() < 3) {
 184                 for (int i = 0; i < min (_film->audio_channels(), _audio_channels); ++i) {
 185                         map.set (i, i, 1);
 186                 }
 187         } else {
 188                 /* Special case: stereo output, at least 3 channel input.
 189                    Map so that Lt = L(-3dB) + Ls(-3dB) + C(-6dB) + Lfe(-10dB)
 190                                Rt = R(-3dB) + Rs(-3dB) + C(-6dB) + Lfe(-10dB)
 191                 */
 192                 map.set (dcp::LEFT,   0, 1 / sqrt(2)); // L -> Lt
 193                 map.set (dcp::RIGHT,  1, 1 / sqrt(2)); // R -> Rt
 194                 map.set (dcp::CENTRE, 0, 1 / 2.0); // C -> Lt
 195                 map.set (dcp::CENTRE, 1, 1 / 2.0); // C -> Rt
 196                 map.set (dcp::LFE,    0, 1 / sqrt(10)); // Lfe -> Lt
 197                 map.set (dcp::LFE,    1, 1 / sqrt(10)); // Lfe -> Rt
 198                 map.set (dcp::LS,     0, 1 / sqrt(2)); // Ls -> Lt
 199                 map.set (dcp::RS,     1, 1 / sqrt(2)); // Rs -> Rt
 200         }
 201
 202         _butler.reset (new Butler(_player, map, _audio_channels, bind(&PlayerVideo::force, _1, AV_PIX_FMT_RGB24), false, true));
 203         if (!Config::instance()->sound() && !_audio.isStreamOpen()) {
 204                 _butler->disable_audio ();
 205         }
 206
 207         _closed_captions_dialog->set_film_and_butler (_film, _butler);
 208
 209         if (was_running) {
 210                 start ();
 211         }
 212 }
 213
 214 void
 215 FilmViewer::refresh_view ()
 216 {
 217         _state_timer.set ("update-view");
 218         _video_view->update ();
 219         _state_timer.unset ();
 220 }
 221
 222 void
 223 FilmViewer::get ()
 224 {
 225         DCPOMATIC_ASSERT (_butler);
 226         ++_gets;
 227
 228         do {
 229                 Butler::Error e;
 230                 _player_video = _butler->get_video (&e);
 231                 if (!_player_video.first && e == Butler::AGAIN) {
 232                         signal_manager->when_idle (boost::bind(&FilmViewer::get, this));
 233                         return;
 234                 }
 235         } while (
 236                 _player_video.first &&
 237                 _film->three_d() &&
 238                 _eyes != _player_video.first->eyes() &&
 239                 _player_video.first->eyes() != EYES_BOTH
 240                 );
 241
 242         _butler->rethrow ();
 243
 244         display_player_video ();
 245 }
 246
 247 void
 248 FilmViewer::display_player_video ()
 249 {
 250         if (!_player_video.first) {
 251                 _video_view->set_image (shared_ptr<Image>());
 252                 refresh_view ();
 253                 return;
 254         }
 255
 256         if (_playing && (time() - _player_video.second) > one_video_frame()) {
 257                 /* Too late; just drop this frame before we try to get its image (which will be the time-consuming
 258                    part if this frame is J2K).
 259                 */
 260                 _video_position = _player_video.second;
 261                 ++_dropped;
 262                 return;
 263         }
 264
 265         /* In an ideal world, what we would do here is:
 266          *
 267          * 1. convert to XYZ exactly as we do in the DCP creation path.
 268          * 2. convert back to RGB for the preview display, compensating
 269          *    for the monitor etc. etc.
 270          *
 271          * but this is inefficient if the source is RGB.  Since we don't
 272          * (currently) care too much about the precise accuracy of the preview's
 273          * colour mapping (and we care more about its speed) we try to short-
 274          * circuit this "ideal" situation in some cases.
 275          *
 276          * The content's specified colour conversion indicates the colourspace
 277          * which the content is in (according to the user).
 278          *
 279          * PlayerVideo::image (bound to PlayerVideo::force) will take the source
 280          * image and convert it (from whatever the user has said it is) to RGB.
 281          */
 282
 283         _state_timer.set ("get image");
 284
 285         _video_view->set_image (
 286                 _player_video.first->image(bind(&PlayerVideo::force, _1, AV_PIX_FMT_RGB24), false, true)
 287                 );
 288
 289         _state_timer.set ("ImageChanged");
 290         ImageChanged (_player_video.first);
 291         _state_timer.unset ();
 292
 293         _video_position = _player_video.second;
 294         _inter_position = _player_video.first->inter_position ();
 295         _inter_size = _player_video.first->inter_size ();
 296
 297         refresh_view ();
 298
 299         _closed_captions_dialog->update (time());
 300 }
 301
 302 void
 303 FilmViewer::timer ()
 304 {
 305         if (!_film || !_playing) {
 306                 return;
 307         }
 308
 309         get ();
 310         PositionChanged ();
 311         DCPTime const next = _video_position + one_video_frame();
 312
 313         if (next >= _film->length()) {
 314                 stop ();
 315                 Finished ();
 316                 return;
 317         }
 318
 319         LOG_DEBUG_PLAYER("%1 -> %2; delay %3", next.seconds(), time().seconds(), max((next.seconds() - time().seconds()) * 1000, 1.0));
 320         _timer.Start (max ((next.seconds() - time().seconds()) * 1000, 1.0), wxTIMER_ONE_SHOT);
 321
 322         if (_butler) {
 323                 _butler->rethrow ();
 324         }
 325 }
 326
 327 void
 328 FilmViewer::set_outline_content (bool o)
 329 {
 330         _outline_content = o;
 331         refresh_view ();
 332 }
 333
 334 void
 335 FilmViewer::set_eyes (Eyes e)
 336 {
 337         _eyes = e;
 338         slow_refresh ();
 339 }
 340
 341 void
 342 FilmViewer::video_view_sized ()
 343 {
 344         calculate_sizes ();
 345         if (!quick_refresh()) {
 346                 slow_refresh ();
 347         }
 348         PositionChanged ();
 349 }
 350
 351 void
 352 FilmViewer::calculate_sizes ()
 353 {
 354         if (!_film || !_player) {
 355                 return;
 356         }
 357
 358         Ratio const * container = _film->container ();
 359
 360         float const view_ratio = float(_video_view->get()->GetSize().x) / _video_view->get()->GetSize().y;
 361         float const film_ratio = container ? container->ratio () : 1.78;
 362
 363         if (view_ratio < film_ratio) {
 364                 /* panel is less widscreen than the film; clamp width */
 365                 _out_size.width = _video_view->get()->GetSize().x;
 366                 _out_size.height = lrintf (_out_size.width / film_ratio);
 367         } else {
 368                 /* panel is more widescreen than the film; clamp height */
 369                 _out_size.height = _video_view->get()->GetSize().y;
 370                 _out_size.width = lrintf (_out_size.height * film_ratio);
 371         }
 372
 373         /* Catch silly values */
 374         _out_size.width = max (64, _out_size.width);
 375         _out_size.height = max (64, _out_size.height);
 376
 377         _player->set_video_container_size (_out_size);
 378 }
 379
 380 void
 381 FilmViewer::start ()
 382 {
 383         if (!_film) {
 384                 return;
 385         }
 386
 387         optional<bool> v = PlaybackPermitted ();
 388         if (v && !*v) {
 389                 /* Computer says no */
 390                 return;
 391         }
 392
 393         if (_audio.isStreamOpen()) {
 394                 _audio.setStreamTime (_video_position.seconds());
 395                 _audio.startStream ();
 396         }
 397
 398         _playing = true;
 399         _dropped = 0;
 400         timer ();
 401         Started (position());
 402 }
 403
 404 bool
 405 FilmViewer::stop ()
 406 {
 407         if (_audio.isStreamRunning()) {
 408                 /* stop stream and discard any remaining queued samples */
 409                 _audio.abortStream ();
 410         }
 411
 412         if (!_playing) {
 413                 return false;
 414         }
 415
 416         _playing = false;
 417         Stopped (position());
 418         return true;
 419 }
 420
 421 void
 422 FilmViewer::player_change (ChangeType type, int property, bool frequent)
 423 {
 424         if (type != CHANGE_TYPE_DONE || frequent) {
 425                 return;
 426         }
 427
 428         if (_coalesce_player_changes) {
 429                 _pending_player_changes.push_back (property);
 430                 return;
 431         }
 432
 433         calculate_sizes ();
 434         bool refreshed = false;
 435         if (
 436                 property == VideoContentProperty::CROP ||
 437                 property == VideoContentProperty::SCALE ||
 438                 property == VideoContentProperty::FADE_IN ||
 439                 property == VideoContentProperty::FADE_OUT ||
 440                 property == VideoContentProperty::COLOUR_CONVERSION ||
 441                 property == PlayerProperty::VIDEO_CONTAINER_SIZE ||
 442                 property == PlayerProperty::FILM_CONTAINER
 443                 ) {
 444                 refreshed = quick_refresh ();
 445         }
 446
 447         if (!refreshed) {
 448                 slow_refresh ();
 449         }
 450         PositionChanged ();
 451 }
 452
 453 void
 454 FilmViewer::film_change (ChangeType type, Film::Property p)
 455 {
 456         if (type == CHANGE_TYPE_DONE && p == Film::AUDIO_CHANNELS) {
 457                 recreate_butler ();
 458         }
 459 }
 460
 461 /** Re-get the current frame slowly by seeking */
 462 void
 463 FilmViewer::slow_refresh ()
 464 {
 465         seek (_video_position, true);
 466 }
 467
 468 /** Try to re-get the current frame quickly by resetting the metadata
 469  *  in the PlayerVideo that we used last time.
 470  *  @return true if this was possible, false if not.
 471  */
 472 bool
 473 FilmViewer::quick_refresh ()
 474 {
 475         if (!_player_video.first) {
 476                 return false;
 477         }
 478
 479         if (!_player_video.first->reset_metadata (_film, _player->video_container_size(), _film->frame_size())) {
 480                 return false;
 481         }
 482
 483         display_player_video ();
 484         return true;
 485 }
 486
 487 void
 488 FilmViewer::seek (shared_ptr<Content> content, ContentTime t, bool accurate)
 489 {
 490         optional<DCPTime> dt = _player->content_time_to_dcp (content, t);
 491         if (dt) {
 492                 seek (*dt, accurate);
 493         }
 494 }
 495
 496 void
 497 FilmViewer::set_coalesce_player_changes (bool c)
 498 {
 499         _coalesce_player_changes = c;
 500
 501         if (!c) {
 502                 BOOST_FOREACH (int i, _pending_player_changes) {
 503                         player_change (CHANGE_TYPE_DONE, i, false);
 504                 }
 505                 _pending_player_changes.clear ();
 506         }
 507 }
 508
 509 void
 510 FilmViewer::seek (DCPTime t, bool accurate)
 511 {
 512         if (!_butler) {
 513                 return;
 514         }
 515
 516         if (t < DCPTime ()) {
 517                 t = DCPTime ();
 518         }
 519
 520         if (t >= _film->length ()) {
 521                 t = _film->length ();
 522         }
 523
 524         bool const was_running = stop ();
 525
 526         _closed_captions_dialog->clear ();
 527         _butler->seek (t, accurate);
 528         get ();
 529
 530         if (was_running) {
 531                 start ();
 532         }
 533
 534         PositionChanged ();
 535 }
 536
 537 void
 538 FilmViewer::config_changed (Config::Property p)
 539 {
 540 #ifdef DCPOMATIC_VARIANT_SWAROOP
 541         if (p == Config::PLAYER_BACKGROUND_IMAGE) {
 542                 refresh_view ();
 543                 return;
 544         }
 545 #endif
 546
 547         if (p != Config::SOUND && p != Config::SOUND_OUTPUT) {
 548                 return;
 549         }
 550
 551         if (_audio.isStreamOpen ()) {
 552                 _audio.closeStream ();
 553         }
 554
 555         if (Config::instance()->sound() && _audio.getDeviceCount() > 0) {
 556                 unsigned int st = 0;
 557                 if (Config::instance()->sound_output()) {
 558                         while (st < _audio.getDeviceCount()) {
 559                                 if (_audio.getDeviceInfo(st).name == Config::instance()->sound_output().get()) {
 560                                         break;
 561                                 }
 562                                 ++st;
 563                         }
 564                         if (st == _audio.getDeviceCount()) {
 565                                 st = _audio.getDefaultOutputDevice();
 566                         }
 567                 } else {
 568                         st = _audio.getDefaultOutputDevice();
 569                 }
 570
 571                 _audio_channels = _audio.getDeviceInfo(st).outputChannels;
 572
 573                 RtAudio::StreamParameters sp;
 574                 sp.deviceId = st;
 575                 sp.nChannels = _audio_channels;
 576                 sp.firstChannel = 0;
 577                 try {
 578                         _audio.openStream (&sp, 0, RTAUDIO_FLOAT32, 48000, &_audio_block_size, &rtaudio_callback, this);
 579 #ifdef DCPOMATIC_USE_RTERROR
 580                 } catch (RtError& e) {
 581 #else
 582                 } catch (RtAudioError& e) {
 583 #endif
 584                         error_dialog (
 585                                 _video_view->get(),
 586                                 _("Could not set up audio output.  There will be no audio during the preview."), std_to_wx(e.what())
 587                                 );
 588                 }
 589                 recreate_butler ();
 590
 591         } else {
 592                 _audio_channels = 0;
 593                 recreate_butler ();
 594         }
 595 }
 596
 597 DCPTime
 598 FilmViewer::uncorrected_time () const
 599 {
 600         if (_audio.isStreamRunning ()) {
 601                 return DCPTime::from_seconds (const_cast<RtAudio*>(&_audio)->getStreamTime());
 602         }
 603
 604         return _video_position;
 605 }
 606
 607 DCPTime
 608 FilmViewer::time () const
 609 {
 610         if (_audio.isStreamRunning ()) {
 611                 return DCPTime::from_seconds (const_cast<RtAudio*>(&_audio)->getStreamTime ()) -
 612                         DCPTime::from_frames (average_latency(), _film->audio_frame_rate());
 613         }
 614
 615         return _video_position;
 616 }
 617
 618 int
 619 FilmViewer::audio_callback (void* out_p, unsigned int frames)
 620 {
 621         while (true) {
 622                 optional<DCPTime> t = _butler->get_audio (reinterpret_cast<float*> (out_p), frames);
 623                 if (!t || DCPTime(uncorrected_time() - *t) < one_video_frame()) {
 624                         /* There was an underrun or this audio is on time; carry on */
 625                         break;
 626                 }
 627                 /* The audio we just got was (very) late; drop it and get some more. */
 628         }
 629
 630         boost::mutex::scoped_lock lm (_latency_history_mutex, boost::try_to_lock);
 631         if (lm) {
 632                 _latency_history.push_back (_audio.getStreamLatency ());
 633                 if (_latency_history.size() > static_cast<size_t> (_latency_history_count)) {
 634                         _latency_history.pop_front ();
 635                 }
 636         }
 637
 638         return 0;
 639 }
 640
 641 Frame
 642 FilmViewer::average_latency () const
 643 {
 644         boost::mutex::scoped_lock lm (_latency_history_mutex);
 645         if (_latency_history.empty()) {
 646                 return 0;
 647         }
 648
 649         Frame total = 0;
 650         BOOST_FOREACH (Frame i, _latency_history) {
 651                 total += i;
 652         }
 653
 654         return total / _latency_history.size();
 655 }
 656
 657 void
 658 FilmViewer::set_dcp_decode_reduction (optional<int> reduction)
 659 {
 660         _dcp_decode_reduction = reduction;
 661         if (_player) {
 662                 _player->set_dcp_decode_reduction (reduction);
 663         }
 664 }
 665
 666 optional<int>
 667 FilmViewer::dcp_decode_reduction () const
 668 {
 669         return _dcp_decode_reduction;
 670 }
 671
 672 DCPTime
 673 FilmViewer::one_video_frame () const
 674 {
 675         return DCPTime::from_frames (1, _film->video_frame_rate());
 676 }
 677
 678 /** Open a dialog box showing our film's closed captions */
 679 void
 680 FilmViewer::show_closed_captions ()
 681 {
 682         _closed_captions_dialog->Show();
 683 }
 684
 685 void
 686 FilmViewer::seek_by (DCPTime by, bool accurate)
 687 {
 688         seek (_video_position + by, accurate);
 689 }
 690
 691 void
 692 FilmViewer::set_pad_black (bool p)
 693 {
 694         _pad_black = p;
 695 }