Logging improvements to allow prettier displays in the server GUI.
[dcpomatic.git] / src / lib / player.cc
index c51f80067fbd87745aa366f202e48a67b858ac65..0606a9340c9d1d6e51cd3f4e0d2ac906a090edf5 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"
 
-#define LOG_GENERAL(...) _film->log()->log (String::compose (__VA_ARGS__), Log::TYPE_GENERAL);
+#define LOG_GENERAL(...) _film->log()->log (String::compose (__VA_ARGS__), LogEntry::TYPE_GENERAL);
 
 using std::list;
 using std::cout;
@@ -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));
@@ -99,40 +107,16 @@ Player::setup_pieces ()
                shared_ptr<Decoder> decoder;
                optional<FrameRateChange> frc;
 
-               /* Work out a FrameRateChange for the best overlap video for this content, in case we need it below */
-               DCPTime best_overlap_t;
-               shared_ptr<VideoContent> best_overlap;
-               BOOST_FOREACH (shared_ptr<Content> j, _playlist->content ()) {
-                       shared_ptr<VideoContent> vc = dynamic_pointer_cast<VideoContent> (j);
-                       if (!vc) {
-                               continue;
-                       }
-
-                       DCPTime const overlap = max (vc->position(), i->position()) - min (vc->end(), i->end());
-                       if (overlap > best_overlap_t) {
-                               best_overlap = vc;
-                               best_overlap_t = overlap;
-                       }
-               }
-
-               optional<FrameRateChange> best_overlap_frc;
-               if (best_overlap) {
-                       best_overlap_frc = FrameRateChange (best_overlap->video_frame_rate(), _film->video_frame_rate ());
-               } else {
-                       /* No video overlap; e.g. if the DCP is just audio */
-                       best_overlap_frc = FrameRateChange (_film->video_frame_rate(), _film->video_frame_rate ());
-               }
-
                /* 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,22 +141,49 @@ Player::setup_pieces ()
                /* SndfileContent */
                shared_ptr<const SndfileContent> sc = dynamic_pointer_cast<const SndfileContent> (i);
                if (sc) {
-                       decoder.reset (new SndfileDecoder (sc));
-                       frc = best_overlap_frc;
+                       decoder.reset (new SndfileDecoder (sc, _fast));
+
+                       /* Work out a FrameRateChange for the best overlap video for this content */
+                       DCPTime best_overlap_t;
+                       shared_ptr<VideoContent> best_overlap;
+                       BOOST_FOREACH (shared_ptr<Content> j, _playlist->content ()) {
+                               shared_ptr<VideoContent> vc = dynamic_pointer_cast<VideoContent> (j);
+                               if (!vc) {
+                                       continue;
+                               }
+
+                               DCPTime const overlap = min (vc->end(), i->end()) - max (vc->position(), i->position());
+                               if (overlap > best_overlap_t) {
+                                       best_overlap = vc;
+                                       best_overlap_t = overlap;
+                               }
+                       }
+
+                       if (best_overlap) {
+                               frc = FrameRateChange (best_overlap->video_frame_rate(), _film->video_frame_rate ());
+                       } else {
+                               /* No video overlap; e.g. if the DCP is just audio */
+                               frc = FrameRateChange (_film->video_frame_rate(), _film->video_frame_rate ());
+                       }
                }
 
+               /* It's questionable whether subtitle content should have a video frame rate; perhaps
+                  it should be assumed that any subtitle content has been prepared at the same rate
+                  as simultaneous video content (like we do with audio).
+               */
+
                /* SubRipContent */
                shared_ptr<const SubRipContent> rc = dynamic_pointer_cast<const SubRipContent> (i);
                if (rc) {
                        decoder.reset (new SubRipDecoder (rc));
-                       frc = best_overlap_frc;
+                       frc = FrameRateChange (rc->subtitle_video_frame_rate(), _film->video_frame_rate());
                }
 
                /* DCPSubtitleContent */
                shared_ptr<const DCPSubtitleContent> dsc = dynamic_pointer_cast<const DCPSubtitleContent> (i);
                if (dsc) {
                        decoder.reset (new DCPSubtitleDecoder (dsc));
-                       frc = best_overlap_frc;
+                       frc = FrameRateChange (dsc->subtitle_video_frame_rate(), _film->video_frame_rate());
                }
 
                shared_ptr<VideoDecoder> vd = dynamic_pointer_cast<VideoDecoder> (decoder);
@@ -180,6 +191,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 ())));
        }
 
@@ -250,7 +266,13 @@ Player::film_changed (Film::Property p)
           last time we were run.
        */
 
-       if (p == Film::CONTAINER || p == Film::VIDEO_FRAME_RATE) {
+       if (p == Film::CONTAINER) {
+               Changed (false);
+       } else if (p == Film::VIDEO_FRAME_RATE) {
+               /* Pieces contain a FrameRateChange which contains the DCP frame rate,
+                  so we need new pieces here.
+               */
+               _have_valid_pieces = false;
                Changed (false);
        } else if (p == Film::AUDIO_PROCESSOR) {
                if (_film->audio_processor ()) {
@@ -293,8 +315,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)
                                        )
                                )
                        );
@@ -321,7 +343,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)
 {
@@ -375,6 +400,11 @@ Player::get_video (DCPTime time, bool accurate)
                        shared_ptr<VideoContent> video_content = dynamic_pointer_cast<VideoContent> (piece->content);
                        DCPOMATIC_ASSERT (video_content);
 
+                       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 ||
@@ -424,6 +454,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)
 {
@@ -441,11 +472,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 */
@@ -464,7 +509,7 @@ Player::get_audio (DCPTime time, DCPTime length, bool accurate)
                        request = DCPTime ();
                }
 
-               Frame const content_frame = dcp_to_resampled_audio (*i, request);
+               Frame const content_frame = dcp_to_resampled_audio (i, request);
 
                BOOST_FOREACH (AudioStreamPtr j, content->audio_streams ()) {
 
@@ -501,7 +546,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;
@@ -524,15 +569,25 @@ Player::dcp_to_content_video (shared_ptr<const Piece> piece, DCPTime t) const
        shared_ptr<const VideoContent> vc = dynamic_pointer_cast<const VideoContent> (piece->content);
        DCPTime s = t - piece->content->position ();
        s = min (piece->content->length_after_trim(), s);
-       return max (ContentTime (), ContentTime (s, piece->frc) + piece->content->trim_start ()).frames_round (vc->video_frame_rate ());
+       s = max (DCPTime(), s + DCPTime (piece->content->trim_start(), piece->frc));
+
+       /* 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
 {
        shared_ptr<const VideoContent> vc = dynamic_pointer_cast<const VideoContent> (piece->content);
-       ContentTime const c = ContentTime::from_frames (f, vc->video_frame_rate ()) - piece->content->trim_start ();
-       return max (DCPTime (), DCPTime (c, piece->frc) + piece->content->position ());
+       /* 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
@@ -552,6 +607,12 @@ Player::dcp_to_content_subtitle (shared_ptr<const Piece> piece, DCPTime t) const
        return max (ContentTime (), ContentTime (s, piece->frc) + piece->content->trim_start());
 }
 
+DCPTime
+Player::content_subtitle_to_dcp (shared_ptr<const Piece> piece, ContentTime t) const
+{
+       return max (DCPTime (), DCPTime (t - piece->content->trim_start(), piece->frc) + piece->content->position());
+}
+
 /** @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.
@@ -569,6 +630,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 */
@@ -594,7 +660,7 @@ Player::get_subtitles (DCPTime time, DCPTime length, bool starting, bool burnt)
 
                list<ContentTextSubtitle> text = subtitle_decoder->get_text_subtitles (ContentTimePeriod (from, to), starting);
                BOOST_FOREACH (ContentTextSubtitle& ts, text) {
-                       BOOST_FOREACH (dcp::SubtitleString& s, ts.subs) {
+                       BOOST_FOREACH (dcp::SubtitleString s, ts.subs) {
                                s.set_h_position (s.h_position() + subtitle_content->subtitle_x_offset ());
                                s.set_v_position (s.v_position() + subtitle_content->subtitle_y_offset ());
                                float const xs = subtitle_content->subtitle_x_scale();
@@ -604,6 +670,8 @@ Player::get_subtitles (DCPTime time, DCPTime length, bool starting, bool burnt)
                                if (fabs (1.0 - xs / ys) > dcp::ASPECT_ADJUST_EPSILON) {
                                        s.set_aspect_adjust (xs / ys);
                                }
+                               s.set_in (dcp::Time(content_subtitle_to_dcp (*j, ts.period().from).seconds()));
+                               s.set_out (dcp::Time(content_subtitle_to_dcp (*j, ts.period().to).seconds()));
                                ps.text.push_back (s);
                                ps.add_fonts (subtitle_content->fonts ());
                        }
@@ -642,6 +710,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 +726,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;
+}