Rather dubious fix for crash due to the sequence:
[dcpomatic.git] / src / lib / player.cc
index 36ffd186839b4d2a287128bae228be02fb904f58..2313e09e580326b6b0dd762f4c3da122b1f292f7 100644 (file)
@@ -52,6 +52,7 @@
 #include <dcp/reel_sound_asset.h>
 #include <dcp/reel_subtitle_asset.h>
 #include <dcp/reel_picture_asset.h>
+#include <dcp/reel_closed_caption_asset.h>
 #include <boost/foreach.hpp>
 #include <stdint.h>
 #include <algorithm>
@@ -88,8 +89,9 @@ Player::Player (shared_ptr<const Film> film, shared_ptr<const Playlist> playlist
        , _playlist (playlist)
        , _have_valid_pieces (false)
        , _ignore_video (false)
-       , _ignore_subtitle (false)
-       , _always_burn_subtitles (false)
+       , _ignore_audio (false)
+       , _ignore_text (false)
+       , _always_burn_open_subtitles (false)
        , _fast (false)
        , _play_referenced (false)
        , _audio_merger (_film->audio_frame_rate())
@@ -125,6 +127,11 @@ Player::setup_pieces ()
                        continue;
                }
 
+               if (_ignore_video && _ignore_audio && i->text.empty()) {
+                       /* We're only interested in text and this content has none */
+                       continue;
+               }
+
                shared_ptr<Decoder> decoder = decoder_factory (i, _film->log(), _fast);
                FrameRateChange frc (i->active_video_frame_rate(), _film->video_frame_rate());
 
@@ -137,8 +144,14 @@ Player::setup_pieces ()
                        decoder->video->set_ignore (true);
                }
 
-               if (decoder->subtitle && _ignore_subtitle) {
-                       decoder->subtitle->set_ignore (true);
+               if (decoder->audio && _ignore_audio) {
+                       decoder->audio->set_ignore (true);
+               }
+
+               if (_ignore_text) {
+                       BOOST_FOREACH (shared_ptr<TextDecoder> i, decoder->text) {
+                               i->set_ignore (true);
+                       }
                }
 
                shared_ptr<DCPDecoder> dcp = dynamic_pointer_cast<DCPDecoder> (decoder);
@@ -165,10 +178,20 @@ Player::setup_pieces ()
                        decoder->audio->Data.connect (bind (&Player::audio, this, weak_ptr<Piece> (piece), _1, _2));
                }
 
-               if (decoder->subtitle) {
-                       decoder->subtitle->BitmapStart.connect (bind (&Player::bitmap_text_start, this, weak_ptr<Piece> (piece), _1));
-                       decoder->subtitle->PlainStart.connect (bind (&Player::plain_text_start, this, weak_ptr<Piece> (piece), _1));
-                       decoder->subtitle->Stop.connect (bind (&Player::subtitle_stop, this, weak_ptr<Piece> (piece), _1, _2));
+               list<shared_ptr<TextDecoder> >::const_iterator j = decoder->text.begin();
+
+               while (j != decoder->text.end()) {
+                       (*j)->BitmapStart.connect (
+                               bind(&Player::bitmap_text_start, this, weak_ptr<Piece>(piece), weak_ptr<const TextContent>((*j)->content()), _1)
+                               );
+                       (*j)->PlainStart.connect (
+                               bind(&Player::plain_text_start, this, weak_ptr<Piece>(piece), weak_ptr<const TextContent>((*j)->content()), _1)
+                               );
+                       (*j)->Stop.connect (
+                               bind(&Player::subtitle_stop, this, weak_ptr<Piece>(piece), weak_ptr<const TextContent>((*j)->content()), _1, _2)
+                               );
+
+                       ++j;
                }
        }
 
@@ -216,7 +239,11 @@ Player::playlist_content_changed (weak_ptr<Content> w, int property, bool freque
                property == FFmpegContentProperty::FILTERS
                ) {
 
-               _have_valid_pieces = false;
+               {
+                       boost::mutex::scoped_lock lm (_mutex);
+                       _have_valid_pieces = false;
+               }
+
                Changed (property, frequent);
 
        } else if (
@@ -231,6 +258,7 @@ Player::playlist_content_changed (weak_ptr<Content> w, int property, bool freque
                property == TextContentProperty::Y_OFFSET ||
                property == TextContentProperty::X_SCALE ||
                property == TextContentProperty::FONTS ||
+               property == TextContentProperty::TYPE ||
                property == VideoContentProperty::CROP ||
                property == VideoContentProperty::SCALE ||
                property == VideoContentProperty::FADE_IN ||
@@ -244,14 +272,18 @@ Player::playlist_content_changed (weak_ptr<Content> w, int property, bool freque
 void
 Player::set_video_container_size (dcp::Size s)
 {
-       if (s == _video_container_size) {
-               return;
-       }
+       {
+               boost::mutex::scoped_lock lm (_mutex);
+
+               if (s == _video_container_size) {
+                       return;
+               }
 
-       _video_container_size = s;
+               _video_container_size = s;
 
-       _black_image.reset (new Image (AV_PIX_FMT_RGB24, _video_container_size, true));
-       _black_image->make_black ();
+               _black_image.reset (new Image (AV_PIX_FMT_RGB24, _video_container_size, true));
+               _black_image->make_black ();
+       }
 
        Changed (PlayerProperty::VIDEO_CONTAINER_SIZE, false);
 }
@@ -259,7 +291,11 @@ Player::set_video_container_size (dcp::Size s)
 void
 Player::playlist_changed ()
 {
-       _have_valid_pieces = false;
+       {
+               boost::mutex::scoped_lock lm (_mutex);
+               _have_valid_pieces = false;
+       }
+
        Changed (PlayerProperty::PLAYLIST, false);
 }
 
@@ -277,13 +313,18 @@ Player::film_changed (Film::Property p)
                /* Pieces contain a FrameRateChange which contains the DCP frame rate,
                   so we need new pieces here.
                */
-               _have_valid_pieces = false;
+               {
+                       boost::mutex::scoped_lock lm (_mutex);
+                       _have_valid_pieces = false;
+               }
                Changed (PlayerProperty::FILM_VIDEO_FRAME_RATE, false);
        } else if (p == Film::AUDIO_PROCESSOR) {
                if (_film->audio_processor ()) {
+                       boost::mutex::scoped_lock lm (_mutex);
                        _audio_processor = _film->audio_processor()->clone (_film->audio_frame_rate ());
                }
        } else if (p == Film::AUDIO_CHANNELS) {
+               boost::mutex::scoped_lock lm (_mutex);
                _audio_merger.clear ();
        }
 }
@@ -400,17 +441,19 @@ Player::content_time_to_dcp (shared_ptr<const Piece> piece, ContentTime t) const
 list<shared_ptr<Font> >
 Player::get_subtitle_fonts ()
 {
+       /* Does not require a lock on _mutex as it's only called from DCPEncoder */
+
        if (!_have_valid_pieces) {
                setup_pieces ();
        }
 
        list<shared_ptr<Font> > fonts;
-       BOOST_FOREACH (shared_ptr<Piece>& p, _pieces) {
-               if (p->content->subtitle) {
+       BOOST_FOREACH (shared_ptr<Piece> i, _pieces) {
+               BOOST_FOREACH (shared_ptr<TextContent> j, i->content->text) {
                        /* XXX: things may go wrong if there are duplicate font IDs
                           with different font files.
                        */
-                       list<shared_ptr<Font> > f = p->content->subtitle->fonts ();
+                       list<shared_ptr<Font> > f = j->fonts ();
                        copy (f.begin(), f.end(), back_inserter (fonts));
                }
        }
@@ -422,29 +465,39 @@ Player::get_subtitle_fonts ()
 void
 Player::set_ignore_video ()
 {
+       boost::mutex::scoped_lock lm (_mutex);
        _ignore_video = true;
+       _have_valid_pieces = false;
+}
+
+void
+Player::set_ignore_audio ()
+{
+       boost::mutex::scoped_lock lm (_mutex);
+       _ignore_audio = true;
+       _have_valid_pieces = false;
 }
 
 void
-Player::set_ignore_subtitle ()
+Player::set_ignore_text ()
 {
-       _ignore_subtitle = true;
+       boost::mutex::scoped_lock lm (_mutex);
+       _ignore_text = true;
 }
 
-/** Set whether or not this player should always burn text subtitles into the image,
- *  regardless of the content settings.
- *  @param burn true to always burn subtitles, false to obey content settings.
- */
+/** Set the player to always burn open texts into the image regardless of the content settings */
 void
-Player::set_always_burn_subtitles (bool burn)
+Player::set_always_burn_open_subtitles ()
 {
-       _always_burn_subtitles = burn;
+       boost::mutex::scoped_lock lm (_mutex);
+       _always_burn_open_subtitles = true;
 }
 
 /** Sets up the player to be faster, possibly at the expense of quality */
 void
 Player::set_fast ()
 {
+       boost::mutex::scoped_lock lm (_mutex);
        _fast = true;
        _have_valid_pieces = false;
 }
@@ -452,6 +505,7 @@ Player::set_fast ()
 void
 Player::set_play_referenced ()
 {
+       boost::mutex::scoped_lock lm (_mutex);
        _play_referenced = true;
        _have_valid_pieces = false;
 }
@@ -459,6 +513,8 @@ Player::set_play_referenced ()
 list<ReferencedReelAsset>
 Player::get_reel_assets ()
 {
+       /* Does not require a lock on _mutex as it's only called from DCPEncoder */
+
        list<ReferencedReelAsset> a;
 
        BOOST_FOREACH (shared_ptr<Content> i, _playlist->content ()) {
@@ -504,7 +560,7 @@ Player::get_reel_assets ()
                                        );
                        }
 
-                       if (j->reference_subtitle ()) {
+                       if (j->reference_text (TEXT_OPEN_SUBTITLE)) {
                                shared_ptr<dcp::ReelAsset> ra = k->main_subtitle ();
                                DCPOMATIC_ASSERT (ra);
                                ra->set_entry_point (ra->entry_point() + trim_start);
@@ -514,6 +570,16 @@ Player::get_reel_assets ()
                                        );
                        }
 
+                       if (j->reference_text (TEXT_CLOSED_CAPTION)) {
+                               shared_ptr<dcp::ReelAsset> ra = k->closed_caption ();
+                               DCPOMATIC_ASSERT (ra);
+                               ra->set_entry_point (ra->entry_point() + trim_start);
+                               ra->set_duration (ra->duration() - trim_start - trim_end);
+                               a.push_back (
+                                       ReferencedReelAsset (ra, DCPTimePeriod (from, from + DCPTime::from_frames (ra->duration(), ffr)))
+                                       );
+                       }
+
                        /* Assume that main picture duration is the length of the reel */
                        offset += k->main_picture()->duration ();
                }
@@ -525,8 +591,16 @@ Player::get_reel_assets ()
 bool
 Player::pass ()
 {
+       boost::mutex::scoped_lock lm (_mutex);
+
        if (!_have_valid_pieces) {
-               setup_pieces ();
+               /* This should only happen when we are under the control of the butler.  In this case, _have_valid_pieces
+                  will be false if something in the Player has changed and we are waiting for the butler to notice
+                  and do a seek back to the place we were at before.  During this time we don't want pass() to do anything,
+                  as just after setup_pieces the new decoders will be back to time 0 until the seek has gone through.  Just do nothing
+                  here and assume that the seek will be forthcoming.
+               */
+               return false;
        }
 
        if (_playlist->length() == DCPTime()) {
@@ -550,10 +624,10 @@ Player::pass ()
                        i->done = true;
                } else {
 
-                       /* Given two choices at the same time, pick the one with a subtitle so we see it before
+                       /* Given two choices at the same time, pick the one with texts so we see it before
                           the video.
                        */
-                       if (!earliest_time || t < *earliest_time || (t == *earliest_time && i->decoder->subtitle)) {
+                       if (!earliest_time || t < *earliest_time || (t == *earliest_time && !i->decoder->text.empty())) {
                                earliest_time = t;
                                earliest_content = i;
                        }
@@ -656,31 +730,34 @@ Player::pass ()
        return done;
 }
 
+/** @return Open subtitles for the frame at the given time, converted to images */
 optional<PositionImage>
-Player::subtitles_for_frame (DCPTime time) const
+Player::open_subtitles_for_frame (DCPTime time) const
 {
-       list<PositionImage> subtitles;
-
+       list<PositionImage> captions;
        int const vfr = _film->video_frame_rate();
 
-       BOOST_FOREACH (PlayerText i, _active_text[TEXT_SUBTITLE].get_burnt (DCPTimePeriod(time, time + DCPTime::from_frames(1, vfr)), _always_burn_subtitles)) {
+       BOOST_FOREACH (
+               PlayerText j,
+               _active_texts[TEXT_OPEN_SUBTITLE].get_burnt(DCPTimePeriod(time, time + DCPTime::from_frames(1, vfr)), _always_burn_open_subtitles)
+               ) {
 
-               /* Image subtitles */
-               list<PositionImage> c = transform_bitmap_texts (i.image);
-               copy (c.begin(), c.end(), back_inserter (subtitles));
+               /* Bitmap subtitles */
+               list<PositionImage> c = transform_bitmap_texts (j.bitmap);
+               copy (c.begin(), c.end(), back_inserter (captions));
 
-               /* Text subtitles (rendered to an image) */
-               if (!i.text.empty ()) {
-                       list<PositionImage> s = render_text (i.text, i.fonts, _video_container_size, time, vfr);
-                       copy (s.begin(), s.end(), back_inserter (subtitles));
+               /* String subtitles (rendered to an image) */
+               if (!j.string.empty ()) {
+                       list<PositionImage> s = render_text (j.string, j.fonts, _video_container_size, time, vfr);
+                       copy (s.begin(), s.end(), back_inserter (captions));
                }
        }
 
-       if (subtitles.empty ()) {
+       if (captions.empty ()) {
                return optional<PositionImage> ();
        }
 
-       return merge (subtitles);
+       return merge (captions);
 }
 
 void
@@ -839,37 +916,39 @@ Player::audio (weak_ptr<Piece> wp, AudioStreamPtr stream, ContentAudio content_a
 }
 
 void
-Player::bitmap_text_start (weak_ptr<Piece> wp, ContentBitmapText subtitle)
+Player::bitmap_text_start (weak_ptr<Piece> wp, weak_ptr<const TextContent> wc, ContentBitmapText subtitle)
 {
        shared_ptr<Piece> piece = wp.lock ();
-       if (!piece) {
+       shared_ptr<const TextContent> text = wc.lock ();
+       if (!piece || !text) {
                return;
        }
 
        /* Apply content's subtitle offsets */
-       subtitle.sub.rectangle.x += piece->content->subtitle->x_offset ();
-       subtitle.sub.rectangle.y += piece->content->subtitle->y_offset ();
+       subtitle.sub.rectangle.x += text->x_offset ();
+       subtitle.sub.rectangle.y += text->y_offset ();
 
        /* Apply a corrective translation to keep the subtitle centred after the scale that is coming up */
-       subtitle.sub.rectangle.x -= subtitle.sub.rectangle.width * ((piece->content->subtitle->x_scale() - 1) / 2);
-       subtitle.sub.rectangle.y -= subtitle.sub.rectangle.height * ((piece->content->subtitle->y_scale() - 1) / 2);
+       subtitle.sub.rectangle.x -= subtitle.sub.rectangle.width * ((text->x_scale() - 1) / 2);
+       subtitle.sub.rectangle.y -= subtitle.sub.rectangle.height * ((text->y_scale() - 1) / 2);
 
        /* Apply content's subtitle scale */
-       subtitle.sub.rectangle.width *= piece->content->subtitle->x_scale ();
-       subtitle.sub.rectangle.height *= piece->content->subtitle->y_scale ();
+       subtitle.sub.rectangle.width *= text->x_scale ();
+       subtitle.sub.rectangle.height *= text->y_scale ();
 
        PlayerText ps;
-       ps.image.push_back (subtitle.sub);
+       ps.bitmap.push_back (subtitle.sub);
        DCPTime from (content_time_to_dcp (piece, subtitle.from()));
 
-       _active_text[subtitle.type()].add_from (wp, ps, from);
+       _active_texts[subtitle.type()].add_from (wc, ps, from);
 }
 
 void
-Player::plain_text_start (weak_ptr<Piece> wp, ContentPlainText subtitle)
+Player::plain_text_start (weak_ptr<Piece> wp, weak_ptr<const TextContent> wc, ContentStringText subtitle)
 {
        shared_ptr<Piece> piece = wp.lock ();
-       if (!piece) {
+       shared_ptr<const TextContent> text = wc.lock ();
+       if (!piece || !text) {
                return;
        }
 
@@ -881,10 +960,10 @@ Player::plain_text_start (weak_ptr<Piece> wp, ContentPlainText subtitle)
        }
 
        BOOST_FOREACH (dcp::SubtitleString s, subtitle.subs) {
-               s.set_h_position (s.h_position() + piece->content->subtitle->x_offset ());
-               s.set_v_position (s.v_position() + piece->content->subtitle->y_offset ());
-               float const xs = piece->content->subtitle->x_scale();
-               float const ys = piece->content->subtitle->y_scale();
+               s.set_h_position (s.h_position() + text->x_offset ());
+               s.set_v_position (s.v_position() + text->y_offset ());
+               float const xs = text->x_scale();
+               float const ys = text->y_scale();
                float size = s.size();
 
                /* Adjust size to express the common part of the scaling;
@@ -901,22 +980,23 @@ Player::plain_text_start (weak_ptr<Piece> wp, ContentPlainText subtitle)
                }
 
                s.set_in (dcp::Time(from.seconds(), 1000));
-               ps.text.push_back (PlainText (s, piece->content->subtitle->outline_width()));
-               ps.add_fonts (piece->content->subtitle->fonts ());
+               ps.string.push_back (StringText (s, text->outline_width()));
+               ps.add_fonts (text->fonts ());
        }
 
-       _active_text[subtitle.type()].add_from (wp, ps, from);
+       _active_texts[subtitle.type()].add_from (wc, ps, from);
 }
 
 void
-Player::subtitle_stop (weak_ptr<Piece> wp, ContentTime to, TextType type)
+Player::subtitle_stop (weak_ptr<Piece> wp, weak_ptr<const TextContent> wc, ContentTime to, TextType type)
 {
-       if (!_active_text[type].have (wp)) {
+       if (!_active_texts[type].have (wc)) {
                return;
        }
 
        shared_ptr<Piece> piece = wp.lock ();
-       if (!piece) {
+       shared_ptr<const TextContent> text = wc.lock ();
+       if (!piece || !text) {
                return;
        }
 
@@ -926,16 +1006,19 @@ Player::subtitle_stop (weak_ptr<Piece> wp, ContentTime to, TextType type)
                return;
        }
 
-       pair<PlayerText, DCPTime> from = _active_text[type].add_to (wp, dcp_to);
+       pair<PlayerText, DCPTime> from = _active_texts[type].add_to (wc, dcp_to);
 
-       if (piece->content->subtitle->use() && !_always_burn_subtitles && !piece->content->subtitle->burn()) {
-               Subtitle (from.first, DCPTimePeriod (from.second, dcp_to));
+       bool const always = (type == TEXT_OPEN_SUBTITLE && _always_burn_open_subtitles);
+       if (text->use() && !always && !text->burn()) {
+               Text (from.first, type, DCPTimePeriod (from.second, dcp_to));
        }
 }
 
 void
 Player::seek (DCPTime time, bool accurate)
 {
+       boost::mutex::scoped_lock lm (_mutex);
+
        if (!_have_valid_pieces) {
                setup_pieces ();
        }
@@ -952,7 +1035,7 @@ Player::seek (DCPTime time, bool accurate)
 
        _audio_merger.clear ();
        for (int i = 0; i < TEXT_COUNT; ++i) {
-               _active_text[i].clear ();
+               _active_texts[i].clear ();
        }
 
        BOOST_FOREACH (shared_ptr<Piece> i, _pieces) {
@@ -1013,13 +1096,13 @@ Player::do_emit_video (shared_ptr<PlayerVideo> pv, DCPTime time)
 {
        if (pv->eyes() == EYES_BOTH || pv->eyes() == EYES_RIGHT) {
                for (int i = 0; i < TEXT_COUNT; ++i) {
-                       _active_text[i].clear_before (time);
+                       _active_texts[i].clear_before (time);
                }
        }
 
-       optional<PositionImage> subtitles = subtitles_for_frame (time);
+       optional<PositionImage> subtitles = open_subtitles_for_frame (time);
        if (subtitles) {
-               pv->set_subtitle (subtitles.get ());
+               pv->set_text (subtitles.get ());
        }
 
        Video (pv, time);
@@ -1084,18 +1167,25 @@ Player::discard_audio (shared_ptr<const AudioBuffers> audio, DCPTime time, DCPTi
 void
 Player::set_dcp_decode_reduction (optional<int> reduction)
 {
-       if (reduction == _dcp_decode_reduction) {
-               return;
+       {
+               boost::mutex::scoped_lock lm (_mutex);
+
+               if (reduction == _dcp_decode_reduction) {
+                       return;
+               }
+
+               _dcp_decode_reduction = reduction;
+               _have_valid_pieces = false;
        }
 
-       _dcp_decode_reduction = reduction;
-       _have_valid_pieces = false;
        Changed (PlayerProperty::DCP_DECODE_REDUCTION, false);
 }
 
 DCPTime
 Player::content_time_to_dcp (shared_ptr<Content> content, ContentTime t)
 {
+       boost::mutex::scoped_lock lm (_mutex);
+
        if (_have_valid_pieces) {
                setup_pieces ();
        }