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