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 housed on SourceForge. The project
15 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 for applications having non-trivial security
45 The author strives mightily to provide an API that is
46 completely independent of operating system and other
47 library dependencies, and which allows selective replacement
48 of some modules for local needs. Specifically, the essence
49 parsers and OpenSSL crypto functions can be replaced by
50 linking to alternative implementations of the ASDCP::
51 objects which provide those services.
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 To build, type 'make'. There are several test targets but you
82 need to assemble a set of test files to use them.
84 I have tested this build on win32, Linux, OpenBSD and Darwin
85 platforms. Others may work as well.
92 asdcp-test - Writes, reads and verifies AS-DCP (MXF) track files.
94 kmfilegen - Writes and verifies large files using a platform-
95 independent format. Use it to test issues related to large files.
97 kmuuidgen, kmrandgen - generate UUID values and random numbers.
99 wavesplit - Splits a WAVE file into two or more output files. Used
100 to untangle incorrectly-paired DCDM sound files.
102 blackwave - Write a WAVE file full of zeros, Used to make filler
103 tracks (though you would be better off modifying asdcp-test if
104 this is a common use case).
109 Currently, the API documentation is mostly in AS_DCP.h. Read
110 that file for a detailed description of the library's capabilities.
111 Read asdcp-test.cpp for library usage examples. The command-line
112 utilities all respond to -h.
116 2007.06.xx - Timed Text and Bug fixes v.1.1.15
117 o Added support for draft SMPTE 429-5 Timed Text Track File. See
118 AS_DCP_TimedText.h for the API. This is *very* experimental, so
119 do not use for shipping products. Timed Text support is NOT part
120 of the default build, run `make WITH_TIMED_TEXT=1` to enable
121 this part of the library. AS_DCP_TimedText.h will be combined
122 with AS_DCP.h when it becomes stable. Because we need an XML
123 parser to create the Track File, expat is now part of the Timed
124 Text build. Follow the XML_PARSER macro in the makefile and KM_xml
125 to see how you can support your favorite parser. See also
126 S429-5-cgi.cpp for an example that shows how to serve plaintext
127 MXF file elements directly via HTTP.
128 o Refactored the following files as a side-effect of the above
129 work: AS_DCP_JP2K.cpp AS_DCP_MPEG2.cpp AS_DCP_PCM.cpp
130 AS_DCP_MXF.cpp AS_DCP_internal.h MXF.[h|cpp] MXFTypes.[h|cpp]
131 Metadata.[h|cpp] h__Reader.cpp h__Writer.cpp klvwalk.cpp.
132 WARNING: While significant effort has been extended to make sure
133 that this work does not affect existing stable file support,
134 users are cautioned to test this release thouroughly.
135 o Added a large set of path manglers to KM_fileio.h. See
136 path-test.cpp for example usage. The path manglers have not yet
137 been tested on win32 platforms (they are currently used only by
138 the Timed Text module. The PathIsFile(), PathIsDirectory() and
139 FileSize() subroutines have been modified to accept const
140 std::string& instead of const char*.
141 o Added namespace and parsing support (Expat) to Kumu::XMLElement
142 (currently used only for Timed Text support). Also added some
147 2007.03.31 - Bug fixes v.1.1.14
148 o Fixed KeyFrameOffset value in MPEG wrapping to have negative
149 value. This is probably not yet complete for handling all
150 types of GOPs. Please send chunks of MPEG-2 VES that you
151 find which break this. Thanks to Doremi.
152 ** no other file format changes in this release **
153 o Fixed error in RIP interpretation when reading arbitrary (i.e.,
155 o Fixed a memory leak in ASDCP::MXF::OPAtomHeader when used
156 in read mode. Thanks to Mahesh Bajaj for pointing out this
157 bug and the one above.
158 o Removed asserts from KM_fileio, replaced with RESULT_WRITEFAIL
159 return value statements.
160 o Added -s and -p to the makefile install target.
161 o Altered ByteString behavior to use target Length() in copy
162 operations (instead of Capacity()).
163 o Added new Set() method to ByteString.
164 o Fixed a bug in ByteString::Unarchive() that caused the operation
165 to fail when the buffer was smaller than the read (i.e., when
166 Capacity() was called).
167 o Added IdentifierList class to KM_util.h.
168 o Changed some Error() messages to Debug() in Wav.cpp
169 o Revived jp2k-test.cpp and asdcp-mem-test.cpp (they both had
173 2007.02.15 - Bug fixes v1.1.13
174 o Removed 'VDescObj->SampleRate.Numerator = VDesc.FrameRate;'
175 from MPEG2_VDesc_to_MD() in AS_DCP_MPEG2.cpp, was line 76.
176 o Added KM_TEST_NULL_STR_L() and KM_TEST_NULL_L() macros to
177 KM_log.h. These versions log the location of the null value.
178 Macros are now used in any module that includes KM_log.h.
179 o MPEG2 VES with run of zero values at the head is now OK.
180 o Increased VESHeaderBufSize to 16K.
181 o Added makefile support for local OpenSSL in ../openssl, if
183 o The Kumu::PathIs*() functions now return false if a null or
184 empty string is given (used to be an assert).
185 o Cleaned up the install target in the makefile.
186 o Fixed SMPTE 429-6 HMAC -- FIPS 186-2 implementation was
187 laughably incorrect. Thanks to Doremi for pointing this out.
188 o Removed default parameter to HMACContext::InitKey().
189 o Cleaned up messages and CLI arg handling in asdcp-test.
192 2006.11.19 - Mo better stuff v1.1.12
193 o Changed read-only Result_t accessor methods to const.
194 o Added Base64 (-B) option to kmrandgen.
195 o Removed 16-bit alignment restriction from kmrandgen.
196 o Improved WAV file extraction speed (Thanks to Jim Radford
197 for pointing this out).
198 o Added single-channel split for WAV extraction (asdcp-test -1).
199 o Fixed remainder bug in h__RNG::fill_rand().
202 2006.11.03 - Bug fixes v1.1.11
203 o Increased index table entry list size to 5000.
204 o Added length checking to TLV writer (returns error if TLV
205 payload exceeds 64kB).
206 o Fixed partition header and RIP errors related to 2-partition
207 files (MXF Interop mode).
208 o Added -t option to asdcp-test (SHA-1 digest with Base64 output
210 o Fixed Sub Descriptor reference bug (Thanks to Denis Leconte
211 for dogged determination).
212 o Added directory-of-wav detection to RawEssenceType()
213 o Modified MXF::Partition::AddChildObject() to only generate
214 a UUID if the InstanceID is unset.
215 o Added ComponentMaxRef & ComponentMinRef to RGBAEssenceDescriptor.
217 o Added detection of 2K/4K jp2c, writing correct 4K metadata.
220 2006.10.05 - Bug fixes v1.1.10
221 o Changed RM_RELEASE to RL_RELEASE in MXFTypes.h.
222 o Changed the MXF writer to use RL_RELEASE (was RL_DEVELOPMENT).
223 o Really fixed source reference chain.
224 o Updated JP2K file package label.
225 o Changed location of JPEG2000PictureSubDescriptor in the
226 header (was erroneously before Preface).
227 o Altered LS_MXF_INTEROP to produce 2-partition files.
230 2006.09.25 - Bug fixes v1.1.9
231 o Fixed SourcePackageID value. All files will be 'original',
232 i.e. SourcePackageID will be all zeros. Let me know if you
233 want to set SourcePackageID.
234 o Fixed compiler warnings on some Linux platforms
235 o Fixed the build so that BUILD_DIR is no longer created
237 o Added duration detection to the raw essence parsers. The
238 MPEG parser uses a nasty approximation so don't use it
239 without paying close attention to the result.
240 o Modified PCMParserList to make it more useful as a base
242 o Fixed bugs and re-organized command-line help in asdcp-test
244 o Fixed two-partition file reads.
245 o Fixed Win32 PRNG initialization.
246 o Renamed asdcp-lf-test as kmfilegen.
247 o Added kmrandgen and kmuuidgen.
248 o Added string retrieval mechanism to Result_t.
249 o Refactored Kumu::Identifier and its sub-classes.
250 o Altered Kumu::PathIsFile to return true when the path
251 is a symbolic link (unix only).
252 o Altered Kumu::FileWriter::OpenWrite to use file creation
253 mode 0664 (was 0644) (unix only).
254 o Added Kumu::WriteStringIntoFile() subroutine.
257 2006.04.05 - Bug fixes and new stuff v1.1.7
258 o Fixed a bug in the MPEG parser that caused it to fail when
259 handling start codes spanning buffer boundaries
260 o Added wavesplit and blackwave utility programs
261 o Added support for revised SMPTE HMAC key derivation when
263 o Refactored platform compatibility and general utilities
264 into a new sub-library "Kumu". There are no new build
265 steps or dependencies, but some important things have
267 + Result_t is no longer an enum, it is now a class.
268 Library result codes are now declared as const objects
271 const Kumu::Result_t RESULT_FORMAT (-101, "The file...");
273 The macros ASDCP_SUCCESS and ASDCP_FAILURE still work
274 the same way thanks to an operator overload for type long.
275 See KM_error.h for more information.
276 + The logging interface has been moved out of AS_DCP.h
278 o Some of the command line utilities that were using headers
279 other than AS_DCP.h have been changed to use the Kumu
280 equivalents. If you have code based on those utilities, you
281 will have to update by hand.
282 o Added new types to the EssenceType_t enum.
283 o The guard macro for Win32 code has changed from WIN32 to
287 2006.03.2x - new stuff
288 o Proper handling of stream-id byte of essence UL values
289 o writes 3-partition files, reads 2-part or 3-part
292 2006.03.16 - bug fixes plus
293 o Removed SMPTE_LABELS compile-time option. The reader will now
294 silently accept either SMPTE or MXF Interop labels, the writer
295 can be instructed which to use at runtime. Default is Interop.
296 o Added an AIFF reader. Support is preliminary, it works with the
297 AIFF files I have on hand.
298 o More code refactoring. More to come.
301 2006.03.09 - full read-write
302 o Removed ASDCP_WITHOUT_OPENSSL compile-time option.
303 o Full read/write now working on new MXF library
306 2005.00.00 - A New Hope
307 o The temporary mxf-lite has been removed. MXF files are now
308 managed via the objects in KLV.h, MXFTypes.h MXF.h and
309 Metadata.h. This release does not support writing MXF files.
310 o Fixed a header interpretation error in the Wav parser.
313 2005.00.00 - The Reformation
314 o Removed mxflib as a dependency by forking the necessary
315 functions and placing them in the mxf-lite subdirectory.
316 Please note that the very heavy modifications done here
317 render all comparisson to mxflib code a substantial task.
318 All errors are now mine and users are warned not to bug
319 Oliver or Matt for help with this code. The version of
320 mxflib at the time of the fork was: 0.5.1.3.
323 2005.06.03 - bug fixes v0.10.18
324 o Updated UL batch to include GC UL.
327 2005.05.27 - bug fixes v0.10.17
328 o Un-did essence container and compression descriptor changes.
329 The default build reflects MXF Interop decisions as of 26 May.
330 o Added note about build versions to README (see above).
331 o Added warnings to SMPTE_LABELS builds.
332 o Fixed JP2K essence container label.
335 2005.05.02 - bug fixes v0.10.16
336 o Reorganized internal files, added file reader object, added OS
337 portability header, removed and renamed some files. If you have a
338 patch against previous versions of the source, you should check
340 o Added RGBA attributes to JP2K descriptor.
341 o Changed interface to CodestreamParser.
342 o Added JP2K parser implementation. It is parsing each frame but is
343 not yet being used to populate the descriptor.
344 o Added 48fps option for `asdcp-test -p`.
345 o Added picture rate constants to AS_DCP.h (23.976, 24, 48).
346 o Added sample rate constant to AS_DCP.h (48k).
347 o Changed asdcp-test to encrypt picture headers by default
348 (plaintext offset will be 0), added -E option to allow
352 2005.04.28 - bug fixes v0.9.15
353 o The XML descriptors for the crypto DMS have moved in mxflib to
354 the file DMS_Crypto.xml (they were in DMS_DCPENC.xml). Older
355 installations should update the file from mxflib.
356 o Added Close() and Seek() to ~MyFileWriter(), cleaned up headers
357 o Added UUID generator output mode (-u).
358 o Added -S option to extract PCM essence into stereo wav files
359 o Added more UL testing and conformance checking.
360 o Added macro SMPTE_LABELS which causes the library to be built
361 with SMPTE (as opposed to MXF Interop) labels. This is not
362 set by default, and currently only affects the PCM container
363 label and encrypted element label.
364 o Cleaned up the GNUmakefile test targets, the source files
365 are now named with the TEST_FILE_PREFIX macro.
366 o enabled 23.976-framed PCM (2002 samples per frame)
367 o The size of the asdcp-test frame buffer for picture essence
368 may now be set from the command line (-b). The default is 4MB.
369 o h__Reader::ReadEKLVPacket() now tests the UL (duh) and switches
370 on the value, allowing plaintext and ciphertext frames to
371 be mixed in the file.
372 o Fixed error in UUID generator format.
373 o JP2K files now use the GenericPictureDescriptor to store
374 ContainerDuration and SampleRate. SampleRate is mapped
375 to EditRate in the PictureDescriptor struct. This fixes
376 the second caveat from the 0.8.13 release.
377 o Fxed bug in PCMParserList that was miscalculating the extent
378 of a PCM sample. This bug did not affect API users, it was
379 only present in asdcp-test.
380 o Fixed EditRate on PCM files (was showing sample rate)
381 o Fixed Encrypted Essence Container UL
382 o Fixed BlockAlign value for PCM essence
384 - The following changes were provided by Jeff Loewenguth
386 o Moved the DMS CryptographicFramework entry from the material
387 package to the source package
388 o Fixed erroneous Source Essence Container Label value
389 o Fixed broken sort of JP2K frames in JP2K parser
390 o Added FindFrameGOPStart() method to the MPEG2 MXFReader
391 o Added missing length values for EKLV packets without HMAC
392 o -x with JP2K essence writes to files with 6 digit names
394 o The Key ID may now be specified as an argument to asdcp-test
398 2004.12.30 - bug fixes + wav files v0.8.14
399 o Added WAV file write to asdcp-test (uses mxflib::waveheader_t).
400 o Three-partition files reading properly. adscplib still writes
402 o Changes in the mxflib WAV essence parser API had broken
403 asdcplib's ability to read essence from a WAV file. I have
404 fixed this bug, but at the expense of breaking compatibility
405 with older versions of mxflib. Beware!
406 o Removed redundant (but working) bin-text-bin conversions.
409 2004.12.23 - JPEG 2000 support v0.8.13
410 o Reads/writes JPEG 2000 essence in plaintext and ciphertext
411 with the following caveats:
412 - The Picture Essence Descriptor is empty.
413 - Because there is no essence descriptor, the reader code
414 in asdcp-test has no idea how many frames are in the file
415 and ends with an out-of-bounds frame error. This error
416 is being suppressed in asdcp-test for the current release.
417 o Still broken when reading three-partition files.
420 2004.10.22 - fixes and UL updates v0.7.11
421 WARNING: COMPATIBILITY BREAKPOINT
422 Files created with this and future versions of this library are
423 not compatible with previous versions of this library. As you
424 might suspect, files created with previous versions of this
425 library are not compatible with this and future versions.
427 o h__Reader will now open a three-partitition file (untested)
428 o Moved DMS from Material partition to File partition
429 o Added length fields to appropriate places in EKLV packet
432 2004.10.22 - fixes and UL updates v0.7.10
433 o fixed frame buffer handling of externally allocated buffer,
434 created unit test (asdcp-mem-test)
435 o added operator==() and operator!=() to Rational type
436 o fixed some type-related compiler warnings
437 o asdcp-test -p now works on unwrap
438 o updated some ULs to match documentation (thanks to Arun
440 o canonicalized line endings
443 2004.07.02 - full plaintext + ciphertext read/write v0.6.9
444 o HMAC, plaintext offest and raw ciphertext read supported
445 o back to proper CBR index
446 o MPEG temporal offset working
449 2004.07.01 - plaintext + ciphertext read/write v0.5.8
450 o encryption of MPEG and PCM essence supported with the
453 - no plaintext offest support
454 - no raw ciphertext read support
455 o moved to reflecting the whole KLV triplet in the CBR
456 index (now incompatible with mxflib, still searching
457 for info about what's "right")
458 o awaitng the following fixes/features:
459 - retrieve Temporal Offset from index in MPEG2::Reader
460 - test for correct ULs when reading frame triplets
461 - fix header metadata items for encrypted files
463 - plaintext offest support
464 - raw ciphertext read support
467 2004.06.14 - plaintext read/write w/key generator v0.4.5
468 o Project now uses OpenSSL (tested with 0.9.7d on win32, Linux, Darwin)
469 Use `make ASDCP_WITHOUT_OPENSSL=1` to make plaintext-only version
470 o Accepts interior I frames when parsing MPEG2 VES
471 o Improved error reporting on format errors
472 o Added support for encryption to asdcp-test
473 o Added RNG for asdcp-test (non-production use only, see notes in FortunaRNG.h)
474 o Implemented CBC encrypt, decrypt module
475 o Added partial TemporalOffset retrieval from MPEG2 parser
476 o Fixed win32 binmode bug
479 2004.05.12 - plaintext read/write v0.3.4
480 o Full read/write of plaintext MPEG-2 VES and WAV files
481 (does not yet support mux from or demux to 2 channel pairs)
482 o Builds with autoconf-based mxflib
483 o Added ASDCP_ prefix to macros
484 o Updated documentation, fixed documentation errors
485 o Simplified API for MXF writer setup
486 o Decoupled essence parsers from MXF writers
487 o added raw ciphertext support to FrameBuffer
488 o Cleaned up Get/Set naming confusion
489 o Added missing const qualifiers
492 2004.04.27 - preview release v0.2.1
493 o hasty release for quick review
494 o this release may not build with mxflib using autoconf.
495 o writes plaintext AS-DCP MPEG2 essence files
496 o tested under win32 and linux. FreeBSD and Darwin do not work
499 2004.02.04 - First release (v0.1.1):
500 o asdcp-test is mostly complete. It should correctly provide
501 access to the read and info capabilities of the library.
502 o The MPEG2 reader is functional but not fully tested.
503 o Some file format integrity tests remain to be coded.
504 o The PCM reader is mostly complete, I am having difficulty
505 getting a suitable test file from mxfwrap.
506 o The makefile creates a static library module. The API
507 will cleanly support a DSO (or DLL). Let me know if DSO
508 support is important to you.
509 o Nothing is thread safe. Thread safety was not a requirement
510 in the initial project definition. Thread safety may be added
511 above the mxflib/klvlib level. Let me know if it is important
513 o The files xmldict.xml and types.xml must be in the current
514 directory when the program is run. The files are supplied
515 with mxflib. Runtime location of the files is not currently
516 a project goal. Comments on how best to handle this situation
517 would be appreciated. See AS_DCP.cpp at init_mxf_types()
518 for a more detailed discussion.