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
7 Group DC28.20 (now TC 21DC).
9 Recently, support has also been added for SMPTE draft ST
10 2067-5 "IMF Essence Component", AKA "AS-02". This code was
11 donated by Fraunhofer IIS. It carries additional copyright
12 information which should be listed whenever you link the
13 AS-02 elements of the library. Please look at the top of
14 the AS-02 files to see this copyright information.
16 AS-02 support is carried in separate object modules, so
17 unless you #include <AS_02.h> and link libas-02.so you are
18 still using plain old asdcp.
20 This work was originally funded by Digital Cinema Initiatives,
21 LLC (DCI). Subsequent efforts have been funded by Deluxe
22 Laboratories, Doremi Labs, CineCert LLC, Avica Technology
25 **The asdcplib project was originally housed on SourceForge.
26 The project has moved to http://www.cinecert.com/asdcplib/
28 The project formerly depended upon the mxflib project. Because
29 of its focus on covering the whole of the MXF specifications,
30 mxflib is considerably larger and more complex that what I
31 require for this application. For this reason I have created
32 a dedicated MXF implementation that is now part of this
33 library. Special thanks to Matt Beard and Oliver Morgan for
34 their great work and support.
36 Thanks also to the members of the SMPTE DC28.20 packaging
37 ad-hoc group and the members of the MXF Interop Initiative
38 for their encouragement and support. Special thanks to
39 Jim Whittlesey and Howard Lukk at DCI for proposing and
40 supporting this project.
45 This library is intended (but of course not limited) for
46 use by developers of commercial D-Cinema products (and now
47 IMF!). It is designed to be easily integrated into a wide
48 variety of development environments. Commercial users are
49 strongly urged to use static linking (at least where you use
50 this library) to prevent malicious in-field replacement of
51 critical system modules. This recommendation should be
52 considered wherever Open Source or Free software is being
53 used in conjunction with critical security parameters, such
54 as cryptographic keys.
56 The author strives mightily to provide an API that is completely
57 independent of operating system and other library dependencies,
58 and which allows selective replacement of some modules for
59 local needs. Specifically, the essence parsers and OpenSSL
60 crypto functions can be replaced by linking to alternative
61 implementations of the ASDCP:: objects which provide those
64 AS_DCP.h contains the entire AS-DCP API. You do not need to
65 read any of the other files, except maybe asdcp-test.cpp which
66 contains detailed usage examples of each of the API's services.
67 The KM_* files may be of interest for general development
68 support, but may be ignored if all you want is simple AS-DCP
71 Likewise, draft 2067-5 "IMF Essence Component" (AS-02) support
72 is entirely contained in AS-02.h
77 On more-or-less POSIX systems (OS X, Linux, and BSD), GNU make and
78 autotools are required to build asdcplib. The same configure script
79 will also build this package on Windows machines with Cygwin and
80 MinGW installed. For those Windows users who would prefer to build
81 this natively, an "nmake" build file and instructions can be found
82 in the win32 subdirectory.
84 OpenSSL is also required, any recent version should be fine. See
85 http://www.openssl.org/ for more information and download instructions.
87 Optional support for writing Timed Text Track Files is supported by
88 either Xerces-C or Expat. See http://xerces.apache.org/xerces-c/ or
89 http://expat.sourceforge.net/ for source and build instructions.
91 To configure and build, type './configure' followed by 'make'. There
92 are several test targets on the POSIX side, but you need to assemble
93 a set of test files to use them. AS-02 support can be enabled with
96 I have tested this build on win32, Linux, OpenBSD, and Darwin
97 platforms. Others may work as well.
104 asdcp-test - Writes, reads and verifies AS-DCP (MXF) track files.
106 asdcp-wrap - Writes AS-DCP (MXF) track files.
108 asdcp-unwrap - Extracts essence from AS-DCP (MXF) track files.
110 asdcp-info - Displays information about AS-DCP (MXF) track files.
112 asdcp-util - Calculates digests and generates random numbers and UUIDs.
114 as-02-wrap - Writes AS-02 Essence Component files.
116 as-02-unwrap - Extracts essence from AS-02 Essence Component files.
118 kmfilegen - Writes and verifies large files using a platform-
119 independent format. Use it to test issues related to large files.
121 kmuuidgen, kmrandgen - generate UUID values and random numbers.
123 wavesplit - Splits a WAVE file into two or more output files. Used
124 to untangle incorrectly-paired DCDM sound files.
126 blackwave - Write a WAVE file full of zeros, Used to make filler
127 tracks (though you would be better off modifying asdcp-test if
128 this is a common use case).
130 j2c-test - Displays information about JP2K codestreams.
135 The API documentation is mostly in AS_DCP.h. and AS_02.h Read those
136 files for a detailed description of the library's capabilities. Read
137 asdcp-*.cpp and as-02-*.cpp files for library usage examples. The
138 command-line utilities all respond to -h.
142 2014-10-2 - Bug fixes and enhancements, 2.2.6
143 o Fixed erroneous 377-4 MCA identifier in AS_DCP_PCM dump routine
144 o Fixed erroneous byte 13 in WaveAudioDescriptor_ReferenceAudioAlignmentLevel label
145 o Added missing implementation of -W option to as-02.unwrap
146 o Fixed erroneous use of d-cinema ChannelAssignment label in as-02-wrap
148 2014-10-01 - Bug fixes and enhancements, 2.2.5
149 o Finished AS-02 text wrap/unwrap
150 o Fixed fractional seconds parsing for Timestamp objects
151 o Updated KLVPacket to use 64-bit length; allows huge packets in AS-02 PCM files
152 o cleaned up use of atoi() in the library
154 2014-07-09 - Additional IMF/AS-02 support, bug fixes and enhancements, 2.1.4
155 o Added IMF App 2 edit rates in AS_02 namespace: EditRate_29_97,
157 o Revised AEC CBC context objects to copy the key rather than
158 keep the reference passed in to it.
159 o Addressed a bug that would allow unimpeded iteration of component
160 values in a JP2K::PictureDescriptor object.
161 o Addressed a bug that was incorrectly recording the sequence Duration
162 in MXF Track objects.
163 o Added ASDCP::AtmosSyncChannelMixer::AppendSilenceChannels()
164 o Added a QCD decoder to the j2c parser.
165 o Altered ASDCP::KLVPacket::HasUL() to use version-blind matching.
166 o Fixed an uninitialized variable in MemIOReader::ReadString() that
167 caused unbounded reads.
168 o Fixed broken ByteString::ArchiveLength() method
169 o Fixed broken version numbers on SoundfieldGroupLinkID and
170 GroupOfSoundfieldGroupsLinkID UL values.
171 o Added DBOXMotionCodePrimaryStream and DBOXMotionCodeSecondaryStream UL
172 values to the internal dictionary.
173 o Added optional prefix handling to MCA label generator.
174 o Re-factored MCA label generator to include additional
175 metadata (Thanks to Mike Radford).
176 o Added new options to as-02-wrap.
178 2014-01-06 – Additional IMF/AS-02 support, bug fixes 2.1.1
179 o Fixed missing-index-partion bugs for AS-02 files.
180 o Moved LocalFilenameResolver into the AS_DCP public API so that it
181 can be used by other modules including AS-02.
182 o Did further refactoring of AS-02 Writer classes to separate CBR
183 and VBR indexing implementations.
184 o Fixed wave wrapping UL in clip-wrapped AS-02 files. Renamed some
185 UL constants to reflect "clip" or "frame" wrapping.
186 o Re-factored JP2K_PDesc_to_MD() and MD_to_JP2K_PDesc() to work
187 with GenericPictureEssenceDescriptor objects.
188 o Fixed a bug that was suppressing PictureComponentSizing,
189 CodingStyleDefault and QuantizationDefault when writing the
190 essence descriptor in a JP2K file (AS-DCP and AS-02).
191 o Fixed the version byte on the following UL values:
192 StereoscopicPictureSubDescriptor
193 GenericPictureEssenceDescriptor_ColorPrimaries
194 GenericPictureEssenceDescriptor_ActiveHeight
195 GenericPictureEssenceDescriptor_ActiveWidth
196 GenericPictureEssenceDescriptor_ActiveXOffset
197 GenericPictureEssenceDescriptor_ActiveYOffset
198 o Added some essence descriptor options to as-02-wrap.
199 o Changed bit rate display in asdcp-info from mebi-bits/s to
201 o Added "SMPTE" / "Interop" format type display to asdcp-info.
202 o Improved integration of ST 377-4 MCA concepts with ST 429-2 static
204 o Modified asdcp-wrap to assume -L when wrapping timed-text (since
205 there is no MXF text wrapping for Interop.)
206 o Added new EssenceType_t values for IMF/AS-02 track files.
207 o Added detection for AS-02 track files to ASDCP::EssenceType()
208 o Changed lots of "const char*" to "const std::string&" in the
209 APIs defined by KM_fileio.h and AS_DCP.h.
210 o Fixed VBR Delta Segment entries to correctly flag progressive
212 o Fixed PCM unwrapping bugs in as-02-unwrap.
213 o Fixed missing return statement in ArchivableString::ArchiveLength
214 (thanks to both Kristof Provost and Franck Chopin)
215 o Fixed broken sample alignment in RF64Writer (thanks to Wolfgang
217 o Fixed win32 build (thanks to Dolby)
218 o fixed a bug that caused blackwave to only produce 96kHz WAV files.
219 (thanks to Stephane W)
222 2013-07-02 – IMF/AS-02 support, bug fixes 2.0.0
223 o Massive refactoring of internals to allow easier implementation
224 of AS-02. Some API changes were made as well (note that
225 OPAtomHeader is now OP1aHeader and RIP is no longer part of the
226 OP1aHeader.) If you are using this project as a library (and
227 especially if you are keeping patches against it) PLEASE TAKE
228 TIME TO EVALUATE THIS RELEASE THOUROUGHLY BEFORE ADDING IT TO
230 o Final integration of Fraunhoffer IIS code contribution. AS-02
231 files are now fully supported with some TODOs and two major
232 exceptions: LEAD indexes are not supported by the MXF writers
233 and interlace images are not yet supported.
234 o Added support for MCA labels (ST 428-12) to asdcp-wrap. Note
235 that this project is still in the early stages of interop testing
236 so errors are likely present and don't expect any server to
237 make use of this feature.
240 2013-07-01 - Bug fixes, enhancements 1.12.50
241 o Fixed missing return statement in ArchivableString::ArchiveLength
242 (thanks to both Kristof Provost and Franck Chopin)
243 o Fixed broken sample alignment in RF64Writer (thanks to Dolby)
244 o Fixed win32 build (thanks to Dolby)
247 2013-04-12 - Dolby Atmos support and more audio labels 1.11.49
248 o Significant code contribution from Dolby Laboratories to add
249 support for generic data track files as proposed in ST 21DC
250 and also Dolby Atmos track file support as a specialization.
251 o Added Dolby-contributed code to support generating the external
252 sync signal for d-cinema as proposed in ST 21DC.
253 o Added Dolby-contributed code to support RF64 WAVE files.
254 o Fixed UL error in ST 429-5 DM encoding (contributed by Dolby).
255 o Added ULs for ST 428-12 and Amd. 429-2 2013. Please check!
258 2013-02-20 - bug fixes, enhancements 1.10.48
259 o Refactored internals of the AS-DCP file readers. While no
260 changes in behavior are intended, users are cautioned to test
261 thouroughly before use in production.
262 o Fixed a bug in ReadAncillaryResource that was causing bogus HMAC
263 failures when reading resources from a file.
264 o Fixed premature-release bug in the Expat version of the XML parser.
265 Thanks to Carsten Feldheim (IIS) for the tip.
266 o Fixed -W option in asdcp-unwrap. Thanks to RGB.
267 o Added P-HFR support to asdcp-wrap (see URL for details:
268 http://isdcf.com/papers/ISDCF-HighFrameRate-DCP.pdf).
269 o Added support for SMPTE ST 428-21 "Archival Frame Rates".
270 o Added -P option to asdcp-wrap (inserts arbitrary UL into the
271 PictureEssenceCoding property when wrapping JP2K files.)
272 o Added support for 96 kHz files to blackwave.
273 o Added new path and string manglers to Kumu.
274 o Updated MCA ULs (I warned you...). Again please take some
275 time to proof this work against ST 477-4 including the latest
276 drafts of the registries.
277 Changed the version byte (8 0f 16) to 0x0e:
278 MCALabelSubDescriptor
279 AudioChannelLabelSubDescriptor
280 SoundfieldGroupLabelSubDescriptor
281 GroupOfSoundfieldGroupsLabelSubDescriptor
282 GroupOfSoundfieldGroupsLinkID
283 Changed bytes 8 and and 13 of SoundfieldGroupLinkID
284 Added items to the UL dictionary:
295 2012-08-07 - bug fix, 1.10.46
296 o Added missing zero-initializers to time values when parsing a
297 timestamp string (in the case where the optional [Thh:mm.[:ss]]
298 syntax is not present in an encoded string).
300 2012-03-06 - bug fixes, enhancements 1.9.45
301 o Removed ASDCP::Timestamp, all items that were of that class are now
302 of class Kumu::Timestamp
303 o Refactored Kumu::Timestamp to use KM_tai for internal representation
304 (replaced public Y M D, h, m, s variables)
305 o Refactored Kumu::Timestamp to use KM_tai for WIN32 builds
306 o Added UTC offset awareness to Kumu::Timestamp
307 o Replaced "long GetSecondsSinceEpoch(void) const" with
308 "ui64_t GetCTime() const"
309 o Corrected UL version segment in "7.1 DS" and "WTF" audio format
310 labels (corresponds with publication of ST 429-2:2011).
311 o Exposed MXF object interface (MXF.h, Metadata.h) via ASDCP MXFReader
312 and MXFWriter classes.
313 o Added UL values from ST 377-4:2012. >>>>NOTE: These are preliminary
314 values, subject to change upon final publication of not only ST 377-4
315 but also the relevant registries. This is a good time to compare them
316 to the standard and complain if you think they are wrong!
317 o Added MCALabelSubDescriptor, AudioChannelLabelSubDescriptor,
318 SoundfieldGroupLabelSubDescriptor, and
319 GroupOfSoundfieldGroupsLabelSubDescriptor (from ST 377-4:2012) to
321 o Changed some internals to make MXFWriter::OPAtomHeader() work correctly.
322 o Split asdcp-test into several different programs to help relieve
323 the impenetrable-list-of-arguments problem. asdcp-wrap, asdcp-unwrap
324 and asdcp-info take the place of asdcp-test's -c, -x and -i options,
325 respectively. asdcp-util contains the remaining functions. Note that
326 asdcp-test is now DEPRECATED, new functionality and bug fixes will be
327 aimed at the new tools. Also note that some options and calling
328 conventions are different for the new tools as compared to asdcp-test.
329 Please read the synopses and make sure you understand the new idioms.
330 o asdcp-wrap has a new argument, -C <UL>, that writes the given UL to the
331 ChannelAssignment item in the WaveAudioDescriptor (only useful when
332 writing PCM essence).
335 2011-11-30 - bug fixes v1.8.44
336 o Corrected a wrong decryption UL selection when unwrapping MXF.
339 2011-10-27 - bug fixes v1.8.43
340 o Corrected broken Essence UL matching. (Thanks to Michael Loder).
343 2011-08-31 - bug fixes v1.8.42
344 o Added missing HFR support for PCM essence reader/writer.
347 2011-08-30 - bug fixes, enhancements v1.8.41
348 o UL version byte now ignored when comparing UL values.
349 o Changed the version byte in the TimedTextEssence UL to 0x01. There
350 is no published Essence Keys registry so it can't have a maintained
352 o JP2K Sequence Parser modified to skip directory entries that
353 are not files in the case where the parser is initialized with
354 a directory path. When initialized with a list of file names
355 this check is not performed. Based on a hint by Steve Quartly.
356 o Increased the size of the MPEG header parser buffer.
357 o Added missing FrameType() implementation to ASDCP::MPEG2::MXFReader.
358 o Added missing Close() implementations to MXF reader classes.
359 o Added missing Timestamp::Timestamp(const char* datestr) implementation.
360 (Thanks to Matt Sheby for this and the previous three items.)
361 o Fixed error in Kumu::FortunaRNG::FillRandom() that was returning the
362 end of the random buffer instead of the front (Thanks to Mike Radford).
363 o Added support for proposed sound channel format identifiers
364 '7.1DS' and 'WTF'. Optimistically chose version '0x0c'.
365 o Added support for stereoscopic images in JP2K files at edit
366 rates of 48, 50 and 60 eups (96, 100 and 120 fps).
369 2010.11.15 - bug fixes, enhancements v1.7.40
370 o Fixed bug in long KLV packet support (Thanks to Jim Radford).
371 o Fixed AvgBps in PCM files, *again*. Sorry for the crazy.
372 o More fixes and changes in support of 25, 30, 50, 60 fps.
373 (Thanks to Hans K. for the TC rate bug).
374 o Updated KLVFill UL version element to 0x02.
375 o Type change to support Xerces-C 3.x. (Thanks to Matt Sheby).
376 o Some internal API changes to KLV types. Does not affect
378 o Added NetworkLocator type to MXF metadata types.
379 o Added file offset display to klvwalk.
382 2010.09.09 - bug fixes, enhancements, v1.7.39
383 o Fixed bug in JP2K PictureDescriptor initialization in
384 JP2K::MXFReader::OpenRead() and JP2K::MXFSReader::OpenRead()
385 o Once again fiddling with AvgBbs. How can something so simple
386 be such a constant cause of trouble? Tested with 1-, 2- and
387 6-channel input Wav files.
388 o asdcp-test now accepts a directory name when making PCM
389 files (-c). The directory name should be the only filename
390 argument. All files in the directory must be Wav files
391 (mixed channel sizes OK). Files are sorted alphabetically by
392 filename. Hint: use numeric name infix to define order:
401 2010.07.20 - bug fixes, v1.6.37
402 o Fixed TimedTextResourceSubDescriptor UL value.
405 2010.06.16 - bug fixes, v1.6.36
406 o Added support for new Edit Rates to asdcp-test.cpp.
407 o Expanded timed-text file reader in asdcp-test.cpp.
408 o Fixed large BER value encoding (plaintext) and decoding
409 (plaintext and ciphertext). This feature was introduced in
411 o Fixed AvgBps value for multi-channel Wave input.
414 2010.05.13 - bug fixes, enhancements, v1.6.34
415 o ST 429-5 files have corrected ULs for DCTimedTextDescriptor and
416 GenericStream DataElement. Files made with previous versions of
417 the library are incompatible with this and future versions.
418 o Fixed File Package TrackNumber values. Th
420 o Added edit rate constants to AS_DCP.h (25, 30, 50, 60).
421 o Changed AudioDescriptor "SampleRate" element name to "EditRate"
422 to make it consistent with the other types.
423 o Now builds with XercesC 3.x.
424 o KM_memio.h has better const behavior.
425 o Fixed a bug in KM_memio.h string archiving.
428 2010.01.05 - bug fixes, enhancements, v1.5.32
429 o Re-fixed swapped Interop and SMPTE OP Atom UL values. The swap
430 introduced in v1.5.31 was done in error.
431 o Added -z,-Z options to asdcp-test (j2c parameter checking)
432 o Reformed jp2k-test as j2c-test, added help and list processing,
433 added to standard install target.
436 2009.12.31 - bug fixes, enhancements, v1.5.31
437 o Fixed swapped Interop and SMPTE OP Atom UL values.
438 o Added get_BER_length_for_value() subroutine.
439 o Modified ASDCP::h__Writer::WriteEKLVPacket() to allow larger BER
440 lengths for KLV packets larger than 16 MB. This was required to
441 support large font files in the SMPTE 429-5 implementation.
444 2009.11.06 - bug fixes, enhancements, v1.5.29
445 o Fixed a bug that could cause HMAC values to be incorrectly
446 stored in MXF files. Files created with versions of asdcplib
447 prior to this version may have incorrect HMAC values.
448 o Improved handing of XML files for MXF wrapping.
449 o Jpeg2000 codestream EditRate and SampleRate mismatches
450 now warns instead of returning an error.
451 o Improved error handling in Jpeg2000 sequence parsing routines.
452 o Added two methods to Kumu::Timestamp, AddSeconds(), to add (or
453 subtract) seconds to a time value, and GetSecondsSinceEpoch()
454 to get the number of seconds since the unix epoch.
455 o Added new option to asdcp-test, '-a', to specify a UUID when
457 o Added support for specifying the intrinsic duration of MXF files
458 containing timed text.
459 o Added new option to wavesplit, '-i', to display WAV file metadata.
462 2009.05.21 - bug fixes, v.1.4.24
463 o Fixed a bug that caused incorrect SubDescriptors UL values to be
464 written into interop format MXF track files. Note that this involved
465 a substantial reorganization of MXF internals. Please test thoroughly
466 in your application before using in production. Note that this is a
467 significant bug fix and track files created with 1.4.22 may be incompatible
471 2009.04.09 - SMPTE format fixes, enhancements and bug fixes, v.1.4.22
472 o asdcplib now uses GNU autotools on POSIX systems to configure
473 and build. See "./configure" for details. Note that two options,
474 --enable-freedist and --with-python are not enabled in the free
475 version of asdcplib and should not be used.
476 o Added build option (CONFIG_RANDOM_UUID) to enable mixed case UUID
477 generation when environment variable KM_USE_RANDOM_UUID is defined.
478 o Fixed a condition that could cause an error to occur when wrapping
479 SMPTE format timed text track files that do not define a starting
481 o Updated ULs for SMPTE format track files.
482 o SampleRate added to JP2K metadata
483 o Support for wrapping 96kHz WAV files added.
484 o Updated ULs for audio channel formats (ChannelFormat)
485 o Updated font subdescriptor MIME Types for TimedText Trackfiles.
486 o Changed time implementation to support dates beyond Jan 19th, 2038.
487 o Xerces-C XML parser support added.
488 o New build method for Windows (see win32/README.txt for details).
489 o Added new functionality in Kumu to recursively create and delete files
490 and directories, and get free disk space for a given volume path.
491 o Added a method to Kumu::Timestamp, AddMinutes(), to add (or subtract)
492 minutes to a time value.
493 o Improved how Kumu::Timestamp parses timestamps with offsets.
494 o Fixed a bug that caused incorrect HMAC values to be calculated.
497 2008.02.16 - SMPTE format fixes, bug fixes v.1.3.18
498 o Added correct SMPTE UL for StereoscopicPictureSubDescriptor.
499 o Exposed JP2K metadata parser as ParseMetadataIntoDesc().
500 o Added simple stereoscopic framebuffer to support paired ReadFrame()
501 and WriteFrame() methods (allows simpler integration with other
503 o Improved detection of JPEG Interop stereoscopic files.
504 o Win32 build fixes (Thanks to Mike Crowe at DTS).
505 o Added the WITH_MD macro to the makefile. Set this value to one
506 to build Win32 with /MD[d] instead of /MT[d].
507 o The Generic Container UL has been added to the EssenceContainers
508 set in the header partition pack for encrypted files. It has always
509 been there in plaintext files.
510 - Below this point the changes are internal and should not affect you
511 unless you use Kumu directly.
512 o Major refactoring of KM_log.[h|cpp].
513 o Fixed buffer re-sizing issue in Kumu::ByteString.
514 o Replaced type IdentifierList with ArchivableList.
515 o Added COPYING file to the release bundle.
518 2007.12.13 - Bug fixes v.1.2.17
519 o Changed Result_t implementation to use int instead of long, which
520 was causing trouble on some 64 bit platforms.
521 o Fixed EKLV HMAC. NOTE: Breaks backward compatibility with older
522 Interop files. To validate these files, use asdcplib-1.1.14. This
523 should not cause too much trouble since files with broken and
524 non-broken HMAC have been in the wild for years without issue.
525 o Fixed HMAC sequence numbering in encrypted stereoscopic files.
526 o Finished stereoscopic test targets in the makefile.
527 o Fixed the win32 build, now expects VS2005 compiler by default,
528 use WITH_VC6=1 top get VC6 flags.
529 o Stereoscopic and Timed Text modes now have SMPTE UL values.
530 NOTE: SMPTE 429-5 and 429-10 are not yet published. It is possible
531 that these UL values may change before publication. Please use
532 caution when using these features for production work.
533 o Changed a bunch of symbol names in the 429-5 implementation to
534 better match the spec.
535 o Added -U option to asdcp-test to dump the UL library to stdout.
536 o Fixed erroneous placement of the PictureEssenceCoding UL in JP2K
537 files (Interop and SMPTE modes).
540 2007.10.22 - Timed Text, Stereoscopic Picture and Bug fixes v.1.2.16
541 o Significant API changes have been made. Please read all entries
542 in this changelog to be sure you understand the changes. Also
543 note that some changes have been made to LS_MXF_SMPTE files that
544 are incompatible with earlier releases (e.g., EKLV HMAC). If
545 you are looking for a stable interop release, use v.1.1.14.
546 o Fixed RFC 2104 HMAC implementation for LS_MXF_SMPTE only. The
547 broken implementation has been maintained for Interop mode.
548 o Added support for draft SMPTE 429-5 Timed Text Track File. This
549 is still waiting for official SMPTE ULs, so do not use it for
550 shipping products. An XML parser is needed to create a Timed
551 Text Track File; Expat is now an optional part of the build.
552 Make with WITH_XML_PARSER=1 to link with Expat. If you do not
553 link with expat, you will get an error when using the TimedText::
554 DCSubtitleParser class. See also S429-5-cgi.cpp for an example
555 that shows how to serve plaintext MXF file elements directly via
557 o Added support for draft SMPTE 429-10 Stereoscopic Picture Track
558 File, including the JPEG Interop version. This is still waiting
559 for official SMPTE ULs, so do not use it with LS_MXF_SMPTE for
561 o Refactored the following files as a side-effect of the above
562 work: AS_DCP_JP2K.cpp AS_DCP_MPEG2.cpp AS_DCP_PCM.cpp
563 AS_DCP_MXF.cpp AS_DCP_internal.h MXF.[h|cpp] MXFTypes.[h|cpp]
564 Metadata.[h|cpp] h__Reader.cpp h__Writer.cpp klvwalk.cpp.
565 WARNING: While significant effort has been extended to make sure
566 that these changes do not affect existing stable file support,
567 users are cautioned to test this release thouroughly.
568 o Added a large set of filesystem path manglers to KM_fileio.h. See
569 path-test.cpp for example usage. The path manglers have not yet
570 been tested on win32 platforms (they are currently used only by
571 the Timed Text module.
572 o The PathIsFile(), PathIsDirectory() and FileSize() subroutines
573 have been modified to accept const std::string& instead of
575 o Added namespace and parsing support (Expat) to Kumu::XMLElement
576 (currently used only for Timed Text support). Also added some
578 o Altered MXF::UTF16String to use mbtowc() and wctomb().
581 2007.03.31 - Bug fixes v.1.1.14
582 o Fixed KeyFrameOffset value in MPEG wrapping to have negative
583 value. This is probably not yet complete for handling all
584 types of GOPs. Please send chunks of MPEG-2 VES that you
585 find which break this. Thanks to Doremi.
586 ** no other file format changes in this release **
587 o Fixed error in RIP interpretation when reading arbitrary (i.e.,
589 o Fixed a memory leak in ASDCP::MXF::OPAtomHeader when used
590 in read mode. Thanks to Mahesh Bajaj for pointing out this
591 bug and the one above.
592 o Removed asserts from KM_fileio, replaced with RESULT_WRITEFAIL
593 return value statements.
594 o Added -s and -p to the makefile install target.
595 o Altered ByteString behavior to use target Length() in copy
596 operations (instead of Capacity()).
597 o Added new Set() method to ByteString.
598 o Fixed a bug in ByteString::Unarchive() that caused the operation
599 to fail when the buffer was smaller than the read (i.e., when
600 Capacity() was called).
601 o Added IdentifierList class to KM_util.h.
602 o Changed some Error() messages to Debug() in Wav.cpp
603 o Revived jp2k-test.cpp and asdcp-mem-test.cpp (they both had
607 2007.02.15 - Bug fixes v1.1.13
608 o Removed 'VDescObj->SampleRate.Numerator = VDesc.FrameRate;'
609 from MPEG2_VDesc_to_MD() in AS_DCP_MPEG2.cpp, was line 76.
610 o Added KM_TEST_NULL_STR_L() and KM_TEST_NULL_L() macros to
611 KM_log.h. These versions log the location of the null value.
612 Macros are now used in any module that includes KM_log.h.
613 o MPEG2 VES with run of zero values at the head is now OK.
614 o Increased VESHeaderBufSize to 16K.
615 o Added makefile support for local OpenSSL in ../openssl, if
617 o The Kumu::PathIs*() functions now return false if a null or
618 empty string is given (used to be an assert).
619 o Cleaned up the install target in the makefile.
620 o Fixed SMPTE 429-6 HMAC -- FIPS 186-2 implementation was
621 laughably incorrect. Thanks to Doremi for pointing this out.
622 o Removed default parameter to HMACContext::InitKey().
623 o Cleaned up messages and CLI arg handling in asdcp-test.
626 2006.11.19 - Mo better stuff v1.1.12
627 o Changed read-only Result_t accessor methods to const.
628 o Added Base64 (-B) option to kmrandgen.
629 o Removed 16-bit alignment restriction from kmrandgen.
630 o Improved WAV file extraction speed (Thanks to Jim Radford
631 for pointing this out).
632 o Added single-channel split for WAV extraction (asdcp-test -1).
633 o Fixed remainder bug in h__RNG::fill_rand().
636 2006.11.03 - Bug fixes v1.1.11
637 o Increased index table entry list size to 5000.
638 o Added length checking to TLV writer (returns error if TLV
639 payload exceeds 64kB).
640 o Fixed partition header and RIP errors related to 2-partition
641 files (MXF Interop mode).
642 o Added -t option to asdcp-test (SHA-1 digest with Base64 output
644 o Fixed Sub Descriptor reference bug (Thanks to Denis Leconte
645 for dogged determination).
646 o Added directory-of-wav detection to RawEssenceType()
647 o Modified MXF::Partition::AddChildObject() to only generate
648 a UUID if the InstanceID is unset.
649 o Added ComponentMaxRef & ComponentMinRef to RGBAEssenceDescriptor.
651 o Added detection of 2K/4K jp2c, writing correct 4K metadata.
654 2006.10.05 - Bug fixes v1.1.10
655 o Changed RM_RELEASE to RL_RELEASE in MXFTypes.h.
656 o Changed the MXF writer to use RL_RELEASE (was RL_DEVELOPMENT).
657 o Really fixed source reference chain.
658 o Updated JP2K file package label.
659 o Changed location of JPEG2000PictureSubDescriptor in the
660 header (was erroneously before Preface).
661 o Altered LS_MXF_INTEROP to produce 2-partition files.
664 2006.09.25 - Bug fixes v1.1.9
665 o Fixed SourcePackageID value. All files will be 'original',
666 i.e. SourcePackageID will be all zeros. Let me know if you
667 want to set SourcePackageID.
668 o Fixed compiler warnings on some Linux platforms
669 o Fixed the build so that BUILD_DIR is no longer created
671 o Added duration detection to the raw essence parsers. The
672 MPEG parser uses a nasty approximation so don't use it
673 without paying close attention to the result.
674 o Modified PCMParserList to make it more useful as a base
676 o Fixed bugs and re-organized command-line help in asdcp-test
678 o Fixed two-partition file reads.
679 o Fixed Win32 PRNG initialization.
680 o Renamed asdcp-lf-test as kmfilegen.
681 o Added kmrandgen and kmuuidgen.
682 o Added string retrieval mechanism to Result_t.
683 o Refactored Kumu::Identifier and its sub-classes.
684 o Altered Kumu::PathIsFile to return true when the path
685 is a symbolic link (unix only).
686 o Altered Kumu::FileWriter::OpenWrite to use file creation
687 mode 0664 (was 0644) (unix only).
688 o Added Kumu::WriteStringIntoFile() subroutine.
691 2006.04.05 - Bug fixes and new stuff v1.1.7
692 o Fixed a bug in the MPEG parser that caused it to fail when
693 handling start codes spanning buffer boundaries
694 o Added wavesplit and blackwave utility programs
695 o Added support for revised SMPTE HMAC key derivation when
697 o Refactored platform compatibility and general utilities
698 into a new sub-library "Kumu". There are no new build
699 steps or dependencies, but some important things have
701 + Result_t is no longer an enum, it is now a class.
702 Library result codes are now declared as const objects
705 const Kumu::Result_t RESULT_FORMAT (-101, "The file...");
707 The macros ASDCP_SUCCESS and ASDCP_FAILURE still work
708 the same way thanks to an operator overload for type long.
709 See KM_error.h for more information.
710 + The logging interface has been moved out of AS_DCP.h
712 o Some of the command line utilities that were using headers
713 other than AS_DCP.h have been changed to use the Kumu
714 equivalents. If you have code based on those utilities, you
715 will have to update by hand.
716 o Added new types to the EssenceType_t enum.
717 o The guard macro for Win32 code has changed from WIN32 to
721 2006.03.2x - new stuff
722 o Proper handling of stream-id byte of essence UL values
723 o writes 3-partition files, reads 2-part or 3-part
726 2006.03.16 - bug fixes plus
727 o Removed SMPTE_LABELS compile-time option. The reader will now
728 silently accept either SMPTE or MXF Interop labels, the writer
729 can be instructed which to use at runtime. Default is Interop.
730 o Added an AIFF reader. Support is preliminary, it works with the
731 AIFF files I have on hand.
732 o More code refactoring. More to come.
735 2006.03.09 - full read-write
736 o Removed ASDCP_WITHOUT_OPENSSL compile-time option.
737 o Full read/write now working on new MXF library
740 2005.00.00 - A New Hope
741 o The temporary mxf-lite has been removed. MXF files are now
742 managed via the objects in KLV.h, MXFTypes.h MXF.h and
743 Metadata.h. This release does not support writing MXF files.
744 o Fixed a header interpretation error in the Wav parser.
747 2005.00.00 - The Reformation
748 o Removed mxflib as a dependency by forking the necessary
749 functions and placing them in the mxf-lite subdirectory.
750 Please note that the very heavy modifications done here
751 render all comparisson to mxflib code a substantial task.
752 All errors are now mine and users are warned not to bug
753 Oliver or Matt for help with this code. The version of
754 mxflib at the time of the fork was: 0.5.1.3.
757 2005.06.03 - bug fixes v0.10.18
758 o Updated UL batch to include GC UL.
761 2005.05.27 - bug fixes v0.10.17
762 o Un-did essence container and compression descriptor changes.
763 The default build reflects MXF Interop decisions as of 26 May.
764 o Added note about build versions to README (see above).
765 o Added warnings to SMPTE_LABELS builds.
766 o Fixed JP2K essence container label.
769 2005.05.02 - bug fixes v0.10.16
770 o Reorganized internal files, added file reader object, added OS
771 portability header, removed and renamed some files. If you have a
772 patch against previous versions of the source, you should check
774 o Added RGBA attributes to JP2K descriptor.
775 o Changed interface to CodestreamParser.
776 o Added JP2K parser implementation. It is parsing each frame but is
777 not yet being used to populate the descriptor.
778 o Added 48fps option for `asdcp-test -p`.
779 o Added picture rate constants to AS_DCP.h (23.976, 24, 48).
780 o Added sample rate constant to AS_DCP.h (48k).
781 o Changed asdcp-test to encrypt picture headers by default
782 (plaintext offset will be 0), added -E option to allow
786 2005.04.28 - bug fixes v0.9.15
787 o The XML descriptors for the crypto DMS have moved in mxflib to
788 the file DMS_Crypto.xml (they were in DMS_DCPENC.xml). Older
789 installations should update the file from mxflib.
790 o Added Close() and Seek() to ~MyFileWriter(), cleaned up headers
791 o Added UUID generator output mode (-u).
792 o Added -S option to extract PCM essence into stereo wav files
793 o Added more UL testing and conformance checking.
794 o Added macro SMPTE_LABELS which causes the library to be built
795 with SMPTE (as opposed to MXF Interop) labels. This is not
796 set by default, and currently only affects the PCM container
797 label and encrypted element label.
798 o Cleaned up the GNUmakefile test targets, the source files
799 are now named with the TEST_FILE_PREFIX macro.
800 o enabled 23.976-framed PCM (2002 samples per frame)
801 o The size of the asdcp-test frame buffer for picture essence
802 may now be set from the command line (-b). The default is 4MB.
803 o h__Reader::ReadEKLVPacket() now tests the UL (duh) and switches
804 on the value, allowing plaintext and ciphertext frames to
805 be mixed in the file.
806 o Fixed error in UUID generator format.
807 o JP2K files now use the GenericPictureDescriptor to store
808 ContainerDuration and SampleRate. SampleRate is mapped
809 to EditRate in the PictureDescriptor struct. This fixes
810 the second caveat from the 0.8.13 release.
811 o Fxed bug in PCMParserList that was miscalculating the extent
812 of a PCM sample. This bug did not affect API users, it was
813 only present in asdcp-test.
814 o Fixed EditRate on PCM files (was showing sample rate)
815 o Fixed Encrypted Essence Container UL
816 o Fixed BlockAlign value for PCM essence
818 - The following changes were provided by Jeff Loewenguth
820 o Moved the DMS CryptographicFramework entry from the material
821 package to the source package
822 o Fixed erroneous Source Essence Container Label value
823 o Fixed broken sort of JP2K frames in JP2K parser
824 o Added FindFrameGOPStart() method to the MPEG2 MXFReader
825 o Added missing length values for EKLV packets without HMAC
826 o -x with JP2K essence writes to files with 6 digit names
828 o The Key ID may now be specified as an argument to asdcp-test
832 2004.12.30 - bug fixes + wav files v0.8.14
833 o Added WAV file write to asdcp-test (uses mxflib::waveheader_t).
834 o Three-partition files reading properly. adscplib still writes
836 o Changes in the mxflib WAV essence parser API had broken
837 asdcplib's ability to read essence from a WAV file. I have
838 fixed this bug, but at the expense of breaking compatibility
839 with older versions of mxflib. Beware!
840 o Removed redundant (but working) bin-text-bin conversions.
843 2004.12.23 - JPEG 2000 support v0.8.13
844 o Reads/writes JPEG 2000 essence in plaintext and ciphertext
845 with the following caveats:
846 - The Picture Essence Descriptor is empty.
847 - Because there is no essence descriptor, the reader code
848 in asdcp-test has no idea how many frames are in the file
849 and ends with an out-of-bounds frame error. This error
850 is being suppressed in asdcp-test for the current release.
851 o Still broken when reading three-partition files.
854 2004.10.22 - fixes and UL updates v0.7.11
855 WARNING: COMPATIBILITY BREAKPOINT
856 Files created with this and future versions of this library are
857 not compatible with previous versions of this library. As you
858 might suspect, files created with previous versions of this
859 library are not compatible with this and future versions.
861 o h__Reader will now open a three-partitition file (untested)
862 o Moved DMS from Material partition to File partition
863 o Added length fields to appropriate places in EKLV packet
866 2004.10.22 - fixes and UL updates v0.7.10
867 o fixed frame buffer handling of externally allocated buffer,
868 created unit test (asdcp-mem-test)
869 o added operator==() and operator!=() to Rational type
870 o fixed some type-related compiler warnings
871 o asdcp-test -p now works on unwrap
872 o updated some ULs to match documentation (thanks to Arun
874 o canonicalized line endings
877 2004.07.02 - full plaintext + ciphertext read/write v0.6.9
878 o HMAC, plaintext offest and raw ciphertext read supported
879 o back to proper CBR index
880 o MPEG temporal offset working
883 2004.07.01 - plaintext + ciphertext read/write v0.5.8
884 o encryption of MPEG and PCM essence supported with the
887 - no plaintext offest support
888 - no raw ciphertext read support
889 o moved to reflecting the whole KLV triplet in the CBR
890 index (now incompatible with mxflib, still searching
891 for info about what's "right")
892 o awaitng the following fixes/features:
893 - retrieve Temporal Offset from index in MPEG2::Reader
894 - test for correct ULs when reading frame triplets
895 - fix header metadata items for encrypted files
897 - plaintext offest support
898 - raw ciphertext read support
901 2004.06.14 - plaintext read/write w/key generator v0.4.5
902 o Project now uses OpenSSL (tested with 0.9.7d on win32, Linux, Darwin)
903 Use `make ASDCP_WITHOUT_OPENSSL=1` to make plaintext-only version
904 o Accepts interior I frames when parsing MPEG2 VES
905 o Improved error reporting on format errors
906 o Added support for encryption to asdcp-test
907 o Added RNG for asdcp-test (non-production use only, see notes in FortunaRNG.h)
908 o Implemented CBC encrypt, decrypt module
909 o Added partial TemporalOffset retrieval from MPEG2 parser
910 o Fixed win32 binmode bug
913 2004.05.12 - plaintext read/write v0.3.4
914 o Full read/write of plaintext MPEG-2 VES and WAV files
915 (does not yet support mux from or demux to 2 channel pairs)
916 o Builds with autoconf-based mxflib
917 o Added ASDCP_ prefix to macros
918 o Updated documentation, fixed documentation errors
919 o Simplified API for MXF writer setup
920 o Decoupled essence parsers from MXF writers
921 o added raw ciphertext support to FrameBuffer
922 o Cleaned up Get/Set naming confusion
923 o Added missing const qualifiers
926 2004.04.27 - preview release v0.2.1
927 o hasty release for quick review
928 o this release may not build with mxflib using autoconf.
929 o writes plaintext AS-DCP MPEG2 essence files
930 o tested under win32 and linux. FreeBSD and Darwin do not work
933 2004.02.04 - First release (v0.1.1):
934 o asdcp-test is mostly complete. It should correctly provide
935 access to the read and info capabilities of the library.
936 o The MPEG2 reader is functional but not fully tested.
937 o Some file format integrity tests remain to be coded.
938 o The PCM reader is mostly complete, I am having difficulty
939 getting a suitable test file from mxfwrap.
940 o The makefile creates a static library module. The API
941 will cleanly support a DSO (or DLL). Let me know if DSO
942 support is important to you.
943 o Nothing is thread safe. Thread safety was not a requirement
944 in the initial project definition. Thread safety may be added
945 above the mxflib/klvlib level. Let me know if it is important
947 o The files xmldict.xml and types.xml must be in the current
948 directory when the program is run. The files are supplied
949 with mxflib. Runtime location of the files is not currently
950 a project goal. Comments on how best to handle this situation
951 would be appreciated. See AS_DCP.cpp at init_mxf_types()
952 for a more detailed discussion.