src/lib/player.h

   1 /*
   2     Copyright (C) 2013-2018 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_text.h"
  25 #include "active_text.h"
  26 #include "content_text.h"
  27 #include "film.h"
  28 #include "content.h"
  29 #include "position_image.h"
  30 #include "piece.h"
  31 #include "content_video.h"
  32 #include "content_audio.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 class Shuffler;
  50
  51 class PlayerProperty
  52 {
  53 public:
  54         static int const VIDEO_CONTAINER_SIZE;
  55         static int const PLAYLIST;
  56         static int const FILM_CONTAINER;
  57         static int const FILM_VIDEO_FRAME_RATE;
  58         static int const DCP_DECODE_REDUCTION;
  59 };
  60
  61 /** @class Player
  62  *  @brief A class which can `play' a Playlist.
  63  */
  64 class Player : public boost::enable_shared_from_this<Player>, public boost::noncopyable
  65 {
  66 public:
  67         Player (boost::shared_ptr<const Film>, boost::shared_ptr<const Playlist> playlist);
  68         ~Player ();
  69
  70         bool pass ();
  71         void seek (DCPTime time, bool accurate);
  72
  73         std::list<boost::shared_ptr<Font> > get_subtitle_fonts ();
  74         std::list<ReferencedReelAsset> get_reel_assets ();
  75         dcp::Size video_container_size () const {
  76                 return _video_container_size;
  77         }
  78
  79         void set_video_container_size (dcp::Size);
  80         void set_ignore_video ();
  81         void set_ignore_subtitle ();
  82         void set_always_burn_subtitles (bool burn);
  83         void set_fast ();
  84         void set_play_referenced ();
  85         void set_dcp_decode_reduction (boost::optional<int> reduction);
  86
  87         DCPTime content_time_to_dcp (boost::shared_ptr<Content> content, ContentTime t);
  88
  89         /** Emitted when something has changed such that if we went back and emitted
  90          *  the last frame again it would look different.  This is not emitted after
  91          *  a seek.
  92          *
  93          *  The first parameter is what changed.
  94          *  The second parameter is true if these signals are currently likely to be frequent.
  95          */
  96         boost::signals2::signal<void (int, bool)> Changed;
  97
  98         /** Emitted when a video frame is ready.  These emissions happen in the correct order. */
  99         boost::signals2::signal<void (boost::shared_ptr<PlayerVideo>, DCPTime)> Video;
 100         boost::signals2::signal<void (boost::shared_ptr<AudioBuffers>, DCPTime)> Audio;
 101         /** Emitted when a caption is ready.  This signal may be emitted considerably
 102          *  after the corresponding Video.
 103          */
 104         boost::signals2::signal<void (PlayerText, TextType, DCPTimePeriod)> Text;
 105
 106 private:
 107         friend class PlayerWrapper;
 108         friend class Piece;
 109         friend struct player_time_calculation_test1;
 110         friend struct player_time_calculation_test2;
 111         friend struct player_time_calculation_test3;
 112         friend struct player_subframe_test;
 113
 114         void setup_pieces ();
 115         void flush ();
 116         void film_changed (Film::Property);
 117         void playlist_changed ();
 118         void playlist_content_changed (boost::weak_ptr<Content>, int, bool);
 119         std::list<PositionImage> transform_bitmap_texts (std::list<BitmapText>) const;
 120         Frame dcp_to_content_video (boost::shared_ptr<const Piece> piece, DCPTime t) const;
 121         DCPTime content_video_to_dcp (boost::shared_ptr<const Piece> piece, Frame f) const;
 122         Frame dcp_to_resampled_audio (boost::shared_ptr<const Piece> piece, DCPTime t) const;
 123         DCPTime resampled_audio_to_dcp (boost::shared_ptr<const Piece> piece, Frame f) const;
 124         ContentTime dcp_to_content_time (boost::shared_ptr<const Piece> piece, DCPTime t) const;
 125         DCPTime content_time_to_dcp (boost::shared_ptr<const Piece> piece, ContentTime t) const;
 126         boost::shared_ptr<PlayerVideo> black_player_video_frame (Eyes eyes) const;
 127         void video (boost::weak_ptr<Piece>, ContentVideo);
 128         void audio (boost::weak_ptr<Piece>, AudioStreamPtr, ContentAudio);
 129         void bitmap_text_start (boost::weak_ptr<Piece>, ContentBitmapText);
 130         void plain_text_start (boost::weak_ptr<Piece>, ContentPlainText);
 131         void subtitle_stop (boost::weak_ptr<Piece>, ContentTime, TextType);
 132         DCPTime one_video_frame () const;
 133         void fill_audio (DCPTimePeriod period);
 134         std::pair<boost::shared_ptr<AudioBuffers>, DCPTime> discard_audio (
 135                 boost::shared_ptr<const AudioBuffers> audio, DCPTime time, DCPTime discard_to
 136                 ) const;
 137         boost::optional<PositionImage> subtitles_for_frame (DCPTime time) const;
 138         void emit_video (boost::shared_ptr<PlayerVideo> pv, DCPTime time);
 139         void do_emit_video (boost::shared_ptr<PlayerVideo> pv, DCPTime time);
 140         void emit_audio (boost::shared_ptr<AudioBuffers> data, DCPTime time);
 141
 142         boost::shared_ptr<const Film> _film;
 143         boost::shared_ptr<const Playlist> _playlist;
 144
 145         /** Our pieces are ready to go; if this is false the pieces must be (re-)created before they are used */
 146         bool _have_valid_pieces;
 147         std::list<boost::shared_ptr<Piece> > _pieces;
 148
 149         /** Size of the image in the DCP (e.g. 1990x1080 for flat) */
 150         dcp::Size _video_container_size;
 151         boost::shared_ptr<Image> _black_image;
 152
 153         /** true if the player should ignore all video; i.e. never produce any */
 154         bool _ignore_video;
 155         /** true if the player should ignore all audio; i.e. never produce any */
 156         bool _ignore_subtitle;
 157         /** true if the player should always burn subtitles into the video regardless
 158             of content settings
 159         */
 160         bool _always_burn_subtitles;
 161         /** true if we should try to be fast rather than high quality */
 162         bool _fast;
 163         /** true if we should `play' (i.e output) referenced DCP data (e.g. for preview) */
 164         bool _play_referenced;
 165
 166         /** Time just after the last video frame we emitted, or the time of the last accurate seek */
 167         boost::optional<DCPTime> _last_video_time;
 168         boost::optional<Eyes> _last_video_eyes;
 169         /** Time just after the last audio frame we emitted, or the time of the last accurate seek */
 170         boost::optional<DCPTime> _last_audio_time;
 171
 172         boost::optional<int> _dcp_decode_reduction;
 173
 174         typedef std::map<boost::weak_ptr<Piece>, boost::shared_ptr<PlayerVideo> > LastVideoMap;
 175         LastVideoMap _last_video;
 176
 177         AudioMerger _audio_merger;
 178         Shuffler* _shuffler;
 179         std::list<std::pair<boost::shared_ptr<PlayerVideo>, DCPTime> > _delay;
 180
 181         class StreamState
 182         {
 183         public:
 184                 StreamState () {}
 185
 186                 StreamState (boost::shared_ptr<Piece> p, DCPTime l)
 187                         : piece(p)
 188                         , last_push_end(l)
 189                 {}
 190
 191                 boost::shared_ptr<Piece> piece;
 192                 DCPTime last_push_end;
 193         };
 194         std::map<AudioStreamPtr, StreamState> _stream_states;
 195
 196         Empty _black;
 197         Empty _silent;
 198
 199         ActiveText _active_text[TEXT_COUNT];
 200         boost::shared_ptr<AudioProcessor> _audio_processor;
 201
 202         boost::signals2::scoped_connection _film_changed_connection;
 203         boost::signals2::scoped_connection _playlist_changed_connection;
 204         boost::signals2::scoped_connection _playlist_content_changed_connection;
 205 };
 206
 207 #endif