src/lib/player.h

   1 /*
   2     Copyright (C) 2013-2014 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 "piece.h"
  33 #include "subtitle.h"
  34
  35 class Job;
  36 class Film;
  37 class Playlist;
  38 class AudioContent;
  39 class Piece;
  40 class Image;
  41 class Resampler;
  42
  43 /** 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 class Player : public boost::enable_shared_from_this<Player>, public boost::noncopyable
  69 {
  70 public:
  71         Player (boost::shared_ptr<const Film>, boost::shared_ptr<const Playlist>);
  72
  73         void disable_video ();
  74         void disable_audio ();
  75
  76         bool pass ();
  77         void seek (Time, bool);
  78
  79         Time video_position () const {
  80                 return _video_position;
  81         }
  82
  83         void set_video_container_size (libdcp::Size);
  84
  85         bool repeat_last_video ();
  86
  87         /** Emitted when a video frame is ready.
  88          *  First parameter is the video image.
  89          *  Second parameter is the eye(s) that should see this image.
  90          *  Third parameter is the colour conversion that should be used for this image.
  91          *  Fourth parameter is true if the image is the same as the last one that was emitted.
  92          *  Fifth parameter is the time.
  93          */
  94         boost::signals2::signal<void (boost::shared_ptr<PlayerImage>, Eyes, ColourConversion, bool, Time)> Video;
  95
  96         /** Emitted when some audio data is ready */
  97         boost::signals2::signal<void (boost::shared_ptr<const AudioBuffers>, Time)> Audio;
  98
  99         /** Emitted when something has changed such that if we went back and emitted
 100          *  the last frame again it would look different.  This is not emitted after
 101          *  a seek.
 102          *
 103          *  The parameter is true if these signals are currently likely to be frequent.
 104          */
 105         boost::signals2::signal<void (bool)> Changed;
 106
 107 private:
 108         friend class PlayerWrapper;
 109         friend class Piece;
 110
 111         void process_video (boost::weak_ptr<Piece>, boost::shared_ptr<const Image>, Eyes, bool, VideoContent::Frame, Time);
 112         void process_audio (boost::weak_ptr<Piece>, boost::shared_ptr<const AudioBuffers>, AudioContent::Frame);
 113         void process_subtitle (boost::weak_ptr<Piece>, boost::shared_ptr<Image>, dcpomatic::Rect<double>, Time, Time);
 114         void setup_pieces ();
 115         void playlist_changed ();
 116         void content_changed (boost::weak_ptr<Content>, int, bool);
 117         void do_seek (Time, bool);
 118         void flush ();
 119         void emit_black ();
 120         void emit_silence (OutputAudioFrame);
 121         boost::shared_ptr<Resampler> resampler (boost::shared_ptr<AudioContent>, bool);
 122         void film_changed (Film::Property);
 123         void update_subtitle ();
 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         Time _video_position;
 137         /** The time after the last audio that we emitted */
 138         Time _audio_position;
 139
 140         AudioMerger<Time, 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         std::list<Subtitle> _subtitles;
 147
 148 #ifdef DCPOMATIC_DEBUG
 149         boost::shared_ptr<Content> _last_video;
 150 #endif
 151
 152         bool _last_emit_was_black;
 153
 154         IncomingVideo _last_incoming_video;
 155
 156         boost::signals2::scoped_connection _playlist_changed_connection;
 157         boost::signals2::scoped_connection _playlist_content_changed_connection;
 158         boost::signals2::scoped_connection _film_changed_connection;
 159 };
 160
 161 #endif