src/lib/player.h

   1 /*
   2     Copyright (C) 2013-2015 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 "content.h"
  24 #include "film.h"
  25 #include "rect.h"
  26 #include "audio_content.h"
  27 #include "dcpomatic_time.h"
  28 #include "content_subtitle.h"
  29 #include "position_image.h"
  30 #include "piece.h"
  31 #include "content_video.h"
  32 #include "player_subtitles.h"
  33 #include <boost/shared_ptr.hpp>
  34 #include <boost/enable_shared_from_this.hpp>
  35 #include <list>
  36
  37 class Job;
  38 class Film;
  39 class AudioContent;
  40 class Piece;
  41 class Image;
  42 class Decoder;
  43 class Resampler;
  44 class PlayerVideo;
  45 class ImageProxy;
  46 class Font;
  47
  48 class PlayerStatistics
  49 {
  50 public:
  51         struct Video {
  52                 Video ()
  53                         : black (0)
  54                         , repeat (0)
  55                         , good (0)
  56                         , skip (0)
  57                 {}
  58
  59                 int black;
  60                 int repeat;
  61                 int good;
  62                 int skip;
  63         } video;
  64
  65         struct Audio {
  66                 Audio ()
  67                         : silence (0)
  68                         , good (0)
  69                         , skip (0)
  70                 {}
  71
  72                 DCPTime silence;
  73                 int64_t good;
  74                 int64_t skip;
  75         } audio;
  76
  77         void dump (boost::shared_ptr<Log>) const;
  78 };
  79
  80 /** @class Player
  81  *  @brief A class which can `play' a Playlist.
  82  */
  83 class Player : public boost::enable_shared_from_this<Player>, public boost::noncopyable
  84 {
  85 public:
  86         Player (boost::shared_ptr<const Film>, boost::shared_ptr<const Playlist> playlist);
  87
  88         std::list<boost::shared_ptr<PlayerVideo> > get_video (DCPTime time, bool accurate);
  89         boost::shared_ptr<AudioBuffers> get_audio (DCPTime time, DCPTime length, bool accurate);
  90         PlayerSubtitles get_subtitles (DCPTime time, DCPTime length, bool starting, bool burnt);
  91         std::list<boost::shared_ptr<Font> > get_subtitle_fonts ();
  92
  93         void set_video_container_size (dcp::Size);
  94         void set_ignore_video ();
  95         void set_enable_subtitles (bool enable);
  96         void set_always_burn_subtitles (bool burn);
  97
  98         PlayerStatistics const & statistics () const;
  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         friend struct player_overlaps_test;
 112         friend struct player_time_calculation_test1;
 113         friend struct player_time_calculation_test2;
 114         friend struct player_time_calculation_test3;
 115
 116         void setup_pieces ();
 117         void flush ();
 118         void film_changed (Film::Property);
 119         void playlist_changed ();
 120         void playlist_content_changed (boost::weak_ptr<Content>, int, bool);
 121         std::list<PositionImage> transform_image_subtitles (std::list<ImageSubtitle>) const;
 122         void update_subtitle_from_text ();
 123         Frame dcp_to_content_video (boost::shared_ptr<const Piece> piece, DCPTime t) const;
 124         DCPTime content_video_to_dcp (boost::shared_ptr<const Piece> piece, Frame f) const;
 125         Frame dcp_to_resampled_audio (boost::shared_ptr<const Piece> piece, DCPTime t) const;
 126         ContentTime dcp_to_content_subtitle (boost::shared_ptr<const Piece> piece, DCPTime t) const;
 127         boost::shared_ptr<PlayerVideo> black_player_video_frame (DCPTime) const;
 128
 129         /** @return Pieces of content type C that overlap a specified time range in the DCP */
 130         template<class C>
 131         std::list<boost::shared_ptr<Piece> >
 132         overlaps (DCPTime from, DCPTime to)
 133         {
 134                 if (!_have_valid_pieces) {
 135                         setup_pieces ();
 136                 }
 137
 138                 std::list<boost::shared_ptr<Piece> > overlaps;
 139                 for (typename std::list<boost::shared_ptr<Piece> >::const_iterator i = _pieces.begin(); i != _pieces.end(); ++i) {
 140                         if (!boost::dynamic_pointer_cast<C> ((*i)->content)) {
 141                                 continue;
 142                         }
 143
 144                         if ((*i)->content->position() <= to && (*i)->content->end() >= from) {
 145                                 overlaps.push_back (*i);
 146                         }
 147                 }
 148
 149                 return overlaps;
 150         }
 151
 152         boost::shared_ptr<const Film> _film;
 153         boost::shared_ptr<const Playlist> _playlist;
 154
 155         /** Our pieces are ready to go; if this is false the pieces must be (re-)created before they are used */
 156         bool _have_valid_pieces;
 157         std::list<boost::shared_ptr<Piece> > _pieces;
 158
 159         /** Size of the image in the DCP (e.g. 1990x1080 for flat) */
 160         dcp::Size _video_container_size;
 161         boost::shared_ptr<Image> _black_image;
 162
 163         /** true if the player should ignore all video; i.e. never produce any */
 164         bool _ignore_video;
 165         /** true if the player should always burn subtitles into the video regardless
 166             of content settings
 167         */
 168         bool _always_burn_subtitles;
 169
 170         boost::shared_ptr<AudioProcessor> _audio_processor;
 171
 172         PlayerStatistics _statistics;
 173
 174         boost::signals2::scoped_connection _film_changed_connection;
 175         boost::signals2::scoped_connection _playlist_changed_connection;
 176         boost::signals2::scoped_connection _playlist_content_changed_connection;
 177 };
 178
 179 #endif