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_content.h"
  31 #include "dcpomatic_time.h"
  32 #include "content_subtitle.h"
  33 #include "position_image.h"
  34 #include "piece.h"
  35
  36 class Job;
  37 class Film;
  38 class Playlist;
  39 class AudioContent;
  40 class Piece;
  41 class Image;
  42 class DCPVideo;
  43 class Decoder;
  44
  45 class PlayerStatistics
  46 {
  47 public:
  48         struct Video {
  49                 Video ()
  50                         : black (0)
  51                         , repeat (0)
  52                         , good (0)
  53                         , skip (0)
  54                 {}
  55
  56                 int black;
  57                 int repeat;
  58                 int good;
  59                 int skip;
  60         } video;
  61
  62         struct Audio {
  63                 Audio ()
  64                         : silence (0)
  65                         , good (0)
  66                         , skip (0)
  67                 {}
  68
  69                 DCPTime silence;
  70                 int64_t good;
  71                 int64_t skip;
  72         } audio;
  73
  74         void dump (boost::shared_ptr<Log>) const;
  75 };
  76
  77 /** A wrapper for an Image which contains some pending operations; these may
  78  *  not be necessary if the receiver of the PlayerImage throws it away.
  79  */
  80 class PlayerImage
  81 {
  82 public:
  83         PlayerImage (boost::shared_ptr<const Image>, Crop, dcp::Size, dcp::Size, Scaler const *);
  84
  85         void set_subtitle (boost::shared_ptr<const Image>, Position<int>);
  86
  87         boost::shared_ptr<Image> image ();
  88
  89 private:
  90         boost::shared_ptr<const Image> _in;
  91         Crop _crop;
  92         dcp::Size _inter_size;
  93         dcp::Size _out_size;
  94         Scaler const * _scaler;
  95         boost::shared_ptr<const Image> _subtitle_image;
  96         Position<int> _subtitle_position;
  97 };
  98
  99 /** @class Player
 100  *  @brief A class which can `play' a Playlist.
 101  */
 102 class Player : public boost::enable_shared_from_this<Player>, public boost::noncopyable
 103 {
 104 public:
 105         Player (boost::shared_ptr<const Film>, boost::shared_ptr<const Playlist>);
 106
 107         boost::shared_ptr<DCPVideo> get_video (DCPTime time, bool accurate);
 108         boost::shared_ptr<AudioBuffers> get_audio (DCPTime time, DCPTime length, bool accurate);
 109
 110         void set_video_container_size (dcp::Size);
 111         void set_approximate_size ();
 112         void set_burn_subtitles (bool burn) {
 113                 _burn_subtitles = burn;
 114         }
 115
 116         PlayerStatistics const & statistics () const;
 117
 118         /** Emitted when something has changed such that if we went back and emitted
 119          *  the last frame again it would look different.  This is not emitted after
 120          *  a seek.
 121          *
 122          *  The parameter is true if these signals are currently likely to be frequent.
 123          */
 124         boost::signals2::signal<void (bool)> Changed;
 125
 126 private:
 127         friend class PlayerWrapper;
 128         friend class Piece;
 129
 130         void setup_pieces ();
 131         void playlist_changed ();
 132         void content_changed (boost::weak_ptr<Content>, int, bool);
 133         void flush ();
 134         void film_changed (Film::Property);
 135         std::list<PositionImage> process_content_image_subtitles (
 136                 boost::shared_ptr<SubtitleContent>, std::list<boost::shared_ptr<ContentImageSubtitle> >
 137                 );
 138         std::list<PositionImage> process_content_text_subtitles (std::list<boost::shared_ptr<ContentTextSubtitle> >);
 139         void update_subtitle_from_text ();
 140         VideoFrame dcp_to_content_video (boost::shared_ptr<const Piece> piece, DCPTime t) const;
 141         AudioFrame dcp_to_content_audio (boost::shared_ptr<const Piece> piece, DCPTime t) const;
 142         ContentTime dcp_to_content_subtitle (boost::shared_ptr<const Piece> piece, DCPTime t) const;
 143         boost::shared_ptr<DCPVideo> black_dcp_video (DCPTime) const;
 144
 145         template<class C>
 146         std::list<boost::shared_ptr<Piece> >
 147         overlaps (DCPTime t)
 148         {
 149                 std::list<boost::shared_ptr<Piece> > overlaps;
 150                 for (typename std::list<boost::shared_ptr<Piece> >::const_iterator i = _pieces.begin(); i != _pieces.end(); ++i) {
 151                         if (boost::dynamic_pointer_cast<C> ((*i)->content) && (*i)->content->position() <= t && t < (*i)->content->end()) {
 152                                 overlaps.push_back (*i);
 153                         }
 154                 }
 155
 156                 return overlaps;
 157         }
 158
 159         boost::shared_ptr<const Film> _film;
 160         boost::shared_ptr<const Playlist> _playlist;
 161
 162         /** Our pieces are ready to go; if this is false the pieces must be (re-)created before they are used */
 163         bool _have_valid_pieces;
 164         std::list<boost::shared_ptr<Piece> > _pieces;
 165
 166         dcp::Size _video_container_size;
 167         boost::shared_ptr<Image> _black_image;
 168
 169         bool _approximate_size;
 170         bool _burn_subtitles;
 171
 172         PlayerStatistics _statistics;
 173
 174         boost::signals2::scoped_connection _playlist_changed_connection;
 175         boost::signals2::scoped_connection _playlist_content_changed_connection;
 176         boost::signals2::scoped_connection _film_changed_connection;
 177 };
 178
 179 #endif