8c8ee53123c322df94fe5b7beee43db5c5ba25b8
[libdcp.git] / src / mono_picture_mxf.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_MXF_H
21 #define LIBDCP_MONO_PICTURE_MXF_H
22
23 #include "picture_mxf.h"
24
25 namespace dcp {
26
27 /** @class MonoPictureMXF
28  *  @brief A 2D (monoscopic) picture MXF.
29  */
30 class MonoPictureMXF : public PictureMXF
31 {
32 public:
33         /** Create a MonoPictureMXF by reading a file.
34          *  @param file MXF file to read.
35          */
36         MonoPictureMXF (boost::filesystem::path file);
37
38         /** Create a MonoPictureMXF with a given edit rate.
39          *  @param edit_rate Edit rate (i.e. frame rate) in frames per second.
40          */
41         MonoPictureMXF (int edit_rate);
42
43         /** Start a progressive write to a MonoPictureMXF */
44         boost::shared_ptr<PictureMXFWriter> start_write (boost::filesystem::path, bool);
45
46         boost::shared_ptr<const MonoPictureFrame> get_frame (int n) const;
47         bool equals (boost::shared_ptr<const Content> other, EqualityOptions opt, boost::function<void (NoteType, std::string)> note) const;
48
49 private:
50         std::string cpl_node_name () const;
51         int edit_rate_factor () const;
52 };
53
54 }       
55
56 #endif