4 The asdcplib library is a set of objects that offer
5 simplified access to files conforming to the sound and
6 picture track file formats developed by the SMPTE Working
9 This work was originally funded by Digital Cinema
10 Initiatives, LLC (DCI). Subsequent efforts have been funded
11 by Deluxe Laboratories, Doremi Labs, CineCert LLC, Avica
12 Technology and others.
14 **The asdcplib project was originally housed on SourceForge.
15 The project has moved to http://www.cinecert.com/asdcplib/
17 The project formerly depended upon the mxflib project. Because
18 of its focus on covering the whole of the MXF specifications,
19 mxflib is considerably larger and more complex that what I
20 require for this application. For this reason I have created
21 a dedicated MXF implementation that is now part of this
22 library. Special thanks to Matt Beard and Oliver Morgan for
23 their great work and support.
25 Thanks also to the members of the SMPTE DC28.20 packaging
26 ad-hoc group and the members of the MXF Interop Initiative
27 for their encouragement and support. Special thanks to
28 Jim Whittlesey and Howard Lukk at DCI for proposing and
29 supporting this project.
34 This library is intended (but of course not limited) for
35 use by developers of commercial D-Cinema products. It is
36 designed to be easily integrated into a wide variety of
37 development environments. Commercial users are strongly
38 urged to use static linking (at least where you use this
39 library) to prevent malicious in-field replacement of
40 critical system modules. This recommendation should be
41 considered wherever Open Source or Free software is being
42 used in conjunction with critical security parameters, such
43 as cryptographic keys.
45 The author strives mightily to provide an API that is completely
46 independent of operating system and other library dependencies,
47 and which allows selective replacement of some modules for
48 local needs. Specifically, the essence parsers and OpenSSL
49 crypto functions can be replaced by linking to alternative
50 implementations of the ASDCP:: objects which provide those
53 AS_DCP.h contains the entire API. You do not need to read
54 any of the other files, except maybe asdcp-test.cpp which
55 contains detailed usage examples of each of the API's
56 services. The KM_* files may be of interest for general
57 development support, but may be ignored if all you want
58 is simple AS-DCP support.
63 GNU make is required to build asdcplib. The makefile will work
64 on win32 systems that have Cygwin and MSVC. Other win32 gmake
65 packages may or may not work depending upon the availability
66 of standard POSIX shell commands. You will need gcc to rebuild
69 OpenSSL is also required. See http://www.openssl.org/
71 If you are building on win32 or a unix with no OpenSSL library
72 support, you will have to also obtain and build OpenSSL. Unpack
73 it into the same parent directory as asdcplib/, and rename (or make
74 a symlink to) the directory as 'openssl':
78 drwxr-xr-x 1 jhurst None 0 Feb 3 16:37 asdcplib
79 drwxr-xr-x 56 jhurst None 0 Feb 2 16:35 openssl
81 Expat is optionally required for writing Timed Text Track Files. See
82 http://expat.sourceforge.net/
84 To build, type 'make'. There are several test targets but you
85 need to assemble a set of test files to use them.
87 I have tested this build on win32, Linux, OpenBSD and Darwin
88 platforms. Others may work as well.
95 asdcp-test - Writes, reads and verifies AS-DCP (MXF) track files.
97 kmfilegen - Writes and verifies large files using a platform-
98 independent format. Use it to test issues related to large files.
100 kmuuidgen, kmrandgen - generate UUID values and random numbers.
102 wavesplit - Splits a WAVE file into two or more output files. Used
103 to untangle incorrectly-paired DCDM sound files.
105 blackwave - Write a WAVE file full of zeros, Used to make filler
106 tracks (though you would be better off modifying asdcp-test if
107 this is a common use case).
112 Currently, the API documentation is mostly in AS_DCP.h. Read
113 that file for a detailed description of the library's capabilities.
114 Read asdcp-test.cpp for library usage examples. The command-line
115 utilities all respond to -h.
119 2008.02.01 - SMPTE format fixes, bug fixes v.1.3.18
120 o Added correct SMPTE UL for StereoscopicPictureSubDescriptor.
121 o Exposed JP2K metadata parser as ParseMetadataIntoDesc().
122 o Added simple stereoscopic framebuffer to support paired ReadFrame()
123 and WriteFrame() methods (allows simpler integration with other
125 o Improved detection of JPEG Interop stereoscopic files.
126 o Win32 build fixes (Thanks to Mike Crowe at DTS).
127 - Below this point the changes are internal and should not affect you
128 unless you use Kumu directly.
129 o Major refactoring of KM_log.[h|cpp].
130 o Fixed buffer re-sizing issue in Kumu::ByteString.
131 o Replaced type IdentifierList with ArchivableList.
132 o Added COPYING file to the release bundle.
135 2007.12.13 - Bug fixes v.1.2.17
136 o Changed Result_t implementation to use int instead of long, which
137 was causing trouble on some 64 bit platforms.
138 o Fixed EKLV HMAC. NOTE: Breaks backward compatibility with older
139 Interop files. To validate these files, use asdcplib-1.1.14. This
140 should not cause too much trouble since files with broken and
141 non-broken HMAC have been in the wild for years without issue.
142 o Fixed HMAC sequence numbering in encrypted stereoscopic files.
143 o Finished stereoscopic test targets in the makefile.
144 o Fixed the win32 build, now expects VS2005 compiler by default,
145 use WITH_VC6=1 top get VC6 flags.
146 o Stereoscopic and Timed Text modes now have SMPTE UL values.
147 NOTE: SMPTE 429-5 and 429-10 are not yet published. It is possible
148 that these UL values may change before publication. Please use
149 caution when using these features for production work.
150 o Changed a bunch of symbol names in the 429-5 implementation to
151 better match the spec.
152 o Added -U option to asdcp-test to dump the UL library to stdout.
153 o Fixed erroneous placement of the PictureEssenceCoding UL in JP2K
154 files (Interop and SMPTE modes).
157 2007.10.22 - Timed Text, Stereoscopic Picture and Bug fixes v.1.2.16
158 o Significant API changes have been made. Please read all entries
159 in this changelog to be sure you understand the changes. Also
160 note that some changes have been made to LS_MXF_SMPTE files that
161 are incompatible with earlier releases (e.g., EKLV HMAC). If
162 you are looking for a stable interop release, use v.1.1.14.
163 o Fixed RFC 2104 HMAC implementation for LS_MXF_SMPTE only. The
164 broken implementation has been maintained for Interop mode.
165 o Added support for draft SMPTE 429-5 Timed Text Track File. This
166 is still waiting for official SMPTE ULs, so do not use it for
167 shipping products. An XML parser is needed to create a Timed
168 Text Track File; Expat is now an optional part of the build.
169 Make with WITH_XML_PARSER=1 to link with Expat. If you do not
170 link with expat, you will get an error when using the TimedText::
171 DCSubtitleParser class. See also S429-5-cgi.cpp for an example
172 that shows how to serve plaintext MXF file elements directly via
174 o Added support for draft SMPTE 429-10 Stereoscopic Picture Track
175 File, including the JPEG Interop version. This is still waiting
176 for official SMPTE ULs, so do not use it with LS_MXF_SMPTE for
178 o Refactored the following files as a side-effect of the above
179 work: AS_DCP_JP2K.cpp AS_DCP_MPEG2.cpp AS_DCP_PCM.cpp
180 AS_DCP_MXF.cpp AS_DCP_internal.h MXF.[h|cpp] MXFTypes.[h|cpp]
181 Metadata.[h|cpp] h__Reader.cpp h__Writer.cpp klvwalk.cpp.
182 WARNING: While significant effort has been extended to make sure
183 that these changes do not affect existing stable file support,
184 users are cautioned to test this release thouroughly.
185 o Added a large set of filesystem path manglers to KM_fileio.h. See
186 path-test.cpp for example usage. The path manglers have not yet
187 been tested on win32 platforms (they are currently used only by
188 the Timed Text module.
189 o The PathIsFile(), PathIsDirectory() and FileSize() subroutines
190 have been modified to accept const std::string& instead of
192 o Added namespace and parsing support (Expat) to Kumu::XMLElement
193 (currently used only for Timed Text support). Also added some
195 o Altered MXF::UTF16String to use mbtowc() and wctomb().
198 2007.03.31 - Bug fixes v.1.1.14
199 o Fixed KeyFrameOffset value in MPEG wrapping to have negative
200 value. This is probably not yet complete for handling all
201 types of GOPs. Please send chunks of MPEG-2 VES that you
202 find which break this. Thanks to Doremi.
203 ** no other file format changes in this release **
204 o Fixed error in RIP interpretation when reading arbitrary (i.e.,
206 o Fixed a memory leak in ASDCP::MXF::OPAtomHeader when used
207 in read mode. Thanks to Mahesh Bajaj for pointing out this
208 bug and the one above.
209 o Removed asserts from KM_fileio, replaced with RESULT_WRITEFAIL
210 return value statements.
211 o Added -s and -p to the makefile install target.
212 o Altered ByteString behavior to use target Length() in copy
213 operations (instead of Capacity()).
214 o Added new Set() method to ByteString.
215 o Fixed a bug in ByteString::Unarchive() that caused the operation
216 to fail when the buffer was smaller than the read (i.e., when
217 Capacity() was called).
218 o Added IdentifierList class to KM_util.h.
219 o Changed some Error() messages to Debug() in Wav.cpp
220 o Revived jp2k-test.cpp and asdcp-mem-test.cpp (they both had
224 2007.02.15 - Bug fixes v1.1.13
225 o Removed 'VDescObj->SampleRate.Numerator = VDesc.FrameRate;'
226 from MPEG2_VDesc_to_MD() in AS_DCP_MPEG2.cpp, was line 76.
227 o Added KM_TEST_NULL_STR_L() and KM_TEST_NULL_L() macros to
228 KM_log.h. These versions log the location of the null value.
229 Macros are now used in any module that includes KM_log.h.
230 o MPEG2 VES with run of zero values at the head is now OK.
231 o Increased VESHeaderBufSize to 16K.
232 o Added makefile support for local OpenSSL in ../openssl, if
234 o The Kumu::PathIs*() functions now return false if a null or
235 empty string is given (used to be an assert).
236 o Cleaned up the install target in the makefile.
237 o Fixed SMPTE 429-6 HMAC -- FIPS 186-2 implementation was
238 laughably incorrect. Thanks to Doremi for pointing this out.
239 o Removed default parameter to HMACContext::InitKey().
240 o Cleaned up messages and CLI arg handling in asdcp-test.
243 2006.11.19 - Mo better stuff v1.1.12
244 o Changed read-only Result_t accessor methods to const.
245 o Added Base64 (-B) option to kmrandgen.
246 o Removed 16-bit alignment restriction from kmrandgen.
247 o Improved WAV file extraction speed (Thanks to Jim Radford
248 for pointing this out).
249 o Added single-channel split for WAV extraction (asdcp-test -1).
250 o Fixed remainder bug in h__RNG::fill_rand().
253 2006.11.03 - Bug fixes v1.1.11
254 o Increased index table entry list size to 5000.
255 o Added length checking to TLV writer (returns error if TLV
256 payload exceeds 64kB).
257 o Fixed partition header and RIP errors related to 2-partition
258 files (MXF Interop mode).
259 o Added -t option to asdcp-test (SHA-1 digest with Base64 output
261 o Fixed Sub Descriptor reference bug (Thanks to Denis Leconte
262 for dogged determination).
263 o Added directory-of-wav detection to RawEssenceType()
264 o Modified MXF::Partition::AddChildObject() to only generate
265 a UUID if the InstanceID is unset.
266 o Added ComponentMaxRef & ComponentMinRef to RGBAEssenceDescriptor.
268 o Added detection of 2K/4K jp2c, writing correct 4K metadata.
271 2006.10.05 - Bug fixes v1.1.10
272 o Changed RM_RELEASE to RL_RELEASE in MXFTypes.h.
273 o Changed the MXF writer to use RL_RELEASE (was RL_DEVELOPMENT).
274 o Really fixed source reference chain.
275 o Updated JP2K file package label.
276 o Changed location of JPEG2000PictureSubDescriptor in the
277 header (was erroneously before Preface).
278 o Altered LS_MXF_INTEROP to produce 2-partition files.
281 2006.09.25 - Bug fixes v1.1.9
282 o Fixed SourcePackageID value. All files will be 'original',
283 i.e. SourcePackageID will be all zeros. Let me know if you
284 want to set SourcePackageID.
285 o Fixed compiler warnings on some Linux platforms
286 o Fixed the build so that BUILD_DIR is no longer created
288 o Added duration detection to the raw essence parsers. The
289 MPEG parser uses a nasty approximation so don't use it
290 without paying close attention to the result.
291 o Modified PCMParserList to make it more useful as a base
293 o Fixed bugs and re-organized command-line help in asdcp-test
295 o Fixed two-partition file reads.
296 o Fixed Win32 PRNG initialization.
297 o Renamed asdcp-lf-test as kmfilegen.
298 o Added kmrandgen and kmuuidgen.
299 o Added string retrieval mechanism to Result_t.
300 o Refactored Kumu::Identifier and its sub-classes.
301 o Altered Kumu::PathIsFile to return true when the path
302 is a symbolic link (unix only).
303 o Altered Kumu::FileWriter::OpenWrite to use file creation
304 mode 0664 (was 0644) (unix only).
305 o Added Kumu::WriteStringIntoFile() subroutine.
308 2006.04.05 - Bug fixes and new stuff v1.1.7
309 o Fixed a bug in the MPEG parser that caused it to fail when
310 handling start codes spanning buffer boundaries
311 o Added wavesplit and blackwave utility programs
312 o Added support for revised SMPTE HMAC key derivation when
314 o Refactored platform compatibility and general utilities
315 into a new sub-library "Kumu". There are no new build
316 steps or dependencies, but some important things have
318 + Result_t is no longer an enum, it is now a class.
319 Library result codes are now declared as const objects
322 const Kumu::Result_t RESULT_FORMAT (-101, "The file...");
324 The macros ASDCP_SUCCESS and ASDCP_FAILURE still work
325 the same way thanks to an operator overload for type long.
326 See KM_error.h for more information.
327 + The logging interface has been moved out of AS_DCP.h
329 o Some of the command line utilities that were using headers
330 other than AS_DCP.h have been changed to use the Kumu
331 equivalents. If you have code based on those utilities, you
332 will have to update by hand.
333 o Added new types to the EssenceType_t enum.
334 o The guard macro for Win32 code has changed from WIN32 to
338 2006.03.2x - new stuff
339 o Proper handling of stream-id byte of essence UL values
340 o writes 3-partition files, reads 2-part or 3-part
343 2006.03.16 - bug fixes plus
344 o Removed SMPTE_LABELS compile-time option. The reader will now
345 silently accept either SMPTE or MXF Interop labels, the writer
346 can be instructed which to use at runtime. Default is Interop.
347 o Added an AIFF reader. Support is preliminary, it works with the
348 AIFF files I have on hand.
349 o More code refactoring. More to come.
352 2006.03.09 - full read-write
353 o Removed ASDCP_WITHOUT_OPENSSL compile-time option.
354 o Full read/write now working on new MXF library
357 2005.00.00 - A New Hope
358 o The temporary mxf-lite has been removed. MXF files are now
359 managed via the objects in KLV.h, MXFTypes.h MXF.h and
360 Metadata.h. This release does not support writing MXF files.
361 o Fixed a header interpretation error in the Wav parser.
364 2005.00.00 - The Reformation
365 o Removed mxflib as a dependency by forking the necessary
366 functions and placing them in the mxf-lite subdirectory.
367 Please note that the very heavy modifications done here
368 render all comparisson to mxflib code a substantial task.
369 All errors are now mine and users are warned not to bug
370 Oliver or Matt for help with this code. The version of
371 mxflib at the time of the fork was: 0.5.1.3.
374 2005.06.03 - bug fixes v0.10.18
375 o Updated UL batch to include GC UL.
378 2005.05.27 - bug fixes v0.10.17
379 o Un-did essence container and compression descriptor changes.
380 The default build reflects MXF Interop decisions as of 26 May.
381 o Added note about build versions to README (see above).
382 o Added warnings to SMPTE_LABELS builds.
383 o Fixed JP2K essence container label.
386 2005.05.02 - bug fixes v0.10.16
387 o Reorganized internal files, added file reader object, added OS
388 portability header, removed and renamed some files. If you have a
389 patch against previous versions of the source, you should check
391 o Added RGBA attributes to JP2K descriptor.
392 o Changed interface to CodestreamParser.
393 o Added JP2K parser implementation. It is parsing each frame but is
394 not yet being used to populate the descriptor.
395 o Added 48fps option for `asdcp-test -p`.
396 o Added picture rate constants to AS_DCP.h (23.976, 24, 48).
397 o Added sample rate constant to AS_DCP.h (48k).
398 o Changed asdcp-test to encrypt picture headers by default
399 (plaintext offset will be 0), added -E option to allow
403 2005.04.28 - bug fixes v0.9.15
404 o The XML descriptors for the crypto DMS have moved in mxflib to
405 the file DMS_Crypto.xml (they were in DMS_DCPENC.xml). Older
406 installations should update the file from mxflib.
407 o Added Close() and Seek() to ~MyFileWriter(), cleaned up headers
408 o Added UUID generator output mode (-u).
409 o Added -S option to extract PCM essence into stereo wav files
410 o Added more UL testing and conformance checking.
411 o Added macro SMPTE_LABELS which causes the library to be built
412 with SMPTE (as opposed to MXF Interop) labels. This is not
413 set by default, and currently only affects the PCM container
414 label and encrypted element label.
415 o Cleaned up the GNUmakefile test targets, the source files
416 are now named with the TEST_FILE_PREFIX macro.
417 o enabled 23.976-framed PCM (2002 samples per frame)
418 o The size of the asdcp-test frame buffer for picture essence
419 may now be set from the command line (-b). The default is 4MB.
420 o h__Reader::ReadEKLVPacket() now tests the UL (duh) and switches
421 on the value, allowing plaintext and ciphertext frames to
422 be mixed in the file.
423 o Fixed error in UUID generator format.
424 o JP2K files now use the GenericPictureDescriptor to store
425 ContainerDuration and SampleRate. SampleRate is mapped
426 to EditRate in the PictureDescriptor struct. This fixes
427 the second caveat from the 0.8.13 release.
428 o Fxed bug in PCMParserList that was miscalculating the extent
429 of a PCM sample. This bug did not affect API users, it was
430 only present in asdcp-test.
431 o Fixed EditRate on PCM files (was showing sample rate)
432 o Fixed Encrypted Essence Container UL
433 o Fixed BlockAlign value for PCM essence
435 - The following changes were provided by Jeff Loewenguth
437 o Moved the DMS CryptographicFramework entry from the material
438 package to the source package
439 o Fixed erroneous Source Essence Container Label value
440 o Fixed broken sort of JP2K frames in JP2K parser
441 o Added FindFrameGOPStart() method to the MPEG2 MXFReader
442 o Added missing length values for EKLV packets without HMAC
443 o -x with JP2K essence writes to files with 6 digit names
445 o The Key ID may now be specified as an argument to asdcp-test
449 2004.12.30 - bug fixes + wav files v0.8.14
450 o Added WAV file write to asdcp-test (uses mxflib::waveheader_t).
451 o Three-partition files reading properly. adscplib still writes
453 o Changes in the mxflib WAV essence parser API had broken
454 asdcplib's ability to read essence from a WAV file. I have
455 fixed this bug, but at the expense of breaking compatibility
456 with older versions of mxflib. Beware!
457 o Removed redundant (but working) bin-text-bin conversions.
460 2004.12.23 - JPEG 2000 support v0.8.13
461 o Reads/writes JPEG 2000 essence in plaintext and ciphertext
462 with the following caveats:
463 - The Picture Essence Descriptor is empty.
464 - Because there is no essence descriptor, the reader code
465 in asdcp-test has no idea how many frames are in the file
466 and ends with an out-of-bounds frame error. This error
467 is being suppressed in asdcp-test for the current release.
468 o Still broken when reading three-partition files.
471 2004.10.22 - fixes and UL updates v0.7.11
472 WARNING: COMPATIBILITY BREAKPOINT
473 Files created with this and future versions of this library are
474 not compatible with previous versions of this library. As you
475 might suspect, files created with previous versions of this
476 library are not compatible with this and future versions.
478 o h__Reader will now open a three-partitition file (untested)
479 o Moved DMS from Material partition to File partition
480 o Added length fields to appropriate places in EKLV packet
483 2004.10.22 - fixes and UL updates v0.7.10
484 o fixed frame buffer handling of externally allocated buffer,
485 created unit test (asdcp-mem-test)
486 o added operator==() and operator!=() to Rational type
487 o fixed some type-related compiler warnings
488 o asdcp-test -p now works on unwrap
489 o updated some ULs to match documentation (thanks to Arun
491 o canonicalized line endings
494 2004.07.02 - full plaintext + ciphertext read/write v0.6.9
495 o HMAC, plaintext offest and raw ciphertext read supported
496 o back to proper CBR index
497 o MPEG temporal offset working
500 2004.07.01 - plaintext + ciphertext read/write v0.5.8
501 o encryption of MPEG and PCM essence supported with the
504 - no plaintext offest support
505 - no raw ciphertext read support
506 o moved to reflecting the whole KLV triplet in the CBR
507 index (now incompatible with mxflib, still searching
508 for info about what's "right")
509 o awaitng the following fixes/features:
510 - retrieve Temporal Offset from index in MPEG2::Reader
511 - test for correct ULs when reading frame triplets
512 - fix header metadata items for encrypted files
514 - plaintext offest support
515 - raw ciphertext read support
518 2004.06.14 - plaintext read/write w/key generator v0.4.5
519 o Project now uses OpenSSL (tested with 0.9.7d on win32, Linux, Darwin)
520 Use `make ASDCP_WITHOUT_OPENSSL=1` to make plaintext-only version
521 o Accepts interior I frames when parsing MPEG2 VES
522 o Improved error reporting on format errors
523 o Added support for encryption to asdcp-test
524 o Added RNG for asdcp-test (non-production use only, see notes in FortunaRNG.h)
525 o Implemented CBC encrypt, decrypt module
526 o Added partial TemporalOffset retrieval from MPEG2 parser
527 o Fixed win32 binmode bug
530 2004.05.12 - plaintext read/write v0.3.4
531 o Full read/write of plaintext MPEG-2 VES and WAV files
532 (does not yet support mux from or demux to 2 channel pairs)
533 o Builds with autoconf-based mxflib
534 o Added ASDCP_ prefix to macros
535 o Updated documentation, fixed documentation errors
536 o Simplified API for MXF writer setup
537 o Decoupled essence parsers from MXF writers
538 o added raw ciphertext support to FrameBuffer
539 o Cleaned up Get/Set naming confusion
540 o Added missing const qualifiers
543 2004.04.27 - preview release v0.2.1
544 o hasty release for quick review
545 o this release may not build with mxflib using autoconf.
546 o writes plaintext AS-DCP MPEG2 essence files
547 o tested under win32 and linux. FreeBSD and Darwin do not work
550 2004.02.04 - First release (v0.1.1):
551 o asdcp-test is mostly complete. It should correctly provide
552 access to the read and info capabilities of the library.
553 o The MPEG2 reader is functional but not fully tested.
554 o Some file format integrity tests remain to be coded.
555 o The PCM reader is mostly complete, I am having difficulty
556 getting a suitable test file from mxfwrap.
557 o The makefile creates a static library module. The API
558 will cleanly support a DSO (or DLL). Let me know if DSO
559 support is important to you.
560 o Nothing is thread safe. Thread safety was not a requirement
561 in the initial project definition. Thread safety may be added
562 above the mxflib/klvlib level. Let me know if it is important
564 o The files xmldict.xml and types.xml must be in the current
565 directory when the program is run. The files are supplied
566 with mxflib. Runtime location of the files is not currently
567 a project goal. Comments on how best to handle this situation
568 would be appreciated. See AS_DCP.cpp at init_mxf_types()
569 for a more detailed discussion.