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                 boost::mutex::scoped_lock lm (_mutex);
  77                 return _video_container_size;
  78         }
  79
  80         void set_video_container_size (dcp::Size);
  81         void set_ignore_video ();
  82         void set_ignore_audio ();
  83         void set_ignore_text ();
  84         void set_always_burn_open_subtitles ();
  85         void set_fast ();
  86         void set_play_referenced ();
  87         void set_dcp_decode_reduction (boost::optional<int> reduction);
  88
  89         boost::optional<DCPTime> content_time_to_dcp (boost::shared_ptr<Content> content, ContentTime t);
  90
  91         /* The player's internal state may be about to change such so
  92            that its emissions from Video and Audio will suddenly be
  93            from an undefined position.  Listeners should prepare
  94            themselves for this possibility.
  95         */
  96         boost::signals2::signal<void ()> MayChange;
  97
  98         /** The player's internal state has now changed.
  99          *
 100          *  The first parameter is what changed.
 101          *  The second parameter is true if these signals are currently likely to be frequent.
 102          */
 103         boost::signals2::signal<void (int, bool)> Changed;
 104
 105         /** The change suggested by a MayChange did not happen */
 106         boost::signals2::signal<void ()> NotChanged;
 107
 108         /** Emitted when a video frame is ready.  These emissions happen in the correct order. */
 109         boost::signals2::signal<void (boost::shared_ptr<PlayerVideo>, DCPTime)> Video;
 110         boost::signals2::signal<void (boost::shared_ptr<AudioBuffers>, DCPTime)> Audio;
 111         /** Emitted when a text is ready.  This signal may be emitted considerably
 112          *  after the corresponding Video.
 113          */
 114         boost::signals2::signal<void (PlayerText, TextType, DCPTimePeriod)> Text;
 115
 116 private:
 117         friend class PlayerWrapper;
 118         friend class Piece;
 119         friend struct player_time_calculation_test1;
 120         friend struct player_time_calculation_test2;
 121         friend struct player_time_calculation_test3;
 122         friend struct player_subframe_test;
 123
 124         void setup_pieces ();
 125         void setup_pieces_unlocked ();
 126         void flush ();
 127         void film_changed (Film::Property);
 128         void playlist_changed ();
 129         void playlist_content_may_change ();
 130         void playlist_content_changed (boost::weak_ptr<Content>, int, bool);
 131         void playlist_content_not_changed ();
 132         std::list<PositionImage> transform_bitmap_texts (std::list<BitmapText>) const;
 133         Frame dcp_to_content_video (boost::shared_ptr<const Piece> piece, DCPTime t) const;
 134         DCPTime content_video_to_dcp (boost::shared_ptr<const Piece> piece, Frame f) const;
 135         Frame dcp_to_resampled_audio (boost::shared_ptr<const Piece> piece, DCPTime t) const;
 136         DCPTime resampled_audio_to_dcp (boost::shared_ptr<const Piece> piece, Frame f) const;
 137         ContentTime dcp_to_content_time (boost::shared_ptr<const Piece> piece, DCPTime t) const;
 138         DCPTime content_time_to_dcp (boost::shared_ptr<const Piece> piece, ContentTime t) const;
 139         boost::shared_ptr<PlayerVideo> black_player_video_frame (Eyes eyes) const;
 140         void video (boost::weak_ptr<Piece>, ContentVideo);
 141         void audio (boost::weak_ptr<Piece>, AudioStreamPtr, ContentAudio);
 142         void bitmap_text_start (boost::weak_ptr<Piece>, boost::weak_ptr<const TextContent>, ContentBitmapText);
 143         void plain_text_start (boost::weak_ptr<Piece>, boost::weak_ptr<const TextContent>, ContentStringText);
 144         void subtitle_stop (boost::weak_ptr<Piece>, boost::weak_ptr<const TextContent>, ContentTime, TextType);
 145         DCPTime one_video_frame () const;
 146         void fill_audio (DCPTimePeriod period);
 147         std::pair<boost::shared_ptr<AudioBuffers>, DCPTime> discard_audio (
 148                 boost::shared_ptr<const AudioBuffers> audio, DCPTime time, DCPTime discard_to
 149                 ) const;
 150         boost::optional<PositionImage> open_subtitles_for_frame (DCPTime time) const;
 151         void emit_video (boost::shared_ptr<PlayerVideo> pv, DCPTime time);
 152         void do_emit_video (boost::shared_ptr<PlayerVideo> pv, DCPTime time);
 153         void emit_audio (boost::shared_ptr<AudioBuffers> data, DCPTime time);
 154
 155         /** Mutex to protect the whole Player state.  When it's used for the preview we have
 156             seek() and pass() called from the Butler thread and lots of other stuff called
 157             from the GUI thread.
 158         */
 159         mutable boost::mutex _mutex;
 160
 161         boost::shared_ptr<const Film> _film;
 162         boost::shared_ptr<const Playlist> _playlist;
 163
 164         /** true if we are suspended (i.e. pass() and seek() do nothing */
 165         bool _suspended;
 166         std::list<boost::shared_ptr<Piece> > _pieces;
 167
 168         /** Size of the image in the DCP (e.g. 1990x1080 for flat) */
 169         dcp::Size _video_container_size;
 170         boost::shared_ptr<Image> _black_image;
 171
 172         /** true if the player should ignore all video; i.e. never produce any */
 173         bool _ignore_video;
 174         bool _ignore_audio;
 175         /** true if the player should ignore all text; i.e. never produce any */
 176         bool _ignore_text;
 177         bool _always_burn_open_subtitles;
 178         /** true if we should try to be fast rather than high quality */
 179         bool _fast;
 180         /** true if we should `play' (i.e output) referenced DCP data (e.g. for preview) */
 181         bool _play_referenced;
 182
 183         /** Time just after the last video frame we emitted, or the time of the last accurate seek */
 184         boost::optional<DCPTime> _last_video_time;
 185         boost::optional<Eyes> _last_video_eyes;
 186         /** Time just after the last audio frame we emitted, or the time of the last accurate seek */
 187         boost::optional<DCPTime> _last_audio_time;
 188
 189         boost::optional<int> _dcp_decode_reduction;
 190
 191         typedef std::map<boost::weak_ptr<Piece>, boost::shared_ptr<PlayerVideo> > LastVideoMap;
 192         LastVideoMap _last_video;
 193
 194         AudioMerger _audio_merger;
 195         Shuffler* _shuffler;
 196         std::list<std::pair<boost::shared_ptr<PlayerVideo>, DCPTime> > _delay;
 197
 198         class StreamState
 199         {
 200         public:
 201                 StreamState () {}
 202
 203                 StreamState (boost::shared_ptr<Piece> p, DCPTime l)
 204                         : piece(p)
 205                         , last_push_end(l)
 206                 {}
 207
 208                 boost::shared_ptr<Piece> piece;
 209                 DCPTime last_push_end;
 210         };
 211         std::map<AudioStreamPtr, StreamState> _stream_states;
 212
 213         Empty _black;
 214         Empty _silent;
 215
 216         ActiveText _active_texts[TEXT_COUNT];
 217         boost::shared_ptr<AudioProcessor> _audio_processor;
 218
 219         boost::signals2::scoped_connection _film_changed_connection;
 220         boost::signals2::scoped_connection _playlist_changed_connection;
 221         boost::signals2::scoped_connection _playlist_content_may_change_connection;
 222         boost::signals2::scoped_connection _playlist_content_changed_connection;
 223         boost::signals2::scoped_connection _playlist_content_not_changed_connection;
 224 };
 225
 226 #endif