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