Merge master.
[dcpomatic.git] / src / lib / playlist.h
index 7dbf416041d8bf4bfa555bf45341ee01e04af812..9e3dbb6dfbf39ccf2f6f6864d1ee2920983ff447 100644 (file)
@@ -25,6 +25,8 @@
 #include <boost/enable_shared_from_this.hpp>
 #include "ffmpeg_content.h"
 #include "audio_mapping.h"
+#include "util.h"
+#include "frame_rate_change.h"
 
 class Content;
 class FFmpegContent;
@@ -37,18 +39,15 @@ 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:
@@ -56,36 +55,42 @@ public:
        ~Playlist ();
 
        void as_xml (xmlpp::Node *);
-       void set_from_xml (boost::shared_ptr<const Film>, boost::shared_ptr<const cxml::Node>);
+       void set_from_xml (boost::shared_ptr<const Film>, cxml::ConstNodePtr, int, std::list<std::string> &);
 
        void add (boost::shared_ptr<Content>);
        void remove (boost::shared_ptr<Content>);
        void remove (ContentList);
-
-       bool has_subtitles () const;
+       void move_earlier (boost::shared_ptr<Content>);
+       void move_later (boost::shared_ptr<Content>);
 
        ContentList content () const;
 
        std::string video_identifier () const;
 
-       Time length () const;
+       DCPTime length () const;
        
        int best_dcp_frame_rate () const;
-       Time video_end () const;
+       DCPTime video_end () const;
+       FrameRateChange active_frame_rate_change (DCPTime, int dcp_frame_rate) const;
 
        void set_sequence_video (bool);
        void maybe_sequence_video ();
 
        void repeat (ContentList, int);
 
+       /** Emitted when content has been added to or removed from the playlist */
        mutable boost::signals2::signal<void ()> Changed;
-       /** Third parameter is true if signals are currently being emitted frequently */
+       /** 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;
        
 private:
        void content_changed (boost::weak_ptr<Content>, int, bool);
        void reconnect ();
 
+       /** List of content.  Kept sorted in position order. */
        ContentList _content;
        bool _sequence_video;
        bool _sequencing_video;