Basics of multiple captions per content so that DCPContent can
[dcpomatic.git] / src / lib / player.cc
index 92e8141e14460d4cb17769a3aa3f13186f73d05e..580c3e6d43946230e85ac3001f42ce7bb9f24555 100644 (file)
 #include "decoder.h"
 #include "video_decoder.h"
 #include "audio_decoder.h"
-#include "text_content.h"
-#include "text_decoder.h"
+#include "caption_content.h"
+#include "caption_decoder.h"
 #include "ffmpeg_content.h"
 #include "audio_content.h"
-#include "content_subtitle.h"
 #include "dcp_decoder.h"
 #include "image_decoder.h"
 #include "compose.hpp"
@@ -53,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>
@@ -89,8 +89,7 @@ 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_caption (false)
        , _fast (false)
        , _play_referenced (false)
        , _audio_merger (_film->audio_frame_rate())
@@ -138,8 +137,10 @@ Player::setup_pieces ()
                        decoder->video->set_ignore (true);
                }
 
-               if (decoder->subtitle && _ignore_subtitle) {
-                       decoder->subtitle->set_ignore (true);
+               if (_ignore_caption) {
+                       BOOST_FOREACH (shared_ptr<CaptionDecoder> i, decoder->caption) {
+                               i->set_ignore (true);
+                       }
                }
 
                shared_ptr<DCPDecoder> dcp = dynamic_pointer_cast<DCPDecoder> (decoder);
@@ -166,10 +167,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));
+               list<shared_ptr<CaptionDecoder> >::const_iterator j = decoder->caption.begin();
+
+               while (j != decoder->caption.end()) {
+                       (*j)->BitmapStart.connect (
+                               bind(&Player::bitmap_text_start, this, weak_ptr<Piece>(piece), weak_ptr<const CaptionContent>((*j)->content()), _1)
+                               );
+                       (*j)->PlainStart.connect (
+                               bind(&Player::plain_text_start, this, weak_ptr<Piece>(piece), weak_ptr<const CaptionContent>((*j)->content()), _1)
+                               );
+                       (*j)->Stop.connect (
+                               bind(&Player::subtitle_stop, this, weak_ptr<Piece>(piece), weak_ptr<const CaptionContent>((*j)->content()), _1, _2)
+                               );
+
+                       ++j;
                }
        }
 
@@ -210,9 +221,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 == TextContentProperty::COLOUR ||
-               property == TextContentProperty::EFFECT ||
-               property == TextContentProperty::EFFECT_COLOUR ||
+               property == CaptionContentProperty::COLOUR ||
+               property == CaptionContentProperty::EFFECT ||
+               property == CaptionContentProperty::EFFECT_COLOUR ||
                property == FFmpegContentProperty::SUBTITLE_STREAM ||
                property == FFmpegContentProperty::FILTERS
                ) {
@@ -221,17 +232,18 @@ Player::playlist_content_changed (weak_ptr<Content> w, int property, bool freque
                Changed (property, frequent);
 
        } else if (
-               property == TextContentProperty::LINE_SPACING ||
-               property == TextContentProperty::OUTLINE_WIDTH ||
-               property == TextContentProperty::Y_SCALE ||
-               property == TextContentProperty::FADE_IN ||
-               property == TextContentProperty::FADE_OUT ||
+               property == CaptionContentProperty::LINE_SPACING ||
+               property == CaptionContentProperty::OUTLINE_WIDTH ||
+               property == CaptionContentProperty::Y_SCALE ||
+               property == CaptionContentProperty::FADE_IN ||
+               property == CaptionContentProperty::FADE_OUT ||
                property == ContentProperty::VIDEO_FRAME_RATE ||
-               property == TextContentProperty::USE ||
-               property == TextContentProperty::X_OFFSET ||
-               property == TextContentProperty::Y_OFFSET ||
-               property == TextContentProperty::X_SCALE ||
-               property == TextContentProperty::FONTS ||
+               property == CaptionContentProperty::USE ||
+               property == CaptionContentProperty::X_OFFSET ||
+               property == CaptionContentProperty::Y_OFFSET ||
+               property == CaptionContentProperty::X_SCALE ||
+               property == CaptionContentProperty::FONTS ||
+               property == CaptionContentProperty::TYPE ||
                property == VideoContentProperty::CROP ||
                property == VideoContentProperty::SCALE ||
                property == VideoContentProperty::FADE_IN ||
@@ -290,11 +302,11 @@ Player::film_changed (Film::Property p)
 }
 
 list<PositionImage>
-Player::transform_bitmap_texts (list<BitmapText> subs) const
+Player::transform_bitmap_captions (list<BitmapCaption> subs) const
 {
        list<PositionImage> all;
 
-       for (list<BitmapText>::const_iterator i = subs.begin(); i != subs.end(); ++i) {
+       for (list<BitmapCaption>::const_iterator i = subs.begin(); i != subs.end(); ++i) {
                if (!i->image) {
                        continue;
                }
@@ -406,12 +418,12 @@ Player::get_subtitle_fonts ()
        }
 
        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<CaptionContent> j, i->content->caption) {
                        /* 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));
                }
        }
@@ -427,19 +439,19 @@ Player::set_ignore_video ()
 }
 
 void
-Player::set_ignore_subtitle ()
+Player::set_ignore_caption ()
 {
-       _ignore_subtitle = true;
+       _ignore_caption = true;
 }
 
-/** Set whether or not this player should always burn text subtitles into the image,
+/** Set a type of caption that this player should always burn into the image,
  *  regardless of the content settings.
- *  @param burn true to always burn subtitles, false to obey content settings.
+ *  @param type type of captions to burn.
  */
 void
-Player::set_always_burn_subtitles (bool burn)
+Player::set_always_burn_captions (CaptionType type)
 {
-       _always_burn_subtitles = burn;
+       _always_burn_captions = type;
 }
 
 /** Sets up the player to be faster, possibly at the expense of quality */
@@ -505,7 +517,7 @@ Player::get_reel_assets ()
                                        );
                        }
 
-                       if (j->reference_subtitle ()) {
+                       if (j->reference_caption (CAPTION_OPEN)) {
                                shared_ptr<dcp::ReelAsset> ra = k->main_subtitle ();
                                DCPOMATIC_ASSERT (ra);
                                ra->set_entry_point (ra->entry_point() + trim_start);
@@ -515,6 +527,16 @@ Player::get_reel_assets ()
                                        );
                        }
 
+                       if (j->reference_caption (CAPTION_CLOSED)) {
+                               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 ();
                }
@@ -551,10 +573,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 captions 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->caption.empty())) {
                                earliest_time = t;
                                earliest_content = i;
                        }
@@ -658,30 +680,36 @@ Player::pass ()
 }
 
 optional<PositionImage>
-Player::subtitles_for_frame (DCPTime time) const
+Player::captions_for_frame (DCPTime time) const
 {
-       list<PositionImage> subtitles;
+       list<PositionImage> captions;
 
        int const vfr = _film->video_frame_rate();
 
-       BOOST_FOREACH (PlayerSubtitles i, _active_subtitles.get_burnt (DCPTimePeriod(time, time + DCPTime::from_frames(1, vfr)), _always_burn_subtitles)) {
-
-               /* Image subtitles */
-               list<PositionImage> c = transform_bitmap_texts (i.image);
-               copy (c.begin(), c.end(), back_inserter (subtitles));
-
-               /* 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));
+       for (int i = 0; i < CAPTION_COUNT; ++i) {
+               bool const always = _always_burn_captions && *_always_burn_captions == i;
+               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));
+                       }
                }
        }
 
-       if (subtitles.empty ()) {
+       if (captions.empty ()) {
                return optional<PositionImage> ();
        }
 
-       return merge (subtitles);
+       return merge (captions);
 }
 
 void
@@ -840,41 +868,43 @@ 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 CaptionContent> wc, ContentBitmapCaption subtitle)
 {
        shared_ptr<Piece> piece = wp.lock ();
-       if (!piece) {
+       shared_ptr<const CaptionContent> caption = wc.lock ();
+       if (!piece || !caption) {
                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 += caption->x_offset ();
+       subtitle.sub.rectangle.y += caption->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 * ((caption->x_scale() - 1) / 2);
+       subtitle.sub.rectangle.y -= subtitle.sub.rectangle.height * ((caption->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 *= caption->x_scale ();
+       subtitle.sub.rectangle.height *= caption->y_scale ();
 
-       PlayerSubtitles ps;
+       PlayerCaption ps;
        ps.image.push_back (subtitle.sub);
        DCPTime from (content_time_to_dcp (piece, subtitle.from()));
 
-       _active_subtitles.add_from (wp, ps, from);
+       _active_captions[subtitle.type()].add_from (wc, ps, from);
 }
 
 void
-Player::plain_text_start (weak_ptr<Piece> wp, ContentTextSubtitle subtitle)
+Player::plain_text_start (weak_ptr<Piece> wp, weak_ptr<const CaptionContent> wc, ContentTextCaption subtitle)
 {
        shared_ptr<Piece> piece = wp.lock ();
-       if (!piece) {
+       shared_ptr<const CaptionContent> caption = wc.lock ();
+       if (!piece || !caption) {
                return;
        }
 
-       PlayerSubtitles ps;
+       PlayerCaption ps;
        DCPTime const from (content_time_to_dcp (piece, subtitle.from()));
 
        if (from > piece->content->end()) {
@@ -882,10 +912,10 @@ Player::plain_text_start (weak_ptr<Piece> wp, ContentTextSubtitle 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() + 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();
                float size = s.size();
 
                /* Adjust size to express the common part of the scaling;
@@ -902,22 +932,23 @@ Player::plain_text_start (weak_ptr<Piece> wp, ContentTextSubtitle subtitle)
                }
 
                s.set_in (dcp::Time(from.seconds(), 1000));
-               ps.text.push_back (SubtitleString (s, piece->content->subtitle->outline_width()));
-               ps.add_fonts (piece->content->subtitle->fonts ());
+               ps.text.push_back (TextCaption (s, caption->outline_width()));
+               ps.add_fonts (caption->fonts ());
        }
 
-       _active_subtitles.add_from (wp, ps, from);
+       _active_captions[subtitle.type()].add_from (wc, ps, from);
 }
 
 void
-Player::subtitle_stop (weak_ptr<Piece> wp, ContentTime to)
+Player::subtitle_stop (weak_ptr<Piece> wp, weak_ptr<const CaptionContent> wc, ContentTime to, CaptionType type)
 {
-       if (!_active_subtitles.have (wp)) {
+       if (!_active_captions[type].have (wc)) {
                return;
        }
 
        shared_ptr<Piece> piece = wp.lock ();
-       if (!piece) {
+       shared_ptr<const CaptionContent> caption = wc.lock ();
+       if (!piece || !caption) {
                return;
        }
 
@@ -927,10 +958,11 @@ Player::subtitle_stop (weak_ptr<Piece> wp, ContentTime to)
                return;
        }
 
-       pair<PlayerSubtitles, DCPTime> from = _active_subtitles.add_to (wp, dcp_to);
+       pair<PlayerCaption, DCPTime> from = _active_captions[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 = _always_burn_captions && *_always_burn_captions == type;
+       if (caption->use() && !always && !caption->burn()) {
+               Caption (from.first, type, DCPTimePeriod (from.second, dcp_to));
        }
 }
 
@@ -952,7 +984,9 @@ Player::seek (DCPTime time, bool accurate)
        }
 
        _audio_merger.clear ();
-       _active_subtitles.clear ();
+       for (int i = 0; i < CAPTION_COUNT; ++i) {
+               _active_captions[i].clear ();
+       }
 
        BOOST_FOREACH (shared_ptr<Piece> i, _pieces) {
                if (time < i->content->position()) {
@@ -1011,12 +1045,14 @@ void
 Player::do_emit_video (shared_ptr<PlayerVideo> pv, DCPTime time)
 {
        if (pv->eyes() == EYES_BOTH || pv->eyes() == EYES_RIGHT) {
-               _active_subtitles.clear_before (time);
+               for (int i = 0; i < CAPTION_COUNT; ++i) {
+                       _active_captions[i].clear_before (time);
+               }
        }
 
-       optional<PositionImage> subtitles = subtitles_for_frame (time);
-       if (subtitles) {
-               pv->set_subtitle (subtitles.get ());
+       optional<PositionImage> captions = captions_for_frame (time);
+       if (captions) {
+               pv->set_caption (captions.get ());
        }
 
        Video (pv, time);