Tidying.
[libdcp.git] / src / j2k.h
1 /*
2     Copyright (C) 2012-2021 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
35 /** @file  src/j2k.h
36  *  @brief Methods to encode and decode JPEG2000
37  */
38
39
40 #include "array_data.h"
41 #include <memory>
42 #include <stdint.h>
43
44
45 namespace dcp {
46
47
48 class OpenJPEGImage;
49
50
51 extern std::shared_ptr<OpenJPEGImage> decompress_j2k (uint8_t* data, int64_t size, int reduce);
52
53 /** Decompress a JPEG2000 image to a bitmap
54  *  @param data JPEG2000 data
55  *  @param size Size of data in bytes
56  *  @param reduce A power of 2 by which to reduce the size of the decoded image;
57  *  e.g. 0 reduces by (2^0 == 1), ie keeping the same size.
58  *       1 reduces by (2^1 == 2), ie halving the size of the image.
59  *  This is useful for scaling 4K DCP images down to 2K.
60  *  @return OpenJPEGImage
61  */
62 extern std::shared_ptr<OpenJPEGImage> decompress_j2k (ArrayData data, int reduce);
63
64 /** @xyz Picture to compress.  Parts of xyz's data WILL BE OVERWRITTEN by libopenjpeg so xyz cannot be re-used
65  *  after this call; see opj_j2k_encode where if l_reuse_data is false it will set l_tilec->data = l_img_comp->data.
66  */
67 extern ArrayData compress_j2k (std::shared_ptr<const OpenJPEGImage>, int bandwith, int frames_per_second, bool threed, bool fourk, std::string comment = "libdcp");
68
69
70 }