/*
- 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/>.
*/
#ifndef DCPOMATIC_PLAYLIST_H
#define DCPOMATIC_PLAYLIST_H
-#include <list>
+#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"
-#include "audio_mapping.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;
+struct ContentSorter
+{
+ bool operator() (boost::shared_ptr<Content> a, boost::shared_ptr<Content> b);
+};
+
/** @class Playlist
- * @brief A set of content files (video and audio), with knowledge of how they should be arranged into
+ * @brief A set of Content objects with knowledge of how they should be arranged into
* a DCP.
- *
- * This class holds Content objects, and it knows how they should be arranged. At the moment
- * the ordering is implicit; video content is placed sequentially, and audio content is taken
- * from the video unless any sound-only files are present. If sound-only files exist, they
- * are played simultaneously (i.e. they can be split up into multiple files for different channels)
*/
-
-class Playlist
+class Playlist : public boost::noncopyable
{
public:
Playlist ();
- Playlist (boost::shared_ptr<const Playlist>);
+ ~Playlist ();
- void as_xml (xmlpp::Node *);
- void set_from_xml (boost::shared_ptr<const cxml::Node>);
+ 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);
void add (boost::shared_ptr<Content>);
void remove (boost::shared_ptr<Content>);
+ void remove (ContentList);
+ void move_earlier (boost::shared_ptr<Content>);
+ void move_later (boost::shared_ptr<Content>);
- bool has_subtitles () const;
-
- struct Region
- {
- Region ()
- : time (0)
- {}
-
- Region (boost::shared_ptr<Content> c, Time t, Playlist* p);
- Region (boost::shared_ptr<const cxml::Node>, Playlist* p);
-
- void as_xml (xmlpp::Node *) const;
-
- boost::shared_ptr<Content> content;
- Time time;
- boost::signals2::connection connection;
- };
-
- typedef std::vector<Region> RegionList;
-
- RegionList regions () const {
- return _regions;
- }
-
- std::string audio_digest () const;
- std::string video_digest () const;
-
- int loop () const {
- return _loop;
- }
-
- void set_loop (int l);
-
- Time length (boost::shared_ptr<const Film>) const;
- int best_dcp_frame_rate () const;
+ ContentList content () const;
+ bool video_content_at (DCPTime time) const;
+ std::string video_identifier () const;
+
+ DCPTime length () const;
+ boost::optional<DCPTime> start () const;
+ int64_t required_disk_space (int j2k_bandwidth, int audio_channels, int audio_frame_rate) const;
+
+ int best_video_frame_rate () const;
+ DCPTime video_end () const;
+ DCPTime subtitle_end () const;
+ FrameRateChange active_frame_rate_change (DCPTime, int dcp_frame_rate) const;
+ std::string content_summary (DCPTimePeriod period) const;
+
+ void set_sequence (bool);
+ void maybe_sequence ();
+
+ void repeat (ContentList, int);
+
+ /** Emitted when content has been added to or removed from the playlist; implies OrderChanged */
mutable boost::signals2::signal<void ()> Changed;
- mutable boost::signals2::signal<void (boost::weak_ptr<Content>, int)> ContentChanged;
-
-private:
- void content_changed (boost::weak_ptr<Content>, int);
+ mutable boost::signals2::signal<void ()> OrderChanged;
+ /** Emitted when something about a piece of our content has changed;
+ * these emissions include when the position of the content changes.
+ * Third parameter is true if signals are currently being emitted frequently.
+ */
+ mutable boost::signals2::signal<void (boost::weak_ptr<Content>, int, bool)> ContentChanged;
- RegionList _regions;
- int _loop;
+private:
+ void content_changed (boost::weak_ptr<Content>, int, bool);
+ void reconnect ();
+
+ /** List of content. Kept sorted in position order. */
+ ContentList _content;
+ bool _sequence;
+ bool _sequencing;
+ std::list<boost::signals2::connection> _content_connections;
};
#endif