src/lib/playlist.h

   1 /*
   2     Copyright (C) 2013-2016 Carl Hetherington <cth@carlh.net>
   3
   4     This file is part of DCP-o-matic.
   5
   6     DCP-o-matic is free software; you can redistribute it and/or modify
   7     it under the terms of the GNU General Public License as published by
   8     the Free Software Foundation; either version 2 of the License, or
   9     (at your option) any later version.
  10
  11     DCP-o-matic is distributed in the hope that it will be useful,
  12     but WITHOUT ANY WARRANTY; without even the implied warranty of
  13     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14     GNU General Public License for more details.
  15
  16     You should have received a copy of the GNU General Public License
  17     along with DCP-o-matic.  If not, see <http://www.gnu.org/licenses/>.
  18
  19 */
  20
  21 #ifndef DCPOMATIC_PLAYLIST_H
  22 #define DCPOMATIC_PLAYLIST_H
  23
  24 #include "util.h"
  25 #include "frame_rate_change.h"
  26 #include <libcxml/cxml.h>
  27 #include <boost/shared_ptr.hpp>
  28 #include <boost/signals2.hpp>
  29 #include <list>
  30
  31 class Film;
  32
  33 struct ContentSorter
  34 {
  35         bool operator() (boost::shared_ptr<Content> a, boost::shared_ptr<Content> b);
  36 };
  37
  38 /** @class Playlist
  39  *  @brief A set of Content objects with knowledge of how they should be arranged into
  40  *  a DCP.
  41  */
  42 class Playlist : public boost::noncopyable
  43 {
  44 public:
  45         Playlist ();
  46         ~Playlist ();
  47
  48         void as_xml (xmlpp::Node *, bool with_content_paths);
  49         void set_from_xml (boost::shared_ptr<const Film>, cxml::ConstNodePtr, int, std::list<std::string> &);
  50
  51         void add (boost::shared_ptr<Content>);
  52         void remove (boost::shared_ptr<Content>);
  53         void remove (ContentList);
  54         void move_earlier (boost::shared_ptr<Content>);
  55         void move_later (boost::shared_ptr<Content>);
  56
  57         ContentList content () const;
  58
  59         std::string video_identifier () const;
  60
  61         DCPTime length () const;
  62         boost::optional<DCPTime> start () const;
  63         int64_t required_disk_space (int j2k_bandwidth, int audio_channels, int audio_frame_rate) const;
  64
  65         int best_video_frame_rate () const;
  66         DCPTime video_end () const;
  67         DCPTime subtitle_end () const;
  68         FrameRateChange active_frame_rate_change (DCPTime, int dcp_frame_rate) const;
  69         std::string content_summary (DCPTimePeriod period) const;
  70
  71         void set_sequence (bool);
  72         void maybe_sequence ();
  73
  74         void repeat (ContentList, int);
  75
  76         /** Emitted when content has been added to or removed from the playlist; implies OrderChanged */
  77         mutable boost::signals2::signal<void ()> Changed;
  78         mutable boost::signals2::signal<void ()> OrderChanged;
  79         /** Emitted when something about a piece of our content has changed;
  80          *  these emissions include when the position of the content changes.
  81          *  Third parameter is true if signals are currently being emitted frequently.
  82          */
  83         mutable boost::signals2::signal<void (boost::weak_ptr<Content>, int, bool)> ContentChanged;
  84
  85 private:
  86         void content_changed (boost::weak_ptr<Content>, int, bool);
  87         void reconnect ();
  88
  89         /** List of content.  Kept sorted in position order. */
  90         ContentList _content;
  91         bool _sequence;
  92         bool _sequencing;
  93         std::list<boost::signals2::connection> _content_connections;
  94 };
  95
  96 #endif