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         boost::signals2::signal<void (ChangeType, int, bool)> Change;
  92
  93         /** The change suggested by a MayChange did not happen */
  94         boost::signals2::signal<void ()> NotChanged;
  95
  96         /** Emitted when a video frame is ready.  These emissions happen in the correct order. */
  97         boost::signals2::signal<void (boost::shared_ptr<PlayerVideo>, DCPTime)> Video;
  98         boost::signals2::signal<void (boost::shared_ptr<AudioBuffers>, DCPTime)> Audio;
  99         /** Emitted when a text is ready.  This signal may be emitted considerably
 100          *  after the corresponding Video.
 101          */
 102         boost::signals2::signal<void (PlayerText, TextType, boost::optional<DCPTextTrack>, DCPTimePeriod)> Text;
 103
 104 private:
 105         friend class PlayerWrapper;
 106         friend class Piece;
 107         friend struct player_time_calculation_test1;
 108         friend struct player_time_calculation_test2;
 109         friend struct player_time_calculation_test3;
 110         friend struct player_subframe_test;
 111
 112         void setup_pieces ();
 113         void setup_pieces_unlocked ();
 114         void flush ();
 115         void film_change (ChangeType, Film::Property);
 116         void playlist_change (ChangeType);
 117         void playlist_content_change (ChangeType, int, bool);
 118         std::list<PositionImage> transform_bitmap_texts (std::list<BitmapText>) const;
 119         Frame dcp_to_content_video (boost::shared_ptr<const Piece> piece, DCPTime t) const;
 120         DCPTime content_video_to_dcp (boost::shared_ptr<const Piece> piece, Frame f) const;
 121         Frame dcp_to_resampled_audio (boost::shared_ptr<const Piece> piece, DCPTime t) const;
 122         DCPTime resampled_audio_to_dcp (boost::shared_ptr<const Piece> piece, Frame f) const;
 123         ContentTime dcp_to_content_time (boost::shared_ptr<const Piece> piece, DCPTime t) const;
 124         DCPTime content_time_to_dcp (boost::shared_ptr<const Piece> piece, ContentTime t) const;
 125         boost::shared_ptr<PlayerVideo> black_player_video_frame (Eyes eyes) const;
 126         void video (boost::weak_ptr<Piece>, ContentVideo);
 127         void audio (boost::weak_ptr<Piece>, AudioStreamPtr, ContentAudio);
 128         void bitmap_text_start (boost::weak_ptr<Piece>, boost::weak_ptr<const TextContent>, ContentBitmapText);
 129         void plain_text_start (boost::weak_ptr<Piece>, boost::weak_ptr<const TextContent>, ContentStringText);
 130         void subtitle_stop (boost::weak_ptr<Piece>, boost::weak_ptr<const TextContent>, ContentTime);
 131         DCPTime one_video_frame () const;
 132         void fill_audio (DCPTimePeriod period);
 133         std::pair<boost::shared_ptr<AudioBuffers>, DCPTime> discard_audio (
 134                 boost::shared_ptr<const AudioBuffers> audio, DCPTime time, DCPTime discard_to
 135                 ) const;
 136         boost::optional<PositionImage> open_subtitles_for_frame (DCPTime time) const;
 137         void emit_video (boost::shared_ptr<PlayerVideo> pv, DCPTime time);
 138         void do_emit_video (boost::shared_ptr<PlayerVideo> pv, DCPTime time);
 139         void emit_audio (boost::shared_ptr<AudioBuffers> data, DCPTime time);
 140
 141         /** Mutex to protect the whole Player state.  When it's used for the preview we have
 142             seek() and pass() called from the Butler thread and lots of other stuff called
 143             from the GUI thread.
 144         */
 145         mutable boost::mutex _mutex;
 146
 147         boost::shared_ptr<const Film> _film;
 148         boost::shared_ptr<const Playlist> _playlist;
 149
 150         /** true if we are suspended (i.e. pass() and seek() do nothing */
 151         bool _suspended;
 152         std::list<boost::shared_ptr<Piece> > _pieces;
 153
 154         /** Size of the image in the DCP (e.g. 1990x1080 for flat) */
 155         dcp::Size _video_container_size;
 156         boost::shared_ptr<Image> _black_image;
 157
 158         /** true if the player should ignore all video; i.e. never produce any */
 159         bool _ignore_video;
 160         bool _ignore_audio;
 161         /** true if the player should ignore all text; i.e. never produce any */
 162         bool _ignore_text;
 163         bool _always_burn_open_subtitles;
 164         /** true if we should try to be fast rather than high quality */
 165         bool _fast;
 166         /** true if we should `play' (i.e output) referenced DCP data (e.g. for preview) */
 167         bool _play_referenced;
 168
 169         /** Time just after the last video frame we emitted, or the time of the last accurate seek */
 170         boost::optional<DCPTime> _last_video_time;
 171         boost::optional<Eyes> _last_video_eyes;
 172         /** Time just after the last audio frame we emitted, or the time of the last accurate seek */
 173         boost::optional<DCPTime> _last_audio_time;
 174
 175         boost::optional<int> _dcp_decode_reduction;
 176
 177         typedef std::map<boost::weak_ptr<Piece>, boost::shared_ptr<PlayerVideo> > LastVideoMap;
 178         LastVideoMap _last_video;
 179
 180         AudioMerger _audio_merger;
 181         Shuffler* _shuffler;
 182         std::list<std::pair<boost::shared_ptr<PlayerVideo>, DCPTime> > _delay;
 183
 184         class StreamState
 185         {
 186         public:
 187                 StreamState () {}
 188
 189                 StreamState (boost::shared_ptr<Piece> p, DCPTime l)
 190                         : piece(p)
 191                         , last_push_end(l)
 192                 {}
 193
 194                 boost::shared_ptr<Piece> piece;
 195                 DCPTime last_push_end;
 196         };
 197         std::map<AudioStreamPtr, StreamState> _stream_states;
 198
 199         Empty _black;
 200         Empty _silent;
 201
 202         ActiveText _active_texts[TEXT_COUNT];
 203         boost::shared_ptr<AudioProcessor> _audio_processor;
 204
 205         boost::signals2::scoped_connection _film_changed_connection;
 206         boost::signals2::scoped_connection _playlist_change_connection;
 207         boost::signals2::scoped_connection _playlist_content_change_connection;
 208 };
 209
 210 #endif