src/lib/player.h

   1 /*
   2     Copyright (C) 2013 Carl Hetherington <cth@carlh.net>
   3
   4     This program is free software; you can redistribute it and/or modify
   5     it under the terms of the GNU General Public License as published by
   6     the Free Software Foundation; either version 2 of the License, or
   7     (at your option) any later version.
   8
   9     This program is distributed in the hope that it will be useful,
  10     but WITHOUT ANY WARRANTY; without even the implied warranty of
  11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12     GNU General Public License for more details.
  13
  14     You should have received a copy of the GNU General Public License
  15     along with this program; if not, write to the Free Software
  16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17
  18 */
  19
  20 #ifndef DCPOMATIC_PLAYER_H
  21 #define DCPOMATIC_PLAYER_H
  22
  23 #include <list>
  24 #include <boost/shared_ptr.hpp>
  25 #include <boost/enable_shared_from_this.hpp>
  26 #include "playlist.h"
  27 #include "content.h"
  28 #include "film.h"
  29 #include "rect.h"
  30 #include "audio_merger.h"
  31 #include "audio_content.h"
  32 #include "decoded.h"
  33
  34 class Job;
  35 class Film;
  36 class Playlist;
  37 class AudioContent;
  38 class Piece;
  39 class Image;
  40
  41 /** @class PlayerImage
  42  *  @brief A wrapper for an Image which contains some pending operations; these may
  43  *  not be necessary if the receiver of the PlayerImage throws it away.
  44  */
  45 class PlayerImage
  46 {
  47 public:
  48         PlayerImage (boost::shared_ptr<const Image>, Crop, libdcp::Size, libdcp::Size, Scaler const *);
  49
  50         void set_subtitle (boost::shared_ptr<const Image>, Position<int>);
  51
  52         boost::shared_ptr<Image> image (AVPixelFormat, bool);
  53
  54 private:
  55         boost::shared_ptr<const Image> _in;
  56         Crop _crop;
  57         libdcp::Size _inter_size;
  58         libdcp::Size _out_size;
  59         Scaler const * _scaler;
  60         boost::shared_ptr<const Image> _subtitle_image;
  61         Position<int> _subtitle_position;
  62 };
  63
  64 class PlayerStatistics
  65 {
  66 public:
  67         struct Video {
  68                 Video ()
  69                         : black (0)
  70                         , repeat (0)
  71                         , good (0)
  72                         , skip (0)
  73                 {}
  74
  75                 int black;
  76                 int repeat;
  77                 int good;
  78                 int skip;
  79         } video;
  80
  81         struct Audio {
  82                 Audio ()
  83                         : silence (0)
  84                         , good (0)
  85                         , skip (0)
  86                 {}
  87
  88                 int64_t silence;
  89                 int64_t good;
  90                 int64_t skip;
  91         } audio;
  92
  93         void dump (boost::shared_ptr<Log>) const;
  94 };
  95
  96 /** @class Player
  97  *  @brief A class which can `play' a Playlist; emitting its audio and video.
  98  */
  99
 100 class Player : public boost::enable_shared_from_this<Player>, public boost::noncopyable
 101 {
 102 public:
 103         Player (boost::shared_ptr<const Film>, boost::shared_ptr<const Playlist>);
 104
 105         void disable_video ();
 106         void disable_audio ();
 107
 108         bool pass ();
 109         void seek (DCPTime, bool);
 110
 111         DCPTime video_position () const {
 112                 return _video_position;
 113         }
 114
 115         void set_video_container_size (libdcp::Size);
 116         void set_approximate_size ();
 117
 118         bool repeat_last_video ();
 119
 120         PlayerStatistics const & statistics () const;
 121
 122         /** Emitted when a video frame is ready.
 123          *  First parameter is the video image.
 124          *  Second parameter is the eye(s) that should see this image.
 125          *  Third parameter is the colour conversion that should be used for this image.
 126          *  Fourth parameter is true if the image is the same as the last one that was emitted.
 127          *  Fifth parameter is the time.
 128          */
 129         boost::signals2::signal<void (boost::shared_ptr<PlayerImage>, Eyes, ColourConversion, bool, DCPTime)> Video;
 130
 131         /** Emitted when some audio data is ready */
 132         boost::signals2::signal<void (boost::shared_ptr<const AudioBuffers>, DCPTime)> Audio;
 133
 134         /** Emitted when something has changed such that if we went back and emitted
 135          *  the last frame again it would look different.  This is not emitted after
 136          *  a seek.
 137          *
 138          *  The parameter is true if these signals are currently likely to be frequent.
 139          */
 140         boost::signals2::signal<void (bool)> Changed;
 141
 142 private:
 143         friend class PlayerWrapper;
 144         friend class Piece;
 145
 146         void setup_pieces ();
 147         void playlist_changed ();
 148         void content_changed (boost::weak_ptr<Content>, int, bool);
 149         void do_seek (DCPTime, bool);
 150         void flush ();
 151         void emit_black ();
 152         void emit_silence (AudioFrame);
 153         void film_changed (Film::Property);
 154         void update_subtitle ();
 155         void emit_video (boost::weak_ptr<Piece>, boost::shared_ptr<DecodedVideo>);
 156         void emit_audio (boost::weak_ptr<Piece>, boost::shared_ptr<DecodedAudio>);
 157         void step_video_position (boost::shared_ptr<DecodedVideo>);
 158
 159         boost::shared_ptr<const Film> _film;
 160         boost::shared_ptr<const Playlist> _playlist;
 161
 162         bool _video;
 163         bool _audio;
 164
 165         /** Our pieces are ready to go; if this is false the pieces must be (re-)created before they are used */
 166         bool _have_valid_pieces;
 167         std::list<boost::shared_ptr<Piece> > _pieces;
 168
 169         /** The time after the last video that we emitted */
 170         DCPTime _video_position;
 171         /** The time after the last audio that we emitted */
 172         DCPTime _audio_position;
 173
 174         AudioMerger<DCPTime, AudioFrame> _audio_merger;
 175
 176         libdcp::Size _video_container_size;
 177         boost::shared_ptr<PlayerImage> _black_frame;
 178
 179         struct {
 180                 boost::weak_ptr<Piece> piece;
 181                 boost::shared_ptr<DecodedSubtitle> subtitle;
 182         } _in_subtitle;
 183
 184         struct {
 185                 Position<int> position;
 186                 boost::shared_ptr<Image> image;
 187                 DCPTime from;
 188                 DCPTime to;
 189         } _out_subtitle;
 190
 191 #ifdef DCPOMATIC_DEBUG
 192         boost::shared_ptr<Content> _last_video;
 193 #endif
 194
 195         bool _last_emit_was_black;
 196
 197         struct {
 198                 boost::weak_ptr<Piece> weak_piece;
 199                 boost::shared_ptr<DecodedVideo> video;
 200         } _last_incoming_video;
 201
 202         bool _just_did_inaccurate_seek;
 203         bool _approximate_size;
 204
 205         PlayerStatistics _statistics;
 206
 207         boost::signals2::scoped_connection _playlist_changed_connection;
 208         boost::signals2::scoped_connection _playlist_content_changed_connection;
 209         boost::signals2::scoped_connection _film_changed_connection;
 210 };
 211
 212 #endif