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 Player
  49  *  @brief A class which can `play' a Playlist.
  50  */
  51 class Player : public boost::enable_shared_from_this<Player>, public boost::noncopyable
  52 {
  53 public:
  54         Player (boost::shared_ptr<const Film>, boost::shared_ptr<const Playlist> playlist);
  55
  56         std::list<boost::shared_ptr<PlayerVideo> > get_video (DCPTime time, bool accurate);
  57         boost::shared_ptr<AudioBuffers> get_audio (DCPTime time, DCPTime length, bool accurate);
  58         PlayerSubtitles get_subtitles (DCPTime time, DCPTime length, bool starting, bool burnt);
  59         std::list<boost::shared_ptr<Font> > get_subtitle_fonts ();
  60
  61         void set_video_container_size (dcp::Size);
  62         void set_ignore_video ();
  63         void set_enable_subtitles (bool enable);
  64         void set_always_burn_subtitles (bool burn);
  65
  66         /** Emitted when something has changed such that if we went back and emitted
  67          *  the last frame again it would look different.  This is not emitted after
  68          *  a seek.
  69          *
  70          *  The parameter is true if these signals are currently likely to be frequent.
  71          */
  72         boost::signals2::signal<void (bool)> Changed;
  73
  74 private:
  75         friend class PlayerWrapper;
  76         friend class Piece;
  77         friend struct player_overlaps_test;
  78         friend struct player_time_calculation_test1;
  79         friend struct player_time_calculation_test2;
  80         friend struct player_time_calculation_test3;
  81
  82         void setup_pieces ();
  83         void flush ();
  84         void film_changed (Film::Property);
  85         void playlist_changed ();
  86         void playlist_content_changed (boost::weak_ptr<Content>, int, bool);
  87         std::list<PositionImage> transform_image_subtitles (std::list<ImageSubtitle>) const;
  88         void update_subtitle_from_text ();
  89         Frame dcp_to_content_video (boost::shared_ptr<const Piece> piece, DCPTime t) const;
  90         DCPTime content_video_to_dcp (boost::shared_ptr<const Piece> piece, Frame f) const;
  91         Frame dcp_to_resampled_audio (boost::shared_ptr<const Piece> piece, DCPTime t) const;
  92         ContentTime dcp_to_content_subtitle (boost::shared_ptr<const Piece> piece, DCPTime t) const;
  93         boost::shared_ptr<PlayerVideo> black_player_video_frame (DCPTime) const;
  94
  95         /** @return Pieces of content type C that overlap a specified time range in the DCP */
  96         template<class C>
  97         std::list<boost::shared_ptr<Piece> >
  98         overlaps (DCPTime from, DCPTime to)
  99         {
 100                 if (!_have_valid_pieces) {
 101                         setup_pieces ();
 102                 }
 103
 104                 std::list<boost::shared_ptr<Piece> > overlaps;
 105                 for (typename std::list<boost::shared_ptr<Piece> >::const_iterator i = _pieces.begin(); i != _pieces.end(); ++i) {
 106                         if (!boost::dynamic_pointer_cast<C> ((*i)->content)) {
 107                                 continue;
 108                         }
 109
 110                         if ((*i)->content->position() <= to && (*i)->content->end() >= from) {
 111                                 overlaps.push_back (*i);
 112                         }
 113                 }
 114
 115                 return overlaps;
 116         }
 117
 118         boost::shared_ptr<const Film> _film;
 119         boost::shared_ptr<const Playlist> _playlist;
 120
 121         /** Our pieces are ready to go; if this is false the pieces must be (re-)created before they are used */
 122         bool _have_valid_pieces;
 123         std::list<boost::shared_ptr<Piece> > _pieces;
 124
 125         /** Size of the image in the DCP (e.g. 1990x1080 for flat) */
 126         dcp::Size _video_container_size;
 127         boost::shared_ptr<Image> _black_image;
 128
 129         /** true if the player should ignore all video; i.e. never produce any */
 130         bool _ignore_video;
 131         /** true if the player should always burn subtitles into the video regardless
 132             of content settings
 133         */
 134         bool _always_burn_subtitles;
 135
 136         boost::shared_ptr<AudioProcessor> _audio_processor;
 137
 138         boost::signals2::scoped_connection _film_changed_connection;
 139         boost::signals2::scoped_connection _playlist_changed_connection;
 140         boost::signals2::scoped_connection _playlist_content_changed_connection;
 141 };
 142
 143 #endif