2 Copyright (c) 2004-2006, John Hurst
5 Redistribution and use in source and binary forms, with or without
6 modification, are permitted provided that the following conditions
8 1. Redistributions of source code must retain the above copyright
9 notice, this list of conditions and the following disclaimer.
10 2. Redistributions in binary form must reproduce the above copyright
11 notice, this list of conditions and the following disclaimer in the
12 documentation and/or other materials provided with the distribution.
13 3. The name of the author may not be used to endorse or promote products
14 derived from this software without specific prior written permission.
16 THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
17 IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
18 OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
19 IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
20 INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
21 NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
22 DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
23 THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
25 THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 /*! \file AS_DCP_internal.h
29 \brief AS-DCP library, non-public common elements
32 #ifndef _AS_DCP_INTERNAL_H_
33 #define _AS_DCP_INTERNAL_H_
35 #include <KM_platform.h>
40 using Kumu::DefaultLogSink;
41 // using namespace std;
42 using namespace ASDCP;
43 using namespace ASDCP::MXF;
49 // constant values used to calculate KLV and EKLV packet sizes
50 static const ui32_t klv_cryptinfo_size =
52 + UUIDlen /* ContextID */
54 + sizeof(ui64_t) /* PlaintextOffset */
56 + SMPTE_UL_LENGTH /* SourceKey */
58 + sizeof(ui64_t) /* SourceLength */
59 + MXF_BER_LENGTH /* ESV length */ ;
61 static const ui32_t klv_intpack_size =
63 + UUIDlen /* TrackFileID */
65 + sizeof(ui64_t) /* SequenceNumber */
67 + 20; /* HMAC length*/
69 // calculate size of encrypted essence with IV, CheckValue, and padding
71 calc_esv_length(ui32_t source_length, ui32_t plaintext_offset)
73 ui32_t ct_size = source_length - plaintext_offset;
74 ui32_t diff = ct_size % CBC_BLOCK_SIZE;
75 ui32_t block_size = ct_size - diff;
76 return plaintext_offset + block_size + (CBC_BLOCK_SIZE * 3);
79 // the check value for EKLV packets
81 static const byte_t ESV_CheckValue[CBC_BLOCK_SIZE] =
82 { 0x43, 0x48, 0x55, 0x4b, 0x43, 0x48, 0x55, 0x4b,
83 0x43, 0x48, 0x55, 0x4b, 0x43, 0x48, 0x55, 0x4b };
85 //------------------------------------------------------------------------------------------
88 Result_t MD_to_WriterInfo(MXF::Identification*, WriterInfo&);
89 Result_t MD_to_CryptoInfo(MXF::CryptographicContext*, WriterInfo&);
90 Result_t EncryptFrameBuffer(const ASDCP::FrameBuffer&, ASDCP::FrameBuffer&, AESEncContext*);
91 Result_t DecryptFrameBuffer(const ASDCP::FrameBuffer&, ASDCP::FrameBuffer&, AESDecContext*);
94 class KLReader : public ASDCP::KLVPacket
96 ASDCP_NO_COPY_CONSTRUCT(KLReader);
97 byte_t m_KeyBuf[SMPTE_UL_LENGTH*2];
103 inline const byte_t* Key() { return m_KeyBuf; }
104 inline const ui64_t Length() { return m_ValueLength; }
105 inline const ui64_t KLLength() { return m_KLLength; }
107 Result_t ReadKLFromFile(Kumu::FileReader& Reader);
113 ASDCP_NO_COPY_CONSTRUCT(h__Reader);
116 Kumu::FileReader m_File;
117 OPAtomHeader m_HeaderPart;
118 Partition m_BodyPart;
119 OPAtomIndexFooter m_FooterPart;
120 ui64_t m_EssenceStart;
122 ASDCP::FrameBuffer m_CtFrameBuf;
123 Kumu::fpos_t m_LastPosition;
126 virtual ~h__Reader();
129 Result_t OpenMXFRead(const char* filename);
130 Result_t InitMXFIndex();
132 // positions file before reading
133 Result_t ReadEKLVFrame(ui32_t FrameNum, ASDCP::FrameBuffer& FrameBuf,
134 const byte_t* EssenceUL, AESDecContext* Ctx, HMACContext* HMAC);
136 // reads from current position
137 Result_t ReadEKLVPacket(ui32_t FrameNum, ui32_t SequenceNum, ASDCP::FrameBuffer& FrameBuf,
138 const byte_t* EssenceUL, AESDecContext* Ctx, HMACContext* HMAC);
143 // state machine for mxf writer
145 ST_BEGIN, // waiting for Open()
146 ST_INIT, // waiting for SetSourceStream()
147 ST_READY, // ready to write frames
148 ST_RUNNING, // one or more frames written
149 ST_FINAL, // index written, file closed
152 // implementation of h__WriterState class Goto_* methods
153 #define Goto_body(s1,s2) if ( m_State != (s1) ) \
154 return RESULT_STATE; \
160 ASDCP_NO_COPY_CONSTRUCT(h__WriterState);
163 WriterState_t m_State;
164 h__WriterState() : m_State(ST_BEGIN) {}
167 inline bool Test_BEGIN() { return m_State == ST_BEGIN; }
168 inline bool Test_INIT() { return m_State == ST_INIT; }
169 inline bool Test_READY() { return m_State == ST_READY;}
170 inline bool Test_RUNNING() { return m_State == ST_RUNNING; }
171 inline bool Test_FINAL() { return m_State == ST_FINAL; }
172 inline Result_t Goto_INIT() { Goto_body(ST_BEGIN, ST_INIT); }
173 inline Result_t Goto_READY() { Goto_body(ST_INIT, ST_READY); }
174 inline Result_t Goto_RUNNING() { Goto_body(ST_READY, ST_RUNNING); }
175 inline Result_t Goto_FINAL() { Goto_body(ST_RUNNING, ST_FINAL); }
178 typedef std::list<ui64_t*> DurationElementList_t;
183 ASDCP_NO_COPY_CONSTRUCT(h__Writer);
186 Kumu::FileWriter m_File;
188 OPAtomHeader m_HeaderPart;
189 Partition m_BodyPart;
190 OPAtomIndexFooter m_FooterPart;
191 ui64_t m_EssenceStart;
193 MaterialPackage* m_MaterialPackage;
194 SourcePackage* m_FilePackage;
196 FileDescriptor* m_EssenceDescriptor;
197 std::list<InterchangeObject*> m_EssenceSubDescriptorList;
199 ui32_t m_FramesWritten;
200 ui64_t m_StreamOffset;
201 ASDCP::FrameBuffer m_CtFrameBuf;
202 h__WriterState m_State;
204 DurationElementList_t m_DurationUpdateList;
207 virtual ~h__Writer();
210 void AddSourceClip(const MXF::Rational& EditRate, ui32_t TCFrameRate,
211 const std::string& TrackName, const UL& DataDefinition,
212 const std::string& PackageLabel);
213 void AddDMSegment(const MXF::Rational& EditRate, ui32_t TCFrameRate,
214 const std::string& TrackName, const UL& DataDefinition,
215 const std::string& PackageLabel);
216 void AddEssenceDescriptor(const UL& WrappingUL);
217 Result_t CreateBodyPart(const MXF::Rational& EditRate, ui32_t BytesPerEditUnit = 0);
219 // all the above for a single source clip
220 Result_t WriteMXFHeader(const std::string& PackageLabel, const UL& WrappingUL,
221 const std::string& TrackName, const UL& DataDefinition,
222 const MXF::Rational& EditRate,
223 ui32_t TCFrameRate, ui32_t BytesPerEditUnit = 0);
225 Result_t WriteEKLVPacket(const ASDCP::FrameBuffer& FrameBuf,
226 const byte_t* EssenceUL, AESEncContext* Ctx, HMACContext* HMAC);
228 Result_t WriteMXFFooter();
233 // helper class for calculating Integrity Packs, used by WriteEKLVPacket() below.
238 byte_t Data[klv_intpack_size];
241 memset(Data, 0, klv_intpack_size);
246 Result_t CalcValues(const ASDCP::FrameBuffer&, byte_t* AssetID, ui32_t sequence, HMACContext* HMAC);
247 Result_t TestValues(const ASDCP::FrameBuffer&, byte_t* AssetID, ui32_t sequence, HMACContext* HMAC);
253 #endif // _AS_DCP_INTERNAL_H_
257 // end AS_DCP_internal.h