src/reel.h

   1 /*
   2     Copyright (C) 2012 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 #ifndef LIBDCP_REEL_H
  21 #define LIBDCP_REEL_H
  22
  23 #include <list>
  24 #include <boost/shared_ptr.hpp>
  25 #include <boost/function.hpp>
  26 #include <libxml++/libxml++.h>
  27 #include "types.h"
  28
  29 namespace xmlpp {
  30         class Node;
  31 }
  32
  33 namespace libdcp {
  34
  35 class PictureAsset;
  36 class SoundAsset;
  37 class SubtitleAsset;
  38 class KDM;
  39
  40 /** @brief A reel within a DCP; the part which actually contains picture, sound and subtitle data */
  41 class Reel
  42 {
  43 public:
  44         Reel (
  45                 boost::shared_ptr<PictureAsset> picture,
  46                 boost::shared_ptr<SoundAsset> sound,
  47                 boost::shared_ptr<SubtitleAsset> subtitle
  48                 )
  49                 : _main_picture (picture)
  50                 , _main_sound (sound)
  51                 , _main_subtitle (subtitle)
  52         {}
  53
  54         boost::shared_ptr<const PictureAsset> main_picture () const {
  55                 return _main_picture;
  56         }
  57
  58         boost::shared_ptr<const SoundAsset> main_sound () const {
  59                 return _main_sound;
  60         }
  61
  62         boost::shared_ptr<const SubtitleAsset> main_subtitle () const {
  63                 return _main_subtitle;
  64         }
  65
  66         void write_to_cpl (xmlpp::Node *, bool) const;
  67
  68         bool encrypted () const;
  69
  70         bool equals (boost::shared_ptr<const Reel> other, EqualityOptions opt, boost::function<void (NoteType, std::string)> notes) const;
  71
  72         void add_kdm (KDM const &);
  73
  74 private:
  75         boost::shared_ptr<PictureAsset> _main_picture;
  76         boost::shared_ptr<SoundAsset> _main_sound;
  77         boost::shared_ptr<SubtitleAsset> _main_subtitle;
  78 };
  79
  80 }
  81
  82 #endif