Split the old PictureAsset into a new PictureAsset + J2KPictureAsset.
[libdcp.git] / src / j2k_picture_asset.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/picture_asset.h
36  *  @brief J2KPictureAsset class
37  */
38
39
40 #ifndef LIBDCP_J2K_PICTURE_ASSET_H
41 #define LIBDCP_J2K_PICTURE_ASSET_H
42
43
44 #include "mxf.h"
45 #include "metadata.h"
46 #include "picture_asset.h"
47 #include "util.h"
48
49
50 namespace ASDCP {
51         namespace JP2K {
52                 struct PictureDescriptor;
53         }
54 }
55
56
57 namespace dcp {
58
59
60 class MonoJ2KPictureFrame;
61 class StereoJ2KPictureFrame;
62 class J2KPictureAssetWriter;
63
64
65 /** @class J2KPictureAsset
66  *  @brief An asset made up of JPEG2000 data
67  */
68 class J2KPictureAsset : public PictureAsset
69 {
70 public:
71         /** Load a J2KPictureAsset from a file */
72         explicit J2KPictureAsset (boost::filesystem::path file);
73
74         /** Create a new J2KPictureAsset with a given edit rate and standard */
75         J2KPictureAsset (Fraction edit_rate, Standard standard);
76
77         enum class Behaviour {
78                 OVERWRITE_EXISTING,
79                 MAKE_NEW
80         };
81
82         virtual std::shared_ptr<J2KPictureAssetWriter> start_write (
83                 boost::filesystem::path file,
84                 Behaviour behaviour
85                 ) = 0;
86
87         static std::string static_pkl_type (Standard standard);
88
89 protected:
90         friend class MonoJ2KPictureAssetWriter;
91         friend class StereoJ2KPictureAssetWriter;
92
93         bool frame_buffer_equals (
94                 int frame, EqualityOptions const& opt, NoteHandler note,
95                 uint8_t const * data_A, unsigned int size_A, uint8_t const * data_B, unsigned int size_B
96                 ) const;
97
98         bool descriptor_equals (
99                 ASDCP::JP2K::PictureDescriptor const & a,
100                 ASDCP::JP2K::PictureDescriptor const & b,
101                 NoteHandler note
102                 ) const;
103
104         void read_picture_descriptor (ASDCP::JP2K::PictureDescriptor const &);
105
106 private:
107         std::string pkl_type (Standard standard) const override;
108 };
109
110
111 }
112
113
114 #endif