Take Film pointer out of Content.
[dcpomatic.git] / src / lib / playlist.h
index c461151d458f6759b8e4faa33b5beb8fc8cdccef..d9140bdfb6d87ead55318bf8ffbac1a6c81dd92e 100644 (file)
 /*
-    Copyright (C) 2013 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2013-2016 Carl Hetherington <cth@carlh.net>
 
-    This program is free software; you can redistribute it and/or modify
+    This file is part of DCP-o-matic.
+
+    DCP-o-matic is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
     the Free Software Foundation; either version 2 of the License, or
     (at your option) any later version.
 
-    This program is distributed in the hope that it will be useful,
+    DCP-o-matic is distributed in the hope that it will be useful,
     but WITHOUT ANY WARRANTY; without even the implied warranty of
     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
     GNU General Public License for more details.
 
     You should have received a copy of the GNU General Public License
-    along with this program; if not, write to the Free Software
-    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+    along with DCP-o-matic.  If not, see <http://www.gnu.org/licenses/>.
 
 */
 
-#include <list>
+#ifndef DCPOMATIC_PLAYLIST_H
+#define DCPOMATIC_PLAYLIST_H
+
+#include "util.h"
+#include "frame_rate_change.h"
+#include <libcxml/cxml.h>
 #include <boost/shared_ptr.hpp>
-#include <boost/enable_shared_from_this.hpp>
-#include "video_source.h"
-#include "audio_source.h"
-#include "video_sink.h"
-#include "audio_sink.h"
-#include "ffmpeg_content.h"
-
-class Content;
-class FFmpegContent;
-class FFmpegDecoder;
-class ImageMagickContent;
-class ImageMagickDecoder;
-class SndfileContent;
-class SndfileDecoder;
-class Job;
+#include <boost/signals2.hpp>
+#include <list>
+
 class Film;
 
-class Playlist
+struct ContentSorter
+{
+       bool operator() (boost::shared_ptr<Content> a, boost::shared_ptr<Content> b);
+};
+
+/** @class Playlist
+ *  @brief A set of Content objects with knowledge of how they should be arranged into
+ *  a DCP.
+ */
+class Playlist : public boost::noncopyable
 {
 public:
        Playlist ();
+       ~Playlist ();
 
-       void setup (ContentList);
-
-       ContentAudioFrame audio_length () const;
-       int audio_channels () const;
-       int audio_frame_rate () const;
-       int64_t audio_channel_layout () const;
-       bool has_audio () const;
-       
-       float video_frame_rate () const;
-       libdcp::Size video_size () const;
-       ContentVideoFrame video_length () const;
-
-       std::vector<FFmpegSubtitleStream> ffmpeg_subtitle_streams () const;
-       boost::optional<FFmpegSubtitleStream> ffmpeg_subtitle_stream () const;
-       std::vector<FFmpegAudioStream> ffmpeg_audio_streams () const;
-       boost::optional<FFmpegAudioStream> ffmpeg_audio_stream () const;
-
-       enum VideoFrom {
-               VIDEO_NONE,
-               VIDEO_FFMPEG,
-               VIDEO_IMAGEMAGICK
-       };
-
-       enum AudioFrom {
-               AUDIO_NONE,
-               AUDIO_FFMPEG,
-               AUDIO_SNDFILE
-       };
-
-       VideoFrom video_from () const {
-               return _video_from;
-       }
-
-       AudioFrom audio_from () const {
-               return _audio_from;
-       }
-
-       boost::shared_ptr<const FFmpegContent> ffmpeg () const {
-               return _ffmpeg;
-       }
-
-       std::list<boost::shared_ptr<const ImageMagickContent> > imagemagick () const {
-               return _imagemagick;
-       }
-
-       std::list<boost::shared_ptr<const SndfileContent> > sndfile () const {
-               return _sndfile;
-       }
-       
-private:
-       VideoFrom _video_from;
-       AudioFrom _audio_from;
+       void as_xml (xmlpp::Node *, bool with_content_paths);
+       void set_from_xml (boost::shared_ptr<const Film> film, cxml::ConstNodePtr node, int version, std::list<std::string>& notes);
 
-       boost::shared_ptr<const FFmpegContent> _ffmpeg;
-       std::list<boost::shared_ptr<const ImageMagickContent> > _imagemagick;
-       std::list<boost::shared_ptr<const SndfileContent> > _sndfile;
-};
+       void add (boost::shared_ptr<const Film> film, boost::shared_ptr<Content>);
+       void remove (boost::shared_ptr<Content>);
+       void remove (ContentList);
+       void move_earlier (boost::shared_ptr<const Film> film, boost::shared_ptr<Content>);
+       void move_later (boost::shared_ptr<const Film> film, boost::shared_ptr<Content>);
 
-class Player : public VideoSource, public AudioSource, public VideoSink, public AudioSink, public boost::enable_shared_from_this<Player>
-{
-public:
-       Player (boost::shared_ptr<const Film>, boost::shared_ptr<const Playlist>);
+       ContentList content () const;
+
+       std::string video_identifier () const;
 
-       void disable_video ();
-       void disable_audio ();
-       void disable_subtitles ();
-       void disable_video_sync ();
+       DCPTime length (boost::shared_ptr<const Film> film) const;
+       boost::optional<DCPTime> start () const;
+       int64_t required_disk_space (boost::shared_ptr<const Film> film, int j2k_bandwidth, int audio_channels, int audio_frame_rate) const;
 
-       bool pass ();
-       void set_progress (boost::shared_ptr<Job>);
-       bool seek (double);
-       bool seek_to_last ();
+       int best_video_frame_rate () const;
+       DCPTime video_end (boost::shared_ptr<const Film> film) const;
+       DCPTime text_end (boost::shared_ptr<const Film> film) const;
+       FrameRateChange active_frame_rate_change (DCPTime, int dcp_frame_rate) const;
+       std::string content_summary (boost::shared_ptr<const Film> film, DCPTimePeriod period) const;
+       std::pair<double, double> speed_up_range (int dcp_video_frame_rate) const;
 
-       double last_video_time () const;
+       void set_sequence (bool);
+       void maybe_sequence (boost::shared_ptr<const Film> film);
+
+       void repeat (boost::shared_ptr<const Film> film, ContentList, int);
+
+       /** Emitted when content has been added to or removed from the playlist; implies OrderChanged */
+       mutable boost::signals2::signal<void (ChangeType)> Change;
+       mutable boost::signals2::signal<void ()> OrderChanged;
+
+       mutable boost::signals2::signal<void (ChangeType, boost::weak_ptr<Content>, int, bool)> ContentChange;
 
 private:
-       void process_video (boost::shared_ptr<Image> i, bool same, boost::shared_ptr<Subtitle> s);
-       void process_audio (boost::shared_ptr<AudioBuffers>);
-       void setup_decoders ();
-
-       boost::shared_ptr<const Film> _film;
-       boost::shared_ptr<const Playlist> _playlist;
-       
-       bool _video;
-       bool _audio;
-       bool _subtitles;
-       
-       bool _have_setup_decoders;
-       boost::shared_ptr<FFmpegDecoder> _ffmpeg_decoder;
-       bool _ffmpeg_decoder_done;
-       std::list<boost::shared_ptr<ImageMagickDecoder> > _imagemagick_decoders;
-       std::list<boost::shared_ptr<ImageMagickDecoder> >::iterator _imagemagick_decoder;
-       std::list<boost::shared_ptr<SndfileDecoder> > _sndfile_decoders;
-
-       bool _video_sync;
+       void content_change (boost::weak_ptr<const Film>, ChangeType, boost::weak_ptr<Content>, int, bool);
+       void disconnect ();
+       void reconnect (boost::shared_ptr<const Film> film);
+
+       /** List of content.  Kept sorted in position order. */
+       ContentList _content;
+       bool _sequence;
+       bool _sequencing;
+       std::list<boost::signals2::connection> _content_connections;
 };
+
+#endif