Add assert.
[dcpomatic.git] / src / wx / film_viewer.cc
index b7e414444f1baa3b55fb274c47445ea2c3bb24e4..17573b4388053fe1ea09539510d8632a7770cffa 100644 (file)
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2012-2018 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2012-2019 Carl Hetherington <cth@carlh.net>
 
     This file is part of DCP-o-matic.
 
@@ -27,6 +27,8 @@
 #include "playhead_to_frame_dialog.h"
 #include "wx_util.h"
 #include "closed_captions_dialog.h"
+#include "gl_video_view.h"
+#include "simple_video_view.h"
 #include "lib/film.h"
 #include "lib/ratio.h"
 #include "lib/util.h"
@@ -43,6 +45,8 @@
 #include "lib/butler.h"
 #include "lib/log.h"
 #include "lib/config.h"
+#include "lib/compose.hpp"
+#include "lib/dcpomatic_log.h"
 extern "C" {
 #include <libavutil/pixfmt.h>
 }
@@ -65,6 +69,7 @@ using boost::dynamic_pointer_cast;
 using boost::weak_ptr;
 using boost::optional;
 using dcp::Size;
+using namespace dcpomatic;
 
 static
 int
@@ -74,27 +79,31 @@ rtaudio_callback (void* out, void *, unsigned int frames, double, RtAudioStreamS
 }
 
 FilmViewer::FilmViewer (wxWindow* p)
-       : _panel (new wxPanel (p))
-       , _coalesce_player_changes (false)
+       : _coalesce_player_changes (false)
        , _audio (DCPOMATIC_RTAUDIO_API)
        , _audio_channels (0)
        , _audio_block_size (1024)
        , _playing (false)
+       , _suspended (0)
        , _latency_history_count (0)
-       , _dropped (0)
-       , _closed_captions_dialog (new ClosedCaptionsDialog(p))
+       , _closed_captions_dialog (new ClosedCaptionsDialog(p, this))
        , _outline_content (false)
-       , _eyes (EYES_LEFT)
-{
-#ifndef __WXOSX__
-       _panel->SetDoubleBuffered (true);
+       , _pad_black (false)
+#ifdef DCPOMATIC_VARIANT_SWAROOP
+       , _background_image (false)
 #endif
+       , _idle_get (false)
+{
+       switch (Config::instance()->video_view_type()) {
+       case Config::VIDEO_VIEW_OPENGL:
+               _video_view = new GLVideoView (this, p);
+               break;
+       case Config::VIDEO_VIEW_SIMPLE:
+               _video_view = new SimpleVideoView (this, p);
+               break;
+       }
 
-       _panel->SetBackgroundStyle (wxBG_STYLE_PAINT);
-
-       _panel->Bind            (wxEVT_PAINT,               boost::bind (&FilmViewer::paint_panel,     this));
-       _panel->Bind            (wxEVT_SIZE,                boost::bind (&FilmViewer::panel_sized,     this, _1));
-       _timer.Bind             (wxEVT_TIMER,               boost::bind (&FilmViewer::timer,           this));
+       _video_view->Sized.connect (boost::bind(&FilmViewer::video_view_sized, this));
 
        set_film (shared_ptr<Film> ());
 
@@ -107,6 +116,34 @@ FilmViewer::~FilmViewer ()
        stop ();
 }
 
+/** Ask for ::get() to be called next time we are idle */
+void
+FilmViewer::request_idle_display_next_frame ()
+{
+       if (_idle_get) {
+               return;
+       }
+
+       _idle_get = true;
+       DCPOMATIC_ASSERT (signal_manager);
+       signal_manager->when_idle (boost::bind(&FilmViewer::idle_handler, this));
+}
+
+void
+FilmViewer::idle_handler ()
+{
+       if (!_idle_get) {
+               return;
+       }
+
+       if (_video_view->display_next_frame(true)) {
+               _idle_get = false;
+       } else {
+               /* get() could not complete quickly so we'll try again later */
+               signal_manager->when_idle (boost::bind(&FilmViewer::idle_handler, this));
+       }
+}
+
 void
 FilmViewer::set_film (shared_ptr<Film> film)
 {
@@ -116,14 +153,13 @@ FilmViewer::set_film (shared_ptr<Film> film)
 
        _film = film;
 
-       _frame.reset ();
+       _video_view->clear ();
        _closed_captions_dialog->clear ();
 
        if (!_film) {
                _player.reset ();
                recreate_butler ();
-               _frame.reset ();
-               refresh_panel ();
+               _video_view->update ();
                return;
        }
 
@@ -133,8 +169,8 @@ FilmViewer::set_film (shared_ptr<Film> film)
                if (_dcp_decode_reduction) {
                        _player->set_dcp_decode_reduction (_dcp_decode_reduction);
                }
-       } catch (bad_alloc) {
-               error_dialog (_panel, _("There is not enough free memory to do that."));
+       } catch (bad_alloc &) {
+               error_dialog (_video_view->get(), _("There is not enough free memory to do that."));
                _film.reset ();
                return;
        }
@@ -143,6 +179,7 @@ FilmViewer::set_film (shared_ptr<Film> film)
        _player->set_play_referenced ();
 
        _film->Change.connect (boost::bind (&FilmViewer::film_change, this, _1, _2));
+       _film->LengthChange.connect (boost::bind(&FilmViewer::film_length_change, this));
        _player->Change.connect (boost::bind (&FilmViewer::player_change, this, _1, _2, _3));
 
        /* Keep about 1 second's worth of history samples */
@@ -157,214 +194,55 @@ FilmViewer::set_film (shared_ptr<Film> film)
 void
 FilmViewer::recreate_butler ()
 {
-       bool const was_running = stop ();
+       suspend ();
        _butler.reset ();
 
        if (!_film) {
+               resume ();
                return;
        }
 
-       AudioMapping map = AudioMapping (_film->audio_channels(), _audio_channels);
+       _butler.reset(
+               new Butler(
+                       _player,
+                       Config::instance()->audio_mapping(_audio_channels),
+                       _audio_channels,
+                       bind(&PlayerVideo::force, _1, AV_PIX_FMT_RGB24),
+                       false,
+                       true
+                       )
+               );
 
-       if (_audio_channels != 2 || _film->audio_channels() < 3) {
-               for (int i = 0; i < min (_film->audio_channels(), _audio_channels); ++i) {
-                       map.set (i, i, 1);
-               }
-       } else {
-               /* Special case: stereo output, at least 3 channel input.
-                  Map so that Lt = L(-3dB) + Ls(-3dB) + C(-6dB) + Lfe(-10dB)
-                              Rt = R(-3dB) + Rs(-3dB) + C(-6dB) + Lfe(-10dB)
-               */
-               map.set (dcp::LEFT,   0, 1 / sqrt(2)); // L -> Lt
-               map.set (dcp::RIGHT,  1, 1 / sqrt(2)); // R -> Rt
-               map.set (dcp::CENTRE, 0, 1 / 2.0); // C -> Lt
-               map.set (dcp::CENTRE, 1, 1 / 2.0); // C -> Rt
-               map.set (dcp::LFE,    0, 1 / sqrt(10)); // Lfe -> Lt
-               map.set (dcp::LFE,    1, 1 / sqrt(10)); // Lfe -> Rt
-               map.set (dcp::LS,     0, 1 / sqrt(2)); // Ls -> Lt
-               map.set (dcp::RS,     1, 1 / sqrt(2)); // Rs -> Rt
-       }
-
-       _butler.reset (new Butler (_player, _film->log(), map, _audio_channels));
        if (!Config::instance()->sound() && !_audio.isStreamOpen()) {
                _butler->disable_audio ();
        }
 
-       _closed_captions_dialog->set_butler (_butler);
-
-       if (was_running) {
-               start ();
-       }
-}
-
-void
-FilmViewer::refresh_panel ()
-{
-       _panel->Refresh ();
-       _panel->Update ();
-}
-
-void
-FilmViewer::get ()
-{
-       DCPOMATIC_ASSERT (_butler);
-
-       do {
-               Butler::Error e;
-               _player_video = _butler->get_video (&e);
-               if (!_player_video.first && e == Butler::AGAIN) {
-                       signal_manager->when_idle (boost::bind(&FilmViewer::get, this));
-                       return;
-               }
-       } while (
-               _player_video.first &&
-               _film->three_d() &&
-               (_eyes != _player_video.first->eyes())
-               );
-
-       _butler->rethrow ();
-
-       display_player_video ();
-}
-
-void
-FilmViewer::display_player_video ()
-{
-       if (!_player_video.first) {
-               _frame.reset ();
-               refresh_panel ();
-               return;
-       }
-
-       if (_playing && (time() - _player_video.second) > one_video_frame()) {
-               /* Too late; just drop this frame before we try to get its image (which will be the time-consuming
-                  part if this frame is J2K).
-               */
-               _video_position = _player_video.second;
-               ++_dropped;
-               return;
-       }
-
-       /* In an ideal world, what we would do here is:
-        *
-        * 1. convert to XYZ exactly as we do in the DCP creation path.
-        * 2. convert back to RGB for the preview display, compensating
-        *    for the monitor etc. etc.
-        *
-        * but this is inefficient if the source is RGB.  Since we don't
-        * (currently) care too much about the precise accuracy of the preview's
-        * colour mapping (and we care more about its speed) we try to short-
-        * circuit this "ideal" situation in some cases.
-        *
-        * The content's specified colour conversion indicates the colourspace
-        * which the content is in (according to the user).
-        *
-        * PlayerVideo::image (bound to PlayerVideo::always_rgb) will take the source
-        * image and convert it (from whatever the user has said it is) to RGB.
-        */
-
-       _frame = _player_video.first->image (
-               bind (&Log::dcp_log, _film->log().get(), _1, _2),
-               bind (&PlayerVideo::always_rgb, _1),
-               false, true
-               );
-
-       ImageChanged (_player_video.first);
-
-       _video_position = _player_video.second;
-       _inter_position = _player_video.first->inter_position ();
-       _inter_size = _player_video.first->inter_size ();
-
-       refresh_panel ();
-
-       _closed_captions_dialog->update (time());
-}
-
-void
-FilmViewer::timer ()
-{
-       if (!_film || !_playing) {
-               return;
-       }
-
-       get ();
-       PositionChanged ();
-       DCPTime const next = _video_position + one_video_frame();
-
-       if (next >= _film->length()) {
-               stop ();
-       }
-
-       _timer.Start (max ((next.seconds() - time().seconds()) * 1000, 1.0), wxTIMER_ONE_SHOT);
-
-       if (_butler) {
-               _butler->rethrow ();
-       }
-}
-
-void
-FilmViewer::paint_panel ()
-{
-       wxPaintDC dc (_panel);
-
-       if (!_frame || !_film || !_out_size.width || !_out_size.height || _out_size != _frame->size()) {
-               dc.Clear ();
-               return;
-       }
-
-       wxImage frame (_out_size.width, _out_size.height, _frame->data()[0], true);
-       wxBitmap frame_bitmap (frame);
-       dc.DrawBitmap (frame_bitmap, 0, 0);
-
-       if (_out_size.width < _panel_size.width) {
-               wxPen p (_panel->GetParent()->GetBackgroundColour());
-               wxBrush b (_panel->GetParent()->GetBackgroundColour());
-               dc.SetPen (p);
-               dc.SetBrush (b);
-               dc.DrawRectangle (_out_size.width, 0, _panel_size.width - _out_size.width, _panel_size.height);
-       }
-
-       if (_out_size.height < _panel_size.height) {
-               wxPen p (_panel->GetParent()->GetBackgroundColour());
-               wxBrush b (_panel->GetParent()->GetBackgroundColour());
-               dc.SetPen (p);
-               dc.SetBrush (b);
-               dc.DrawRectangle (0, _out_size.height, _panel_size.width, _panel_size.height - _out_size.height);
-       }
+       _closed_captions_dialog->set_film_and_butler (_film, _butler);
 
-       if (_outline_content) {
-               wxPen p (wxColour (255, 0, 0), 2);
-               dc.SetPen (p);
-               dc.SetBrush (*wxTRANSPARENT_BRUSH);
-               dc.DrawRectangle (_inter_position.x, _inter_position.y, _inter_size.width, _inter_size.height);
-       }
+       resume ();
 }
 
 void
 FilmViewer::set_outline_content (bool o)
 {
        _outline_content = o;
-       refresh_panel ();
+       _video_view->update ();
 }
 
 void
 FilmViewer::set_eyes (Eyes e)
 {
-       _eyes = e;
+       _video_view->set_eyes (e);
        slow_refresh ();
 }
 
 void
-FilmViewer::panel_sized (wxSizeEvent& ev)
+FilmViewer::video_view_sized ()
 {
-       _panel_size.width = ev.GetSize().GetWidth();
-       _panel_size.height = ev.GetSize().GetHeight();
-
        calculate_sizes ();
        if (!quick_refresh()) {
                slow_refresh ();
        }
-       PositionChanged ();
 }
 
 void
@@ -376,16 +254,16 @@ FilmViewer::calculate_sizes ()
 
        Ratio const * container = _film->container ();
 
-       float const panel_ratio = _panel_size.ratio ();
+       float const view_ratio = float(_video_view->get()->GetSize().x) / _video_view->get()->GetSize().y;
        float const film_ratio = container ? container->ratio () : 1.78;
 
-       if (panel_ratio < film_ratio) {
+       if (view_ratio < film_ratio) {
                /* panel is less widscreen than the film; clamp width */
-               _out_size.width = _panel_size.width;
+               _out_size.width = _video_view->get()->GetSize().x;
                _out_size.height = lrintf (_out_size.width / film_ratio);
        } else {
                /* panel is more widescreen than the film; clamp height */
-               _out_size.height = _panel_size.height;
+               _out_size.height = _video_view->get()->GetSize().y;
                _out_size.width = lrintf (_out_size.height * film_ratio);
        }
 
@@ -396,6 +274,29 @@ FilmViewer::calculate_sizes ()
        _player->set_video_container_size (_out_size);
 }
 
+void
+FilmViewer::suspend ()
+{
+       ++_suspended;
+       if (_audio.isStreamRunning()) {
+               _audio.abortStream();
+       }
+}
+
+void
+FilmViewer::resume ()
+{
+       DCPOMATIC_ASSERT (_suspended > 0);
+       --_suspended;
+       if (_playing && !_suspended) {
+               if (_audio.isStreamOpen()) {
+                       _audio.setStreamTime (_video_view->position().seconds());
+                       _audio.startStream ();
+               }
+               _video_view->start ();
+       }
+}
+
 void
 FilmViewer::start ()
 {
@@ -403,14 +304,20 @@ FilmViewer::start ()
                return;
        }
 
+       optional<bool> v = PlaybackPermitted ();
+       if (v && !*v) {
+               /* Computer says no */
+               return;
+       }
+
        if (_audio.isStreamOpen()) {
-               _audio.setStreamTime (_video_position.seconds());
+               _audio.setStreamTime (_video_view->position().seconds());
                _audio.startStream ();
        }
 
        _playing = true;
-       _dropped = 0;
-       timer ();
+       _video_view->start ();
+       Started (position());
 }
 
 bool
@@ -426,22 +333,11 @@ FilmViewer::stop ()
        }
 
        _playing = false;
-       return true;
-}
-
-void
-FilmViewer::go_to (DCPTime t)
-{
-       if (t < DCPTime ()) {
-               t = DCPTime ();
-       }
-
-       if (t >= _film->length ()) {
-               t = _film->length ();
-       }
+       _video_view->stop ();
+       Stopped (position());
 
-       seek (t, true);
-       PositionChanged ();
+       _video_view->rethrow ();
+       return true;
 }
 
 void
@@ -473,22 +369,35 @@ FilmViewer::player_change (ChangeType type, int property, bool frequent)
        if (!refreshed) {
                slow_refresh ();
        }
-       PositionChanged ();
 }
 
 void
 FilmViewer::film_change (ChangeType type, Film::Property p)
 {
-       if (type == CHANGE_TYPE_DONE && p == Film::AUDIO_CHANNELS) {
+       if (type != CHANGE_TYPE_DONE) {
+               return;
+       }
+
+       if (p == Film::AUDIO_CHANNELS) {
                recreate_butler ();
+       } else if (p == Film::VIDEO_FRAME_RATE) {
+               _video_view->set_video_frame_rate (_film->video_frame_rate());
+       } else if (p == Film::THREE_D) {
+               _video_view->set_three_d (_film->three_d());
        }
 }
 
+void
+FilmViewer::film_length_change ()
+{
+       _video_view->set_length (_film->length());
+}
+
 /** Re-get the current frame slowly by seeking */
 void
 FilmViewer::slow_refresh ()
 {
-       seek (_video_position, true);
+       seek (_video_view->position(), true);
 }
 
 /** Try to re-get the current frame quickly by resetting the metadata
@@ -498,32 +407,18 @@ FilmViewer::slow_refresh ()
 bool
 FilmViewer::quick_refresh ()
 {
-       if (!_player_video.first) {
-               return false;
+       if (!_video_view || !_film) {
+               return true;
        }
-
-       if (!_player_video.first->reset_metadata (_player->video_container_size(), _film->frame_size())) {
-               return false;
-       }
-
-       display_player_video ();
-       return true;
-}
-
-void
-FilmViewer::set_position (DCPTime p)
-{
-       _video_position = p;
-       seek (p, true);
-       PositionChanged ();
+       return _video_view->refresh_metadata (_film, _player->video_container_size(), _film->frame_size());
 }
 
 void
-FilmViewer::set_position (shared_ptr<Content> content, ContentTime t)
+FilmViewer::seek (shared_ptr<Content> content, ContentTime t, bool accurate)
 {
        optional<DCPTime> dt = _player->content_time_to_dcp (content, t);
        if (dt) {
-               set_position (*dt);
+               seek (*dt, accurate);
        }
 }
 
@@ -547,20 +442,43 @@ FilmViewer::seek (DCPTime t, bool accurate)
                return;
        }
 
-       bool const was_running = stop ();
+       if (t < DCPTime ()) {
+               t = DCPTime ();
+       }
+
+       if (t >= _film->length ()) {
+               t = _film->length ();
+       }
+
+       suspend ();
 
        _closed_captions_dialog->clear ();
        _butler->seek (t, accurate);
-       get ();
 
-       if (was_running) {
-               start ();
+       if (!_playing) {
+               request_idle_display_next_frame ();
+       } else {
+               while (!_video_view->display_next_frame(false)) {}
        }
+
+       resume ();
 }
 
 void
 FilmViewer::config_changed (Config::Property p)
 {
+#ifdef DCPOMATIC_VARIANT_SWAROOP
+       if (p == Config::PLAYER_BACKGROUND_IMAGE) {
+               _video_view->update ();
+               return;
+       }
+#endif
+
+       if (p == Config::AUDIO_MAPPING) {
+               recreate_butler ();
+               return;
+       }
+
        if (p != Config::SOUND && p != Config::SOUND_OUTPUT) {
                return;
        }
@@ -599,7 +517,7 @@ FilmViewer::config_changed (Config::Property p)
                } catch (RtAudioError& e) {
 #endif
                        error_dialog (
-                               _panel,
+                               _video_view->get(),
                                _("Could not set up audio output.  There will be no audio during the preview."), std_to_wx(e.what())
                                );
                }
@@ -618,18 +536,24 @@ FilmViewer::uncorrected_time () const
                return DCPTime::from_seconds (const_cast<RtAudio*>(&_audio)->getStreamTime());
        }
 
-       return _video_position;
+       return _video_view->position();
 }
 
-DCPTime
-FilmViewer::time () const
+optional<DCPTime>
+FilmViewer::audio_time () const
 {
-       if (_audio.isStreamRunning ()) {
-               return DCPTime::from_seconds (const_cast<RtAudio*>(&_audio)->getStreamTime ()) -
-                       DCPTime::from_frames (average_latency(), _film->audio_frame_rate());
+       if (!_audio.isStreamRunning()) {
+               return optional<DCPTime>();
        }
 
-       return _video_position;
+       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
@@ -689,9 +613,10 @@ FilmViewer::dcp_decode_reduction () const
 DCPTime
 FilmViewer::one_video_frame () const
 {
-       return DCPTime::from_frames (1, _film->video_frame_rate());
+       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 ()
 {
@@ -699,11 +624,44 @@ FilmViewer::show_closed_captions ()
 }
 
 void
-FilmViewer::move (DCPTime by)
+FilmViewer::seek_by (DCPTime by, bool accurate)
 {
-       if (!_film) {
-               return;
-       }
+       seek (_video_view->position() + by, accurate);
+}
 
-       go_to (_video_position + by);
+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.
+ */
+void
+FilmViewer::finished ()
+{
+       emit (boost::bind(&FilmViewer::ui_finished, this));
+}
+
+/** Called by finished() in the UI thread */
+void
+FilmViewer::ui_finished ()
+{
+       stop ();
+       Finished ();
+}
+
+int
+FilmViewer::dropped () const
+{
+       return _video_view->dropped ();
 }
+
+int
+FilmViewer::gets () const
+{
+       return _video_view->gets ();
+}
+
+