src/lib/player.h

   1 /*
   2     Copyright (C) 2013-2015 Carl Hetherington <cth@carlh.net>
   3
   4     This file is part of DCP-o-matic.
   5
   6     DCP-o-matic is free software; you can redistribute it and/or modify
   7     it under the terms of the GNU General Public License as published by
   8     the Free Software Foundation; either version 2 of the License, or
   9     (at your option) any later version.
  10
  11     DCP-o-matic is distributed in the hope that it will be useful,
  12     but WITHOUT ANY WARRANTY; without even the implied warranty of
  13     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14     GNU General Public License for more details.
  15
  16     You should have received a copy of the GNU General Public License
  17     along with DCP-o-matic.  If not, see <http://www.gnu.org/licenses/>.
  18
  19 */
  20
  21 #ifndef DCPOMATIC_PLAYER_H
  22 #define DCPOMATIC_PLAYER_H
  23
  24 #include "player_subtitles.h"
  25 #include "film.h"
  26 #include "content.h"
  27 #include "position_image.h"
  28 #include "piece.h"
  29 #include "content_video.h"
  30 #include "content_audio.h"
  31 #include "content_subtitle.h"
  32 #include "audio_stream.h"
  33 #include "audio_merger.h"
  34 #include <boost/shared_ptr.hpp>
  35 #include <boost/enable_shared_from_this.hpp>
  36 #include <list>
  37
  38 namespace dcp {
  39         class ReelAsset;
  40 }
  41
  42 class PlayerVideo;
  43 class Playlist;
  44 class Font;
  45 class AudioBuffers;
  46 class ReferencedReelAsset;
  47 class Resampler;
  48
  49 /** @class Player
  50  *  @brief A class which can `play' a Playlist.
  51  */
  52 class Player : public boost::enable_shared_from_this<Player>, public boost::noncopyable
  53 {
  54 public:
  55         Player (boost::shared_ptr<const Film>, boost::shared_ptr<const Playlist> playlist);
  56
  57         bool pass ();
  58         void seek (DCPTime time, bool accurate);
  59
  60         std::list<boost::shared_ptr<Font> > get_subtitle_fonts ();
  61         std::list<ReferencedReelAsset> get_reel_assets ();
  62
  63         void set_video_container_size (dcp::Size);
  64         void set_ignore_video ();
  65         void set_enable_subtitles (bool enable);
  66         void set_always_burn_subtitles (bool burn);
  67         void set_fast ();
  68         void set_play_referenced ();
  69
  70         /** Emitted when something has changed such that if we went back and emitted
  71          *  the last frame again it would look different.  This is not emitted after
  72          *  a seek.
  73          *
  74          *  The parameter is true if these signals are currently likely to be frequent.
  75          */
  76         boost::signals2::signal<void (bool)> Changed;
  77
  78         boost::signals2::signal<void (boost::shared_ptr<PlayerVideo>, DCPTime)> Video;
  79         boost::signals2::signal<void (boost::shared_ptr<AudioBuffers>, DCPTime)> Audio;
  80         /** Emitted when a subtitle is ready.  This signal may be emitted considerably
  81          *  after the corresponding Video.
  82          */
  83         boost::signals2::signal<void (PlayerSubtitles, DCPTimePeriod)> Subtitle;
  84
  85 private:
  86         friend class PlayerWrapper;
  87         friend class Piece;
  88         friend struct player_time_calculation_test1;
  89         friend struct player_time_calculation_test2;
  90         friend struct player_time_calculation_test3;
  91
  92         void setup_pieces ();
  93         void flush ();
  94         void film_changed (Film::Property);
  95         void playlist_changed ();
  96         void playlist_content_changed (boost::weak_ptr<Content>, int, bool);
  97         std::list<PositionImage> transform_image_subtitles (std::list<ImageSubtitle>) const;
  98         Frame dcp_to_content_video (boost::shared_ptr<const Piece> piece, DCPTime t) const;
  99         DCPTime content_video_to_dcp (boost::shared_ptr<const Piece> piece, Frame f) const;
 100         Frame dcp_to_resampled_audio (boost::shared_ptr<const Piece> piece, DCPTime t) const;
 101         DCPTime resampled_audio_to_dcp (boost::shared_ptr<const Piece> piece, Frame f) const;
 102         ContentTime dcp_to_content_time (boost::shared_ptr<const Piece> piece, DCPTime t) const;
 103         DCPTime content_time_to_dcp (boost::shared_ptr<const Piece> piece, ContentTime t) const;
 104         boost::shared_ptr<PlayerVideo> black_player_video_frame () const;
 105         void video (boost::weak_ptr<Piece>, ContentVideo);
 106         void audio (boost::weak_ptr<Piece>, AudioStreamPtr, ContentAudio);
 107         void image_subtitle_start (boost::weak_ptr<Piece>, ContentImageSubtitle);
 108         void text_subtitle_start (boost::weak_ptr<Piece>, ContentTextSubtitle);
 109         void subtitle_stop (boost::weak_ptr<Piece>, ContentTime);
 110         boost::shared_ptr<Resampler> resampler (boost::shared_ptr<const AudioContent> content, AudioStreamPtr stream, bool create);
 111         DCPTime one_video_frame () const;
 112         void fill_video (DCPTimePeriod period);
 113         void fill_audio (DCPTimePeriod period);
 114         void audio_flush (boost::shared_ptr<Piece>, AudioStreamPtr stream);
 115         void audio_transform (boost::shared_ptr<AudioContent> content, AudioStreamPtr stream, ContentAudio content_audio, DCPTime time);
 116         std::pair<boost::shared_ptr<AudioBuffers>, DCPTime> discard_audio (
 117                 boost::shared_ptr<const AudioBuffers> audio, DCPTime time, DCPTime discard_to
 118                 ) const;
 119         boost::optional<PositionImage> subtitles_for_frame (DCPTime time) const;
 120
 121         boost::shared_ptr<const Film> _film;
 122         boost::shared_ptr<const Playlist> _playlist;
 123
 124         /** Our pieces are ready to go; if this is false the pieces must be (re-)created before they are used */
 125         bool _have_valid_pieces;
 126         std::list<boost::shared_ptr<Piece> > _pieces;
 127
 128         /** Size of the image in the DCP (e.g. 1990x1080 for flat) */
 129         dcp::Size _video_container_size;
 130         boost::shared_ptr<Image> _black_image;
 131
 132         /** true if the player should ignore all video; i.e. never produce any */
 133         bool _ignore_video;
 134         /** true if the player should ignore all audio; i.e. never produce any */
 135         bool _ignore_audio;
 136         /** true if the player should always burn subtitles into the video regardless
 137             of content settings
 138         */
 139         bool _always_burn_subtitles;
 140         /** true if we should try to be fast rather than high quality */
 141         bool _fast;
 142         /** true if we should `play' (i.e output) referenced DCP data (e.g. for preview) */
 143         bool _play_referenced;
 144
 145         /** Last PlayerVideo that was emitted */
 146         boost::shared_ptr<PlayerVideo> _last_video;
 147         /** Time just after the last video frame we emitted, or the last seek time */
 148         boost::optional<DCPTime> _last_video_time;
 149         /** Time just after the last audio frame we emitted, or the last seek time */
 150         boost::optional<DCPTime> _last_audio_time;
 151         boost::optional<DCPTime> _last_seek_time;
 152
 153         AudioMerger _audio_merger;
 154
 155         class StreamState
 156         {
 157         public:
 158                 StreamState () {}
 159
 160                 StreamState (boost::shared_ptr<Piece> p, DCPTime l)
 161                         : piece(p)
 162                         , last_push_end(l)
 163                 {}
 164
 165                 boost::shared_ptr<Piece> piece;
 166                 DCPTime last_push_end;
 167         };
 168         std::map<AudioStreamPtr, StreamState> _stream_states;
 169
 170         std::list<DCPTimePeriod> _no_video;
 171         std::list<DCPTimePeriod> _no_audio;
 172
 173         class ActiveSubtitles
 174         {
 175         public:
 176                 ActiveSubtitles () {}
 177
 178                 ActiveSubtitles (PlayerSubtitles s, DCPTime f)
 179                         : subs (s)
 180                         , from (f)
 181                 {}
 182
 183                 PlayerSubtitles subs;
 184                 DCPTime from;
 185                 boost::optional<DCPTime> to;
 186         };
 187         typedef std::map<boost::weak_ptr<Piece>, std::list<ActiveSubtitles> > ActiveSubtitlesMap;
 188         ActiveSubtitlesMap _active_subtitles;
 189
 190         boost::shared_ptr<AudioProcessor> _audio_processor;
 191         typedef std::map<std::pair<boost::shared_ptr<const AudioContent>, AudioStreamPtr>, boost::shared_ptr<Resampler> > ResamplerMap;
 192         ResamplerMap _resamplers;
 193
 194         boost::signals2::scoped_connection _film_changed_connection;
 195         boost::signals2::scoped_connection _playlist_changed_connection;
 196         boost::signals2::scoped_connection _playlist_content_changed_connection;
 197 };
 198
 199 #endif