Fix macOS build.
[dcpomatic.git] / src / wx / film_viewer.cc
index b9e9bd5331ae07c9b2959446a5a50a8ae9b69e4c..0e6e908b3245c88fb8e9851e4e898a452c8d64bb 100644 (file)
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2012-2019 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2012-2021 Carl Hetherington <cth@carlh.net>
 
     This file is part of DCP-o-matic.
 
 
 */
 
+
 /** @file  src/film_viewer.cc
  *  @brief A wx widget to view a preview of a Film.
  */
 
-#include "film_viewer.h"
-#include "playhead_to_timecode_dialog.h"
-#include "playhead_to_frame_dialog.h"
-#include "wx_util.h"
+
 #include "closed_captions_dialog.h"
+#include "film_viewer.h"
 #include "gl_video_view.h"
+#include "nag_dialog.h"
+#include "playhead_to_frame_dialog.h"
+#include "playhead_to_timecode_dialog.h"
 #include "simple_video_view.h"
-#include "lib/film.h"
-#include "lib/ratio.h"
-#include "lib/util.h"
-#include "lib/job_manager.h"
-#include "lib/image.h"
-#include "lib/exceptions.h"
+#include "wx_util.h"
+#include "lib/butler.h"
+#include "lib/compose.hpp"
+#include "lib/config.h"
+#include "lib/dcpomatic_log.h"
 #include "lib/examine_content_job.h"
+#include "lib/exceptions.h"
+#include "lib/film.h"
 #include "lib/filter.h"
+#include "lib/image.h"
+#include "lib/job_manager.h"
+#include "lib/log.h"
 #include "lib/player.h"
 #include "lib/player_video.h"
+#include "lib/ratio.h"
+#include "lib/text_content.h"
+#include "lib/timer.h"
+#include "lib/util.h"
 #include "lib/video_content.h"
 #include "lib/video_decoder.h"
-#include "lib/timer.h"
-#include "lib/butler.h"
-#include "lib/log.h"
-#include "lib/config.h"
-#include "lib/compose.hpp"
-#include "lib/dcpomatic_log.h"
-#include "lib/text_content.h"
+#include <dcp/exceptions.h>
+#include <dcp/warnings.h>
 extern "C" {
 #include <libavutil/pixfmt.h>
 }
-#include <dcp/exceptions.h>
+LIBDCP_DISABLE_WARNINGS
 #include <wx/tglbtn.h>
-#include <iostream>
+LIBDCP_ENABLE_WARNINGS
 #include <iomanip>
 
-using std::string;
-using std::pair;
-using std::min;
-using std::max;
-using std::cout;
-using std::list;
+
 using std::bad_alloc;
-using std::make_pair;
-using std::exception;
-using std::shared_ptr;
 using std::dynamic_pointer_cast;
+using std::make_shared;
+using std::max;
+using std::shared_ptr;
+using std::string;
 using std::vector;
-using std::weak_ptr;
 using boost::optional;
 #if BOOST_VERSION >= 106100
 using namespace boost::placeholders;
@@ -76,6 +76,7 @@ using namespace boost::placeholders;
 using dcp::Size;
 using namespace dcpomatic;
 
+
 static
 int
 rtaudio_callback (void* out, void *, unsigned int frames, double, RtAudioStreamStatus, void* data)
@@ -83,42 +84,41 @@ rtaudio_callback (void* out, void *, unsigned int frames, double, RtAudioStreamS
        return reinterpret_cast<FilmViewer*>(data)->audio_callback (out, frames);
 }
 
+
 FilmViewer::FilmViewer (wxWindow* p)
-       : _coalesce_player_changes (false)
-       , _audio (DCPOMATIC_RTAUDIO_API)
-       , _audio_channels (0)
-       , _audio_block_size (1024)
-       , _playing (false)
-       , _suspended (0)
-       , _latency_history_count (0)
+       : _audio (DCPOMATIC_RTAUDIO_API)
        , _closed_captions_dialog (new ClosedCaptionsDialog(p, this))
-       , _outline_content (false)
-       , _pad_black (false)
-       , _idle_get (false)
 {
+#if wxCHECK_VERSION(3, 1, 0)
        switch (Config::instance()->video_view_type()) {
        case Config::VIDEO_VIEW_OPENGL:
-               _video_view = new GLVideoView (this, p);
+               _video_view = std::make_shared<GLVideoView>(this, p);
                break;
        case Config::VIDEO_VIEW_SIMPLE:
-               _video_view = new SimpleVideoView (this, p);
+               _video_view = std::make_shared<SimpleVideoView>(this, p);
                break;
        }
+#else
+       _video_view = std::make_shared<SimpleVideoView>(this, p);
+#endif
 
        _video_view->Sized.connect (boost::bind(&FilmViewer::video_view_sized, this));
+       _video_view->TooManyDropped.connect (boost::bind(boost::ref(TooManyDropped)));
 
-       set_film (shared_ptr<Film> ());
+       set_film (shared_ptr<Film>());
 
-       _config_changed_connection = Config::instance()->Changed.connect (bind (&FilmViewer::config_changed, this, _1));
+       _config_changed_connection = Config::instance()->Changed.connect(bind(&FilmViewer::config_changed, this, _1));
        config_changed (Config::SOUND_OUTPUT);
 }
 
+
 FilmViewer::~FilmViewer ()
 {
        stop ();
 }
 
-/** Ask for ::get() to be called next time we are idle */
+
+/** Ask for ::idle_handler() to be called next time we are idle */
 void
 FilmViewer::request_idle_display_next_frame ()
 {
@@ -131,6 +131,7 @@ FilmViewer::request_idle_display_next_frame ()
        signal_manager->when_idle (boost::bind(&FilmViewer::idle_handler, this));
 }
 
+
 void
 FilmViewer::idle_handler ()
 {
@@ -146,6 +147,7 @@ FilmViewer::idle_handler ()
        }
 }
 
+
 void
 FilmViewer::set_film (shared_ptr<Film> film)
 {
@@ -166,7 +168,7 @@ FilmViewer::set_film (shared_ptr<Film> film)
        }
 
        try {
-               _player.reset (new Player(_film));
+               _player = make_shared<Player>(_film, _optimise_for_j2k ? Image::Alignment::COMPACT : Image::Alignment::PADDED);
                _player->set_fast ();
                if (_dcp_decode_reduction) {
                        _player->set_dcp_decode_reduction (_dcp_decode_reduction);
@@ -199,6 +201,7 @@ FilmViewer::set_film (shared_ptr<Film> film)
        slow_refresh ();
 }
 
+
 void
 FilmViewer::recreate_butler ()
 {
@@ -210,17 +213,22 @@ FilmViewer::recreate_butler ()
                return;
        }
 
-       _butler.reset(
-               new Butler(
-                       _film,
-                       _player,
-                       Config::instance()->audio_mapping(_audio_channels),
-                       _audio_channels,
-                       bind(&PlayerVideo::force, _1, AV_PIX_FMT_RGB24),
-                       VideoRange::FULL,
-                       false,
-                       true
-                       )
+#if wxCHECK_VERSION(3, 1, 0)
+       auto const j2k_gl_optimised = dynamic_pointer_cast<GLVideoView>(_video_view) && _optimise_for_j2k;
+#else
+       auto const j2k_gl_optimised = false;
+#endif
+
+       _butler = std::make_shared<Butler>(
+               _film,
+               _player,
+               Config::instance()->audio_mapping(_audio_channels),
+               _audio_channels,
+               boost::bind(&PlayerVideo::force, AV_PIX_FMT_RGB24),
+               VideoRange::FULL,
+               j2k_gl_optimised ? Image::Alignment::COMPACT : Image::Alignment::PADDED,
+               true,
+               j2k_gl_optimised
                );
 
        if (!Config::instance()->sound() && !_audio.isStreamOpen()) {
@@ -232,6 +240,7 @@ FilmViewer::recreate_butler ()
        resume ();
 }
 
+
 void
 FilmViewer::set_outline_content (bool o)
 {
@@ -241,7 +250,7 @@ FilmViewer::set_outline_content (bool o)
 
 
 void
-FilmViewer::set_outline_subtitles (optional<dcpomatic::Rect<double> > rect)
+FilmViewer::set_outline_subtitles (optional<dcpomatic::Rect<double>> rect)
 {
        _outline_subtitles = rect;
        _video_view->update ();
@@ -255,6 +264,7 @@ FilmViewer::set_eyes (Eyes e)
        slow_refresh ();
 }
 
+
 void
 FilmViewer::video_view_sized ()
 {
@@ -264,6 +274,7 @@ FilmViewer::video_view_sized ()
        }
 }
 
+
 void
 FilmViewer::calculate_sizes ()
 {
@@ -271,28 +282,34 @@ FilmViewer::calculate_sizes ()
                return;
        }
 
-       Ratio const * container = _film->container ();
+       auto const container = _film->container ();
 
-       float const view_ratio = float(_video_view->get()->GetSize().x) / _video_view->get()->GetSize().y;
-       float const film_ratio = container ? container->ratio () : 1.78;
+       auto const scale = dpi_scale_factor (_video_view->get());
+       int const video_view_width = std::round(_video_view->get()->GetSize().x * scale);
+       int const video_view_height = std::round(_video_view->get()->GetSize().y * scale);
 
+       auto const view_ratio = float(video_view_width) / video_view_height;
+       auto const film_ratio = container ? container->ratio () : 1.78;
+
+       dcp::Size out_size;
        if (view_ratio < film_ratio) {
                /* panel is less widscreen than the film; clamp width */
-               _out_size.width = _video_view->get()->GetSize().x;
-               _out_size.height = lrintf (_out_size.width / film_ratio);
+               out_size.width = video_view_width;
+               out_size.height = lrintf (out_size.width / film_ratio);
        } else {
                /* panel is more widescreen than the film; clamp height */
-               _out_size.height = _video_view->get()->GetSize().y;
-               _out_size.width = lrintf (_out_size.height * film_ratio);
+               out_size.height = video_view_height;
+               out_size.width = lrintf (out_size.height * film_ratio);
        }
 
        /* Catch silly values */
-       _out_size.width = max (64, _out_size.width);
-       _out_size.height = max (64, _out_size.height);
+       out_size.width = max (64, out_size.width);
+       out_size.height = max (64, out_size.height);
 
-       _player->set_video_container_size (_out_size);
+       _player->set_video_container_size (out_size);
 }
 
+
 void
 FilmViewer::suspend ()
 {
@@ -302,20 +319,37 @@ FilmViewer::suspend ()
        }
 }
 
+
+void
+FilmViewer::start_audio_stream_if_open ()
+{
+       if (_audio.isStreamOpen()) {
+               _audio.setStreamTime (_video_view->position().seconds());
+               try {
+                       _audio.startStream ();
+               } catch (RtAudioError& e) {
+                       _audio_channels = 0;
+                       error_dialog (
+                               _video_view->get(),
+                               _("There was a problem starting audio playback.  Please try another audio output device in Preferences."), std_to_wx(e.what())
+                               );
+               }
+       }
+}
+
+
 void
 FilmViewer::resume ()
 {
        DCPOMATIC_ASSERT (_suspended > 0);
        --_suspended;
        if (_playing && !_suspended) {
-               if (_audio.isStreamOpen()) {
-                       _audio.setStreamTime (_video_view->position().seconds());
-                       _audio.startStream ();
-               }
+               start_audio_stream_if_open ();
                _video_view->start ();
        }
 }
 
+
 void
 FilmViewer::start ()
 {
@@ -323,7 +357,7 @@ FilmViewer::start ()
                return;
        }
 
-       optional<bool> v = PlaybackPermitted ();
+       auto v = PlaybackPermitted ();
        if (v && !*v) {
                /* Computer says no */
                return;
@@ -340,19 +374,17 @@ FilmViewer::start ()
        /* Take the video view's idea of position as our `playhead' and start the
           audio stream (which is the timing reference) there.
          */
-       if (_audio.isStreamOpen()) {
-               _audio.setStreamTime (_video_view->position().seconds());
-               _audio.startStream ();
-       }
+       start_audio_stream_if_open ();
 
        _playing = true;
        /* Calling start() below may directly result in Stopped being emitted, and if that
         * happens we want it to come after the Started signal, so do that first.
         */
-       Started (position());
+       Started ();
        _video_view->start ();
 }
 
+
 bool
 FilmViewer::stop ()
 {
@@ -367,12 +399,13 @@ FilmViewer::stop ()
 
        _playing = false;
        _video_view->stop ();
-       Stopped (position());
+       Stopped ();
 
        _video_view->rethrow ();
        return true;
 }
 
+
 void
 FilmViewer::player_change (ChangeType type, int property, bool frequent)
 {
@@ -388,6 +421,7 @@ FilmViewer::player_change (ChangeType type, int property, bool frequent)
        player_change ({property});
 }
 
+
 void
 FilmViewer::player_change (vector<int> properties)
 {
@@ -399,7 +433,8 @@ FilmViewer::player_change (vector<int> properties)
        for (auto i: properties) {
                if (
                        i == VideoContentProperty::CROP ||
-                       i == VideoContentProperty::SCALE ||
+                       i == VideoContentProperty::CUSTOM_RATIO ||
+                       i == VideoContentProperty::CUSTOM_SIZE ||
                        i == VideoContentProperty::FADE_IN ||
                        i == VideoContentProperty::FADE_OUT ||
                        i == VideoContentProperty::COLOUR_CONVERSION ||
@@ -423,6 +458,7 @@ FilmViewer::player_change (vector<int> properties)
        }
 }
 
+
 void
 FilmViewer::film_change (ChangeType type, Film::Property p)
 {
@@ -441,12 +477,14 @@ FilmViewer::film_change (ChangeType type, Film::Property p)
        }
 }
 
+
 void
 FilmViewer::film_length_change ()
 {
        _video_view->set_length (_film->length());
 }
 
+
 /** Re-get the current frame slowly by seeking */
 void
 FilmViewer::slow_refresh ()
@@ -454,6 +492,7 @@ FilmViewer::slow_refresh ()
        seek (_video_view->position(), true);
 }
 
+
 /** Try to re-get the current frame quickly by resetting the metadata
  *  in the PlayerVideo that we used last time.
  *  @return true if this was possible, false if not.
@@ -467,15 +506,17 @@ FilmViewer::quick_refresh ()
        return _video_view->reset_metadata (_film, _player->video_container_size());
 }
 
+
 void
 FilmViewer::seek (shared_ptr<Content> content, ContentTime t, bool accurate)
 {
-       optional<DCPTime> dt = _player->content_time_to_dcp (content, t);
+       auto dt = _player->content_time_to_dcp (content, t);
        if (dt) {
                seek (*dt, accurate);
        }
 }
 
+
 void
 FilmViewer::set_coalesce_player_changes (bool c)
 {
@@ -487,6 +528,7 @@ FilmViewer::set_coalesce_player_changes (bool c)
        }
 }
 
+
 void
 FilmViewer::seek (DCPTime t, bool accurate)
 {
@@ -494,11 +536,11 @@ FilmViewer::seek (DCPTime t, bool accurate)
                return;
        }
 
-       if (t < DCPTime ()) {
+       if (t < DCPTime()) {
                t = DCPTime ();
        }
 
-       if (t >= _film->length ()) {
+       if (t >= _film->length()) {
                t = _film->length() - one_video_frame();
        }
 
@@ -522,6 +564,7 @@ FilmViewer::seek (DCPTime t, bool accurate)
        resume ();
 }
 
+
 void
 FilmViewer::config_changed (Config::Property p)
 {
@@ -580,38 +623,42 @@ FilmViewer::config_changed (Config::Property p)
        }
 }
 
+
 DCPTime
 FilmViewer::uncorrected_time () const
 {
-       if (_audio.isStreamRunning ()) {
+       if (_audio.isStreamRunning()) {
                return DCPTime::from_seconds (const_cast<RtAudio*>(&_audio)->getStreamTime());
        }
 
        return _video_view->position();
 }
 
+
 optional<DCPTime>
 FilmViewer::audio_time () const
 {
        if (!_audio.isStreamRunning()) {
-               return optional<DCPTime>();
+               return {};
        }
 
        return DCPTime::from_seconds (const_cast<RtAudio*>(&_audio)->getStreamTime ()) -
                DCPTime::from_frames (average_latency(), _film->audio_frame_rate());
 }
 
+
 DCPTime
 FilmViewer::time () const
 {
        return audio_time().get_value_or(_video_view->position());
 }
 
+
 int
 FilmViewer::audio_callback (void* out_p, unsigned int frames)
 {
        while (true) {
-               optional<DCPTime> t = _butler->get_audio (reinterpret_cast<float*> (out_p), frames);
+               auto t = _butler->get_audio (Butler::Behaviour::NON_BLOCKING, reinterpret_cast<float*> (out_p), frames);
                if (!t || DCPTime(uncorrected_time() - *t) < one_video_frame()) {
                        /* There was an underrun or this audio is on time; carry on */
                        break;
@@ -630,6 +677,7 @@ FilmViewer::audio_callback (void* out_p, unsigned int frames)
        return 0;
 }
 
+
 Frame
 FilmViewer::average_latency () const
 {
@@ -646,6 +694,7 @@ FilmViewer::average_latency () const
         return total / _latency_history.size();
 }
 
+
 void
 FilmViewer::set_dcp_decode_reduction (optional<int> reduction)
 {
@@ -655,18 +704,28 @@ FilmViewer::set_dcp_decode_reduction (optional<int> reduction)
        }
 }
 
+
 optional<int>
 FilmViewer::dcp_decode_reduction () const
 {
        return _dcp_decode_reduction;
 }
 
+
+optional<ContentTime>
+FilmViewer::position_in_content (shared_ptr<const Content> content) const
+{
+       return _player->dcp_to_content_time (content, position());
+}
+
+
 DCPTime
 FilmViewer::one_video_frame () const
 {
        return DCPTime::from_frames (1, _film ? _film->video_frame_rate() : 24);
 }
 
+
 /** Open a dialog box showing our film's closed captions */
 void
 FilmViewer::show_closed_captions ()
@@ -674,18 +733,21 @@ FilmViewer::show_closed_captions ()
        _closed_captions_dialog->Show();
 }
 
+
 void
 FilmViewer::seek_by (DCPTime by, bool accurate)
 {
        seek (_video_view->position() + by, accurate);
 }
 
+
 void
 FilmViewer::set_pad_black (bool p)
 {
        _pad_black = p;
 }
 
+
 /** Called when a player has finished the current film.
  *  May be called from a non-UI thread.
  */
@@ -695,6 +757,7 @@ FilmViewer::finished ()
        emit (boost::bind(&FilmViewer::ui_finished, this));
 }
 
+
 /** Called by finished() in the UI thread */
 void
 FilmViewer::ui_finished ()
@@ -703,6 +766,7 @@ FilmViewer::ui_finished ()
        Finished ();
 }
 
+
 int
 FilmViewer::dropped () const
 {
@@ -730,3 +794,29 @@ FilmViewer::image_changed (shared_ptr<PlayerVideo> pv)
        emit (boost::bind(boost::ref(ImageChanged), pv));
 }
 
+
+void
+FilmViewer::set_optimise_for_j2k (bool o)
+{
+       _optimise_for_j2k = o;
+       _video_view->set_optimise_for_j2k (o);
+}
+
+
+void
+FilmViewer::set_crop_guess (dcpomatic::Rect<float> crop)
+{
+       if (crop != _crop_guess) {
+               _crop_guess = crop;
+               _video_view->update ();
+       }
+}
+
+
+void
+FilmViewer::unset_crop_guess ()
+{
+       _crop_guess = {};
+       _video_view->update ();
+}
+