Reword again: Text -> Caption and Plain -> Text.
[dcpomatic.git] / src / lib / player.h
index a795f8174323002900ece524f1cffcad88309cdd..16e9d57a5b38d92af5a0431b988a3c5413275d9a 100644 (file)
@@ -1,49 +1,62 @@
 /*
-    Copyright (C) 2013-2015 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 "content.h"
+#include "player_caption.h"
+#include "active_captions.h"
+#include "content_text.h"
 #include "film.h"
-#include "rect.h"
-#include "audio_content.h"
-#include "dcpomatic_time.h"
-#include "content_subtitle.h"
+#include "content.h"
 #include "position_image.h"
 #include "piece.h"
 #include "content_video.h"
-#include "player_subtitles.h"
+#include "content_audio.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 <list>
 
-class Job;
-class Film;
-class AudioContent;
-class Piece;
-class Image;
-class Decoder;
-class Resampler;
+namespace dcp {
+       class ReelAsset;
+}
+
 class PlayerVideo;
-class ImageProxy;
+class Playlist;
 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.
@@ -52,68 +65,79 @@ class Player : public boost::enable_shared_from_this<Player>, public boost::nonc
 {
 public:
        Player (boost::shared_ptr<const Film>, boost::shared_ptr<const Playlist> playlist);
+       ~Player ();
+
+       bool pass ();
+       void seek (DCPTime time, bool accurate);
 
-       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<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_enable_subtitles (bool enable);
+       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);
+
+       DCPTime content_time_to_dcp (boost::shared_ptr<Content> content, ContentTime t);
 
        /** 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 parameter is true if these signals are currently likely to be frequent.
+        *  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 caption is ready.  This signal may be emitted considerably
+        *  after the corresponding Video.
         */
-       boost::signals2::signal<void (bool)> Changed;
+       boost::signals2::signal<void (PlayerCaption, TextType, DCPTimePeriod)> Text;
 
 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;
+       friend struct player_subframe_test;
 
        void setup_pieces ();
        void flush ();
        void film_changed (Film::Property);
        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 ();
+       std::list<PositionImage> transform_bitmap_texts (std::list<BitmapText>) 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;
-       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;
-       }
+       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 bitmap_text_start (boost::weak_ptr<Piece>, ContentBitmapCaption);
+       void plain_text_start (boost::weak_ptr<Piece>, ContentTextCaption);
+       void subtitle_stop (boost::weak_ptr<Piece>, ContentTime, TextType);
+       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;
@@ -128,11 +152,51 @@ private:
 
        /** 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;
 
+       ActiveCaptions _active_text[TEXT_COUNT];
        boost::shared_ptr<AudioProcessor> _audio_processor;
 
        boost::signals2::scoped_connection _film_changed_connection;