HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
ImfKeyCode.h
Go to the documentation of this file.
1 //
2 // SPDX-License-Identifier: BSD-3-Clause
3 // Copyright (c) Contributors to the OpenEXR Project.
4 //
5 
6 #ifndef INCLUDED_IMF_KEY_CODE_H
7 #define INCLUDED_IMF_KEY_CODE_H
8 
9 //-----------------------------------------------------------------------------
10 //
11 // class KeyCode
12 //
13 // A KeyCode object uniquely identifies a motion picture film frame.
14 // The following fields specify film manufacturer, film type, film
15 // roll and the frame's position within the roll:
16 //
17 // filmMfcCode film manufacturer code
18 // range: 0 - 99
19 //
20 // filmType film type code
21 // range: 0 - 99
22 //
23 // prefix prefix to identify film roll
24 // range: 0 - 999999
25 //
26 // count count, increments once every perfsPerCount
27 // perforations (see below)
28 // range: 0 - 9999
29 //
30 // perfOffset offset of frame, in perforations from
31 // zero-frame reference mark
32 // range: 0 - 119
33 //
34 // perfsPerFrame number of perforations per frame
35 // range: 1 - 15
36 //
37 // typical values:
38 //
39 // 1 for 16mm film
40 // 3, 4, or 8 for 35mm film
41 // 5, 8 or 15 for 65mm film
42 //
43 // perfsPerCount number of perforations per count
44 // range: 20 - 120
45 //
46 // typical values:
47 //
48 // 20 for 16mm film
49 // 64 for 35mm film
50 // 80 or 120 for 65mm film
51 //
52 // For more information about the interpretation of those fields see
53 // the following standards and recommended practice publications:
54 //
55 // SMPTE 254 Motion-Picture Film (35-mm) - Manufacturer-Printed
56 // Latent Image Identification Information
57 //
58 // SMPTE 268M File Format for Digital Moving-Picture Exchange (DPX)
59 // (section 6.1)
60 //
61 // SMPTE 270 Motion-Picture Film (65-mm) - Manufacturer- Printed
62 // Latent Image Identification Information
63 //
64 // SMPTE 271 Motion-Picture Film (16-mm) - Manufacturer- Printed
65 // Latent Image Identification Information
66 //
67 //-----------------------------------------------------------------------------
68 #include "ImfExport.h"
69 #include "ImfNamespace.h"
70 
71 OPENEXR_IMF_INTERNAL_NAMESPACE_HEADER_ENTER
72 
73 class IMF_EXPORT_TYPE KeyCode
74 {
75 public:
76  //-------------------------------------
77  // Constructors and assignment operator
78  //-------------------------------------
79 
80  IMF_EXPORT
81  KeyCode (
82  int filmMfcCode = 0,
83  int filmType = 0,
84  int prefix = 0,
85  int count = 0,
86  int perfOffset = 0,
87  int perfsPerFrame = 4,
88  int perfsPerCount = 64);
89 
90  IMF_EXPORT
91  KeyCode (const KeyCode& other);
92  ~KeyCode () = default;
93  IMF_EXPORT
94  KeyCode& operator= (const KeyCode& other);
95 
96  //----------------------------
97  // Access to individual fields
98  //----------------------------
99 
100  IMF_EXPORT
101  int filmMfcCode () const;
102  IMF_EXPORT
103  void setFilmMfcCode (int filmMfcCode);
104 
105  IMF_EXPORT
106  int filmType () const;
107  IMF_EXPORT
108  void setFilmType (int filmType);
109 
110  IMF_EXPORT
111  int prefix () const;
112  IMF_EXPORT
113  void setPrefix (int prefix);
114 
115  IMF_EXPORT
116  int count () const;
117  IMF_EXPORT
118  void setCount (int count);
119 
120  IMF_EXPORT
121  int perfOffset () const;
122  IMF_EXPORT
123  void setPerfOffset (int perfOffset);
124 
125  IMF_EXPORT
126  int perfsPerFrame () const;
127  IMF_EXPORT
128  void setPerfsPerFrame (int perfsPerFrame);
129 
130  IMF_EXPORT
131  int perfsPerCount () const;
132  IMF_EXPORT
133  void setPerfsPerCount (int perfsPerCount);
134 
135 private:
136  int _filmMfcCode;
137  int _filmType;
138  int _prefix;
139  int _count;
140  int _perfOffset;
141  int _perfsPerFrame;
142  int _perfsPerCount;
143 };
144 
145 OPENEXR_IMF_INTERNAL_NAMESPACE_HEADER_EXIT
146 
147 #endif
ImfNamespace.h
OPENEXR_IMF_INTERNAL_NAMESPACE_HEADER_EXIT
#define OPENEXR_IMF_INTERNAL_NAMESPACE_HEADER_EXIT
Definition: ImfNamespace.h:83
VE_InstanceExtension::count
IMF_EXPORT
#define IMF_EXPORT
Definition: ImfExport.h:54
nanovdb::operator=
LeafData & operator=(const LeafData &)=delete
ImfExport.h
OPENEXR_IMF_INTERNAL_NAMESPACE_HEADER_ENTER
#define OPENEXR_IMF_INTERNAL_NAMESPACE_HEADER_ENTER
Definition: ImfNamespace.h:80
IMF_EXPORT_TYPE
#define IMF_EXPORT_TYPE
Definition: ImfExport.h:57
count
GLint GLsizei count
Definition: glcorearb.h:405