Fix seconds_to_approximate_hms sometimes saying things like 1h60m (#1314).
[dcpomatic.git] / src / lib / player.h
index 20b83bfdb7c2468e702409fbc500286937553ec5..fc7117ba201abc006482819a5c27f8f7e56e140a 100644 (file)
 /*
-    Copyright (C) 2013 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2013-2018 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 "player_subtitles.h"
+#include "active_subtitles.h"
+#include "film.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 "empty.h"
 #include <boost/shared_ptr.hpp>
 #include <boost/enable_shared_from_this.hpp>
-#include "video_source.h"
-#include "audio_source.h"
-#include "video_sink.h"
-#include "audio_sink.h"
-
-class VideoDecoder;
-class AudioDecoder;
-class Job;
-class Film;
+#include <list>
+
+namespace dcp {
+       class ReelAsset;
+}
+
+class PlayerVideo;
 class Playlist;
-class AudioContent;
+class Font;
+class AudioBuffers;
+class ReferencedReelAsset;
+class Shuffler;
+
+class PlayerProperty
+{
+public:
+       static int const VIDEO_CONTAINER_SIZE;
+       static int const PLAYLIST;
+       static int const FILM_CONTAINER;
+       static int const FILM_VIDEO_FRAME_RATE;
+       static int const DCP_DECODE_REDUCTION;
+};
 
 /** @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 TimedVideoSource, public TimedAudioSource, public TimedVideoSink, public boost::enable_shared_from_this<Player>
+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 ();
-       void disable_subtitles ();
+       Player (boost::shared_ptr<const Film>, boost::shared_ptr<const Playlist> playlist);
+       ~Player ();
 
        bool pass ();
-       void set_progress (boost::shared_ptr<Job>);
-       bool seek (double);
-       void seek_back ();
-       void seek_forward ();
-
-       double last_video_time () const;
+       void seek (DCPTime time, bool accurate);
+
+       std::list<boost::shared_ptr<Font> > get_subtitle_fonts ();
+       std::list<ReferencedReelAsset> get_reel_assets ();
+       dcp::Size video_container_size () const {
+               return _video_container_size;
+       }
+
+       void set_video_container_size (dcp::Size);
+       void set_ignore_video ();
+       void set_ignore_subtitle ();
+       void set_always_burn_subtitles (bool burn);
+       void set_fast ();
+       void set_play_referenced ();
+       void set_dcp_decode_reduction (boost::optional<int> reduction);
+
+       /** 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
+        *  a seek.
+        *
+        *  The first parameter is what changed.
+        *  The second parameter is true if these signals are currently likely to be frequent.
+        */
+       boost::signals2::signal<void (int, bool)> Changed;
+
+       /** Emitted when a video frame is ready.  These emissions happen in the correct order. */
+       boost::signals2::signal<void (boost::shared_ptr<PlayerVideo>, DCPTime)> Video;
+       boost::signals2::signal<void (boost::shared_ptr<AudioBuffers>, DCPTime)> Audio;
+       /** Emitted when a subtitle is ready.  This signal may be emitted considerably
+        *  after the corresponding Video.
+        */
+       boost::signals2::signal<void (PlayerSubtitles, DCPTimePeriod)> Subtitle;
 
 private:
-       void process_video (boost::shared_ptr<const Image> i, bool same, boost::shared_ptr<Subtitle> s, double);
-       void process_audio (boost::weak_ptr<const AudioContent>, boost::shared_ptr<const AudioBuffers>, double);
-       void setup_decoders ();
+       friend class PlayerWrapper;
+       friend class Piece;
+       friend struct player_time_calculation_test1;
+       friend struct player_time_calculation_test2;
+       friend struct player_time_calculation_test3;
+       friend struct player_subframe_test;
+
+       void setup_pieces ();
+       void flush ();
+       void film_changed (Film::Property);
        void playlist_changed ();
-       void content_changed (boost::weak_ptr<Content>, int);
+       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 (Eyes eyes) const;
+       void video (boost::weak_ptr<Piece>, ContentVideo);
+       void audio (boost::weak_ptr<Piece>, AudioStreamPtr, ContentAudio);
+       void image_subtitle_start (boost::weak_ptr<Piece>, ContentImageSubtitle);
+       void text_subtitle_start (boost::weak_ptr<Piece>, ContentTextSubtitle);
+       void subtitle_stop (boost::weak_ptr<Piece>, ContentTime);
+       DCPTime one_video_frame () const;
+       void fill_audio (DCPTimePeriod period);
+       std::pair<boost::shared_ptr<AudioBuffers>, DCPTime> discard_audio (
+               boost::shared_ptr<const AudioBuffers> audio, DCPTime time, DCPTime discard_to
+               ) const;
+       boost::optional<PositionImage> subtitles_for_frame (DCPTime time) const;
+       void emit_video (boost::shared_ptr<PlayerVideo> pv, DCPTime time);
+       void do_emit_video (boost::shared_ptr<PlayerVideo> pv, DCPTime time);
+       void emit_audio (boost::shared_ptr<AudioBuffers> data, DCPTime time);
 
        boost::shared_ptr<const Film> _film;
        boost::shared_ptr<const Playlist> _playlist;
-       
-       bool _video;
-       bool _audio;
-       bool _subtitles;
-
-       /** Our decoders are ready to go; if this is false the decoders must be (re-)created before they are used */
-       bool _have_valid_decoders;
-       /** Video decoders in order of presentation */
-       std::vector<boost::shared_ptr<VideoDecoder> > _video_decoders;
-       /** Start positions of each video decoder in seconds*/
-       std::vector<double> _video_start;
-        /** Index of current video decoder */
-       size_t _video_decoder;
-        /** Audio decoders in order of presentation (if they are from FFmpeg) */
-       std::vector<boost::shared_ptr<AudioDecoder> > _audio_decoders;
-       /** Start positions of each audio decoder (if they are from FFmpeg) in seconds */
-       std::vector<double> _audio_start;
-       /** Current audio decoder index if we are running them sequentially; otherwise undefined */
-       size_t _sequential_audio_decoder;
-
-       boost::shared_ptr<AudioBuffers> _audio_buffers;
-       boost::optional<double> _audio_time;
+
+       /** 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;
+
+       /** 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_subtitle;
+       /** 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;
+
+       /** Time just after the last video frame we emitted, or the time of the last accurate seek */
+       boost::optional<DCPTime> _last_video_time;
+       boost::optional<Eyes> _last_video_eyes;
+       /** Time just after the last audio frame we emitted, or the time of the last accurate seek */
+       boost::optional<DCPTime> _last_audio_time;
+
+       boost::optional<int> _dcp_decode_reduction;
+
+       typedef std::map<boost::weak_ptr<Piece>, boost::shared_ptr<PlayerVideo> > LastVideoMap;
+       LastVideoMap _last_video;
+
+       AudioMerger _audio_merger;
+       Shuffler* _shuffler;
+       std::list<std::pair<boost::shared_ptr<PlayerVideo>, DCPTime> > _delay;
+
+       class StreamState
+       {
+       public:
+               StreamState () {}
+
+               StreamState (boost::shared_ptr<Piece> p, DCPTime l)
+                       : piece(p)
+                       , last_push_end(l)
+               {}
+
+               boost::shared_ptr<Piece> piece;
+               DCPTime last_push_end;
+       };
+       std::map<AudioStreamPtr, StreamState> _stream_states;
+
+       Empty _black;
+       Empty _silent;
+
+       ActiveSubtitles _active_subtitles;
+       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;
 };
 
 #endif