Back-end for very basic and hacky VF support for a DCP imported as content.
[dcpomatic.git] / src / lib / player.h
index 4368f48ba9d0da6043694d397c4114a3b0d7d4d7..e52ad59c2f6014554bfaace206149a6494914e81 100644 (file)
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2013-2014 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2013-2015 Carl Hetherington <cth@carlh.net>
 
     This program is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
 #ifndef DCPOMATIC_PLAYER_H
 #define DCPOMATIC_PLAYER_H
 
-#include <list>
-#include <boost/shared_ptr.hpp>
-#include <boost/enable_shared_from_this.hpp>
-#include "playlist.h"
-#include "content.h"
+#include "player_subtitles.h"
 #include "film.h"
-#include "rect.h"
-#include "audio_merger.h"
-#include "audio_content.h"
+#include "content.h"
+#include "position_image.h"
 #include "piece.h"
+#include <boost/shared_ptr.hpp>
+#include <boost/enable_shared_from_this.hpp>
+#include <list>
 
-class Job;
-class Film;
-class Playlist;
-class AudioContent;
-class Piece;
-class Image;
-class Resampler;
-
-/** A wrapper for an Image which contains some pending operations; these may
- *  not be necessary if the receiver of the PlayerImage throws it away.
- */
-class PlayerImage
-{
-public:
-       PlayerImage (boost::shared_ptr<const Image>, Crop, libdcp::Size, libdcp::Size, Scaler const *);
+namespace dcp {
+       class ReelAsset;
+}
 
-       void set_subtitle (boost::shared_ptr<const Image>, Position<int>);
-       
-       boost::shared_ptr<Image> image ();
+class PlayerVideo;
+class Playlist;
+class Font;
+class AudioBuffers;
 
-private:
-       boost::shared_ptr<const Image> _in;
-       Crop _crop;
-       libdcp::Size _inter_size;
-       libdcp::Size _out_size;
-       Scaler const * _scaler;
-       boost::shared_ptr<const Image> _subtitle_image;
-       Position<int> _subtitle_position;
-};
 /** @class Player
- *  @brief A class which can `play' a Playlist; emitting its audio and video.
+ *  @brief A class which can `play' a Playlist.
  */
 class Player : public boost::enable_shared_from_this<Player>, public boost::noncopyable
 {
 public:
-       Player (boost::shared_ptr<const Film>, boost::shared_ptr<const Playlist>);
-
-       void disable_video ();
-       void disable_audio ();
-
-       bool pass ();
-       void seek (Time, bool);
-
-       Time video_position () const {
-               return _video_position;
-       }
-
-       void set_video_container_size (libdcp::Size);
-
-       bool repeat_last_video ();
-
-       /** Emitted when a video frame is ready.
-        *  First parameter is the video image.
-        *  Second parameter is the eye(s) that should see this image.
-        *  Third parameter is the colour conversion that should be used for this image.
-        *  Fourth parameter is true if the image is the same as the last one that was emitted.
-        *  Fifth parameter is the time.
-        */
-       boost::signals2::signal<void (boost::shared_ptr<PlayerImage>, Eyes, ColourConversion, bool, Time)> Video;
-       
-       /** Emitted when some audio data is ready */
-       boost::signals2::signal<void (boost::shared_ptr<const AudioBuffers>, Time)> Audio;
+       Player (boost::shared_ptr<const Film>, boost::shared_ptr<const Playlist> playlist);
+
+       std::list<boost::shared_ptr<PlayerVideo> > get_video (DCPTime time, bool accurate);
+       boost::shared_ptr<AudioBuffers> get_audio (DCPTime time, DCPTime length, bool accurate);
+       PlayerSubtitles get_subtitles (DCPTime time, DCPTime length, bool starting, bool burnt);
+       std::list<boost::shared_ptr<Font> > get_subtitle_fonts ();
+       std::list<boost::shared_ptr<dcp::ReelAsset> > get_reel_assets ();
+
+       void set_video_container_size (dcp::Size);
+       void set_ignore_video ();
+       void set_ignore_audio ();
+       void set_enable_subtitles (bool enable);
+       void set_always_burn_subtitles (bool burn);
+       void set_fast ();
+       void set_play_referenced ();
 
        /** Emitted when something has changed such that if we went back and emitted
         *  the last frame again it would look different.  This is not emitted after
@@ -106,68 +71,76 @@ public:
 private:
        friend class PlayerWrapper;
        friend class Piece;
+       friend struct player_overlaps_test;
+       friend struct player_time_calculation_test1;
+       friend struct player_time_calculation_test2;
+       friend struct player_time_calculation_test3;
 
-       void process_video (boost::weak_ptr<Piece>, boost::shared_ptr<const Image>, Eyes, bool, VideoContent::Frame, Time);
-       void process_audio (boost::weak_ptr<Piece>, boost::shared_ptr<const AudioBuffers>, AudioContent::Frame);
-       void process_subtitle (boost::weak_ptr<Piece>, boost::shared_ptr<Image>, dcpomatic::Rect<double>, Time, Time);
        void setup_pieces ();
-       void playlist_changed ();
-       void content_changed (boost::weak_ptr<Content>, int, bool);
-       void do_seek (Time, bool);
        void flush ();
-       void emit_black ();
-       void emit_silence (OutputAudioFrame);
-       boost::shared_ptr<Resampler> resampler (boost::shared_ptr<AudioContent>, bool);
        void film_changed (Film::Property);
-       void update_subtitle ();
+       void playlist_changed ();
+       void playlist_content_changed (boost::weak_ptr<Content>, int, bool);
+       std::list<PositionImage> transform_image_subtitles (std::list<ImageSubtitle>) const;
+       void update_subtitle_from_text ();
+       Frame dcp_to_content_video (boost::shared_ptr<const Piece> piece, DCPTime t) const;
+       DCPTime content_video_to_dcp (boost::shared_ptr<const Piece> piece, Frame f) const;
+       Frame dcp_to_resampled_audio (boost::shared_ptr<const Piece> piece, DCPTime t) const;
+       ContentTime dcp_to_content_subtitle (boost::shared_ptr<const Piece> piece, DCPTime t) const;
+       boost::shared_ptr<PlayerVideo> black_player_video_frame (DCPTime) const;
+
+       /** @return Pieces of content type C that overlap a specified time range in the DCP */
+       template<class C>
+       std::list<boost::shared_ptr<Piece> >
+       overlaps (DCPTime from, DCPTime to)
+       {
+               if (!_have_valid_pieces) {
+                       setup_pieces ();
+               }
+
+               std::list<boost::shared_ptr<Piece> > overlaps;
+               for (typename std::list<boost::shared_ptr<Piece> >::const_iterator i = _pieces.begin(); i != _pieces.end(); ++i) {
+                       if (!boost::dynamic_pointer_cast<C> ((*i)->content)) {
+                               continue;
+                       }
+
+                       if ((*i)->content->position() <= to && (*i)->content->end() >= from) {
+                               overlaps.push_back (*i);
+                       }
+               }
+
+               return overlaps;
+       }
 
        boost::shared_ptr<const Film> _film;
        boost::shared_ptr<const Playlist> _playlist;
-       
-       bool _video;
-       bool _audio;
 
        /** Our pieces are ready to go; if this is false the pieces must be (re-)created before they are used */
        bool _have_valid_pieces;
        std::list<boost::shared_ptr<Piece> > _pieces;
 
-       /** The time after the last video that we emitted */
-       Time _video_position;
-       /** The time after the last audio that we emitted */
-       Time _audio_position;
-
-       AudioMerger<Time, AudioContent::Frame> _audio_merger;
-
-       libdcp::Size _video_container_size;
-       boost::shared_ptr<PlayerImage> _black_frame;
-       std::map<boost::shared_ptr<AudioContent>, boost::shared_ptr<Resampler> > _resamplers;
-
-       struct {
-               boost::weak_ptr<Piece> piece;
-               boost::shared_ptr<Image> image;
-               dcpomatic::Rect<double> rect;
-               Time from;
-               Time to;
-       } _in_subtitle;
-
-       struct {
-               boost::shared_ptr<Image> image;
-               Position<int> position;
-               Time from;
-               Time to;
-       } _out_subtitle;
-
-#ifdef DCPOMATIC_DEBUG
-       boost::shared_ptr<Content> _last_video;
-#endif
-
-       bool _last_emit_was_black;
-
-       IncomingVideo _last_incoming_video;
+       /** Size of the image in the DCP (e.g. 1990x1080 for flat) */
+       dcp::Size _video_container_size;
+       boost::shared_ptr<Image> _black_image;
+
+       /** true if the player should ignore all video; i.e. never produce any */
+       bool _ignore_video;
+       /** true if the player should ignore all audio; i.e. never produce any */
+       bool _ignore_audio;
+       /** true if the player should always burn subtitles into the video regardless
+           of content settings
+       */
+       bool _always_burn_subtitles;
+       /** true if we should try to be fast rather than high quality */
+       bool _fast;
+       /** true if we should `play' (i.e output) referenced DCP data (e.g. for preview) */
+       bool _play_referenced;
+
+       boost::shared_ptr<AudioProcessor> _audio_processor;
 
+       boost::signals2::scoped_connection _film_changed_connection;
        boost::signals2::scoped_connection _playlist_changed_connection;
        boost::signals2::scoped_connection _playlist_content_changed_connection;
-       boost::signals2::scoped_connection _film_changed_connection;
 };
 
 #endif