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 "key.h"
  24 #include "types.h"
  25 #include "ref.h"
  26 #include <libxml++/libxml++.h>
  27 #include <boost/shared_ptr.hpp>
  28 #include <boost/function.hpp>
  29 #include <list>
  30
  31 namespace cxml {
  32         class Node;
  33 }
  34
  35 namespace dcp {
  36
  37 class KDM;
  38 class ReelAsset;
  39 class ReelPictureAsset;
  40 class ReelSoundAsset;
  41 class ReelSubtitleAsset;
  42
  43 /** @brief A reel within a DCP; the part which actually contains picture, sound and subtitle data */
  44 class Reel : public Object
  45 {
  46 public:
  47         Reel () {}
  48
  49         Reel (
  50                 boost::shared_ptr<ReelPictureAsset> picture,
  51                 boost::shared_ptr<ReelSoundAsset> sound,
  52                 boost::shared_ptr<ReelSubtitleAsset> subtitle
  53                 )
  54                 : _main_picture (picture)
  55                 , _main_sound (sound)
  56                 , _main_subtitle (subtitle)
  57         {}
  58
  59         Reel (boost::shared_ptr<const cxml::Node>);
  60
  61         boost::shared_ptr<ReelPictureAsset> main_picture () const {
  62                 return _main_picture;
  63         }
  64
  65         boost::shared_ptr<ReelSoundAsset> main_sound () const {
  66                 return _main_sound;
  67         }
  68
  69         boost::shared_ptr<ReelSubtitleAsset> main_subtitle () const {
  70                 return _main_subtitle;
  71         }
  72
  73         void add (boost::shared_ptr<ReelAsset> asset);
  74
  75         void write_to_cpl (xmlpp::Element* node, Standard standard) const;
  76
  77         bool encrypted () const;
  78
  79         void set_mxf_keys (dcp::Key);
  80
  81         bool equals (boost::shared_ptr<const Reel> other, EqualityOptions opt, boost::function<void (NoteType, std::string)> notes) const;
  82
  83         void add_kdm (KDM const &);
  84
  85 private:
  86         boost::shared_ptr<ReelPictureAsset> _main_picture;
  87         boost::shared_ptr<ReelSoundAsset> _main_sound;
  88         boost::shared_ptr<ReelSubtitleAsset> _main_subtitle;
  89 };
  90
  91 }
  92
  93 #endif