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