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
67 the dep.make file. Alternatively, a native MSVC build file
68 and instructions can be found in the win32 subdirectory.
70 OpenSSL is also required. See http://www.openssl.org/
72 If you are building on win32 or a unix with no OpenSSL library
73 support, you will have to also obtain and build OpenSSL. Unpack
74 it into the same parent directory as asdcplib/, and rename (or make
75 a symlink to) the directory as 'openssl':
79 drwxr-xr-x 1 jhurst None 0 Feb 3 16:37 asdcplib
80 drwxr-xr-x 56 jhurst None 0 Feb 2 16:35 openssl
82 Expat is optionally required for writing Timed Text Track Files. See
83 http://expat.sourceforge.net/
85 To build, type 'make'. There are several test targets but you
86 need to assemble a set of test files to use them.
88 I have tested this build on win32, Linux, OpenBSD and Darwin
89 platforms. Others may work as well.
96 asdcp-test - Writes, reads and verifies AS-DCP (MXF) track files.
98 kmfilegen - Writes and verifies large files using a platform-
99 independent format. Use it to test issues related to large files.
101 kmuuidgen, kmrandgen - generate UUID values and random numbers.
103 wavesplit - Splits a WAVE file into two or more output files. Used
104 to untangle incorrectly-paired DCDM sound files.
106 blackwave - Write a WAVE file full of zeros, Used to make filler
107 tracks (though you would be better off modifying asdcp-test if
108 this is a common use case).
113 Currently, the API documentation is mostly in AS_DCP.h. Read
114 that file for a detailed description of the library's capabilities.
115 Read asdcp-test.cpp for library usage examples. The command-line
116 utilities all respond to -h.
120 2008.02.16 - SMPTE format fixes, bug fixes v.1.3.18
121 o Added correct SMPTE UL for StereoscopicPictureSubDescriptor.
122 o Exposed JP2K metadata parser as ParseMetadataIntoDesc().
123 o Added simple stereoscopic framebuffer to support paired ReadFrame()
124 and WriteFrame() methods (allows simpler integration with other
126 o Improved detection of JPEG Interop stereoscopic files.
127 o Win32 build fixes (Thanks to Mike Crowe at DTS).
128 o Added the WITH_MD macro to the makefile. Set this value to one
129 to build Win32 with /MD[d] instead of /MT[d].
130 o The Generic Container UL has been added to the EssenceContainers
131 set in the header partition pack for encrypted files. It has always
132 been there in plaintext files.
133 - Below this point the changes are internal and should not affect you
134 unless you use Kumu directly.
135 o Major refactoring of KM_log.[h|cpp].
136 o Fixed buffer re-sizing issue in Kumu::ByteString.
137 o Replaced type IdentifierList with ArchivableList.
138 o Added COPYING file to the release bundle.
141 2007.12.13 - Bug fixes v.1.2.17
142 o Changed Result_t implementation to use int instead of long, which
143 was causing trouble on some 64 bit platforms.
144 o Fixed EKLV HMAC. NOTE: Breaks backward compatibility with older
145 Interop files. To validate these files, use asdcplib-1.1.14. This
146 should not cause too much trouble since files with broken and
147 non-broken HMAC have been in the wild for years without issue.
148 o Fixed HMAC sequence numbering in encrypted stereoscopic files.
149 o Finished stereoscopic test targets in the makefile.
150 o Fixed the win32 build, now expects VS2005 compiler by default,
151 use WITH_VC6=1 top get VC6 flags.
152 o Stereoscopic and Timed Text modes now have SMPTE UL values.
153 NOTE: SMPTE 429-5 and 429-10 are not yet published. It is possible
154 that these UL values may change before publication. Please use
155 caution when using these features for production work.
156 o Changed a bunch of symbol names in the 429-5 implementation to
157 better match the spec.
158 o Added -U option to asdcp-test to dump the UL library to stdout.
159 o Fixed erroneous placement of the PictureEssenceCoding UL in JP2K
160 files (Interop and SMPTE modes).
163 2007.10.22 - Timed Text, Stereoscopic Picture and Bug fixes v.1.2.16
164 o Significant API changes have been made. Please read all entries
165 in this changelog to be sure you understand the changes. Also
166 note that some changes have been made to LS_MXF_SMPTE files that
167 are incompatible with earlier releases (e.g., EKLV HMAC). If
168 you are looking for a stable interop release, use v.1.1.14.
169 o Fixed RFC 2104 HMAC implementation for LS_MXF_SMPTE only. The
170 broken implementation has been maintained for Interop mode.
171 o Added support for draft SMPTE 429-5 Timed Text Track File. This
172 is still waiting for official SMPTE ULs, so do not use it for
173 shipping products. An XML parser is needed to create a Timed
174 Text Track File; Expat is now an optional part of the build.
175 Make with WITH_XML_PARSER=1 to link with Expat. If you do not
176 link with expat, you will get an error when using the TimedText::
177 DCSubtitleParser class. See also S429-5-cgi.cpp for an example
178 that shows how to serve plaintext MXF file elements directly via
180 o Added support for draft SMPTE 429-10 Stereoscopic Picture Track
181 File, including the JPEG Interop version. This is still waiting
182 for official SMPTE ULs, so do not use it with LS_MXF_SMPTE for
184 o Refactored the following files as a side-effect of the above
185 work: AS_DCP_JP2K.cpp AS_DCP_MPEG2.cpp AS_DCP_PCM.cpp
186 AS_DCP_MXF.cpp AS_DCP_internal.h MXF.[h|cpp] MXFTypes.[h|cpp]
187 Metadata.[h|cpp] h__Reader.cpp h__Writer.cpp klvwalk.cpp.
188 WARNING: While significant effort has been extended to make sure
189 that these changes do not affect existing stable file support,
190 users are cautioned to test this release thouroughly.
191 o Added a large set of filesystem path manglers to KM_fileio.h. See
192 path-test.cpp for example usage. The path manglers have not yet
193 been tested on win32 platforms (they are currently used only by
194 the Timed Text module.
195 o The PathIsFile(), PathIsDirectory() and FileSize() subroutines
196 have been modified to accept const std::string& instead of
198 o Added namespace and parsing support (Expat) to Kumu::XMLElement
199 (currently used only for Timed Text support). Also added some
201 o Altered MXF::UTF16String to use mbtowc() and wctomb().
204 2007.03.31 - Bug fixes v.1.1.14
205 o Fixed KeyFrameOffset value in MPEG wrapping to have negative
206 value. This is probably not yet complete for handling all
207 types of GOPs. Please send chunks of MPEG-2 VES that you
208 find which break this. Thanks to Doremi.
209 ** no other file format changes in this release **
210 o Fixed error in RIP interpretation when reading arbitrary (i.e.,
212 o Fixed a memory leak in ASDCP::MXF::OPAtomHeader when used
213 in read mode. Thanks to Mahesh Bajaj for pointing out this
214 bug and the one above.
215 o Removed asserts from KM_fileio, replaced with RESULT_WRITEFAIL
216 return value statements.
217 o Added -s and -p to the makefile install target.
218 o Altered ByteString behavior to use target Length() in copy
219 operations (instead of Capacity()).
220 o Added new Set() method to ByteString.
221 o Fixed a bug in ByteString::Unarchive() that caused the operation
222 to fail when the buffer was smaller than the read (i.e., when
223 Capacity() was called).
224 o Added IdentifierList class to KM_util.h.
225 o Changed some Error() messages to Debug() in Wav.cpp
226 o Revived jp2k-test.cpp and asdcp-mem-test.cpp (they both had
230 2007.02.15 - Bug fixes v1.1.13
231 o Removed 'VDescObj->SampleRate.Numerator = VDesc.FrameRate;'
232 from MPEG2_VDesc_to_MD() in AS_DCP_MPEG2.cpp, was line 76.
233 o Added KM_TEST_NULL_STR_L() and KM_TEST_NULL_L() macros to
234 KM_log.h. These versions log the location of the null value.
235 Macros are now used in any module that includes KM_log.h.
236 o MPEG2 VES with run of zero values at the head is now OK.
237 o Increased VESHeaderBufSize to 16K.
238 o Added makefile support for local OpenSSL in ../openssl, if
240 o The Kumu::PathIs*() functions now return false if a null or
241 empty string is given (used to be an assert).
242 o Cleaned up the install target in the makefile.
243 o Fixed SMPTE 429-6 HMAC -- FIPS 186-2 implementation was
244 laughably incorrect. Thanks to Doremi for pointing this out.
245 o Removed default parameter to HMACContext::InitKey().
246 o Cleaned up messages and CLI arg handling in asdcp-test.
249 2006.11.19 - Mo better stuff v1.1.12
250 o Changed read-only Result_t accessor methods to const.
251 o Added Base64 (-B) option to kmrandgen.
252 o Removed 16-bit alignment restriction from kmrandgen.
253 o Improved WAV file extraction speed (Thanks to Jim Radford
254 for pointing this out).
255 o Added single-channel split for WAV extraction (asdcp-test -1).
256 o Fixed remainder bug in h__RNG::fill_rand().
259 2006.11.03 - Bug fixes v1.1.11
260 o Increased index table entry list size to 5000.
261 o Added length checking to TLV writer (returns error if TLV
262 payload exceeds 64kB).
263 o Fixed partition header and RIP errors related to 2-partition
264 files (MXF Interop mode).
265 o Added -t option to asdcp-test (SHA-1 digest with Base64 output
267 o Fixed Sub Descriptor reference bug (Thanks to Denis Leconte
268 for dogged determination).
269 o Added directory-of-wav detection to RawEssenceType()
270 o Modified MXF::Partition::AddChildObject() to only generate
271 a UUID if the InstanceID is unset.
272 o Added ComponentMaxRef & ComponentMinRef to RGBAEssenceDescriptor.
274 o Added detection of 2K/4K jp2c, writing correct 4K metadata.
277 2006.10.05 - Bug fixes v1.1.10
278 o Changed RM_RELEASE to RL_RELEASE in MXFTypes.h.
279 o Changed the MXF writer to use RL_RELEASE (was RL_DEVELOPMENT).
280 o Really fixed source reference chain.
281 o Updated JP2K file package label.
282 o Changed location of JPEG2000PictureSubDescriptor in the
283 header (was erroneously before Preface).
284 o Altered LS_MXF_INTEROP to produce 2-partition files.
287 2006.09.25 - Bug fixes v1.1.9
288 o Fixed SourcePackageID value. All files will be 'original',
289 i.e. SourcePackageID will be all zeros. Let me know if you
290 want to set SourcePackageID.
291 o Fixed compiler warnings on some Linux platforms
292 o Fixed the build so that BUILD_DIR is no longer created
294 o Added duration detection to the raw essence parsers. The
295 MPEG parser uses a nasty approximation so don't use it
296 without paying close attention to the result.
297 o Modified PCMParserList to make it more useful as a base
299 o Fixed bugs and re-organized command-line help in asdcp-test
301 o Fixed two-partition file reads.
302 o Fixed Win32 PRNG initialization.
303 o Renamed asdcp-lf-test as kmfilegen.
304 o Added kmrandgen and kmuuidgen.
305 o Added string retrieval mechanism to Result_t.
306 o Refactored Kumu::Identifier and its sub-classes.
307 o Altered Kumu::PathIsFile to return true when the path
308 is a symbolic link (unix only).
309 o Altered Kumu::FileWriter::OpenWrite to use file creation
310 mode 0664 (was 0644) (unix only).
311 o Added Kumu::WriteStringIntoFile() subroutine.
314 2006.04.05 - Bug fixes and new stuff v1.1.7
315 o Fixed a bug in the MPEG parser that caused it to fail when
316 handling start codes spanning buffer boundaries
317 o Added wavesplit and blackwave utility programs
318 o Added support for revised SMPTE HMAC key derivation when
320 o Refactored platform compatibility and general utilities
321 into a new sub-library "Kumu". There are no new build
322 steps or dependencies, but some important things have
324 + Result_t is no longer an enum, it is now a class.
325 Library result codes are now declared as const objects
328 const Kumu::Result_t RESULT_FORMAT (-101, "The file...");
330 The macros ASDCP_SUCCESS and ASDCP_FAILURE still work
331 the same way thanks to an operator overload for type long.
332 See KM_error.h for more information.
333 + The logging interface has been moved out of AS_DCP.h
335 o Some of the command line utilities that were using headers
336 other than AS_DCP.h have been changed to use the Kumu
337 equivalents. If you have code based on those utilities, you
338 will have to update by hand.
339 o Added new types to the EssenceType_t enum.
340 o The guard macro for Win32 code has changed from WIN32 to
344 2006.03.2x - new stuff
345 o Proper handling of stream-id byte of essence UL values
346 o writes 3-partition files, reads 2-part or 3-part
349 2006.03.16 - bug fixes plus
350 o Removed SMPTE_LABELS compile-time option. The reader will now
351 silently accept either SMPTE or MXF Interop labels, the writer
352 can be instructed which to use at runtime. Default is Interop.
353 o Added an AIFF reader. Support is preliminary, it works with the
354 AIFF files I have on hand.
355 o More code refactoring. More to come.
358 2006.03.09 - full read-write
359 o Removed ASDCP_WITHOUT_OPENSSL compile-time option.
360 o Full read/write now working on new MXF library
363 2005.00.00 - A New Hope
364 o The temporary mxf-lite has been removed. MXF files are now
365 managed via the objects in KLV.h, MXFTypes.h MXF.h and
366 Metadata.h. This release does not support writing MXF files.
367 o Fixed a header interpretation error in the Wav parser.
370 2005.00.00 - The Reformation
371 o Removed mxflib as a dependency by forking the necessary
372 functions and placing them in the mxf-lite subdirectory.
373 Please note that the very heavy modifications done here
374 render all comparisson to mxflib code a substantial task.
375 All errors are now mine and users are warned not to bug
376 Oliver or Matt for help with this code. The version of
377 mxflib at the time of the fork was: 0.5.1.3.
380 2005.06.03 - bug fixes v0.10.18
381 o Updated UL batch to include GC UL.
384 2005.05.27 - bug fixes v0.10.17
385 o Un-did essence container and compression descriptor changes.
386 The default build reflects MXF Interop decisions as of 26 May.
387 o Added note about build versions to README (see above).
388 o Added warnings to SMPTE_LABELS builds.
389 o Fixed JP2K essence container label.
392 2005.05.02 - bug fixes v0.10.16
393 o Reorganized internal files, added file reader object, added OS
394 portability header, removed and renamed some files. If you have a
395 patch against previous versions of the source, you should check
397 o Added RGBA attributes to JP2K descriptor.
398 o Changed interface to CodestreamParser.
399 o Added JP2K parser implementation. It is parsing each frame but is
400 not yet being used to populate the descriptor.
401 o Added 48fps option for `asdcp-test -p`.
402 o Added picture rate constants to AS_DCP.h (23.976, 24, 48).
403 o Added sample rate constant to AS_DCP.h (48k).
404 o Changed asdcp-test to encrypt picture headers by default
405 (plaintext offset will be 0), added -E option to allow
409 2005.04.28 - bug fixes v0.9.15
410 o The XML descriptors for the crypto DMS have moved in mxflib to
411 the file DMS_Crypto.xml (they were in DMS_DCPENC.xml). Older
412 installations should update the file from mxflib.
413 o Added Close() and Seek() to ~MyFileWriter(), cleaned up headers
414 o Added UUID generator output mode (-u).
415 o Added -S option to extract PCM essence into stereo wav files
416 o Added more UL testing and conformance checking.
417 o Added macro SMPTE_LABELS which causes the library to be built
418 with SMPTE (as opposed to MXF Interop) labels. This is not
419 set by default, and currently only affects the PCM container
420 label and encrypted element label.
421 o Cleaned up the GNUmakefile test targets, the source files
422 are now named with the TEST_FILE_PREFIX macro.
423 o enabled 23.976-framed PCM (2002 samples per frame)
424 o The size of the asdcp-test frame buffer for picture essence
425 may now be set from the command line (-b). The default is 4MB.
426 o h__Reader::ReadEKLVPacket() now tests the UL (duh) and switches
427 on the value, allowing plaintext and ciphertext frames to
428 be mixed in the file.
429 o Fixed error in UUID generator format.
430 o JP2K files now use the GenericPictureDescriptor to store
431 ContainerDuration and SampleRate. SampleRate is mapped
432 to EditRate in the PictureDescriptor struct. This fixes
433 the second caveat from the 0.8.13 release.
434 o Fxed bug in PCMParserList that was miscalculating the extent
435 of a PCM sample. This bug did not affect API users, it was
436 only present in asdcp-test.
437 o Fixed EditRate on PCM files (was showing sample rate)
438 o Fixed Encrypted Essence Container UL
439 o Fixed BlockAlign value for PCM essence
441 - The following changes were provided by Jeff Loewenguth
443 o Moved the DMS CryptographicFramework entry from the material
444 package to the source package
445 o Fixed erroneous Source Essence Container Label value
446 o Fixed broken sort of JP2K frames in JP2K parser
447 o Added FindFrameGOPStart() method to the MPEG2 MXFReader
448 o Added missing length values for EKLV packets without HMAC
449 o -x with JP2K essence writes to files with 6 digit names
451 o The Key ID may now be specified as an argument to asdcp-test
455 2004.12.30 - bug fixes + wav files v0.8.14
456 o Added WAV file write to asdcp-test (uses mxflib::waveheader_t).
457 o Three-partition files reading properly. adscplib still writes
459 o Changes in the mxflib WAV essence parser API had broken
460 asdcplib's ability to read essence from a WAV file. I have
461 fixed this bug, but at the expense of breaking compatibility
462 with older versions of mxflib. Beware!
463 o Removed redundant (but working) bin-text-bin conversions.
466 2004.12.23 - JPEG 2000 support v0.8.13
467 o Reads/writes JPEG 2000 essence in plaintext and ciphertext
468 with the following caveats:
469 - The Picture Essence Descriptor is empty.
470 - Because there is no essence descriptor, the reader code
471 in asdcp-test has no idea how many frames are in the file
472 and ends with an out-of-bounds frame error. This error
473 is being suppressed in asdcp-test for the current release.
474 o Still broken when reading three-partition files.
477 2004.10.22 - fixes and UL updates v0.7.11
478 WARNING: COMPATIBILITY BREAKPOINT
479 Files created with this and future versions of this library are
480 not compatible with previous versions of this library. As you
481 might suspect, files created with previous versions of this
482 library are not compatible with this and future versions.
484 o h__Reader will now open a three-partitition file (untested)
485 o Moved DMS from Material partition to File partition
486 o Added length fields to appropriate places in EKLV packet
489 2004.10.22 - fixes and UL updates v0.7.10
490 o fixed frame buffer handling of externally allocated buffer,
491 created unit test (asdcp-mem-test)
492 o added operator==() and operator!=() to Rational type
493 o fixed some type-related compiler warnings
494 o asdcp-test -p now works on unwrap
495 o updated some ULs to match documentation (thanks to Arun
497 o canonicalized line endings
500 2004.07.02 - full plaintext + ciphertext read/write v0.6.9
501 o HMAC, plaintext offest and raw ciphertext read supported
502 o back to proper CBR index
503 o MPEG temporal offset working
506 2004.07.01 - plaintext + ciphertext read/write v0.5.8
507 o encryption of MPEG and PCM essence supported with the
510 - no plaintext offest support
511 - no raw ciphertext read support
512 o moved to reflecting the whole KLV triplet in the CBR
513 index (now incompatible with mxflib, still searching
514 for info about what's "right")
515 o awaitng the following fixes/features:
516 - retrieve Temporal Offset from index in MPEG2::Reader
517 - test for correct ULs when reading frame triplets
518 - fix header metadata items for encrypted files
520 - plaintext offest support
521 - raw ciphertext read support
524 2004.06.14 - plaintext read/write w/key generator v0.4.5
525 o Project now uses OpenSSL (tested with 0.9.7d on win32, Linux, Darwin)
526 Use `make ASDCP_WITHOUT_OPENSSL=1` to make plaintext-only version
527 o Accepts interior I frames when parsing MPEG2 VES
528 o Improved error reporting on format errors
529 o Added support for encryption to asdcp-test
530 o Added RNG for asdcp-test (non-production use only, see notes in FortunaRNG.h)
531 o Implemented CBC encrypt, decrypt module
532 o Added partial TemporalOffset retrieval from MPEG2 parser
533 o Fixed win32 binmode bug
536 2004.05.12 - plaintext read/write v0.3.4
537 o Full read/write of plaintext MPEG-2 VES and WAV files
538 (does not yet support mux from or demux to 2 channel pairs)
539 o Builds with autoconf-based mxflib
540 o Added ASDCP_ prefix to macros
541 o Updated documentation, fixed documentation errors
542 o Simplified API for MXF writer setup
543 o Decoupled essence parsers from MXF writers
544 o added raw ciphertext support to FrameBuffer
545 o Cleaned up Get/Set naming confusion
546 o Added missing const qualifiers
549 2004.04.27 - preview release v0.2.1
550 o hasty release for quick review
551 o this release may not build with mxflib using autoconf.
552 o writes plaintext AS-DCP MPEG2 essence files
553 o tested under win32 and linux. FreeBSD and Darwin do not work
556 2004.02.04 - First release (v0.1.1):
557 o asdcp-test is mostly complete. It should correctly provide
558 access to the read and info capabilities of the library.
559 o The MPEG2 reader is functional but not fully tested.
560 o Some file format integrity tests remain to be coded.
561 o The PCM reader is mostly complete, I am having difficulty
562 getting a suitable test file from mxfwrap.
563 o The makefile creates a static library module. The API
564 will cleanly support a DSO (or DLL). Let me know if DSO
565 support is important to you.
566 o Nothing is thread safe. Thread safety was not a requirement
567 in the initial project definition. Thread safety may be added
568 above the mxflib/klvlib level. Let me know if it is important
570 o The files xmldict.xml and types.xml must be in the current
571 directory when the program is run. The files are supplied
572 with mxflib. Runtime location of the files is not currently
573 a project goal. Comments on how best to handle this situation
574 would be appreciated. See AS_DCP.cpp at init_mxf_types()
575 for a more detailed discussion.