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 class Resampler;
  41
  42 /** @class PlayerImage
  43  *  @brief A wrapper for an Image which contains some pending operations; these may
  44  *  not be necessary if the receiver of the PlayerImage throws it away.
  45  */
  46 class PlayerImage
  47 {
  48 public:
  49         PlayerImage (boost::shared_ptr<const Image>, Crop, libdcp::Size, libdcp::Size, Scaler const *);
  50
  51         void set_subtitle (boost::shared_ptr<const Image>, Position<int>);
  52
  53         boost::shared_ptr<Image> image ();
  54
  55 private:
  56         boost::shared_ptr<const Image> _in;
  57         Crop _crop;
  58         libdcp::Size _inter_size;
  59         libdcp::Size _out_size;
  60         Scaler const * _scaler;
  61         boost::shared_ptr<const Image> _subtitle_image;
  62         Position<int> _subtitle_position;
  63 };
  64
  65 /** @class Player
  66  *  @brief A class which can `play' a Playlist; emitting its audio and video.
  67  */
  68
  69 class Player : public boost::enable_shared_from_this<Player>, public boost::noncopyable
  70 {
  71 public:
  72         Player (boost::shared_ptr<const Film>, boost::shared_ptr<const Playlist>);
  73
  74         void disable_video ();
  75         void disable_audio ();
  76
  77         bool pass ();
  78         void seek (DCPTime, bool);
  79
  80         DCPTime video_position () const {
  81                 return _video_position;
  82         }
  83
  84         void set_video_container_size (libdcp::Size);
  85
  86         bool repeat_last_video ();
  87
  88         /** Emitted when a video frame is ready.
  89          *  First parameter is the video image.
  90          *  Second parameter is the eye(s) that should see this image.
  91          *  Third parameter is the colour conversion that should be used for this image.
  92          *  Fourth parameter is true if the image is the same as the last one that was emitted.
  93          *  Fifth parameter is the time.
  94          */
  95         boost::signals2::signal<void (boost::shared_ptr<PlayerImage>, Eyes, ColourConversion, bool, DCPTime)> Video;
  96
  97         /** Emitted when some audio data is ready */
  98         boost::signals2::signal<void (boost::shared_ptr<const AudioBuffers>, DCPTime)> Audio;
  99
 100         /** Emitted when something has changed such that if we went back and emitted
 101          *  the last frame again it would look different.  This is not emitted after
 102          *  a seek.
 103          *
 104          *  The parameter is true if these signals are currently likely to be frequent.
 105          */
 106         boost::signals2::signal<void (bool)> Changed;
 107
 108 private:
 109         friend class PlayerWrapper;
 110         friend class Piece;
 111
 112         void setup_pieces ();
 113         void playlist_changed ();
 114         void content_changed (boost::weak_ptr<Content>, int, bool);
 115         void do_seek (DCPTime, bool);
 116         void flush ();
 117         void emit_black ();
 118         void emit_silence (OutputAudioFrame);
 119         boost::shared_ptr<Resampler> resampler (boost::shared_ptr<AudioContent>, bool);
 120         void film_changed (Film::Property);
 121         void update_subtitle ();
 122         void emit_video (boost::weak_ptr<Piece>, boost::shared_ptr<DecodedVideo>);
 123         void emit_audio (boost::weak_ptr<Piece>, boost::shared_ptr<DecodedAudio>);
 124
 125         boost::shared_ptr<const Film> _film;
 126         boost::shared_ptr<const Playlist> _playlist;
 127
 128         bool _video;
 129         bool _audio;
 130
 131         /** Our pieces are ready to go; if this is false the pieces must be (re-)created before they are used */
 132         bool _have_valid_pieces;
 133         std::list<boost::shared_ptr<Piece> > _pieces;
 134
 135         /** The time after the last video that we emitted */
 136         DCPTime _video_position;
 137         /** The time after the last audio that we emitted */
 138         DCPTime _audio_position;
 139
 140         AudioMerger<DCPTime, AudioContent::Frame> _audio_merger;
 141
 142         libdcp::Size _video_container_size;
 143         boost::shared_ptr<PlayerImage> _black_frame;
 144         std::map<boost::shared_ptr<AudioContent>, boost::shared_ptr<Resampler> > _resamplers;
 145
 146         struct {
 147                 boost::weak_ptr<Piece> piece;
 148                 boost::shared_ptr<DecodedSubtitle> subtitle;
 149         } _in_subtitle;
 150
 151         struct {
 152                 Position<int> position;
 153                 boost::shared_ptr<DecodedSubtitle> subtitle;
 154         } _out_subtitle;
 155
 156 #ifdef DCPOMATIC_DEBUG
 157         boost::shared_ptr<Content> _last_video;
 158 #endif
 159
 160         bool _last_emit_was_black;
 161
 162         struct {
 163                 boost::weak_ptr<Piece> weak_piece;
 164                 boost::shared_ptr<DecodedVideo> video;
 165         } _last_incoming_video;
 166
 167         bool _just_did_inaccurate_seek;
 168
 169         boost::signals2::scoped_connection _playlist_changed_connection;
 170         boost::signals2::scoped_connection _playlist_content_changed_connection;
 171         boost::signals2::scoped_connection _film_changed_connection;
 172 };
 173
 174 #endif