Attempt to tidy up internal APIs slightly.
[dcpomatic.git] / src / lib / player.h
index 6860807b3deb72c7d1cf5866a2bac44e232cb68f..05e994d0bb105aa8b797762e96a285e3de4e4624 100644 (file)
 /*
-    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
+    This file is part of DCP-o-matic.
+
+    DCP-o-matic is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
     the Free Software Foundation; either version 2 of the License, or
     (at your option) any later version.
 
-    This program is distributed in the hope that it will be useful,
+    DCP-o-matic is distributed in the hope that it will be useful,
     but WITHOUT ANY WARRANTY; without even the implied warranty of
     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
     GNU General Public License for more details.
 
     You should have received a copy of the GNU General Public License
-    along with this program; if not, write to the Free Software
-    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+    along with DCP-o-matic.  If not, see <http://www.gnu.org/licenses/>.
 
 */
 
 #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 "content.h"
+#include "position_image.h"
+#include "piece.h"
+#include "content_video.h"
+#include "content_audio.h"
+#include "content_subtitle.h"
+#include "audio_stream.h"
 #include "audio_merger.h"
-#include "audio_content.h"
-#include "decoded.h"
-
-class Job;
-class Film;
-class Playlist;
-class AudioContent;
-class Piece;
-class Image;
-
-/** @class PlayerImage
- *  @brief 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, dcp::Size, dcp::Size, Scaler const *);
+#include <boost/shared_ptr.hpp>
+#include <boost/enable_shared_from_this.hpp>
+#include <list>
 
-       void set_subtitle (boost::shared_ptr<const Image>, Position<int>);
-       
-       boost::shared_ptr<Image> image (AVPixelFormat, bool);
+namespace dcp {
+       class ReelAsset;
+}
 
-private:
-       boost::shared_ptr<const Image> _in;
-       Crop _crop;
-       dcp::Size _inter_size;
-       dcp::Size _out_size;
-       Scaler const * _scaler;
-       boost::shared_ptr<const Image> _subtitle_image;
-       Position<int> _subtitle_position;
-};
+class PlayerVideo;
+class Playlist;
+class Font;
+class AudioBuffers;
+class ReferencedReelAsset;
 
-class PlayerStatistics
-{
-public:
-       struct Video {
-               Video ()
-                       : black (0)
-                       , repeat (0)
-                       , good (0)
-                       , skip (0)
-               {}
-               
-               int black;
-               int repeat;
-               int good;
-               int skip;
-       } video;
-
-       struct Audio {
-               Audio ()
-                       : silence (0)
-                       , good (0)
-                       , skip (0)
-               {}
-               
-               DCPTime silence;
-               int64_t good;
-               int64_t skip;
-       } audio;
-
-       void dump (boost::shared_ptr<Log>) const;
-};
 /** @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 ();
+       Player (boost::shared_ptr<const Film>, boost::shared_ptr<const Playlist> playlist);
 
        bool pass ();
-       void seek (DCPTime, bool);
+       void seek (DCPTime time, bool accurate);
 
-       DCPTime video_position () const {
-               return _video_position;
-       }
+       std::list<boost::shared_ptr<Font> > get_subtitle_fonts ();
+       std::list<ReferencedReelAsset> get_reel_assets ();
 
        void set_video_container_size (dcp::Size);
-       void set_approximate_size ();
-
-       bool repeat_last_video ();
-
-       PlayerStatistics const & statistics () const;
-       
-       /** 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, DCPTime)> Video;
-       
-       /** Emitted when some audio data is ready */
-       boost::signals2::signal<void (boost::shared_ptr<const AudioBuffers>, DCPTime)> Audio;
+       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
@@ -139,80 +75,74 @@ public:
         */
        boost::signals2::signal<void (bool)> Changed;
 
+       boost::signals2::signal<void (boost::shared_ptr<PlayerVideo>, DCPTime)> Video;
+       boost::signals2::signal<void (boost::shared_ptr<AudioBuffers>, DCPTime)> Audio;
+       boost::signals2::signal<void (PlayerSubtitles, DCPTimePeriod)> Subtitle;
+
 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 setup_pieces ();
-       void playlist_changed ();
-       void content_changed (boost::weak_ptr<Content>, int, bool);
-       void do_seek (DCPTime, bool);
        void flush ();
-       void emit_black ();
-       void emit_silence (DCPTime);
        void film_changed (Film::Property);
-       void update_subtitle_from_image ();
-       void update_subtitle_from_text ();
-       void emit_video (boost::weak_ptr<Piece>, boost::shared_ptr<DecodedVideo>);
-       void emit_audio (boost::weak_ptr<Piece>, boost::shared_ptr<DecodedAudio>);
-       void step_video_position (boost::shared_ptr<DecodedVideo>);
+       void playlist_changed ();
+       void playlist_content_changed (boost::weak_ptr<Content>, int, bool);
+       std::list<PositionImage> transform_image_subtitles (std::list<ImageSubtitle>) const;
+       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;
+       DCPTime resampled_audio_to_dcp (boost::shared_ptr<const Piece> piece, Frame f) const;
+       ContentTime dcp_to_content_time (boost::shared_ptr<const Piece> piece, DCPTime t) const;
+       DCPTime content_time_to_dcp (boost::shared_ptr<const Piece> piece, ContentTime t) const;
+       boost::shared_ptr<PlayerVideo> black_player_video_frame () const;
+       std::list<boost::shared_ptr<Piece> > overlaps (DCPTime from, DCPTime to, boost::function<bool (Content *)> valid);
+       void video (boost::weak_ptr<Piece>, ContentVideo);
+       void audio (boost::weak_ptr<Piece>, AudioStreamPtr, ContentAudio);
+       void image_subtitle (boost::weak_ptr<Piece>, ContentImageSubtitle);
+       void text_subtitle (boost::weak_ptr<Piece>, ContentTextSubtitle);
 
        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 */
-       DCPTime _video_position;
-       /** The time after the last audio that we emitted */
-       DCPTime _audio_position;
-
-       AudioMerger _audio_merger;
-
+       /** Size of the image in the DCP (e.g. 1990x1080 for flat) */
        dcp::Size _video_container_size;
-       boost::shared_ptr<PlayerImage> _black_frame;
-
-       struct {
-               boost::weak_ptr<Piece> piece;
-               boost::shared_ptr<DecodedImageSubtitle> subtitle;
-       } _image_subtitle;
-
-       struct {
-               boost::weak_ptr<Piece> piece;
-               boost::shared_ptr<DecodedTextSubtitle> subtitle;
-       } _text_subtitle;
-       
-       struct {
-               Position<int> position;
-               boost::shared_ptr<Image> image;
-               DCPTime from;
-               DCPTime to;
-       } _out_subtitle;
-
-#ifdef DCPOMATIC_DEBUG
-       boost::shared_ptr<Content> _last_video;
-#endif
+       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<PlayerVideo> _last_video;
+       boost::optional<DCPTime> _last_video_time;
 
-       bool _last_emit_was_black;
-
-       struct {
-               boost::weak_ptr<Piece> weak_piece;
-               boost::shared_ptr<DecodedVideo> video;
-       } _last_incoming_video;
+       AudioMerger _audio_merger;
+       DCPTime _last_audio_time;
 
-       bool _just_did_inaccurate_seek;
-       bool _approximate_size;
+       std::list<std::pair<PlayerSubtitles, DCPTimePeriod> > _subtitles;
 
-       PlayerStatistics _statistics;
+       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