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