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