2 Copyright (c) 2003-2008, 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.
29 \brief AS-DCP library, public interface
31 The asdcplib library is a set of wrapper objects that offer simplified
32 access to files conforming to the file formats proposed by the SMPTE
33 D-Cinema packaging working group DC28.20. The file format, labeled
34 AS-DCP, is described in series of separate documents which include but
35 may not be limited to:
37 o MXF Interop Track File Specification
38 o MXF Interop Track File Essence Encryption Specification
39 o MXF Interop Operational Constraints Specification
40 o SMPTE 429-3-2006 Track File Specification
41 o SMPTE 429-4-2006 JPEG 2000 for D-Cinema
42 o SMPTE 429-5-200X Timed Text Track File
43 o SMPTE 429-6-2006 Essence Encryption Specification
44 o SMPTE 429-10-200X Stereoscopic Image Track File
48 o SMPTE 390M - OP-Atom
49 o SMPTE 379M - Generic Container
50 o SMPTE 381M - MPEG2 picture
51 o SMPTE 422M - JPEG 2000 picture
52 o SMPTE 382M - WAV/PCM sound
53 o IETF RFC 2104 - HMAC/SHA1
54 o NIST FIPS 197 - AES (Rijndael)
56 The following use cases are supported by the library:
58 o Write a plaintext MPEG2 Video Elementary Stream to a plaintext ASDCP file
59 o Write a plaintext MPEG2 Video Elementary Stream to a ciphertext ASDCP file
60 o Read a plaintext MPEG2 Video Elementary Stream from a plaintext ASDCP file
61 o Read a plaintext MPEG2 Video Elementary Stream from a ciphertext ASDCP file
62 o Read a ciphertext MPEG2 Video Elementary Stream from a ciphertext ASDCP file
63 o Write one or more plaintext JPEG 2000 codestreams to a plaintext ASDCP file
64 o Write one or more plaintext JPEG 2000 codestreams to a ciphertext ASDCP file
65 o Read one or more plaintext JPEG 2000 codestreams from a plaintext ASDCP file
66 o Read one or more plaintext JPEG 2000 codestreams from a ciphertext ASDCP file
67 o Read one or more ciphertext JPEG 2000 codestreams from a ciphertext ASDCP file
68 o Write one or more plaintext JPEG 2000 stereoscopic codestream pairs to a plaintext ASDCP file
69 o Write one or more plaintext JPEG 2000 stereoscopic codestream pairs to a ciphertext ASDCP file
70 o Read one or more plaintext JPEG 2000 stereoscopic codestream pairs from a plaintext ASDCP file
71 o Read one or more plaintext JPEG 2000 stereoscopic codestream pairs from a ciphertext ASDCP file
72 o Read one or more ciphertext JPEG 2000 stereoscopic codestream pairs from a ciphertext ASDCP file
73 o Write one or more plaintext PCM audio streams to a plaintext ASDCP file
74 o Write one or more plaintext PCM audio streams to a ciphertext ASDCP file
75 o Read one or more plaintext PCM audio streams from a plaintext ASDCP file
76 o Read one or more plaintext PCM audio streams from a ciphertext ASDCP file
77 o Read one or more ciphertext PCM audio streams from a ciphertext ASDCP file
78 o Read header metadata from an ASDCP file
80 This project depends upon the following libraries:
81 - OpenSSL http://www.openssl.org/
82 - Expat http://expat.sourceforge.net/ (optional)
98 //--------------------------------------------------------------------------------
99 // common integer types
100 // supply your own by defining ASDCP_NO_BASE_TYPES
102 #ifndef ASDCP_NO_BASE_TYPES
103 typedef unsigned char byte_t;
105 typedef unsigned char ui8_t;
107 typedef unsigned short ui16_t;
109 typedef unsigned int ui32_t;
113 //--------------------------------------------------------------------------------
114 // convenience macros
116 // Convenience macros for managing return values in predicates
117 #define ASDCP_SUCCESS(v) (((v) < 0) ? 0 : 1)
118 #define ASDCP_FAILURE(v) (((v) < 0) ? 1 : 0)
121 // Returns RESULT_PTR if the given argument is NULL.
122 // See Result_t below for an explanation of RESULT_* symbols.
123 #define ASDCP_TEST_NULL(p) \
125 return ASDCP::RESULT_PTR; \
128 // Returns RESULT_PTR if the given argument is NULL. See Result_t
129 // below for an explanation of RESULT_* symbols. It then assumes
130 // that the argument is a pointer to a string and returns
131 // RESULT_NULL_STR if the first character is '\0'.
133 #define ASDCP_TEST_NULL_STR(p) \
134 ASDCP_TEST_NULL(p); \
135 if ( (p)[0] == '\0' ) { \
136 return ASDCP::RESULT_NULL_STR; \
139 // Produces copy constructor boilerplate. Allows convenient private
140 // declatarion of copy constructors to prevent the compiler from
141 // silently manufacturing default methods.
142 #define ASDCP_NO_COPY_CONSTRUCT(T) \
144 T& operator=(const T&)
146 //--------------------------------------------------------------------------------
147 // All library components are defined in the namespace ASDCP
151 // The version number declaration and explanation have moved to ../configure.ac
152 const char* Version();
154 // UUIDs are passed around as strings of UUIDlen bytes
155 const ui32_t UUIDlen = 16;
157 // Encryption keys are passed around as strings of KeyLen bytes
158 const ui32_t KeyLen = 16;
160 //---------------------------------------------------------------------------------
163 using Kumu::Result_t;
165 using Kumu::RESULT_FALSE;
166 using Kumu::RESULT_OK;
167 using Kumu::RESULT_FAIL;
168 using Kumu::RESULT_PTR;
169 using Kumu::RESULT_NULL_STR;
170 using Kumu::RESULT_ALLOC;
171 using Kumu::RESULT_PARAM;
172 using Kumu::RESULT_SMALLBUF;
173 using Kumu::RESULT_INIT;
174 using Kumu::RESULT_NOT_FOUND;
175 using Kumu::RESULT_NO_PERM;
176 using Kumu::RESULT_FILEOPEN;
177 using Kumu::RESULT_BADSEEK;
178 using Kumu::RESULT_READFAIL;
179 using Kumu::RESULT_WRITEFAIL;
180 using Kumu::RESULT_STATE;
181 using Kumu::RESULT_ENDOFFILE;
182 using Kumu::RESULT_CONFIG;
184 const Kumu::Result_t RESULT_FORMAT (-101, "The file format is not proper OP-Atom/AS-DCP.");
185 const Kumu::Result_t RESULT_RAW_ESS (-102, "Unknown raw essence file type.");
186 const Kumu::Result_t RESULT_RAW_FORMAT (-103, "Raw essence format invalid.");
187 const Kumu::Result_t RESULT_RANGE (-104, "Frame number out of range.");
188 const Kumu::Result_t RESULT_CRYPT_CTX (-105, "AESEncContext required when writing to encrypted file.");
189 const Kumu::Result_t RESULT_LARGE_PTO (-106, "Plaintext offset exceeds frame buffer size.");
190 const Kumu::Result_t RESULT_CAPEXTMEM (-107, "Cannot resize externally allocated memory.");
191 const Kumu::Result_t RESULT_CHECKFAIL (-108, "The check value did not decrypt correctly.");
192 const Kumu::Result_t RESULT_HMACFAIL (-109, "HMAC authentication failure.");
193 const Kumu::Result_t RESULT_HMAC_CTX (-110, "HMAC context required.");
194 const Kumu::Result_t RESULT_CRYPT_INIT (-111, "Error initializing block cipher context.");
195 const Kumu::Result_t RESULT_EMPTY_FB (-112, "Empty frame buffer.");
196 const Kumu::Result_t RESULT_KLV_CODING (-113, "KLV coding error.");
197 const Kumu::Result_t RESULT_SPHASE (-114, "Stereoscopic phase mismatch.");
198 const Kumu::Result_t RESULT_SFORMAT (-115, "Rate mismatch, file may contain stereoscopic essence.");
200 //---------------------------------------------------------------------------------
201 // file identification
203 // The file accessors in this library implement a bounded set of essence types.
204 // This list will be expanded when support for new types is added to the library.
206 ESS_UNKNOWN, // the file is not a supported AS-DCP essence container
207 ESS_MPEG2_VES, // the file contains an MPEG video elementary stream
208 ESS_JPEG_2000, // the file contains one or more JPEG 2000 codestreams
209 ESS_PCM_24b_48k, // the file contains one or more PCM audio pairs
210 ESS_PCM_24b_96k, // the file contains one or more PCM audio pairs
211 ESS_TIMED_TEXT, // the file contains an XML timed text document and one or more resources
212 ESS_JPEG_2000_S, // the file contains one or more JPEG 2000 codestream pairs (stereoscopic)
215 // Determine the type of essence contained in the given MXF file. RESULT_OK
216 // is returned if the file is successfully opened and contains a valid MXF
217 // stream. If there is an error, the result code will indicate the reason.
218 Result_t EssenceType(const char* filename, EssenceType_t& type);
220 // Determine the type of essence contained in the given raw file. RESULT_OK
221 // is returned if the file is successfully opened and contains a known
222 // stream type. If there is an error, the result code will indicate the reason.
223 Result_t RawEssenceType(const char* filename, EssenceType_t& type);
226 //---------------------------------------------------------------------------------
229 // A simple container for rational numbers.
236 Rational() : Numerator(0), Denominator(0) {}
237 Rational(i32_t n, i32_t d) : Numerator(n), Denominator(d) {}
239 inline double Quotient() const {
240 return (double)Numerator / (double)Denominator;
243 inline bool operator==(const Rational& rhs) const {
244 return ( rhs.Numerator == Numerator && rhs.Denominator == Denominator );
247 inline bool operator!=(const Rational& rhs) const {
248 return ( rhs.Numerator != Numerator || rhs.Denominator != Denominator );
252 // common edit rates, use these instead of hard coded constants
253 const Rational EditRate_24(24,1);
254 const Rational EditRate_23_98(24000,1001); // Not a DCI-compliant value!
255 const Rational EditRate_48(48,1);
256 const Rational SampleRate_48k(48000,1);
257 const Rational SampleRate_96k(96000,1);
259 // Non-reference counting container for internal member objects.
260 // Please do not use this class for any other purpose.
264 T* m_p; // the thing we point to
268 mem_ptr() : m_p(0) {}
269 mem_ptr(T* p) : m_p(p) {}
270 ~mem_ptr() { delete m_p; }
272 inline T& operator*() const { return *m_p; }
273 inline T* operator->() const { return m_p; }
274 inline operator T*()const { return m_p; }
275 inline const mem_ptr<T>& operator=(T* p) { set(p); return *this; }
276 inline T* set(T* p) { delete m_p; m_p = p; return m_p; }
277 inline T* get() const { return m_p; }
278 inline void release() { m_p = 0; }
279 inline bool empty() const { return m_p == 0; }
283 //---------------------------------------------------------------------------------
284 // WriterInfo class - encapsulates writer identification details used for
285 // OpenWrite() calls. Replace these values at runtime to identify your product.
287 // MXF files use SMPTE Universal Labels to identify data items. The set of Labels
288 // in a file is determined by the MXF Operational Pattern and any constraining
289 // documentation. There are currently two flavors of AS-DCP file in use: MXF Interop
290 // and SMPTE. The two differ only in the values of two labels:
292 // OP Atom / Interop : 06 0e 2b 34 04 01 01 01 0d 01 02 01 10 00 00 00
293 // OP Atom / SMPTE : 06 0e 2b 34 04 01 01 02 0d 01 02 01 10 00 00 00
295 // EKLV Packet / Interop : 06 0e 2b 34 02 04 01 07 0d 01 03 01 02 7e 01 00
296 // EKLV Packet / SMPTE : 06 0e 2b 34 02 04 01 01 0d 01 03 01 02 7e 01 00
298 // asdcplib will read any (otherwise valid) file which has any combination of the
299 // above values. When writing files, MXF Interop labels are used by default. To
300 // write a file containing SMPTE labels, replace the default label set value in
301 // the WriterInfo before calling OpenWrite()
313 byte_t ProductUUID[UUIDlen];
314 byte_t AssetUUID[UUIDlen];
315 byte_t ContextID[UUIDlen];
316 byte_t CryptographicKeyID[UUIDlen];
317 bool EncryptedEssence; // true if essence data is (or is going to be) encrypted
318 bool UsesHMAC; // true if HMAC exists or is to be calculated
319 std::string ProductVersion;
320 std::string CompanyName;
321 std::string ProductName;
322 LabelSet_t LabelSetType;
324 WriterInfo() : EncryptedEssence(false), UsesHMAC(false), LabelSetType(LS_MXF_INTEROP)
326 static byte_t default_ProductUUID_Data[UUIDlen] = {
327 0x43, 0x05, 0x9a, 0x1d, 0x04, 0x32, 0x41, 0x01,
328 0xb8, 0x3f, 0x73, 0x68, 0x15, 0xac, 0xf3, 0x1d };
330 memcpy(ProductUUID, default_ProductUUID_Data, UUIDlen);
331 memset(AssetUUID, 0, UUIDlen);
332 memset(ContextID, 0, UUIDlen);
333 memset(CryptographicKeyID, 0, UUIDlen);
335 ProductVersion = "Unreleased ";
336 ProductVersion += Version();
338 ProductName = "asdcplib";
342 // Print WriterInfo to std::ostream
343 std::ostream& operator << (std::ostream& strm, const WriterInfo& winfo);
344 // Print WriterInfo to stream, stderr by default.
345 void WriterInfoDump(const WriterInfo&, FILE* = 0);
347 //---------------------------------------------------------------------------------
348 // cryptographic support
350 // The following classes define interfaces to Rijndael contexts having the following properties:
352 // o CBC mode with 16 byte block size
353 const ui32_t CBC_KEY_SIZE = 16;
354 const ui32_t CBC_BLOCK_SIZE = 16;
355 const ui32_t HMAC_SIZE = 20;
361 mem_ptr<h__AESContext> m_Context;
362 ASDCP_NO_COPY_CONSTRUCT(AESEncContext);
368 // Initializes Rijndael CBC encryption context.
369 // Returns error if the key argument is NULL.
370 Result_t InitKey(const byte_t* key);
372 // Initializes 16 byte CBC Initialization Vector. This operation may be performed
373 // any number of times for a given key.
374 // Returns error if the i_vec argument is NULL.
375 Result_t SetIVec(const byte_t* i_vec);
376 Result_t GetIVec(byte_t* i_vec) const;
378 // Encrypt a block of data. The block size must be a multiple of CBC_BLOCK_SIZE.
379 // Returns error if either argument is NULL.
380 Result_t EncryptBlock(const byte_t* pt_buf, byte_t* ct_buf, ui32_t block_size);
387 mem_ptr<h__AESContext> m_Context;
388 ASDCP_NO_COPY_CONSTRUCT(AESDecContext);
394 // Initializes Rijndael CBC decryption context.
395 // Returns error if the key argument is NULL.
396 Result_t InitKey(const byte_t* key);
398 // Initializes 16 byte CBC Initialization Vector. This operation may be performed
399 // any number of times for a given key.
400 // Returns error if the i_vec argument is NULL.
401 Result_t SetIVec(const byte_t* i_vec);
403 // Decrypt a block of data. The block size must be a multiple of CBC_BLOCK_SIZE.
404 // Returns error if either argument is NULL.
405 Result_t DecryptBlock(const byte_t* ct_buf, byte_t* pt_buf, ui32_t block_size);
411 class h__HMACContext;
412 mem_ptr<h__HMACContext> m_Context;
413 ASDCP_NO_COPY_CONSTRUCT(HMACContext);
419 // Initializes HMAC context. The key argument must point to a binary
420 // key that is CBC_KEY_SIZE bytes in length. Returns error if the key
422 Result_t InitKey(const byte_t* key, LabelSet_t);
424 // Reset internal state, allows repeated cycles of Update -> Finalize
427 // Add data to the digest. Returns error if the key argument is NULL or
428 // if the digest has been finalized.
429 Result_t Update(const byte_t* buf, ui32_t buf_len);
431 // Finalize digest. Returns error if the digest has already been finalized.
434 // Writes HMAC value to given buffer. buf must point to a writable area of
435 // memory that is at least HMAC_SIZE bytes in length. Returns error if the
436 // buf argument is NULL or if the digest has not been finalized.
437 Result_t GetHMACValue(byte_t* buf) const;
439 // Tests the given value against the finalized value in the object. buf must
440 // point to a readable area of memory that is at least HMAC_SIZE bytes in length.
441 // Returns error if the buf argument is NULL or if the values do ot match.
442 Result_t TestHMACValue(const byte_t* buf) const;
445 //---------------------------------------------------------------------------------
446 // frame buffer base class
448 // The supported essence types are stored using per-frame KLV packetization. The
449 // following class implements essence-neutral functionality for managing a buffer
450 // containing a frame of essence.
454 ASDCP_NO_COPY_CONSTRUCT(FrameBuffer);
457 byte_t* m_Data; // pointer to memory area containing frame data
458 ui32_t m_Capacity; // size of memory area pointed to by m_Data
459 bool m_OwnMem; // if false, m_Data points to externally allocated memory
460 ui32_t m_Size; // size of frame data in memory area pointed to by m_Data
461 ui32_t m_FrameNumber; // delivery-order frame number
463 // It is possible to read raw ciphertext from an encrypted AS-DCP file.
464 // After reading an encrypted AS-DCP file in raw mode, the frame buffer will
465 // contain the encrypted source value portion of the Encrypted Triplet, followed
466 // by the integrity pack, if it exists.
467 // The buffer will begin with the IV and CheckValue, followed by encrypted essence
468 // and optional integrity pack
469 // The SourceLength and PlaintextOffset values from the packet will be held in the
470 // following variables:
471 ui32_t m_SourceLength; // plaintext length (delivered plaintext+decrypted ciphertext)
472 ui32_t m_PlaintextOffset; // offset to first byte of ciphertext
476 virtual ~FrameBuffer();
478 // Instructs the object to use an externally allocated buffer. The external
479 // buffer will not be cleaned up by the frame buffer when it exits.
480 // Call with (0,0) to revert to internally allocated buffer.
481 // Returns error if the buf_addr argument is NULL and buf_size is non-zero.
482 Result_t SetData(byte_t* buf_addr, ui32_t buf_size);
484 // Sets the size of the internally allocate buffer. Returns RESULT_CAPEXTMEM
485 // if the object is using an externally allocated buffer via SetData();
486 // Resets content size to zero.
487 Result_t Capacity(ui32_t cap);
489 // returns the size of the buffer
490 inline ui32_t Capacity() const { return m_Capacity; }
492 // returns a const pointer to the essence data
493 inline const byte_t* RoData() const { return m_Data; }
495 // returns a non-const pointer to the essence data
496 inline byte_t* Data() { return m_Data; }
498 // set the size of the buffer's contents
499 inline ui32_t Size(ui32_t size) { return m_Size = size; }
501 // returns the size of the buffer's contents
502 inline ui32_t Size() const { return m_Size; }
504 // Sets the absolute frame number of this frame in the file in delivery order.
505 inline void FrameNumber(ui32_t num) { m_FrameNumber = num; }
507 // Returns the absolute frame number of this frame in the file in delivery order.
508 inline ui32_t FrameNumber() const { return m_FrameNumber; }
510 // Sets the length of the plaintext essence data
511 inline void SourceLength(ui32_t len) { m_SourceLength = len; }
513 // When this value is 0 (zero), the buffer contains only plaintext. When it is
514 // non-zero, the buffer contains raw ciphertext and the return value is the length
515 // of the original plaintext.
516 inline ui32_t SourceLength() const { return m_SourceLength; }
518 // Sets the offset into the buffer at which encrypted data begins
519 inline void PlaintextOffset(ui32_t ofst) { m_PlaintextOffset = ofst; }
521 // Returns offset into buffer of first byte of ciphertext.
522 inline ui32_t PlaintextOffset() const { return m_PlaintextOffset; }
526 //---------------------------------------------------------------------------------
527 // MPEG2 video elementary stream support
532 // MPEG picture coding type
534 FRAME_U = 0x00, // Unknown
535 FRAME_I = 0x01, // I-Frame
536 FRAME_P = 0x02, // P-Frame
537 FRAME_B = 0x03 // B-Frame
540 // convert FrameType_t to char
541 inline char FrameTypeChar(FrameType_t type)
545 case FRAME_I: return 'I';
546 case FRAME_B: return 'B';
547 case FRAME_P: return 'P';
552 // Structure represents the metadata elements in the file header's
553 // MPEG2VideoDescriptor object.
554 struct VideoDescriptor
556 Rational EditRate; //
558 Rational SampleRate; //
559 ui8_t FrameLayout; //
560 ui32_t StoredWidth; //
561 ui32_t StoredHeight; //
562 Rational AspectRatio; //
563 ui32_t ComponentDepth; //
564 ui32_t HorizontalSubsampling; //
565 ui32_t VerticalSubsampling; //
566 ui8_t ColorSiting; //
567 ui8_t CodedContentType; //
570 ui8_t ProfileAndLevel; //
571 ui32_t ContainerDuration; //
574 // Print VideoDescriptor to std::ostream
575 std::ostream& operator << (std::ostream& strm, const VideoDescriptor& vdesc);
576 // Print VideoDescriptor to stream, stderr by default.
577 void VideoDescriptorDump(const VideoDescriptor&, FILE* = 0);
579 // A container for MPEG frame data.
580 class FrameBuffer : public ASDCP::FrameBuffer
582 ASDCP_NO_COPY_CONSTRUCT(FrameBuffer); // TODO: should have copy construct
585 FrameType_t m_FrameType;
586 ui8_t m_TemporalOffset;
592 m_FrameType(FRAME_U), m_TemporalOffset(0),
593 m_ClosedGOP(false), m_GOPStart(false) {}
595 FrameBuffer(ui32_t size) :
596 m_FrameType(FRAME_U), m_TemporalOffset(0),
597 m_ClosedGOP(false), m_GOPStart(false)
602 virtual ~FrameBuffer() {}
604 // Sets the MPEG frame type of the picture data in the frame buffer.
605 inline void FrameType(FrameType_t type) { m_FrameType = type; }
607 // Returns the MPEG frame type of the picture data in the frame buffer.
608 inline FrameType_t FrameType() const { return m_FrameType; }
610 // Sets the MPEG temporal offset of the picture data in the frame buffer.
611 inline void TemporalOffset(ui8_t offset) { m_TemporalOffset = offset; }
613 // Returns the MPEG temporal offset of the picture data in the frame buffer.
614 inline ui8_t TemporalOffset() const { return m_TemporalOffset; }
616 // Sets the MPEG GOP 'start' attribute for the frame buffer.
617 inline void GOPStart(bool start) { m_GOPStart = start; }
619 // True if the frame in the buffer is the first in the GOP (in transport order)
620 inline bool GOPStart() const { return m_GOPStart; }
622 // Sets the MPEG GOP 'closed' attribute for the frame buffer.
623 inline void ClosedGOP(bool closed) { m_ClosedGOP = closed; }
625 // Returns true if the frame in the buffer is from a closed GOP, false if
626 // the frame is from an open GOP. Always returns false unless GOPStart()
628 inline bool ClosedGOP() const { return m_ClosedGOP; }
630 // Print object state to stream, include n bytes of frame data if indicated.
631 // Default stream is stderr.
632 void Dump(FILE* = 0, ui32_t dump_len = 0) const;
636 // An object which opens and reads an MPEG2 Video Elementary Stream file. The call to
637 // OpenRead() reads metadata from the file and populates an internal VideoDescriptor object.
638 // Each subsequent call to ReadFrame() reads exactly one frame from the stream into the
639 // given FrameBuffer object.
643 mem_ptr<h__Parser> m_Parser;
644 ASDCP_NO_COPY_CONSTRUCT(Parser);
650 // Opens the stream for reading, parses enough data to provide a complete
651 // set of stream metadata for the MXFWriter below.
652 Result_t OpenRead(const char* filename) const;
654 // Fill a VideoDescriptor struct with the values from the file's header.
655 // Returns RESULT_INIT if the file is not open.
656 Result_t FillVideoDescriptor(VideoDescriptor&) const;
658 // Rewind the stream to the beginning.
659 Result_t Reset() const;
661 // Reads the next sequential frame in the input file and places it in the
662 // frame buffer. Fails if the buffer is too small or the stream is empty.
663 // The frame buffer's PlaintextOffset parameter will be set to the first
664 // data byte of the first slice. Set this value to zero if you want
665 // encrypted headers.
666 Result_t ReadFrame(FrameBuffer&) const;
669 // A class which creates and writes MPEG frame data to an AS-DCP format MXF file.
670 // Not yet implemented
674 mem_ptr<h__Writer> m_Writer;
675 ASDCP_NO_COPY_CONSTRUCT(MXFWriter);
679 virtual ~MXFWriter();
681 // Open the file for writing. The file must not exist. Returns error if
682 // the operation cannot be completed or if nonsensical data is discovered
683 // in the essence descriptor.
684 Result_t OpenWrite(const char* filename, const WriterInfo&,
685 const VideoDescriptor&, ui32_t HeaderSize = 16384);
687 // Writes a frame of essence to the MXF file. If the optional AESEncContext
688 // argument is present, the essence is encrypted prior to writing.
689 // Fails if the file is not open, is finalized, or an operating system
691 Result_t WriteFrame(const FrameBuffer&, AESEncContext* = 0, HMACContext* = 0);
693 // Closes the MXF file, writing the index and revised header.
697 // A class which reads MPEG frame data from an AS-DCP format MXF file.
701 mem_ptr<h__Reader> m_Reader;
702 ASDCP_NO_COPY_CONSTRUCT(MXFReader);
706 virtual ~MXFReader();
708 // Open the file for reading. The file must exist. Returns error if the
709 // operation cannot be completed.
710 Result_t OpenRead(const char* filename) const;
712 // Returns RESULT_INIT if the file is not open.
713 Result_t Close() const;
715 // Fill a VideoDescriptor struct with the values from the file's header.
716 // Returns RESULT_INIT if the file is not open.
717 Result_t FillVideoDescriptor(VideoDescriptor&) const;
719 // Fill a WriterInfo struct with the values from the file's header.
720 // Returns RESULT_INIT if the file is not open.
721 Result_t FillWriterInfo(WriterInfo&) const;
723 // Reads a frame of essence from the MXF file. If the optional AESEncContext
724 // argument is present, the essence is decrypted after reading. If the MXF
725 // file is encrypted and the AESDecContext argument is NULL, the frame buffer
726 // will contain the ciphertext frame data. If the HMACContext argument is
727 // not NULL, the HMAC will be calculated (if the file supports it).
728 // Returns RESULT_INIT if the file is not open, failure if the frame number is
729 // out of range, or if optional decrypt or HAMC operations fail.
730 Result_t ReadFrame(ui32_t frame_number, FrameBuffer&, AESDecContext* = 0, HMACContext* = 0) const;
732 // Calculates the first frame in transport order of the GOP in which the requested
733 // frame is located. Calls ReadFrame() to fetch the frame at the calculated position.
734 // Returns RESULT_INIT if the file is not open.
735 Result_t ReadFrameGOPStart(ui32_t frame_number, FrameBuffer&, AESDecContext* = 0, HMACContext* = 0) const;
737 // Calculates the first frame in transport order of the GOP in which the requested
738 // frame is located. Sets key_frame_number to the number of the frame at the calculated position.
739 // Returns RESULT_INIT if the file is not open.
740 Result_t FindFrameGOPStart(ui32_t frame_number, ui32_t& key_frame_number) const;
742 // Returns the type of the frame at the given position.
743 // Returns RESULT_INIT if the file is not open or RESULT_RANGE if the index is out of range.
744 Result_t FrameType(ui32_t frame_number, FrameType_t&) const;
746 // Print debugging information to stream
747 void DumpHeaderMetadata(FILE* = 0) const;
748 void DumpIndex(FILE* = 0) const;
755 struct AudioDescriptor
757 Rational SampleRate; // rate of frame wrapping
758 Rational AudioSamplingRate; // rate of audio sample
760 ui32_t ChannelCount; // number of channels
761 ui32_t QuantizationBits; // number of bits per single-channel sample
762 ui32_t BlockAlign; // number of bytes ber sample, all channels
764 ui32_t LinkedTrackID; //
765 ui32_t ContainerDuration; // number of frames
768 // Print AudioDescriptor to std::ostream
769 std::ostream& operator << (std::ostream& strm, const AudioDescriptor& adesc);
770 // Print debugging information to stream (stderr default)
771 void AudioDescriptorDump(const AudioDescriptor&, FILE* = 0);
773 // Returns size in bytes of a single sample of data described by ADesc
774 inline ui32_t CalcSampleSize(const AudioDescriptor& ADesc)
776 return (ADesc.QuantizationBits / 8) * ADesc.ChannelCount;
779 // Returns number of samples per frame of data described by ADesc
780 inline ui32_t CalcSamplesPerFrame(const AudioDescriptor& ADesc)
782 double tmpd = ADesc.AudioSamplingRate.Quotient() / ADesc.SampleRate.Quotient();
783 return (ui32_t)ceil(tmpd);
786 // Returns the size in bytes of a frame of data described by ADesc
787 inline ui32_t CalcFrameBufferSize(const AudioDescriptor& ADesc)
789 return CalcSampleSize(ADesc) * CalcSamplesPerFrame(ADesc);
793 class FrameBuffer : public ASDCP::FrameBuffer
797 FrameBuffer(ui32_t size) { Capacity(size); }
798 virtual ~FrameBuffer() {}
800 // Print debugging information to stream (stderr default)
801 void Dump(FILE* = 0, ui32_t dump_bytes = 0) const;
804 // An object which opens and reads a WAV file. The call to OpenRead() reads metadata from
805 // the file and populates an internal AudioDescriptor object. Each subsequent call to
806 // ReadFrame() reads exactly one frame from the stream into the given FrameBuffer object.
807 // A "frame" is either 2000 or 2002 samples, depending upon the value of PictureRate.
811 mem_ptr<h__WAVParser> m_Parser;
812 ASDCP_NO_COPY_CONSTRUCT(WAVParser);
816 virtual ~WAVParser();
818 // Opens the stream for reading, parses enough data to provide a complete
819 // set of stream metadata for the MXFWriter below. PictureRate controls
820 // ther frame rate for the MXF frame wrapping option.
821 Result_t OpenRead(const char* filename, const Rational& PictureRate) const;
823 // Fill an AudioDescriptor struct with the values from the file's header.
824 // Returns RESULT_INIT if the file is not open.
825 Result_t FillAudioDescriptor(AudioDescriptor&) const;
827 // Rewind the stream to the beginning.
828 Result_t Reset() const;
830 // Reads the next sequential frame in the input file and places it in the
831 // frame buffer. Fails if the buffer is too small or the stream is empty.
832 Result_t ReadFrame(FrameBuffer&) const;
840 mem_ptr<h__Writer> m_Writer;
841 ASDCP_NO_COPY_CONSTRUCT(MXFWriter);
845 virtual ~MXFWriter();
847 // Open the file for writing. The file must not exist. Returns error if
848 // the operation cannot be completed or if nonsensical data is discovered
849 // in the essence descriptor.
850 Result_t OpenWrite(const char* filename, const WriterInfo&,
851 const AudioDescriptor&, ui32_t HeaderSize = 16384);
853 // Writes a frame of essence to the MXF file. If the optional AESEncContext
854 // argument is present, the essence is encrypted prior to writing.
855 // Fails if the file is not open, is finalized, or an operating system
857 Result_t WriteFrame(const FrameBuffer&, AESEncContext* = 0, HMACContext* = 0);
859 // Closes the MXF file, writing the index and revised header.
867 mem_ptr<h__Reader> m_Reader;
868 ASDCP_NO_COPY_CONSTRUCT(MXFReader);
872 virtual ~MXFReader();
874 // Open the file for reading. The file must exist. Returns error if the
875 // operation cannot be completed.
876 Result_t OpenRead(const char* filename) const;
878 // Returns RESULT_INIT if the file is not open.
879 Result_t Close() const;
881 // Fill an AudioDescriptor struct with the values from the file's header.
882 // Returns RESULT_INIT if the file is not open.
883 Result_t FillAudioDescriptor(AudioDescriptor&) const;
885 // Fill a WriterInfo struct with the values from the file's header.
886 // Returns RESULT_INIT if the file is not open.
887 Result_t FillWriterInfo(WriterInfo&) const;
889 // Reads a frame of essence from the MXF file. If the optional AESEncContext
890 // argument is present, the essence is decrypted after reading. If the MXF
891 // file is encrypted and the AESDecContext argument is NULL, the frame buffer
892 // will contain the ciphertext frame data. If the HMACContext argument is
893 // not NULL, the HMAC will be calculated (if the file supports it).
894 // Returns RESULT_INIT if the file is not open, failure if the frame number is
895 // out of range, or if optional decrypt or HAMC operations fail.
896 Result_t ReadFrame(ui32_t frame_number, FrameBuffer&, AESDecContext* = 0, HMACContext* = 0) const;
898 // Print debugging information to stream
899 void DumpHeaderMetadata(FILE* = 0) const;
900 void DumpIndex(FILE* = 0) const;
907 const ui32_t MaxComponents = 3;
908 const ui32_t MaxPrecincts = 32; // ISO 15444-1 Annex A.6.1
909 const ui32_t MaxDefaults = 256; // made up
912 struct ImageComponent_t // ISO 15444-1 Annex A.5.1
919 struct CodingStyleDefault_t // ISO 15444-1 Annex A.6.1
925 ui8_t ProgressionOrder;
926 ui8_t NumberOfLayers[sizeof(ui16_t)];
927 ui8_t MultiCompTransform;
932 ui8_t DecompositionLevels;
933 ui8_t CodeblockWidth;
934 ui8_t CodeblockHeight;
935 ui8_t CodeblockStyle;
936 ui8_t Transformation;
937 ui8_t PrecinctSize[MaxPrecincts];
941 struct QuantizationDefault_t // ISO 15444-1 Annex A.6.4
944 ui8_t SPqcd[MaxDefaults];
949 struct PictureDescriptor
952 ui32_t ContainerDuration;
956 Rational AspectRatio;
967 ImageComponent_t ImageComponents[MaxComponents];
968 CodingStyleDefault_t CodingStyleDefault;
969 QuantizationDefault_t QuantizationDefault;
972 // Print debugging information to std::ostream
973 std::ostream& operator << (std::ostream& strm, const PictureDescriptor& pdesc);
974 // Print debugging information to stream (stderr default)
975 void PictureDescriptorDump(const PictureDescriptor&, FILE* = 0);
978 class FrameBuffer : public ASDCP::FrameBuffer
982 FrameBuffer(ui32_t size) { Capacity(size); }
983 virtual ~FrameBuffer() {}
985 // Print debugging information to stream (stderr default)
986 void Dump(FILE* = 0, ui32_t dump_bytes = 0) const;
990 // An object which opens and reads a JPEG 2000 codestream file. The file is expected
991 // to contain exactly one complete frame of picture essence as an unwrapped (raw)
992 // ISO/IEC 15444 codestream.
993 class CodestreamParser
995 class h__CodestreamParser;
996 mem_ptr<h__CodestreamParser> m_Parser;
997 ASDCP_NO_COPY_CONSTRUCT(CodestreamParser);
1001 virtual ~CodestreamParser();
1003 // Opens a file for reading, parses enough data to provide a complete
1004 // set of stream metadata for the MXFWriter below.
1005 // The frame buffer's PlaintextOffset parameter will be set to the first
1006 // byte of the data segment. Set this value to zero if you want
1007 // encrypted headers.
1008 Result_t OpenReadFrame(const char* filename, FrameBuffer&) const;
1010 // Fill a PictureDescriptor struct with the values from the file's codestream.
1011 // Returns RESULT_INIT if the file is not open.
1012 Result_t FillPictureDescriptor(PictureDescriptor&) const;
1015 // Parses the data in the frame buffer to fill in the picture descriptor. Copies
1016 // the offset of the image data into start_of_data. Returns error if the parser fails.
1017 Result_t ParseMetadataIntoDesc(const FrameBuffer&, PictureDescriptor&, byte_t* start_of_data = 0);
1019 // An object which reads a sequence of files containing JPEG 2000 pictures.
1020 class SequenceParser
1022 class h__SequenceParser;
1023 mem_ptr<h__SequenceParser> m_Parser;
1024 ASDCP_NO_COPY_CONSTRUCT(SequenceParser);
1028 virtual ~SequenceParser();
1030 // Opens a directory for reading. The directory is expected to contain one or
1031 // more files, each containing the codestream for exactly one picture. The
1032 // files must be named such that the frames are in temporal order when sorted
1033 // alphabetically by filename. The parser will automatically parse enough data
1034 // from the first file to provide a complete set of stream metadata for the
1035 // MXFWriter below. If the "pedantic" parameter is given and is true, the
1036 // parser will check the metadata for each codestream and fail if a
1037 // mismatch is detected.
1038 Result_t OpenRead(const char* filename, bool pedantic = false) const;
1040 // Fill a PictureDescriptor struct with the values from the first file's codestream.
1041 // Returns RESULT_INIT if the directory is not open.
1042 Result_t FillPictureDescriptor(PictureDescriptor&) const;
1044 // Rewind the directory to the beginning.
1045 Result_t Reset() const;
1047 // Reads the next sequential frame in the directory and places it in the
1048 // frame buffer. Fails if the buffer is too small or the direcdtory
1049 // contains no more files.
1050 // The frame buffer's PlaintextOffset parameter will be set to the first
1051 // byte of the data segment. Set this value to zero if you want
1052 // encrypted headers.
1053 Result_t ReadFrame(FrameBuffer&) const;
1061 mem_ptr<h__Writer> m_Writer;
1062 ASDCP_NO_COPY_CONSTRUCT(MXFWriter);
1066 virtual ~MXFWriter();
1068 // Open the file for writing. The file must not exist. Returns error if
1069 // the operation cannot be completed or if nonsensical data is discovered
1070 // in the essence descriptor.
1071 Result_t OpenWrite(const char* filename, const WriterInfo&,
1072 const PictureDescriptor&, ui32_t HeaderSize = 16384);
1074 // Writes a frame of essence to the MXF file. If the optional AESEncContext
1075 // argument is present, the essence is encrypted prior to writing.
1076 // Fails if the file is not open, is finalized, or an operating system
1078 Result_t WriteFrame(const FrameBuffer&, AESEncContext* = 0, HMACContext* = 0);
1080 // Closes the MXF file, writing the index and revised header.
1081 Result_t Finalize();
1088 mem_ptr<h__Reader> m_Reader;
1089 ASDCP_NO_COPY_CONSTRUCT(MXFReader);
1093 virtual ~MXFReader();
1095 // Open the file for reading. The file must exist. Returns error if the
1096 // operation cannot be completed.
1097 Result_t OpenRead(const char* filename) const;
1099 // Returns RESULT_INIT if the file is not open.
1100 Result_t Close() const;
1102 // Fill an AudioDescriptor struct with the values from the file's header.
1103 // Returns RESULT_INIT if the file is not open.
1104 Result_t FillPictureDescriptor(PictureDescriptor&) const;
1106 // Fill a WriterInfo struct with the values from the file's header.
1107 // Returns RESULT_INIT if the file is not open.
1108 Result_t FillWriterInfo(WriterInfo&) const;
1110 // Reads a frame of essence from the MXF file. If the optional AESEncContext
1111 // argument is present, the essence is decrypted after reading. If the MXF
1112 // file is encrypted and the AESDecContext argument is NULL, the frame buffer
1113 // will contain the ciphertext frame data. If the HMACContext argument is
1114 // not NULL, the HMAC will be calculated (if the file supports it).
1115 // Returns RESULT_INIT if the file is not open, failure if the frame number is
1116 // out of range, or if optional decrypt or HAMC operations fail.
1117 Result_t ReadFrame(ui32_t frame_number, FrameBuffer&, AESDecContext* = 0, HMACContext* = 0) const;
1119 // Print debugging information to stream
1120 void DumpHeaderMetadata(FILE* = 0) const;
1121 void DumpIndex(FILE* = 0) const;
1125 // Stereoscopic Image support
1128 enum StereoscopicPhase_t
1136 JP2K::FrameBuffer Left;
1137 JP2K::FrameBuffer Right;
1139 SFrameBuffer(ui32_t size) {
1140 Left.Capacity(size);
1141 Right.Capacity(size);
1148 mem_ptr<h__SWriter> m_Writer;
1149 ASDCP_NO_COPY_CONSTRUCT(MXFSWriter);
1153 virtual ~MXFSWriter();
1155 // Open the file for writing. The file must not exist. Returns error if
1156 // the operation cannot be completed or if nonsensical data is discovered
1157 // in the essence descriptor.
1158 Result_t OpenWrite(const char* filename, const WriterInfo&,
1159 const PictureDescriptor&, ui32_t HeaderSize = 16384);
1161 // Writes a pair of frames of essence to the MXF file. If the optional AESEncContext
1162 // argument is present, the essence is encrypted prior to writing.
1163 // Fails if the file is not open, is finalized, or an operating system
1165 Result_t WriteFrame(const SFrameBuffer&, AESEncContext* = 0, HMACContext* = 0);
1167 // Writes a frame of essence to the MXF file. If the optional AESEncContext
1168 // argument is present, the essence is encrypted prior to writing.
1169 // Fails if the file is not open, is finalized, or an operating system
1170 // error occurs. Frames must be written in the proper phase (L-R-L-R),
1171 // RESULT_SPHASE will be returned if phase is reversed. The first frame
1172 // written must be left eye.
1173 Result_t WriteFrame(const FrameBuffer&, StereoscopicPhase_t phase,
1174 AESEncContext* = 0, HMACContext* = 0);
1176 // Closes the MXF file, writing the index and revised header. Returns
1177 // RESULT_SPHASE if WriteFrame was called an odd number of times.
1178 Result_t Finalize();
1185 mem_ptr<h__SReader> m_Reader;
1186 ASDCP_NO_COPY_CONSTRUCT(MXFSReader);
1190 virtual ~MXFSReader();
1192 // Open the file for reading. The file must exist. Returns error if the
1193 // operation cannot be completed.
1194 Result_t OpenRead(const char* filename) const;
1196 // Returns RESULT_INIT if the file is not open.
1197 Result_t Close() const;
1199 // Fill an AudioDescriptor struct with the values from the file's header.
1200 // Returns RESULT_INIT if the file is not open.
1201 Result_t FillPictureDescriptor(PictureDescriptor&) const;
1203 // Fill a WriterInfo struct with the values from the file's header.
1204 // Returns RESULT_INIT if the file is not open.
1205 Result_t FillWriterInfo(WriterInfo&) const;
1207 // Reads a pair of frames of essence from the MXF file. If the optional AESEncContext
1208 // argument is present, the essence is decrypted after reading. If the MXF
1209 // file is encrypted and the AESDecContext argument is NULL, the frame buffer
1210 // will contain the ciphertext frame data. If the HMACContext argument is
1211 // not NULL, the HMAC will be calculated (if the file supports it).
1212 // Returns RESULT_INIT if the file is not open, failure if the frame number is
1213 // out of range, or if optional decrypt or HAMC operations fail.
1214 Result_t ReadFrame(ui32_t frame_number, SFrameBuffer&, AESDecContext* = 0, HMACContext* = 0) const;
1216 // Reads a frame of essence from the MXF file. If the optional AESEncContext
1217 // argument is present, the essence is decrypted after reading. If the MXF
1218 // file is encrypted and the AESDecContext argument is NULL, the frame buffer
1219 // will contain the ciphertext frame data. If the HMACContext argument is
1220 // not NULL, the HMAC will be calculated (if the file supports it).
1221 // Returns RESULT_INIT if the file is not open, failure if the frame number is
1222 // out of range, or if optional decrypt or HAMC operations fail.
1223 Result_t ReadFrame(ui32_t frame_number, StereoscopicPhase_t phase,
1224 FrameBuffer&, AESDecContext* = 0, HMACContext* = 0) const;
1226 // Print debugging information to stream
1227 void DumpHeaderMetadata(FILE* = 0) const;
1228 void DumpIndex(FILE* = 0) const;
1235 enum MIMEType_t { MT_BIN, MT_PNG, MT_OPENTYPE };
1237 struct TimedTextResourceDescriptor
1239 byte_t ResourceID[UUIDlen];
1242 TimedTextResourceDescriptor() : Type(MT_BIN) {}
1245 typedef std::list<TimedTextResourceDescriptor> ResourceList_t;
1247 struct TimedTextDescriptor
1249 Rational EditRate; //
1250 ui32_t ContainerDuration;
1251 byte_t AssetID[UUIDlen];
1252 std::string NamespaceName;
1253 std::string EncodingName;
1254 ResourceList_t ResourceList;
1256 TimedTextDescriptor() : ContainerDuration(0), EncodingName("UTF-8") {} // D-Cinema format is always UTF-8
1259 // Print debugging information to std::ostream
1260 std::ostream& operator << (std::ostream& strm, const TimedTextDescriptor& tinfo);
1261 // Print debugging information to stream (stderr default)
1262 void DescriptorDump(const TimedTextDescriptor&, FILE* = 0);
1265 class FrameBuffer : public ASDCP::FrameBuffer
1267 ASDCP_NO_COPY_CONSTRUCT(FrameBuffer); // TODO: should have copy construct
1270 byte_t m_AssetID[UUIDlen];
1271 std::string m_MIMEType;
1274 FrameBuffer() { memset(m_AssetID, 0, UUIDlen); }
1275 FrameBuffer(ui32_t size) { Capacity(size); memset(m_AssetID, 0, UUIDlen); }
1276 virtual ~FrameBuffer() {}
1278 inline const byte_t* AssetID() const { return m_AssetID; }
1279 inline void AssetID(const byte_t* buf) { memcpy(m_AssetID, buf, UUIDlen); }
1280 inline const char* MIMEType() const { return m_MIMEType.c_str(); }
1281 inline void MIMEType(const std::string& s) { m_MIMEType = s; }
1283 // Print debugging information to stream (stderr default)
1284 void Dump(FILE* = 0, ui32_t dump_bytes = 0) const;
1288 class IResourceResolver
1291 virtual ~IResourceResolver() {}
1292 virtual Result_t ResolveRID(const byte_t* uuid, FrameBuffer&) const = 0; // return data for RID
1296 class DCSubtitleParser
1298 class h__SubtitleParser;
1299 mem_ptr<h__SubtitleParser> m_Parser;
1300 ASDCP_NO_COPY_CONSTRUCT(DCSubtitleParser);
1304 virtual ~DCSubtitleParser();
1306 // Opens the XML file for reading, parse data to provide a complete
1307 // set of stream metadata for the MXFWriter below.
1308 Result_t OpenRead(const char* filename) const;
1310 // Fill a TimedTextDescriptor struct with the values from the file's contents.
1311 // Returns RESULT_INIT if the file is not open.
1312 Result_t FillDescriptor(TimedTextDescriptor&) const;
1314 // Reads the complete Timed Text Resource into the given string.
1315 Result_t ReadTimedTextResource(std::string&) const;
1317 // Reads the Ancillary Resource having the given ID. Fails if the buffer
1318 // is too small or the resource does not exist. The optional Resolver
1319 // argument can be provided which will be used to retrieve the resource
1320 // having a particulat UUID. If a Resolver is not supplied, the default
1321 // internal resolver will return the contents of the file having the UUID
1322 // as the filename. The filename must exist in the same directory as the
1323 // XML file opened with OpenRead().
1324 Result_t ReadAncillaryResource(const byte_t* uuid, FrameBuffer&,
1325 const IResourceResolver* Resolver = 0) const;
1332 mem_ptr<h__Writer> m_Writer;
1333 ASDCP_NO_COPY_CONSTRUCT(MXFWriter);
1337 virtual ~MXFWriter();
1339 // Open the file for writing. The file must not exist. Returns error if
1340 // the operation cannot be completed or if nonsensical data is discovered
1341 // in the essence descriptor.
1342 Result_t OpenWrite(const char* filename, const WriterInfo&,
1343 const TimedTextDescriptor&, ui32_t HeaderSize = 16384);
1345 // Writes the Timed-Text Resource to the MXF file. The file must be UTF-8
1346 // encoded. If the optional AESEncContext argument is present, the essence
1347 // is encrypted prior to writing. Fails if the file is not open, is finalized,
1348 // or an operating system error occurs.
1349 // This method may only be called once, and it must be called before any
1350 // call to WriteAncillaryResource(). RESULT_STATE will be returned if these
1351 // conditions are not met.
1352 Result_t WriteTimedTextResource(const std::string& XMLDoc, AESEncContext* = 0, HMACContext* = 0);
1354 // Writes an Ancillary Resource to the MXF file. If the optional AESEncContext
1355 // argument is present, the essence is encrypted prior to writing.
1356 // Fails if the file is not open, is finalized, or an operating system
1357 // error occurs. RESULT_STATE will be returned if the method is called before
1358 // WriteTimedTextResource()
1359 Result_t WriteAncillaryResource(const FrameBuffer&, AESEncContext* = 0, HMACContext* = 0);
1361 // Closes the MXF file, writing the index and revised header.
1362 Result_t Finalize();
1369 mem_ptr<h__Reader> m_Reader;
1370 ASDCP_NO_COPY_CONSTRUCT(MXFReader);
1374 virtual ~MXFReader();
1376 // Open the file for reading. The file must exist. Returns error if the
1377 // operation cannot be completed.
1378 Result_t OpenRead(const char* filename) const;
1380 // Returns RESULT_INIT if the file is not open.
1381 Result_t Close() const;
1383 // Fill a TimedTextDescriptor struct with the values from the file's header.
1384 // Returns RESULT_INIT if the file is not open.
1385 Result_t FillDescriptor(TimedTextDescriptor&) const;
1387 // Fill a WriterInfo struct with the values from the file's header.
1388 // Returns RESULT_INIT if the file is not open.
1389 Result_t FillWriterInfo(WriterInfo&) const;
1391 // Reads the complete Timed Text Resource into the given string. Fails if the resource
1392 // is encrypted and AESDecContext is NULL (use the following method to retrieve the
1393 // raw ciphertet block).
1394 Result_t ReadTimedTextResource(std::string&, AESDecContext* = 0, HMACContext* = 0) const;
1396 // Reads the complete Timed Text Resource from the MXF file. If the optional AESEncContext
1397 // argument is present, the resource is decrypted after reading. If the MXF
1398 // file is encrypted and the AESDecContext argument is NULL, the frame buffer
1399 // will contain the ciphertext frame data. If the HMACContext argument is
1400 // not NULL, the HMAC will be calculated (if the file supports it).
1401 // Returns RESULT_INIT if the file is not open, failure if the frame number is
1402 // out of range, or if optional decrypt or HAMC operations fail.
1403 Result_t ReadTimedTextResource(FrameBuffer&, AESDecContext* = 0, HMACContext* = 0) const;
1405 // Reads the timed-text resource having the given UUID from the MXF file. If the
1406 // optional AESEncContext argument is present, the resource is decrypted after
1407 // reading. If the MXF file is encrypted and the AESDecContext argument is NULL,
1408 // the frame buffer will contain the ciphertext frame data. If the HMACContext
1409 // argument is not NULL, the HMAC will be calculated (if the file supports it).
1410 // Returns RESULT_INIT if the file is not open, failure if the frame number is
1411 // out of range, or if optional decrypt or HAMC operations fail.
1412 Result_t ReadAncillaryResource(const byte_t* uuid, FrameBuffer&, AESDecContext* = 0, HMACContext* = 0) const;
1414 // Print debugging information to stream
1415 void DumpHeaderMetadata(FILE* = 0) const;
1416 void DumpIndex(FILE* = 0) const;
1418 } // namespace TimedText
1421 } // namespace ASDCP
1424 #endif // _AS_DCP_H_