Make player decide whether subtitles should be burnt based on
[dcpomatic.git] / src / lib / player.cc
index 215b48ee444f83c9025d29e08c05890958425996..361f41c92cf07263a083bdd872136cfb68e4ce3c 100644 (file)
@@ -30,7 +30,6 @@
 #include "subrip_decoder.h"
 #include "subrip_content.h"
 #include "dcp_content.h"
-#include "playlist.h"
 #include "job.h"
 #include "image.h"
 #include "raw_image_proxy.h"
@@ -69,15 +68,13 @@ using boost::weak_ptr;
 using boost::dynamic_pointer_cast;
 using boost::optional;
 
-Player::Player (shared_ptr<const Film> f, shared_ptr<const Playlist> p)
-       : _film (f)
-       , _playlist (p)
+Player::Player (shared_ptr<const Film> film)
+       : _film (film)
        , _have_valid_pieces (false)
        , _ignore_video (false)
-       , _burn_subtitles (f->burn_subtitles ())
+       , _always_burn_subtitles (false)
 {
-       _playlist_changed_connection = _playlist->Changed.connect (bind (&Player::playlist_changed, this));
-       _playlist_content_changed_connection = _playlist->ContentChanged.connect (bind (&Player::content_changed, this, _1, _2, _3));
+       _film_content_changed_connection = _film->ContentChanged.connect (bind (&Player::content_changed, this, _1, _2, _3));
        _film_changed_connection = _film->Changed.connect (bind (&Player::film_changed, this, _1));
        set_video_container_size (_film->frame_size ());
 
@@ -90,14 +87,14 @@ Player::setup_pieces ()
        list<shared_ptr<Piece> > old_pieces = _pieces;
        _pieces.clear ();
 
-       ContentList content = _playlist->content ();
+       ContentList content = _film->content ();
 
        for (ContentList::iterator i = content.begin(); i != content.end(); ++i) {
 
                if (!(*i)->paths_valid ()) {
                        continue;
                }
-               
+
                shared_ptr<Decoder> decoder;
                optional<FrameRateChange> frc;
 
@@ -109,7 +106,7 @@ Player::setup_pieces ()
                        if (!vc) {
                                continue;
                        }
-                       
+
                        DCPTime const overlap = max (vc->position(), (*i)->position()) - min (vc->end(), (*i)->end());
                        if (overlap > best_overlap_t) {
                                best_overlap = vc;
@@ -205,7 +202,7 @@ Player::content_changed (weak_ptr<Content> w, int property, bool frequent)
                property == VideoContentProperty::VIDEO_FRAME_TYPE ||
                property == DCPContentProperty::CAN_BE_PLAYED
                ) {
-               
+
                _have_valid_pieces = false;
                Changed (frequent);
 
@@ -221,18 +218,11 @@ Player::content_changed (weak_ptr<Content> w, int property, bool frequent)
                property == VideoContentProperty::VIDEO_FADE_IN ||
                property == VideoContentProperty::VIDEO_FADE_OUT
                ) {
-               
+
                Changed (frequent);
        }
 }
 
-void
-Player::playlist_changed ()
-{
-       _have_valid_pieces = false;
-       Changed (false);
-}
-
 void
 Player::set_video_container_size (dcp::Size s)
 {
@@ -250,7 +240,10 @@ Player::film_changed (Film::Property p)
           last time we were run.
        */
 
-       if (p == Film::CONTAINER || p == Film::VIDEO_FRAME_RATE) {
+       if (p == Film::CONTENT) {
+               _have_valid_pieces = false;
+               Changed (false);
+       } else if (p == Film::CONTAINER || p == Film::VIDEO_FRAME_RATE) {
                Changed (false);
        } else if (p == Film::AUDIO_PROCESSOR) {
                if (_film->audio_processor ()) {
@@ -263,7 +256,7 @@ list<PositionImage>
 Player::transform_image_subtitles (list<ImageSubtitle> subs) const
 {
        list<PositionImage> all;
-       
+
        for (list<ImageSubtitle>::const_iterator i = subs.begin(); i != subs.end(); ++i) {
                if (!i->image) {
                        continue;
@@ -271,7 +264,7 @@ Player::transform_image_subtitles (list<ImageSubtitle> subs) const
 
                /* We will scale the subtitle up to fit _video_container_size */
                dcp::Size scaled_size (i->rectangle.width * _video_container_size.width, i->rectangle.height * _video_container_size.height);
-               
+
                /* Then we need a corrective translation, consisting of two parts:
                 *
                 * 1.  that which is the result of the scaling of the subtitle by _video_container_size; this will be
@@ -329,9 +322,32 @@ Player::get_video (DCPTime time, bool accurate)
                setup_pieces ();
        }
 
+       /* Find subtitles for possible burn-in */
+
+       PlayerSubtitles ps = get_subtitles (time, DCPTime::from_frames (1, _film->video_frame_rate ()), false, true);
+
+       list<PositionImage> sub_images;
+
+       /* Image subtitles */
+       list<PositionImage> c = transform_image_subtitles (ps.image);
+       copy (c.begin(), c.end(), back_inserter (sub_images));
+
+       /* Text subtitles (rendered to an image) */
+       if (!ps.text.empty ()) {
+               list<PositionImage> s = render_subtitles (ps.text, _video_container_size);
+               copy (s.begin (), s.end (), back_inserter (sub_images));
+       }
+
+       optional<PositionImage> subtitles;
+       if (!sub_images.empty ()) {
+               subtitles = merge (sub_images);
+       }
+
+       /* Find video */
+
        list<shared_ptr<Piece> > ov = overlaps<VideoContent> (
                time,
-               time + DCPTime::from_frames (1, _film->video_frame_rate ())
+               time + DCPTime::from_frames (1, _film->video_frame_rate ()) - DCPTime::delta()
                );
 
        list<shared_ptr<PlayerVideo> > pvf;
@@ -345,16 +361,16 @@ Player::get_video (DCPTime time, bool accurate)
                shared_ptr<Piece> piece = ov.back ();
                shared_ptr<VideoDecoder> decoder = dynamic_pointer_cast<VideoDecoder> (piece->decoder);
                DCPOMATIC_ASSERT (decoder);
-               shared_ptr<VideoContent> content = dynamic_pointer_cast<VideoContent> (piece->content);
-               DCPOMATIC_ASSERT (content);
+               shared_ptr<VideoContent> video_content = dynamic_pointer_cast<VideoContent> (piece->content);
+               DCPOMATIC_ASSERT (video_content);
 
                list<ContentVideo> content_video = decoder->get_video (dcp_to_content_video (piece, time), accurate);
                if (content_video.empty ()) {
                        pvf.push_back (black_player_video_frame (time));
                        return pvf;
                }
-               
-               dcp::Size image_size = content->scale().size (content, _video_container_size, _film->frame_size ());
+
+               dcp::Size image_size = video_content->scale().size (video_content, _video_container_size, _film->frame_size ());
 
                for (list<ContentVideo>::const_iterator i = content_video.begin(); i != content_video.end(); ++i) {
                        pvf.push_back (
@@ -362,41 +378,25 @@ Player::get_video (DCPTime time, bool accurate)
                                        new PlayerVideo (
                                                i->image,
                                                content_video_to_dcp (piece, i->frame),
-                                               content->crop (),
-                                               content->fade (i->frame),
+                                               video_content->crop (),
+                                               video_content->fade (i->frame),
                                                image_size,
                                                _video_container_size,
                                                i->eyes,
                                                i->part,
-                                               content->colour_conversion ()
+                                               video_content->colour_conversion ()
                                                )
                                        )
                                );
                }
        }
 
-       /* Add subtitles (for possible burn-in) to whatever PlayerVideos we got */
-
-       PlayerSubtitles ps = get_subtitles (time, DCPTime::from_frames (1, _film->video_frame_rate ()), false);
-
-       list<PositionImage> sub_images;
-
-       /* Image subtitles */
-       list<PositionImage> c = transform_image_subtitles (ps.image);
-       copy (c.begin(), c.end(), back_inserter (sub_images));
-
-       /* Text subtitles (rendered to an image) */
-       if (_burn_subtitles && !ps.text.empty ()) {
-               list<PositionImage> s = render_subtitles (ps.text, _video_container_size);
-               copy (s.begin (), s.end (), back_inserter (sub_images));
+       if (subtitles) {
+               BOOST_FOREACH (shared_ptr<PlayerVideo> p, pvf) {
+                       p->set_subtitle (subtitles.get ());
+               }
        }
 
-       if (!sub_images.empty ()) {
-               for (list<shared_ptr<PlayerVideo> >::const_iterator i = pvf.begin(); i != pvf.end(); ++i) {
-                       (*i)->set_subtitle (merge (sub_images));
-               }
-       }       
-               
        return pvf;
 }
 
@@ -411,7 +411,7 @@ Player::get_audio (DCPTime time, DCPTime length, bool accurate)
 
        shared_ptr<AudioBuffers> audio (new AudioBuffers (_film->audio_channels(), length_frames));
        audio->make_silent ();
-       
+
        list<shared_ptr<Piece> > ov = overlaps<AudioContent> (time, time + length);
        if (ov.empty ()) {
                return audio;
@@ -443,7 +443,7 @@ Player::get_audio (DCPTime time, DCPTime length, bool accurate)
                Frame const content_frame = dcp_to_content_audio (*i, request);
 
                BOOST_FOREACH (AudioStreamPtr j, content->audio_streams ()) {
-                       
+
                        /* Audio from this piece's decoder stream (which might be more or less than what we asked for) */
                        ContentAudio all = decoder->get_audio (j, content_frame, request_frames, accurate);
 
@@ -474,7 +474,7 @@ Player::get_audio (DCPTime time, DCPTime length, bool accurate)
                        if (_audio_processor) {
                                dcp_mapped = _audio_processor->run (dcp_mapped);
                        }
-               
+
                        all.audio = dcp_mapped;
 
                        audio->accumulate_frames (
@@ -548,8 +548,12 @@ Player::statistics () const
        return _statistics;
 }
 
+/** @param burnt true to return only subtitles to be burnt, false to return only
+ *  subtitles that should not be burnt.  This parameter will be ignored if
+ *  _always_burn_subtitles is true; in this case, all subtitles will be returned.
+ */
 PlayerSubtitles
-Player::get_subtitles (DCPTime time, DCPTime length, bool starting)
+Player::get_subtitles (DCPTime time, DCPTime length, bool starting, bool burnt)
 {
        list<shared_ptr<Piece> > subs = overlaps<SubtitleContent> (time, time + length);
 
@@ -557,7 +561,7 @@ Player::get_subtitles (DCPTime time, DCPTime length, bool starting)
 
        for (list<shared_ptr<Piece> >::const_iterator j = subs.begin(); j != subs.end(); ++j) {
                shared_ptr<SubtitleContent> subtitle_content = dynamic_pointer_cast<SubtitleContent> ((*j)->content);
-               if (!subtitle_content->use_subtitles ()) {
+               if (!subtitle_content->use_subtitles () || (!_always_burn_subtitles && (burnt != subtitle_content->burn_subtitles ()))) {
                        continue;
                }
 
@@ -568,7 +572,7 @@ Player::get_subtitles (DCPTime time, DCPTime length, bool starting)
 
                list<ContentImageSubtitle> image = subtitle_decoder->get_image_subtitles (ContentTimePeriod (from, to), starting);
                for (list<ContentImageSubtitle>::iterator i = image.begin(); i != image.end(); ++i) {
-                       
+
                        /* Apply content's subtitle offsets */
                        i->sub.rectangle.x += subtitle_content->subtitle_x_offset ();
                        i->sub.rectangle.y += subtitle_content->subtitle_y_offset ();
@@ -580,7 +584,7 @@ Player::get_subtitles (DCPTime time, DCPTime length, bool starting)
                        /* Apply a corrective translation to keep the subtitle centred after that scale */
                        i->sub.rectangle.x -= i->sub.rectangle.width * (subtitle_content->subtitle_x_scale() - 1);
                        i->sub.rectangle.y -= i->sub.rectangle.height * (subtitle_content->subtitle_y_scale() - 1);
-                       
+
                        ps.image.push_back (i->sub);
                }
 
@@ -633,11 +637,12 @@ Player::set_ignore_video ()
        _ignore_video = true;
 }
 
-/** Set whether or not this player should burn text subtitles into the image.
- *  @param burn true to burn subtitles, false to not.
+/** 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.
  */
 void
-Player::set_burn_subtitles (bool burn)
+Player::set_always_burn_subtitles (bool burn)
 {
-       _burn_subtitles = burn;
+       _always_burn_subtitles = burn;
 }