Comment tweaks.
[libdcp.git] / src / mxf_asset.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_MXF_ASSET_H
21 #define LIBDCP_MXF_ASSET_H
22
23 #include <boost/signals2.hpp>
24 #include "asset.h"
25
26 namespace libdcp
27 {
28
29 /** @brief Parent class for assets which have MXF files */      
30 class MXFAsset : public Asset
31 {
32 public:
33         /** Construct an MXFAsset.
34          *  @param directory Directory where MXF file is.
35          *  @param file_name Name of MXF file.
36          *  @param progress Signal to inform of progress.
37          *  @param fps Frames per second.
38          *  @param entry_point The entry point of this MXF; ie the first frame that should be used.
39          *  @param length Length in frames.
40          */
41         MXFAsset (std::string directory, std::string file_name, boost::signals2::signal<void (float)>* progress, int fps, int entry_point, int length);
42
43         virtual bool equals (boost::shared_ptr<const Asset> other, EqualityOptions opt, std::list<std::string>& notes) const;
44         
45         int length () const;
46
47 protected:
48         /** Fill in a ADSCP::WriteInfo struct.
49          *  @param w struct to fill in.
50          */
51         void fill_writer_info (ASDCP::WriterInfo* w) const;
52
53         /** Signal to emit to report progress */
54         boost::signals2::signal<void (float)>* _progress;
55         /** Frames per second */
56         int _fps;
57         int _entry_point;
58         /** Length in frames */
59         int _length;
60 };
61
62 }
63
64 #endif