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