Rename TYPE_DEBUG_PLAYER to TYPE_DEBUG_VIDEO_VIEW.
[dcpomatic.git] / src / lib / playlist.h
index 35709f109d2bf4bb4cbcbd725f61bbce7f7bf3ae..dc984aacf077d64f78ea37520d9162cbfdbad9f8 100644 (file)
 /*
-    Copyright (C) 2013 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2013-2018 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 <boost/shared_ptr.hpp>
-#include <boost/enable_shared_from_this.hpp>
-#include "ffmpeg_content.h"
-#include "audio_mapping.h"
 #include "util.h"
+#include "frame_rate_change.h"
+#include "atomicity_checker.h"
+#include <libcxml/cxml.h>
+#include <boost/shared_ptr.hpp>
+#include <boost/signals2.hpp>
+#include <list>
 
-class Content;
-class FFmpegContent;
-class FFmpegDecoder;
-class StillImageMagickContent;
-class StillImageMagickDecoder;
-class SndfileContent;
-class SndfileDecoder;
-class Job;
 class Film;
-class Region;
-
-/** @class Playlist
- *  @brief A set of content files (video and audio), with knowledge of how they should be arranged into
- *  a DCP.
- *
- * This class holds Content objects, and it knows how they should be arranged.
- */
 
 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 as_xml (xmlpp::Node *);
-       void set_from_xml (boost::shared_ptr<const Film>, boost::shared_ptr<const cxml::Node>, int);
+       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 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<Content>);
-       void move_later (boost::shared_ptr<Content>);
-
-       bool has_subtitles () const;
+       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>);
 
        ContentList content () const;
 
        std::string video_identifier () const;
 
-       DCPTime length () const;
-       
-       int best_dcp_frame_rate () const;
-       DCPTime video_end () const;
-       FrameRateChange active_frame_rate_change (DCPTime, int dcp_frame_rate) const;
+       dcpomatic::DCPTime length (boost::shared_ptr<const Film> film) const;
+       boost::optional<dcpomatic::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;
+
+       int best_video_frame_rate () const;
+       dcpomatic::DCPTime video_end (boost::shared_ptr<const Film> film) const;
+       dcpomatic::DCPTime text_end (boost::shared_ptr<const Film> film) const;
+       FrameRateChange active_frame_rate_change (dcpomatic::DCPTime, int dcp_frame_rate) const;
+       std::string content_summary (boost::shared_ptr<const Film> film, dcpomatic::DCPTimePeriod period) const;
+       std::pair<double, double> speed_up_range (int dcp_video_frame_rate) const;
+
+       void set_sequence (bool);
+       void maybe_sequence (boost::shared_ptr<const Film> film);
+
+       void repeat (boost::shared_ptr<const Film> film, ContentList, int);
 
-       void set_sequence_video (bool);
-       void maybe_sequence_video ();
+       /** 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 ()> OrderChange;
+       /** Emitted when the length might have changed; may sometimes be emitted when it has not */
+       mutable boost::signals2::signal<void ()> LengthChange;
 
-       void repeat (ContentList, int);
+       mutable boost::signals2::signal<void (ChangeType, boost::weak_ptr<Content>, int, bool)> ContentChange;
 
-       mutable boost::signals2::signal<void ()> Changed;
-       /** Third parameter is true if signals are currently being emitted frequently */
-       mutable boost::signals2::signal<void (boost::weak_ptr<Content>, int, bool)> ContentChanged;
-       
 private:
-       void content_changed (boost::weak_ptr<Content>, int, bool);
-       void reconnect ();
+       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);
 
+       mutable boost::mutex _mutex;
        /** List of content.  Kept sorted in position order. */
        ContentList _content;
-       bool _sequence_video;
-       bool _sequencing_video;
+       bool _sequence;
+       bool _sequencing;
        std::list<boost::signals2::connection> _content_connections;
+       AtomicityChecker _checker;
 };
 
 #endif