Protect the public API of Player with a mutex, since
[dcpomatic.git] / src / lib / player.cc
index dfd3097745b8a15d58322149be6a394e01e26906..f8471c752cb1838ad5841af2eb068d04acc8b96c 100644 (file)
@@ -40,8 +40,8 @@
 #include "decoder.h"
 #include "video_decoder.h"
 #include "audio_decoder.h"
-#include "caption_content.h"
-#include "caption_decoder.h"
+#include "text_content.h"
+#include "text_decoder.h"
 #include "ffmpeg_content.h"
 #include "audio_content.h"
 #include "dcp_decoder.h"
@@ -89,7 +89,8 @@ Player::Player (shared_ptr<const Film> film, shared_ptr<const Playlist> playlist
        , _playlist (playlist)
        , _have_valid_pieces (false)
        , _ignore_video (false)
-       , _ignore_caption (false)
+       , _ignore_text (false)
+       , _always_burn_open_subtitles (false)
        , _fast (false)
        , _play_referenced (false)
        , _audio_merger (_film->audio_frame_rate())
@@ -137,8 +138,8 @@ Player::setup_pieces ()
                        decoder->video->set_ignore (true);
                }
 
-               if (_ignore_caption) {
-                       BOOST_FOREACH (shared_ptr<CaptionDecoder> i, decoder->caption) {
+               if (_ignore_text) {
+                       BOOST_FOREACH (shared_ptr<TextDecoder> i, decoder->text) {
                                i->set_ignore (true);
                        }
                }
@@ -167,17 +168,17 @@ Player::setup_pieces ()
                        decoder->audio->Data.connect (bind (&Player::audio, this, weak_ptr<Piece> (piece), _1, _2));
                }
 
-               list<shared_ptr<CaptionDecoder> >::const_iterator j = decoder->caption.begin();
+               list<shared_ptr<TextDecoder> >::const_iterator j = decoder->text.begin();
 
-               while (j != decoder->caption.end()) {
+               while (j != decoder->text.end()) {
                        (*j)->BitmapStart.connect (
-                               bind(&Player::bitmap_text_start, this, weak_ptr<Piece>(piece), weak_ptr<const CaptionContent>((*j)->content()), _1)
+                               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 CaptionContent>((*j)->content()), _1)
+                               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 CaptionContent>((*j)->content()), _1, _2)
+                               bind(&Player::subtitle_stop, this, weak_ptr<Piece>(piece), weak_ptr<const TextContent>((*j)->content()), _1, _2)
                                );
 
                        ++j;
@@ -221,9 +222,9 @@ Player::playlist_content_changed (weak_ptr<Content> w, int property, bool freque
                property == AudioContentProperty::STREAMS ||
                property == DCPContentProperty::NEEDS_ASSETS ||
                property == DCPContentProperty::NEEDS_KDM ||
-               property == CaptionContentProperty::COLOUR ||
-               property == CaptionContentProperty::EFFECT ||
-               property == CaptionContentProperty::EFFECT_COLOUR ||
+               property == TextContentProperty::COLOUR ||
+               property == TextContentProperty::EFFECT ||
+               property == TextContentProperty::EFFECT_COLOUR ||
                property == FFmpegContentProperty::SUBTITLE_STREAM ||
                property == FFmpegContentProperty::FILTERS
                ) {
@@ -232,18 +233,18 @@ Player::playlist_content_changed (weak_ptr<Content> w, int property, bool freque
                Changed (property, frequent);
 
        } else if (
-               property == CaptionContentProperty::LINE_SPACING ||
-               property == CaptionContentProperty::OUTLINE_WIDTH ||
-               property == CaptionContentProperty::Y_SCALE ||
-               property == CaptionContentProperty::FADE_IN ||
-               property == CaptionContentProperty::FADE_OUT ||
+               property == TextContentProperty::LINE_SPACING ||
+               property == TextContentProperty::OUTLINE_WIDTH ||
+               property == TextContentProperty::Y_SCALE ||
+               property == TextContentProperty::FADE_IN ||
+               property == TextContentProperty::FADE_OUT ||
                property == ContentProperty::VIDEO_FRAME_RATE ||
-               property == CaptionContentProperty::USE ||
-               property == CaptionContentProperty::X_OFFSET ||
-               property == CaptionContentProperty::Y_OFFSET ||
-               property == CaptionContentProperty::X_SCALE ||
-               property == CaptionContentProperty::FONTS ||
-               property == CaptionContentProperty::TYPE ||
+               property == TextContentProperty::USE ||
+               property == TextContentProperty::X_OFFSET ||
+               property == TextContentProperty::Y_OFFSET ||
+               property == TextContentProperty::X_SCALE ||
+               property == TextContentProperty::FONTS ||
+               property == TextContentProperty::TYPE ||
                property == VideoContentProperty::CROP ||
                property == VideoContentProperty::SCALE ||
                property == VideoContentProperty::FADE_IN ||
@@ -257,14 +258,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);
 }
@@ -302,11 +307,11 @@ Player::film_changed (Film::Property p)
 }
 
 list<PositionImage>
-Player::transform_bitmap_captions (list<BitmapCaption> subs) const
+Player::transform_bitmap_texts (list<BitmapText> subs) const
 {
        list<PositionImage> all;
 
-       for (list<BitmapCaption>::const_iterator i = subs.begin(); i != subs.end(); ++i) {
+       for (list<BitmapText>::const_iterator i = subs.begin(); i != subs.end(); ++i) {
                if (!i->image) {
                        continue;
                }
@@ -413,13 +418,15 @@ 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> i, _pieces) {
-               BOOST_FOREACH (shared_ptr<CaptionContent> j, i->content->caption) {
+               BOOST_FOREACH (shared_ptr<TextContent> j, i->content->text) {
                        /* XXX: things may go wrong if there are duplicate font IDs
                           with different font files.
                        */
@@ -435,26 +442,30 @@ Player::get_subtitle_fonts ()
 void
 Player::set_ignore_video ()
 {
+       boost::mutex::scoped_lock lm (_mutex);
        _ignore_video = true;
 }
 
 void
-Player::set_ignore_caption ()
+Player::set_ignore_text ()
 {
-       _ignore_caption = true;
+       boost::mutex::scoped_lock lm (_mutex);
+       _ignore_text = true;
 }
 
-/** Set the player to always burn open captions into the image regardless of the content settings */
+/** Set the player to always burn open texts into the image regardless of the content settings */
 void
-Player::set_always_burn_open_captions ()
+Player::set_always_burn_open_subtitles ()
 {
-       _always_burn_open_captions = true;
+       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;
 }
@@ -462,6 +473,7 @@ Player::set_fast ()
 void
 Player::set_play_referenced ()
 {
+       boost::mutex::scoped_lock lm (_mutex);
        _play_referenced = true;
        _have_valid_pieces = false;
 }
@@ -469,6 +481,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 ()) {
@@ -514,7 +528,7 @@ Player::get_reel_assets ()
                                        );
                        }
 
-                       if (j->reference_caption (CAPTION_OPEN)) {
+                       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);
@@ -524,7 +538,7 @@ Player::get_reel_assets ()
                                        );
                        }
 
-                       if (j->reference_caption (CAPTION_CLOSED)) {
+                       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);
@@ -545,6 +559,8 @@ Player::get_reel_assets ()
 bool
 Player::pass ()
 {
+       boost::mutex::scoped_lock lm (_mutex);
+
        if (!_have_valid_pieces) {
                setup_pieces ();
        }
@@ -570,10 +586,10 @@ Player::pass ()
                        i->done = true;
                } else {
 
-                       /* Given two choices at the same time, pick the one with captions 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->caption.empty())) {
+                       if (!earliest_time || t < *earliest_time || (t == *earliest_time && !i->decoder->text.empty())) {
                                earliest_time = t;
                                earliest_content = i;
                        }
@@ -676,29 +692,35 @@ Player::pass ()
        return done;
 }
 
+list<PlayerText>
+Player::closed_captions_for_frame (DCPTime time) const
+{
+       boost::mutex::scoped_lock _lm (_mutex);
+       return _active_texts[TEXT_CLOSED_CAPTION].get (
+               DCPTimePeriod(time, time + DCPTime::from_frames(1, _film->video_frame_rate()))
+               );
+}
+
+/** @return Open subtitles for the frame at the given time, converted to images */
 optional<PositionImage>
-Player::captions_for_frame (DCPTime time) const
+Player::open_subtitles_for_frame (DCPTime time) const
 {
        list<PositionImage> captions;
-
        int const vfr = _film->video_frame_rate();
 
-       for (int i = 0; i < CAPTION_COUNT; ++i) {
-               bool const always = i == CAPTION_OPEN && _always_burn_open_captions;
-               BOOST_FOREACH (
-                       PlayerCaption j,
-                       _active_captions[i].get_burnt(DCPTimePeriod(time, time + DCPTime::from_frames(1, vfr)), always)
-                       ) {
-
-                       /* Image subtitles */
-                       list<PositionImage> c = transform_bitmap_captions (j.image);
-                       copy (c.begin(), c.end(), back_inserter (captions));
-
-                       /* Text subtitles (rendered to an image) */
-                       if (!j.text.empty ()) {
-                               list<PositionImage> s = render_text (j.text, j.fonts, _video_container_size, time, vfr);
-                               copy (s.begin(), s.end(), back_inserter (captions));
-                       }
+       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 (j.image);
+               copy (c.begin(), c.end(), back_inserter (captions));
+
+               /* Text subtitles (rendered to an image) */
+               if (!j.text.empty ()) {
+                       list<PositionImage> s = render_text (j.text, j.fonts, _video_container_size, time, vfr);
+                       copy (s.begin(), s.end(), back_inserter (captions));
                }
        }
 
@@ -865,43 +887,43 @@ Player::audio (weak_ptr<Piece> wp, AudioStreamPtr stream, ContentAudio content_a
 }
 
 void
-Player::bitmap_text_start (weak_ptr<Piece> wp, weak_ptr<const CaptionContent> wc, ContentBitmapCaption subtitle)
+Player::bitmap_text_start (weak_ptr<Piece> wp, weak_ptr<const TextContent> wc, ContentBitmapText subtitle)
 {
        shared_ptr<Piece> piece = wp.lock ();
-       shared_ptr<const CaptionContent> caption = wc.lock ();
-       if (!piece || !caption) {
+       shared_ptr<const TextContent> text = wc.lock ();
+       if (!piece || !text) {
                return;
        }
 
        /* Apply content's subtitle offsets */
-       subtitle.sub.rectangle.x += caption->x_offset ();
-       subtitle.sub.rectangle.y += caption->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 * ((caption->x_scale() - 1) / 2);
-       subtitle.sub.rectangle.y -= subtitle.sub.rectangle.height * ((caption->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 *= caption->x_scale ();
-       subtitle.sub.rectangle.height *= caption->y_scale ();
+       subtitle.sub.rectangle.width *= text->x_scale ();
+       subtitle.sub.rectangle.height *= text->y_scale ();
 
-       PlayerCaption ps;
+       PlayerText ps;
        ps.image.push_back (subtitle.sub);
        DCPTime from (content_time_to_dcp (piece, subtitle.from()));
 
-       _active_captions[subtitle.type()].add_from (wc, ps, from);
+       _active_texts[subtitle.type()].add_from (wc, ps, from);
 }
 
 void
-Player::plain_text_start (weak_ptr<Piece> wp, weak_ptr<const CaptionContent> wc, ContentTextCaption subtitle)
+Player::plain_text_start (weak_ptr<Piece> wp, weak_ptr<const TextContent> wc, ContentStringText subtitle)
 {
        shared_ptr<Piece> piece = wp.lock ();
-       shared_ptr<const CaptionContent> caption = wc.lock ();
-       if (!piece || !caption) {
+       shared_ptr<const TextContent> text = wc.lock ();
+       if (!piece || !text) {
                return;
        }
 
-       PlayerCaption ps;
+       PlayerText ps;
        DCPTime const from (content_time_to_dcp (piece, subtitle.from()));
 
        if (from > piece->content->end()) {
@@ -909,10 +931,10 @@ Player::plain_text_start (weak_ptr<Piece> wp, weak_ptr<const CaptionContent> wc,
        }
 
        BOOST_FOREACH (dcp::SubtitleString s, subtitle.subs) {
-               s.set_h_position (s.h_position() + caption->x_offset ());
-               s.set_v_position (s.v_position() + caption->y_offset ());
-               float const xs = caption->x_scale();
-               float const ys = caption->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;
@@ -929,23 +951,23 @@ Player::plain_text_start (weak_ptr<Piece> wp, weak_ptr<const CaptionContent> wc,
                }
 
                s.set_in (dcp::Time(from.seconds(), 1000));
-               ps.text.push_back (TextCaption (s, caption->outline_width()));
-               ps.add_fonts (caption->fonts ());
+               ps.text.push_back (StringText (s, text->outline_width()));
+               ps.add_fonts (text->fonts ());
        }
 
-       _active_captions[subtitle.type()].add_from (wc, ps, from);
+       _active_texts[subtitle.type()].add_from (wc, ps, from);
 }
 
 void
-Player::subtitle_stop (weak_ptr<Piece> wp, weak_ptr<const CaptionContent> wc, ContentTime to, CaptionType type)
+Player::subtitle_stop (weak_ptr<Piece> wp, weak_ptr<const TextContent> wc, ContentTime to, TextType type)
 {
-       if (!_active_captions[type].have (wc)) {
+       if (!_active_texts[type].have (wc)) {
                return;
        }
 
        shared_ptr<Piece> piece = wp.lock ();
-       shared_ptr<const CaptionContent> caption = wc.lock ();
-       if (!piece || !caption) {
+       shared_ptr<const TextContent> text = wc.lock ();
+       if (!piece || !text) {
                return;
        }
 
@@ -955,17 +977,19 @@ Player::subtitle_stop (weak_ptr<Piece> wp, weak_ptr<const CaptionContent> wc, Co
                return;
        }
 
-       pair<PlayerCaption, DCPTime> from = _active_captions[type].add_to (wc, dcp_to);
+       pair<PlayerText, DCPTime> from = _active_texts[type].add_to (wc, dcp_to);
 
-       bool const always = type == CAPTION_OPEN && _always_burn_open_captions;
-       if (caption->use() && !always && !caption->burn()) {
-               Caption (from.first, type, 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 ();
        }
@@ -981,8 +1005,8 @@ Player::seek (DCPTime time, bool accurate)
        }
 
        _audio_merger.clear ();
-       for (int i = 0; i < CAPTION_COUNT; ++i) {
-               _active_captions[i].clear ();
+       for (int i = 0; i < TEXT_COUNT; ++i) {
+               _active_texts[i].clear ();
        }
 
        BOOST_FOREACH (shared_ptr<Piece> i, _pieces) {
@@ -1042,14 +1066,14 @@ void
 Player::do_emit_video (shared_ptr<PlayerVideo> pv, DCPTime time)
 {
        if (pv->eyes() == EYES_BOTH || pv->eyes() == EYES_RIGHT) {
-               for (int i = 0; i < CAPTION_COUNT; ++i) {
-                       _active_captions[i].clear_before (time);
+               for (int i = 0; i < TEXT_COUNT; ++i) {
+                       _active_texts[i].clear_before (time);
                }
        }
 
-       optional<PositionImage> captions = captions_for_frame (time);
-       if (captions) {
-               pv->set_caption (captions.get ());
+       optional<PositionImage> subtitles = open_subtitles_for_frame (time);
+       if (subtitles) {
+               pv->set_text (subtitles.get ());
        }
 
        Video (pv, time);
@@ -1114,18 +1138,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 ();
        }