Add Reader classes to permit much more efficient DCP reading.
[libdcp.git] / src / mono_picture_asset.h
1 /*
2     Copyright (C) 2012-2015 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 dcp {
26
27 class MonoPictureAssetWriter;
28 class MonoPictureAssetReader;
29
30 /** @class MonoPictureAsset
31  *  @brief A 2D (monoscopic) picture asset.
32  */
33 class MonoPictureAsset : public PictureAsset
34 {
35 public:
36         /** Create a MonoPictureAsset by reading a file.
37          *  @param file Asset file to read.
38          */
39         MonoPictureAsset (boost::filesystem::path file);
40
41         /** Create a MonoPictureAsset with a given edit rate.
42          *  @param edit_rate Edit rate (i.e. frame rate) in frames per second.
43          */
44         MonoPictureAsset (Fraction edit_rate);
45
46         /** Start a progressive write to a MonoPictureAsset */
47         boost::shared_ptr<PictureAssetWriter> start_write (boost::filesystem::path, Standard standard, bool);
48         boost::shared_ptr<MonoPictureAssetReader> start_read () const;
49
50         bool equals (
51                 boost::shared_ptr<const Asset> other,
52                 EqualityOptions opt,
53                 NoteHandler note
54                 ) const;
55
56 private:
57         std::string cpl_node_name () const;
58 };
59
60 }
61
62 #endif