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