src/lib/playlist.h

   1 /*
   2     Copyright (C) 2013 Carl Hetherington <cth@carlh.net>
   3
   4     This program is free software; you can redistribute it and/or modify
   5     it under the terms of the GNU General Public License as published by
   6     the Free Software Foundation; either version 2 of the License, or
   7     (at your option) any later version.
   8
   9     This program is distributed in the hope that it will be useful,
  10     but WITHOUT ANY WARRANTY; without even the implied warranty of
  11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12     GNU General Public License for more details.
  13
  14     You should have received a copy of the GNU General Public License
  15     along with this program; if not, write to the Free Software
  16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17
  18 */
  19
  20 #include <list>
  21 #include <boost/shared_ptr.hpp>
  22 #include <boost/enable_shared_from_this.hpp>
  23 #include "video_source.h"
  24 #include "audio_source.h"
  25 #include "video_sink.h"
  26 #include "audio_sink.h"
  27 #include "ffmpeg_content.h"
  28 #include "audio_mapping.h"
  29
  30 class Content;
  31 class FFmpegContent;
  32 class FFmpegDecoder;
  33 class ImageMagickContent;
  34 class ImageMagickDecoder;
  35 class SndfileContent;
  36 class SndfileDecoder;
  37 class Job;
  38 class Film;
  39
  40 /** @class Playlist
  41  *  @brief A set of content files (video and audio), with knowledge of how they should be arranged into
  42  *  a DCP.
  43  *
  44  * This class holds Content objects, and it knows how they should be arranged.  At the moment
  45  * the ordering is implicit; video content is placed sequentially, and audio content is taken
  46  * from the video unless any sound-only files are present.  If sound-only files exist, they
  47  * are played simultaneously (i.e. they can be split up into multiple files for different channels)
  48  */
  49
  50 class Playlist
  51 {
  52 public:
  53         Playlist ();
  54         Playlist (boost::shared_ptr<const Playlist>);
  55
  56         void as_xml (xmlpp::Node *);
  57         void set_from_xml (boost::shared_ptr<const cxml::Node>);
  58
  59         void add (boost::shared_ptr<Content>);
  60         void remove (boost::shared_ptr<Content>);
  61         void move_earlier (boost::shared_ptr<Content>);
  62         void move_later (boost::shared_ptr<Content>);
  63
  64         ContentAudioFrame audio_length () const;
  65         int audio_channels () const;
  66         int audio_frame_rate () const;
  67         bool has_audio () const;
  68
  69         float video_frame_rate () const;
  70         libdcp::Size video_size () const;
  71         ContentVideoFrame video_length () const;
  72
  73         AudioMapping default_audio_mapping () const;
  74         ContentVideoFrame content_length () const;
  75
  76         enum AudioFrom {
  77                 AUDIO_FFMPEG,
  78                 AUDIO_SNDFILE
  79         };
  80
  81         AudioFrom audio_from () const {
  82                 return _audio_from;
  83         }
  84
  85         bool has_subtitles () const;
  86
  87         ContentList content () const {
  88                 return _content;
  89         }
  90
  91         boost::shared_ptr<FFmpegContent> ffmpeg () const;
  92
  93         std::list<boost::shared_ptr<const VideoContent> > video () const {
  94                 return _video;
  95         }
  96
  97         std::list<boost::shared_ptr<const AudioContent> > audio () const {
  98                 return _audio;
  99         }
 100
 101         std::string audio_digest () const;
 102         std::string video_digest () const;
 103
 104         int loop () const {
 105                 return _loop;
 106         }
 107
 108         void set_loop (int l);
 109
 110         mutable boost::signals2::signal<void ()> Changed;
 111         mutable boost::signals2::signal<void (boost::weak_ptr<Content>, int)> ContentChanged;
 112
 113 private:
 114         void setup ();
 115         void content_changed (boost::weak_ptr<Content>, int);
 116
 117         /** where we should get our audio from */
 118         AudioFrom _audio_from;
 119
 120         /** all our content */
 121         ContentList _content;
 122         /** all our content which contains video */
 123         std::list<boost::shared_ptr<const VideoContent> > _video;
 124         /** all our content which contains audio.  This may contain the same objects
 125          *  as _video for FFmpegContent.
 126          */
 127         std::list<boost::shared_ptr<const AudioContent> > _audio;
 128
 129         int _loop;
 130
 131         std::list<boost::signals2::connection> _content_connections;
 132 };