Rename XYZImage -> OpenJPEGImage.
[libdcp.git] / src / openjpeg_image.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 /** @file  src/openjpeg_image.h
21  *  @brief OpenJPEGImage class.
22  */
23
24 #include "util.h"
25 #include <openjpeg.h>
26
27 namespace dcp {
28
29 /** @class OpenJPEGImage
30  *  @brief A wrapper of libopenjpeg's opj_image_t.
31  */
32 class OpenJPEGImage : public boost::noncopyable
33 {
34 public:
35         OpenJPEGImage (opj_image_t *);
36         OpenJPEGImage (Size);
37         ~OpenJPEGImage ();
38
39         int* data (int) const;
40         dcp::Size size () const;
41
42         /** @return Pointer to opj_image_t struct.  The caller
43          *  must not delete this.
44          */
45         opj_image_t* opj_image () const {
46                 return _opj_image;
47         }
48
49 private:
50         opj_image_t* _opj_image; ///< opj_image_t that we are managing
51 };
52
53 }