Rename XYZFrame -> XYZImage and ARGBFrame -> ARGBImage.
[libdcp.git] / src / mono_picture_frame.h
1 /*
2     Copyright (C) 2012-2014 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 /** @file  src/mono_picture_frame.h
21  *  @brief MonoPictureFrame class.
22  */
23
24 #include "types.h"
25 #include <boost/shared_ptr.hpp>
26 #include <boost/noncopyable.hpp>
27 #include <boost/filesystem.hpp>
28 #include <boost/optional.hpp>
29 #include <string>
30 #include <stdint.h>
31
32 namespace ASDCP {
33         namespace JP2K {
34                 class FrameBuffer;
35         }
36         class AESDecContext;
37 }
38
39 namespace dcp {
40
41 class ARGBImage;
42 class Image;
43
44 /** @class MonoPictureFrame
45  *  @brief A single frame of a 2D (monoscopic) picture asset.
46  */
47 class MonoPictureFrame : public boost::noncopyable
48 {
49 public:
50         MonoPictureFrame (boost::filesystem::path mxf_path, int n, ASDCP::AESDecContext *);
51         MonoPictureFrame (boost::filesystem::path path);
52         MonoPictureFrame ();
53         ~MonoPictureFrame ();
54
55         boost::shared_ptr<ARGBImage> argb_image (int reduce = 0) const;
56         void rgb_frame (boost::shared_ptr<Image> rgb, boost::optional<NoteHandler> note = boost::optional<NoteHandler> ()) const;
57         uint8_t const * j2k_data () const;
58         uint8_t* j2k_data ();
59         int j2k_size () const;
60
61 private:
62         ASDCP::JP2K::FrameBuffer* _buffer;
63 };
64
65 }