libdcp
picture_asset.h
Go to the documentation of this file.
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 
40 #ifndef LIBDCP_PICTURE_ASSET_H
41 #define LIBDCP_PICTURE_ASSET_H
42 
43 
44 #include "mxf.h"
45 #include "util.h"
46 #include "metadata.h"
47 
48 
49 namespace ASDCP {
50  namespace JP2K {
51  struct PictureDescriptor;
52  }
53 }
54 
55 
56 namespace dcp {
57 
58 
59 class MonoPictureFrame;
60 class StereoPictureFrame;
61 class PictureAssetWriter;
62 
63 
67 class PictureAsset : public Asset, public MXF
68 {
69 public:
71  explicit PictureAsset (boost::filesystem::path file);
72 
74  explicit PictureAsset (Fraction edit_rate, Standard standard);
75 
76  virtual std::shared_ptr<PictureAssetWriter> start_write (
77  boost::filesystem::path file,
78  bool overwrite
79  ) = 0;
80 
81  Size size () const {
82  return _size;
83  }
84 
85  void set_size (Size s) {
86  _size = s;
87  }
88 
89  Fraction frame_rate () const {
90  return _frame_rate;
91  }
92 
93  void set_frame_rate (Fraction r) {
94  _frame_rate = r;
95  }
96 
97  Fraction screen_aspect_ratio () const {
98  return _screen_aspect_ratio;
99  }
100 
101  void set_screen_aspect_ratio (Fraction r) {
102  _screen_aspect_ratio = r;
103  }
104 
105  Fraction edit_rate () const {
106  return _edit_rate;
107  }
108 
109  int64_t intrinsic_duration () const {
110  return _intrinsic_duration;
111  }
112 
113  static std::string static_pkl_type (Standard standard);
114 
115 protected:
116  friend class MonoPictureAssetWriter;
117  friend class StereoPictureAssetWriter;
118 
119  bool frame_buffer_equals (
120  int frame, EqualityOptions opt, NoteHandler note,
121  uint8_t const * data_A, unsigned int size_A, uint8_t const * data_B, unsigned int size_B
122  ) const;
123 
124  bool descriptor_equals (
125  ASDCP::JP2K::PictureDescriptor const & a,
126  ASDCP::JP2K::PictureDescriptor const & b,
127  NoteHandler note
128  ) const;
129 
130  void read_picture_descriptor (ASDCP::JP2K::PictureDescriptor const &);
131 
132  Fraction _edit_rate;
136  int64_t _intrinsic_duration = 0;
139  Fraction _frame_rate;
140  Fraction _screen_aspect_ratio;
141 
142 private:
143  std::string pkl_type (Standard standard) const override;
144 };
145 
146 
147 }
148 
149 
150 #endif
Parent class for DCP assets, i.e. picture, sound, subtitles, closed captions, CPLs,...
Definition: asset.h:70
boost::optional< boost::filesystem::path > file() const
Definition: asset.h:97
A fraction (i.e. a thing with an integer numerator and an integer denominator).
Definition: types.h:214
Parent for classes which represent MXF files.
Definition: mxf.h:74
A helper class for writing to MonoPictureAssets.
An asset made up of JPEG2000 data.
Definition: picture_asset.h:68
int64_t _intrinsic_duration
PictureAsset(boost::filesystem::path file)
std::string pkl_type(Standard standard) const override
A helper class for writing to StereoPictureAssets.
MXFMetadata class.
MXF class.
Namespace for everything in libdcp.
Definition: array_data.h:50
A class to describe what "equality" means for a particular test.
Definition: types.h:249
The integer, two-dimensional size of something.
Definition: types.h:71
Utility methods and classes.