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