Use uchardet to guess encoding of subtitle files and reject non-UTF-8.
[dcpomatic.git] / src / lib / player.cc
index 1a008eebb9abc5da060221443a671109ab57957a..64fcfc93e7682efcfef68394b6106920aa53bd05 100644 (file)
 #include "dcp_subtitle_decoder.h"
 #include "audio_processor.h"
 #include "playlist.h"
+#include <dcp/reel.h>
+#include <dcp/reel_sound_asset.h>
+#include <dcp/reel_subtitle_asset.h>
+#include <dcp/reel_picture_asset.h>
 #include <boost/foreach.hpp>
 #include <stdint.h>
 #include <algorithm>
+#include <iostream>
 
 #include "i18n.h"
 
@@ -74,7 +79,10 @@ Player::Player (shared_ptr<const Film> film, shared_ptr<const Playlist> playlist
        , _playlist (playlist)
        , _have_valid_pieces (false)
        , _ignore_video (false)
+       , _ignore_audio (false)
        , _always_burn_subtitles (false)
+       , _fast (false)
+       , _play_referenced (false)
 {
        _film_changed_connection = _film->Changed.connect (bind (&Player::film_changed, this, _1));
        _playlist_changed_connection = _playlist->Changed.connect (bind (&Player::playlist_changed, this));
@@ -126,13 +134,13 @@ Player::setup_pieces ()
                /* FFmpeg */
                shared_ptr<const FFmpegContent> fc = dynamic_pointer_cast<const FFmpegContent> (i);
                if (fc) {
-                       decoder.reset (new FFmpegDecoder (fc, _film->log()));
+                       decoder.reset (new FFmpegDecoder (fc, _film->log(), _fast));
                        frc = FrameRateChange (fc->video_frame_rate(), _film->video_frame_rate());
                }
 
                shared_ptr<const DCPContent> dc = dynamic_pointer_cast<const DCPContent> (i);
                if (dc) {
-                       decoder.reset (new DCPDecoder (dc));
+                       decoder.reset (new DCPDecoder (dc, _fast));
                        frc = FrameRateChange (dc->video_frame_rate(), _film->video_frame_rate());
                }
 
@@ -157,7 +165,7 @@ Player::setup_pieces ()
                /* SndfileContent */
                shared_ptr<const SndfileContent> sc = dynamic_pointer_cast<const SndfileContent> (i);
                if (sc) {
-                       decoder.reset (new SndfileDecoder (sc));
+                       decoder.reset (new SndfileDecoder (sc, _fast));
                        frc = best_overlap_frc;
                }
 
@@ -180,6 +188,11 @@ Player::setup_pieces ()
                        vd->set_ignore_video ();
                }
 
+               shared_ptr<AudioDecoder> ad = dynamic_pointer_cast<AudioDecoder> (decoder);
+               if (ad && _ignore_audio) {
+                       ad->set_ignore_audio ();
+               }
+
                _pieces.push_back (shared_ptr<Piece> (new Piece (i, decoder, frc.get ())));
        }
 
@@ -213,11 +226,13 @@ Player::playlist_content_changed (weak_ptr<Content> w, int property, bool freque
                property == SubtitleContentProperty::SUBTITLE_Y_OFFSET ||
                property == SubtitleContentProperty::SUBTITLE_X_SCALE ||
                property == SubtitleContentProperty::SUBTITLE_Y_SCALE ||
+               property == SubtitleContentProperty::FONTS ||
                property == VideoContentProperty::VIDEO_CROP ||
                property == VideoContentProperty::VIDEO_SCALE ||
                property == VideoContentProperty::VIDEO_FRAME_RATE ||
                property == VideoContentProperty::VIDEO_FADE_IN ||
-               property == VideoContentProperty::VIDEO_FADE_OUT
+               property == VideoContentProperty::VIDEO_FADE_OUT ||
+               property == VideoContentProperty::COLOUR_CONVERSION
                ) {
 
                Changed (frequent);
@@ -291,8 +306,8 @@ Player::transform_image_subtitles (list<ImageSubtitle> subs) const
                                        true
                                        ),
                                Position<int> (
-                                       rint (_video_container_size.width * i->rectangle.x),
-                                       rint (_video_container_size.height * i->rectangle.y)
+                                       lrint (_video_container_size.width * i->rectangle.x),
+                                       lrint (_video_container_size.height * i->rectangle.y)
                                        )
                                )
                        );
@@ -309,7 +324,7 @@ Player::black_player_video_frame (DCPTime time) const
                        shared_ptr<const ImageProxy> (new RawImageProxy (_black_image)),
                        time,
                        Crop (),
-                       optional<float> (),
+                       optional<double> (),
                        _video_container_size,
                        _video_container_size,
                        EYES_BOTH,
@@ -319,7 +334,10 @@ Player::black_player_video_frame (DCPTime time) const
        );
 }
 
-/** @return All PlayerVideos at the given time (there may be two frames for 3D) */
+/** @return All PlayerVideos at the given time.  There may be none if the content
+ *  at `time' is a DCP which we are passing through (i.e. referring to by reference)
+ *  or 2 if we have 3D.
+ */
 list<shared_ptr<PlayerVideo> >
 Player::get_video (DCPTime time, bool accurate)
 {
@@ -339,7 +357,7 @@ Player::get_video (DCPTime time, bool accurate)
 
        /* Text subtitles (rendered to an image) */
        if (!ps.text.empty ()) {
-               list<PositionImage> s = render_subtitles (ps.text, _video_container_size);
+               list<PositionImage> s = render_subtitles (ps.text, ps.fonts, _video_container_size);
                copy (s.begin (), s.end (), back_inserter (sub_images));
        }
 
@@ -348,7 +366,7 @@ Player::get_video (DCPTime time, bool accurate)
                subtitles = merge (sub_images);
        }
 
-       /* Find video */
+       /* Find pieces containing video which is happening now */
 
        list<shared_ptr<Piece> > ov = overlaps<VideoContent> (
                time,
@@ -361,38 +379,60 @@ Player::get_video (DCPTime time, bool accurate)
                /* No video content at this time */
                pvf.push_back (black_player_video_frame (time));
        } else {
-               /* Create a PlayerVideo from the content's video at this time */
+               /* Some video content at this time */
+               shared_ptr<Piece> last = *(ov.rbegin ());
+               VideoFrameType const last_type = dynamic_pointer_cast<VideoContent> (last->content)->video_frame_type ();
 
-               shared_ptr<Piece> piece = ov.back ();
-               shared_ptr<VideoDecoder> decoder = dynamic_pointer_cast<VideoDecoder> (piece->decoder);
-               DCPOMATIC_ASSERT (decoder);
-               shared_ptr<VideoContent> video_content = dynamic_pointer_cast<VideoContent> (piece->content);
-               DCPOMATIC_ASSERT (video_content);
+               /* Get video from appropriate piece(s) */
+               BOOST_FOREACH (shared_ptr<Piece> piece, ov) {
 
-               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;
-               }
+                       shared_ptr<VideoDecoder> decoder = dynamic_pointer_cast<VideoDecoder> (piece->decoder);
+                       DCPOMATIC_ASSERT (decoder);
+                       shared_ptr<VideoContent> video_content = dynamic_pointer_cast<VideoContent> (piece->content);
+                       DCPOMATIC_ASSERT (video_content);
 
-               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 (
-                               shared_ptr<PlayerVideo> (
-                                       new PlayerVideo (
-                                               i->image,
-                                               content_video_to_dcp (piece, i->frame),
-                                               video_content->crop (),
-                                               video_content->fade (i->frame),
-                                               image_size,
-                                               _video_container_size,
-                                               i->eyes,
-                                               i->part,
-                                               video_content->colour_conversion ()
-                                               )
-                                       )
-                               );
+                       shared_ptr<DCPContent> dcp_content = dynamic_pointer_cast<DCPContent> (video_content);
+                       if (dcp_content && dcp_content->reference_video () && !_play_referenced) {
+                               continue;
+                       }
+
+                       bool const use =
+                               /* always use the last video */
+                               piece == last ||
+                               /* with a corresponding L/R eye if appropriate */
+                               (last_type == VIDEO_FRAME_TYPE_3D_LEFT && video_content->video_frame_type() == VIDEO_FRAME_TYPE_3D_RIGHT) ||
+                               (last_type == VIDEO_FRAME_TYPE_3D_RIGHT && video_content->video_frame_type() == VIDEO_FRAME_TYPE_3D_LEFT);
+
+                       if (use) {
+                               /* We want to use this piece */
+                               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));
+                               } else {
+                                       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 (
+                                                       shared_ptr<PlayerVideo> (
+                                                               new PlayerVideo (
+                                                                       i->image,
+                                                                       content_video_to_dcp (piece, i->frame),
+                                                                       video_content->crop (),
+                                                                       video_content->fade (i->frame),
+                                                                       image_size,
+                                                                       _video_container_size,
+                                                                       i->eyes,
+                                                                       i->part,
+                                                                       video_content->colour_conversion ()
+                                                                       )
+                                                               )
+                                                       );
+                                       }
+                               }
+                       } else {
+                               /* Discard unused video */
+                               decoder->get_video (dcp_to_content_video (piece, time), accurate);
+                       }
                }
        }
 
@@ -405,6 +445,7 @@ Player::get_video (DCPTime time, bool accurate)
        return pvf;
 }
 
+/** @return Audio data or 0 if the only audio data here is referenced DCP data */
 shared_ptr<AudioBuffers>
 Player::get_audio (DCPTime time, DCPTime length, bool accurate)
 {
@@ -412,7 +453,7 @@ Player::get_audio (DCPTime time, DCPTime length, bool accurate)
                setup_pieces ();
        }
 
-       Frame const length_frames = length.frames (_film->audio_frame_rate ());
+       Frame const length_frames = length.frames_round (_film->audio_frame_rate ());
 
        shared_ptr<AudioBuffers> audio (new AudioBuffers (_film->audio_channels(), length_frames));
        audio->make_silent ();
@@ -422,11 +463,25 @@ Player::get_audio (DCPTime time, DCPTime length, bool accurate)
                return audio;
        }
 
-       for (list<shared_ptr<Piece> >::iterator i = ov.begin(); i != ov.end(); ++i) {
+       bool all_referenced = true;
+       BOOST_FOREACH (shared_ptr<Piece> i, ov) {
+               shared_ptr<AudioContent> audio_content = dynamic_pointer_cast<AudioContent> (i->content);
+               shared_ptr<DCPContent> dcp_content = dynamic_pointer_cast<DCPContent> (i->content);
+               if (audio_content && (!dcp_content || !dcp_content->reference_audio ())) {
+                       /* There is audio content which is not from a DCP or not set to be referenced */
+                       all_referenced = false;
+               }
+       }
+
+       if (all_referenced && !_play_referenced) {
+               return shared_ptr<AudioBuffers> ();
+       }
+
+       BOOST_FOREACH (shared_ptr<Piece> i, ov) {
 
-               shared_ptr<AudioContent> content = dynamic_pointer_cast<AudioContent> ((*i)->content);
+               shared_ptr<AudioContent> content = dynamic_pointer_cast<AudioContent> (i->content);
                DCPOMATIC_ASSERT (content);
-               shared_ptr<AudioDecoder> decoder = dynamic_pointer_cast<AudioDecoder> ((*i)->decoder);
+               shared_ptr<AudioDecoder> decoder = dynamic_pointer_cast<AudioDecoder> (i->decoder);
                DCPOMATIC_ASSERT (decoder);
 
                /* The time that we should request from the content */
@@ -438,17 +493,22 @@ Player::get_audio (DCPTime time, DCPTime length, bool accurate)
                           the stuff we get back.
                        */
                        offset = -request;
-                       request_frames += request.frames (_film->audio_frame_rate ());
+                       request_frames += request.frames_round (_film->audio_frame_rate ());
                        if (request_frames < 0) {
                                request_frames = 0;
                        }
                        request = DCPTime ();
                }
 
-               Frame const content_frame = dcp_to_content_audio (*i, request);
+               Frame const content_frame = dcp_to_resampled_audio (i, request);
 
                BOOST_FOREACH (AudioStreamPtr j, content->audio_streams ()) {
 
+                       if (j->channels() == 0) {
+                               /* Some content (e.g. DCPs) can have streams with no channels */
+                               continue;
+                       }
+
                        /* 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);
 
@@ -477,7 +537,7 @@ Player::get_audio (DCPTime time, DCPTime length, bool accurate)
                        }
 
                        if (_audio_processor) {
-                               dcp_mapped = _audio_processor->run (dcp_mapped);
+                               dcp_mapped = _audio_processor->run (dcp_mapped, _film->audio_channels ());
                        }
 
                        all.audio = dcp_mapped;
@@ -485,7 +545,7 @@ Player::get_audio (DCPTime time, DCPTime length, bool accurate)
                        audio->accumulate_frames (
                                all.audio.get(),
                                content_frame - all.frame,
-                               offset.frames (_film->audio_frame_rate()),
+                               offset.frames_round (_film->audio_frame_rate()),
                                min (Frame (all.audio->frames()), request_frames)
                                );
                }
@@ -497,60 +557,45 @@ Player::get_audio (DCPTime time, DCPTime length, bool accurate)
 Frame
 Player::dcp_to_content_video (shared_ptr<const Piece> piece, DCPTime t) const
 {
-       /* s is the offset of t from the start position of this content */
+       shared_ptr<const VideoContent> vc = dynamic_pointer_cast<const VideoContent> (piece->content);
        DCPTime s = t - piece->content->position ();
-       s = DCPTime (max (DCPTime::Type (0), s.get ()));
-       s = DCPTime (min (piece->content->length_after_trim().get(), s.get()));
+       s = min (piece->content->length_after_trim(), s);
+       s = max (DCPTime(), s + DCPTime (piece->content->trim_start(), piece->frc));
 
-       /* Convert this to the content frame */
-       return DCPTime (s + piece->content->trim_start()).frames (_film->video_frame_rate()) / piece->frc.factor ();
+       /* It might seem more logical here to convert s to a ContentTime (using the FrameRateChange)
+          then convert that ContentTime to frames at the content's rate.  However this fails for
+          situations like content at 29.9978733fps, DCP at 30fps.  The accuracy of the Time type is not
+          enough to distinguish between the two with low values of time (e.g. 3200 in Time units).
+
+          Instead we convert the DCPTime using the DCP video rate then account for any skip/repeat.
+       */
+       return s.frames_floor (piece->frc.dcp) / piece->frc.factor ();
 }
 
 DCPTime
 Player::content_video_to_dcp (shared_ptr<const Piece> piece, Frame f) const
 {
-       DCPTime t = DCPTime::from_frames (f * piece->frc.factor (), _film->video_frame_rate()) - piece->content->trim_start () + piece->content->position ();
-       if (t < DCPTime ()) {
-               t = DCPTime ();
-       }
-
-       return t;
+       shared_ptr<const VideoContent> vc = dynamic_pointer_cast<const VideoContent> (piece->content);
+       /* See comment in dcp_to_content_video */
+       DCPTime const d = DCPTime::from_frames (f * piece->frc.factor(), piece->frc.dcp) - DCPTime (piece->content->trim_start (), piece->frc);
+       return max (DCPTime (), d + piece->content->position ());
 }
 
 Frame
-Player::dcp_to_content_audio (shared_ptr<const Piece> piece, DCPTime t) const
+Player::dcp_to_resampled_audio (shared_ptr<const Piece> piece, DCPTime t) const
 {
-       /* s is the offset of t from the start position of this content */
        DCPTime s = t - piece->content->position ();
-       s = DCPTime (max (DCPTime::Type (0), s.get ()));
-       s = DCPTime (min (piece->content->length_after_trim().get(), s.get()));
-
-       /* Convert this to the content frame */
-       return DCPTime (s + piece->content->trim_start()).frames (_film->audio_frame_rate());
+       s = min (piece->content->length_after_trim(), s);
+       /* See notes in dcp_to_content_video */
+       return max (DCPTime (), DCPTime (piece->content->trim_start (), piece->frc) + s).frames_floor (_film->audio_frame_rate ());
 }
 
 ContentTime
 Player::dcp_to_content_subtitle (shared_ptr<const Piece> piece, DCPTime t) const
 {
-       /* s is the offset of t from the start position of this content */
        DCPTime s = t - piece->content->position ();
-       s = DCPTime (max (DCPTime::Type (0), s.get ()));
-       s = DCPTime (min (piece->content->length_after_trim().get(), s.get()));
-
-       return ContentTime (s + piece->content->trim_start(), piece->frc);
-}
-
-void
-PlayerStatistics::dump (shared_ptr<Log> log) const
-{
-       log->log (String::compose ("Video: %1 good %2 skipped %3 black %4 repeat", video.good, video.skip, video.black, video.repeat), Log::TYPE_GENERAL);
-       log->log (String::compose ("Audio: %1 good %2 skipped %3 silence", audio.good, audio.skip, audio.silence.seconds()), Log::TYPE_GENERAL);
-}
-
-PlayerStatistics const &
-Player::statistics () const
-{
-       return _statistics;
+       s = min (piece->content->length_after_trim(), s);
+       return max (ContentTime (), ContentTime (s, piece->frc) + piece->content->trim_start());
 }
 
 /** @param burnt true to return only subtitles to be burnt, false to return only
@@ -570,6 +615,11 @@ Player::get_subtitles (DCPTime time, DCPTime length, bool starting, bool burnt)
                        continue;
                }
 
+               shared_ptr<DCPContent> dcp_content = dynamic_pointer_cast<DCPContent> (subtitle_content);
+               if (dcp_content && dcp_content->reference_subtitle () && !_play_referenced) {
+                       continue;
+               }
+
                shared_ptr<SubtitleDecoder> subtitle_decoder = dynamic_pointer_cast<SubtitleDecoder> ((*j)->decoder);
                ContentTime const from = dcp_to_content_subtitle (*j, time);
                /* XXX: this video_frame_rate() should be the rate that the subtitle content has been prepared for */
@@ -606,6 +656,7 @@ Player::get_subtitles (DCPTime time, DCPTime length, bool starting, bool burnt)
                                        s.set_aspect_adjust (xs / ys);
                                }
                                ps.text.push_back (s);
+                               ps.add_fonts (subtitle_content->fonts ());
                        }
                }
        }
@@ -642,6 +693,13 @@ Player::set_ignore_video ()
        _ignore_video = true;
 }
 
+/** Set this player never to produce any audio data */
+void
+Player::set_ignore_audio ()
+{
+       _ignore_audio = 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.
@@ -651,3 +709,43 @@ Player::set_always_burn_subtitles (bool burn)
 {
        _always_burn_subtitles = burn;
 }
+
+void
+Player::set_fast ()
+{
+       _fast = true;
+       _have_valid_pieces = false;
+}
+
+void
+Player::set_play_referenced ()
+{
+       _play_referenced = true;
+       _have_valid_pieces = false;
+}
+
+list<shared_ptr<dcp::ReelAsset> >
+Player::get_reel_assets ()
+{
+       list<shared_ptr<dcp::ReelAsset> > a;
+
+       BOOST_FOREACH (shared_ptr<Content> i, _playlist->content ()) {
+               shared_ptr<DCPContent> j = dynamic_pointer_cast<DCPContent> (i);
+               if (!j) {
+                       continue;
+               }
+               /* XXX: hack hack hack */
+               DCPDecoder decoder (j, false);
+               if (j->reference_video ()) {
+                       a.push_back (decoder.reels().front()->main_picture ());
+               }
+               if (j->reference_audio ()) {
+                       a.push_back (decoder.reels().front()->main_sound ());
+               }
+               if (j->reference_subtitle ()) {
+                       a.push_back (decoder.reels().front()->main_subtitle ());
+               }
+       }
+
+       return a;
+}