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 "active_subtitles.h"
  26 #include "film.h"
  27 #include "content.h"
  28 #include "position_image.h"
  29 #include "piece.h"
  30 #include "content_video.h"
  31 #include "content_audio.h"
  32 #include "content_subtitle.h"
  33 #include "audio_stream.h"
  34 #include "audio_merger.h"
  35 #include "empty.h"
  36 #include <boost/shared_ptr.hpp>
  37 #include <boost/enable_shared_from_this.hpp>
  38 #include <list>
  39
  40 namespace dcp {
  41         class ReelAsset;
  42 }
  43
  44 class PlayerVideo;
  45 class Playlist;
  46 class Font;
  47 class AudioBuffers;
  48 class ReferencedReelAsset;
  49
  50 /** @class Player
  51  *  @brief A class which can `play' a Playlist.
  52  */
  53 class Player : public boost::enable_shared_from_this<Player>, public boost::noncopyable
  54 {
  55 public:
  56         Player (boost::shared_ptr<const Film>, boost::shared_ptr<const Playlist> playlist);
  57
  58         bool pass ();
  59         void seek (DCPTime time, bool accurate);
  60
  61         std::list<boost::shared_ptr<Font> > get_subtitle_fonts ();
  62         std::list<ReferencedReelAsset> get_reel_assets ();
  63
  64         void set_video_container_size (dcp::Size);
  65         void set_ignore_video ();
  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         DCPTime one_video_frame () const;
 111         void fill_audio (DCPTimePeriod period);
 112         std::pair<boost::shared_ptr<AudioBuffers>, DCPTime> discard_audio (
 113                 boost::shared_ptr<const AudioBuffers> audio, DCPTime time, DCPTime discard_to
 114                 ) const;
 115         boost::optional<PositionImage> subtitles_for_frame (DCPTime time) const;
 116         void emit_video (boost::shared_ptr<PlayerVideo> pv, DCPTime time);
 117         void emit_audio (boost::shared_ptr<AudioBuffers> data, DCPTime time);
 118
 119         boost::shared_ptr<const Film> _film;
 120         boost::shared_ptr<const Playlist> _playlist;
 121
 122         /** Our pieces are ready to go; if this is false the pieces must be (re-)created before they are used */
 123         bool _have_valid_pieces;
 124         std::list<boost::shared_ptr<Piece> > _pieces;
 125
 126         /** Size of the image in the DCP (e.g. 1990x1080 for flat) */
 127         dcp::Size _video_container_size;
 128         boost::shared_ptr<Image> _black_image;
 129
 130         /** true if the player should ignore all video; i.e. never produce any */
 131         bool _ignore_video;
 132         /** true if the player should ignore all audio; i.e. never produce any */
 133         bool _ignore_audio;
 134         /** true if the player should always burn subtitles into the video regardless
 135             of content settings
 136         */
 137         bool _always_burn_subtitles;
 138         /** true if we should try to be fast rather than high quality */
 139         bool _fast;
 140         /** true if we should `play' (i.e output) referenced DCP data (e.g. for preview) */
 141         bool _play_referenced;
 142
 143         /** Time just after the last video frame we emitted, or the time of the last accurate seek */
 144         boost::optional<DCPTime> _last_video_time;
 145         /** Time just after the last audio frame we emitted, or the time of the last accurate seek */
 146         boost::optional<DCPTime> _last_audio_time;
 147
 148         typedef std::map<boost::weak_ptr<Piece>, boost::shared_ptr<PlayerVideo> > LastVideoMap;
 149         LastVideoMap _last_video;
 150
 151         AudioMerger _audio_merger;
 152
 153         class StreamState
 154         {
 155         public:
 156                 StreamState () {}
 157
 158                 StreamState (boost::shared_ptr<Piece> p, DCPTime l)
 159                         : piece(p)
 160                         , last_push_end(l)
 161                 {}
 162
 163                 boost::shared_ptr<Piece> piece;
 164                 DCPTime last_push_end;
 165         };
 166         std::map<AudioStreamPtr, StreamState> _stream_states;
 167
 168         Empty _black;
 169         Empty _silent;
 170
 171         ActiveSubtitles _active_subtitles;
 172         boost::shared_ptr<AudioProcessor> _audio_processor;
 173
 174         boost::signals2::scoped_connection _film_changed_connection;
 175         boost::signals2::scoped_connection _playlist_changed_connection;
 176         boost::signals2::scoped_connection _playlist_content_changed_connection;
 177 };
 178
 179 #endif