ae2df4d23e525397a4b1b3f1dc030223eb8033db
[libdcp.git] / src / mono_picture_asset.h
1 /*
2     Copyright (C) 2012-2013 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_MONO_PICTURE_ASSET_H
21 #define LIBDCP_MONO_PICTURE_ASSET_H
22
23 #include "picture_asset.h"
24
25 namespace libdcp {
26
27 /** A 2D (monoscopic) picture asset */
28 class MonoPictureAsset : public PictureAsset
29 {
30 public:
31         MonoPictureAsset (boost::filesystem::path directory, boost::filesystem::path mxf_name);
32
33         void read ();
34
35         /** The following parameters must be set up (if required) before calling this:
36          *      Interop mode (set_interop)
37          *      Edit rate    (set_edit_rate)
38          *      MXF Metadata (set_metadata)
39          */
40         void create (std::vector<boost::filesystem::path> const & files);
41
42         /** The following parameters must be set up (if required) before calling this:
43          *      Interop mode (set_interop)
44          *      Edit rate    (set_edit_rate)
45          *      MXF Metadata (set_metadata)
46          */
47         void create (boost::function<boost::filesystem::path (int)> get_path);
48
49         /** Start a progressive write to a MonoPictureAsset */
50         boost::shared_ptr<PictureAssetWriter> start_write (bool);
51
52         boost::shared_ptr<const MonoPictureFrame> get_frame (int n) const;
53         bool equals (boost::shared_ptr<const Asset> other, EqualityOptions opt, boost::function<void (NoteType, std::string)> note) const;
54
55 private:
56         boost::filesystem::path path_from_list (int f, std::vector<boost::filesystem::path> const & files) const;
57         void construct (boost::function<boost::filesystem::path (int)>, bool, MXFMetadata const &);
58         std::string cpl_node_name () const;
59         int edit_rate_factor () const;
60 };
61
62 }       
63
64 #endif