Use an enum class for Marker.
[libdcp.git] / src / openjpeg_image.h
1 /*
2     Copyright (C) 2012-2015 Carl Hetherington <cth@carlh.net>
3
4     This file is part of libdcp.
5
6     libdcp is free software; you can redistribute it and/or modify
7     it under the terms of the GNU General Public License as published by
8     the Free Software Foundation; either version 2 of the License, or
9     (at your option) any later version.
10
11     libdcp is distributed in the hope that it will be useful,
12     but WITHOUT ANY WARRANTY; without even the implied warranty of
13     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14     GNU General Public License for more details.
15
16     You should have received a copy of the GNU General Public License
17     along with libdcp.  If not, see <http://www.gnu.org/licenses/>.
18
19     In addition, as a special exception, the copyright holders give
20     permission to link the code of portions of this program with the
21     OpenSSL library under certain conditions as described in each
22     individual source file, and distribute linked combinations
23     including the two.
24
25     You must obey the GNU General Public License in all respects
26     for all of the code used other than OpenSSL.  If you modify
27     file(s) with this exception, you may extend this exception to your
28     version of the file(s), but you are not obligated to do so.  If you
29     do not wish to do so, delete this exception statement from your
30     version.  If you delete this exception statement from all source
31     files in the program, then also delete it here.
32 */
33
34 /** @file  src/openjpeg_image.h
35  *  @brief OpenJPEGImage class.
36  */
37
38 #include "util.h"
39
40 struct opj_image;
41 typedef struct opj_image opj_image_t;
42
43 namespace dcp {
44
45 /** @class OpenJPEGImage
46  *  @brief A wrapper of libopenjpeg's opj_image_t.
47  */
48 class OpenJPEGImage
49 {
50 public:
51         explicit OpenJPEGImage (opj_image_t *);
52         explicit OpenJPEGImage (OpenJPEGImage const & other);
53         explicit OpenJPEGImage (Size);
54         OpenJPEGImage (uint8_t const * in_16, dcp::Size size, int stride);
55         ~OpenJPEGImage ();
56
57         int* data (int) const;
58         Size size () const;
59         int precision (int component) const;
60         bool srgb () const;
61         int factor (int component) const;
62
63         /** @return Pointer to opj_image_t struct.  The caller
64          *  must not delete this.
65          */
66         opj_image_t* opj_image () const {
67                 return _opj_image;
68         }
69
70 private:
71         void create (Size size);
72
73         opj_image_t* _opj_image; ///< opj_image_t that we are managing
74 };
75
76 }