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.
132 Experimental feature: Prototype for High Dynamic Range is a wrapper
133 for the IMF application that allows JPEG-2000 codestreams to be paired
134 with opaque blobs of metadata. AS-02 support must be enabled to
135 build this feature, so --enable-as-02 must be enabled if
136 --enable-phdr is to be used. The following executable programs will be
139 phdr-wrap - Writes AS-02 PHDR Essence Component files.
141 phdr-unwrap - Extracts essence from AS-02 PHDR Essence Component files.
146 The API documentation is mostly in AS_DCP.h. and AS_02.h Read those
147 files for a detailed description of the library's capabilities. Read
148 asdcp-*.cpp and as-02-*.cpp files for library usage examples. The
149 command-line utilities all respond to -h.
155 2015-02-23 - bug fixes
156 o Fixed a new bug introduced by the fix to large numbers of subtitle ancillary
158 o Added support for generic Aux Data (ST 429-14) to asdcp-wrap.
161 2015-02-19 - PHDR feature, bug fixes
162 o Modified PCMParser and PCMParserList to return partial frame buffers at the
163 end of a WAV input file. This was needed to allow wrapping all samples into
164 an AS-02 audio file (which is clip-wrapped) in the case where the input file
165 has an odd number of samples with respect to the frame buffer size being
166 used. If there is more than one input file the length of the last buffer
167 will be determined by PCMParserList to be the shortest of the input files.
168 Prior to this change, partial samples in an input WAV file have been
169 abandoned (i.e., not written out to the MXF file). As a result, AS-DCP
170 applications will have to decide whether to abandon the partial last frame
171 (usually detected by testing frame_buffer.Size() != frame_buffer.Capacity())
172 or write it to the MXF file. Programs written to the old API will write the
173 partial frame (i.e., new behavior.) This should not be harmful since the
174 remainder of the buffer is zeroed and the output file will contain one
175 additional edit unit compared to the previous version.
176 o asdcp-wrap has been modified to test for the partial buffer and by default
177 will complain and abandon the buffer (i.e., same behavior but with a warning
178 message.) A new command line switch (-g) alters this behavior and writes
179 the buffer to the MXF file (it still warns the user that this condition is
181 o as-02-wrap now wraps all samples from the input file to the MXF file. There
182 is no padding, the clip is exactly the set of samples from the input.
183 o as-02 unwrap is temporarily restricted to creating wav files that are
184 aligned with the frame buffer size. This means that the output file will
185 be longer than the original WAV input in the case where the input file has
186 an odd number of samples with respect to the frame buffer size being used.
187 The pad samples are zero (silence).
188 o Modified CalcFramesFromDurationInSamples() to increment the count by one for
189 the case where the input file has an odd number of samples with respect to
190 the frame buffer size being used (previously it truncated the odd samples.)
191 o Fixed ST 429-5 / ST 2067-5 wrapping to increase header space when ancillary
192 resources are present (fixes a bug that cause the header to overflow the
193 allotted space when large numbers of PNG files were present.)
194 o Refactored GetXMLDocType() to use the XML parser.
195 o Added ParseFirstFromString() method to Kumu::XMLElement
196 o Removed Kumu::StringIsXML from the API.
197 o Added ASDCP::MXF::RGBALayout type
198 o Added J2CLayout property to JPEG2000PictureSubDescriptor
199 o Changed km_token_split() to retain empty elements in the output list
200 o Added PHDR wrapping for AS-02.
201 o Added J2CLayout property to the JPEG2000PictureSubDescriptor. This
202 support is preliminary: the Raw data type is being used instead of
203 RGBALayout type, which will be in the next release.
206 2014-10-2 - Bug fixes and enhancements, 2.2.6
207 o Fixed erroneous 377-4 MCA identifier in AS_DCP_PCM dump routine
208 o Fixed erroneous byte 13 in
209 WaveAudioDescriptor_ReferenceAudioAlignmentLevel label
210 o Added missing implementation of -W option to as-02.unwrap
211 o Fixed erroneous use of d-cinema ChannelAssignment label in as-02-wrap
214 2014-10-01 - Bug fixes and enhancements, 2.2.5
215 o Finished AS-02 text wrap/unwrap
216 o Fixed fractional seconds parsing for Timestamp objects
217 o Updated KLVPacket to use 64-bit length; allows huge packets
219 o cleaned up use of atoi() in the library
222 2014-07-09 - Additional IMF/AS-02 support, bug fixes and enhancements, 2.1.4
223 o Added IMF App 2 edit rates in AS_02 namespace: EditRate_29_97,
225 o Revised AEC CBC context objects to copy the key rather than
226 keep the reference passed in to it.
227 o Addressed a bug that would allow unimpeded iteration of component
228 values in a JP2K::PictureDescriptor object.
229 o Addressed a bug that was incorrectly recording the sequence Duration
230 in MXF Track objects.
231 o Added ASDCP::AtmosSyncChannelMixer::AppendSilenceChannels()
232 o Added a QCD decoder to the j2c parser.
233 o Altered ASDCP::KLVPacket::HasUL() to use version-blind matching.
234 o Fixed an uninitialized variable in MemIOReader::ReadString() that
235 caused unbounded reads.
236 o Fixed broken ByteString::ArchiveLength() method
237 o Fixed broken version numbers on SoundfieldGroupLinkID and
238 GroupOfSoundfieldGroupsLinkID UL values.
239 o Added DBOXMotionCodePrimaryStream and DBOXMotionCodeSecondaryStream UL
240 values to the internal dictionary.
241 o Added optional prefix handling to MCA label generator.
242 o Re-factored MCA label generator to include additional
243 metadata (Thanks to Mike Radford).
244 o Added new options to as-02-wrap.
247 2014-01-06 – Additional IMF/AS-02 support, bug fixes 2.1.1
248 o Fixed missing-index-partion bugs for AS-02 files.
249 o Moved LocalFilenameResolver into the AS_DCP public API so that it
250 can be used by other modules including AS-02.
251 o Did further refactoring of AS-02 Writer classes to separate CBR
252 and VBR indexing implementations.
253 o Fixed wave wrapping UL in clip-wrapped AS-02 files. Renamed some
254 UL constants to reflect "clip" or "frame" wrapping.
255 o Re-factored JP2K_PDesc_to_MD() and MD_to_JP2K_PDesc() to work
256 with GenericPictureEssenceDescriptor objects.
257 o Fixed a bug that was suppressing PictureComponentSizing,
258 CodingStyleDefault and QuantizationDefault when writing the
259 essence descriptor in a JP2K file (AS-DCP and AS-02).
260 o Fixed the version byte on the following UL values:
261 StereoscopicPictureSubDescriptor
262 GenericPictureEssenceDescriptor_ColorPrimaries
263 GenericPictureEssenceDescriptor_ActiveHeight
264 GenericPictureEssenceDescriptor_ActiveWidth
265 GenericPictureEssenceDescriptor_ActiveXOffset
266 GenericPictureEssenceDescriptor_ActiveYOffset
267 o Added some essence descriptor options to as-02-wrap.
268 o Changed bit rate display in asdcp-info from mebi-bits/s to
270 o Added "SMPTE" / "Interop" format type display to asdcp-info.
271 o Improved integration of ST 377-4 MCA concepts with ST 429-2 static
273 o Modified asdcp-wrap to assume -L when wrapping timed-text (since
274 there is no MXF text wrapping for Interop.)
275 o Added new EssenceType_t values for IMF/AS-02 track files.
276 o Added detection for AS-02 track files to ASDCP::EssenceType()
277 o Changed lots of "const char*" to "const std::string&" in the
278 APIs defined by KM_fileio.h and AS_DCP.h.
279 o Fixed VBR Delta Segment entries to correctly flag progressive
281 o Fixed PCM unwrapping bugs in as-02-unwrap.
282 o Fixed missing return statement in ArchivableString::ArchiveLength
283 (thanks to both Kristof Provost and Franck Chopin)
284 o Fixed broken sample alignment in RF64Writer (thanks to Wolfgang
286 o Fixed win32 build (thanks to Dolby)
287 o fixed a bug that caused blackwave to only produce 96kHz WAV files.
288 (thanks to Stephane W)
291 2013-07-02 – IMF/AS-02 support, bug fixes 2.0.0
292 o Massive refactoring of internals to allow easier implementation
293 of AS-02. Some API changes were made as well (note that
294 OPAtomHeader is now OP1aHeader and RIP is no longer part of the
295 OP1aHeader.) If you are using this project as a library (and
296 especially if you are keeping patches against it) PLEASE TAKE
297 TIME TO EVALUATE THIS RELEASE THOUROUGHLY BEFORE ADDING IT TO
299 o Final integration of Fraunhoffer IIS code contribution. AS-02
300 files are now fully supported with some TODOs and two major
301 exceptions: LEAD indexes are not supported by the MXF writers
302 and interlace images are not yet supported.
303 o Added support for MCA labels (ST 428-12) to asdcp-wrap. Note
304 that this project is still in the early stages of interop testing
305 so errors are likely present and don't expect any server to
306 make use of this feature.
309 2013-07-01 - Bug fixes, enhancements 1.12.50
310 o Fixed missing return statement in ArchivableString::ArchiveLength
311 (thanks to both Kristof Provost and Franck Chopin)
312 o Fixed broken sample alignment in RF64Writer (thanks to Dolby)
313 o Fixed win32 build (thanks to Dolby)
316 2013-04-12 - Dolby Atmos support and more audio labels 1.11.49
317 o Significant code contribution from Dolby Laboratories to add
318 support for generic data track files as proposed in ST 21DC
319 and also Dolby Atmos track file support as a specialization.
320 o Added Dolby-contributed code to support generating the external
321 sync signal for d-cinema as proposed in ST 21DC.
322 o Added Dolby-contributed code to support RF64 WAVE files.
323 o Fixed UL error in ST 429-5 DM encoding (contributed by Dolby).
324 o Added ULs for ST 428-12 and Amd. 429-2 2013. Please check!
327 2013-02-20 - bug fixes, enhancements 1.10.48
328 o Refactored internals of the AS-DCP file readers. While no
329 changes in behavior are intended, users are cautioned to test
330 thouroughly before use in production.
331 o Fixed a bug in ReadAncillaryResource that was causing bogus HMAC
332 failures when reading resources from a file.
333 o Fixed premature-release bug in the Expat version of the XML parser.
334 Thanks to Carsten Feldheim (IIS) for the tip.
335 o Fixed -W option in asdcp-unwrap. Thanks to RGB.
336 o Added P-HFR support to asdcp-wrap (see URL for details:
337 http://isdcf.com/papers/ISDCF-HighFrameRate-DCP.pdf).
338 o Added support for SMPTE ST 428-21 "Archival Frame Rates".
339 o Added -P option to asdcp-wrap (inserts arbitrary UL into the
340 PictureEssenceCoding property when wrapping JP2K files.)
341 o Added support for 96 kHz files to blackwave.
342 o Added new path and string manglers to Kumu.
343 o Updated MCA ULs (I warned you...). Again please take some
344 time to proof this work against ST 477-4 including the latest
345 drafts of the registries.
346 Changed the version byte (8 0f 16) to 0x0e:
347 MCALabelSubDescriptor
348 AudioChannelLabelSubDescriptor
349 SoundfieldGroupLabelSubDescriptor
350 GroupOfSoundfieldGroupsLabelSubDescriptor
351 GroupOfSoundfieldGroupsLinkID
352 Changed bytes 8 and and 13 of SoundfieldGroupLinkID
353 Added items to the UL dictionary:
364 2012-08-07 - bug fix, 1.10.46
365 o Added missing zero-initializers to time values when parsing a
366 timestamp string (in the case where the optional [Thh:mm.[:ss]]
367 syntax is not present in an encoded string).
369 2012-03-06 - bug fixes, enhancements 1.9.45
370 o Removed ASDCP::Timestamp, all items that were of that class are now
371 of class Kumu::Timestamp
372 o Refactored Kumu::Timestamp to use KM_tai for internal representation
373 (replaced public Y M D, h, m, s variables)
374 o Refactored Kumu::Timestamp to use KM_tai for WIN32 builds
375 o Added UTC offset awareness to Kumu::Timestamp
376 o Replaced "long GetSecondsSinceEpoch(void) const" with
377 "ui64_t GetCTime() const"
378 o Corrected UL version segment in "7.1 DS" and "WTF" audio format
379 labels (corresponds with publication of ST 429-2:2011).
380 o Exposed MXF object interface (MXF.h, Metadata.h) via ASDCP MXFReader
381 and MXFWriter classes.
382 o Added UL values from ST 377-4:2012. >>>>NOTE: These are preliminary
383 values, subject to change upon final publication of not only ST 377-4
384 but also the relevant registries. This is a good time to compare them
385 to the standard and complain if you think they are wrong!
386 o Added MCALabelSubDescriptor, AudioChannelLabelSubDescriptor,
387 SoundfieldGroupLabelSubDescriptor, and
388 GroupOfSoundfieldGroupsLabelSubDescriptor (from ST 377-4:2012) to
390 o Changed some internals to make MXFWriter::OPAtomHeader() work correctly.
391 o Split asdcp-test into several different programs to help relieve
392 the impenetrable-list-of-arguments problem. asdcp-wrap, asdcp-unwrap
393 and asdcp-info take the place of asdcp-test's -c, -x and -i options,
394 respectively. asdcp-util contains the remaining functions. Note that
395 asdcp-test is now DEPRECATED, new functionality and bug fixes will be
396 aimed at the new tools. Also note that some options and calling
397 conventions are different for the new tools as compared to asdcp-test.
398 Please read the synopses and make sure you understand the new idioms.
399 o asdcp-wrap has a new argument, -C <UL>, that writes the given UL to the
400 ChannelAssignment item in the WaveAudioDescriptor (only useful when
401 writing PCM essence).
404 2011-11-30 - bug fixes v1.8.44
405 o Corrected a wrong decryption UL selection when unwrapping MXF.
408 2011-10-27 - bug fixes v1.8.43
409 o Corrected broken Essence UL matching. (Thanks to Michael Loder).
412 2011-08-31 - bug fixes v1.8.42
413 o Added missing HFR support for PCM essence reader/writer.
416 2011-08-30 - bug fixes, enhancements v1.8.41
417 o UL version byte now ignored when comparing UL values.
418 o Changed the version byte in the TimedTextEssence UL to 0x01. There
419 is no published Essence Keys registry so it can't have a maintained
421 o JP2K Sequence Parser modified to skip directory entries that
422 are not files in the case where the parser is initialized with
423 a directory path. When initialized with a list of file names
424 this check is not performed. Based on a hint by Steve Quartly.
425 o Increased the size of the MPEG header parser buffer.
426 o Added missing FrameType() implementation to ASDCP::MPEG2::MXFReader.
427 o Added missing Close() implementations to MXF reader classes.
428 o Added missing Timestamp::Timestamp(const char* datestr) implementation.
429 (Thanks to Matt Sheby for this and the previous three items.)
430 o Fixed error in Kumu::FortunaRNG::FillRandom() that was returning the
431 end of the random buffer instead of the front (Thanks to Mike Radford).
432 o Added support for proposed sound channel format identifiers
433 '7.1DS' and 'WTF'. Optimistically chose version '0x0c'.
434 o Added support for stereoscopic images in JP2K files at edit
435 rates of 48, 50 and 60 eups (96, 100 and 120 fps).
438 2010.11.15 - bug fixes, enhancements v1.7.40
439 o Fixed bug in long KLV packet support (Thanks to Jim Radford).
440 o Fixed AvgBps in PCM files, *again*. Sorry for the crazy.
441 o More fixes and changes in support of 25, 30, 50, 60 fps.
442 (Thanks to Hans K. for the TC rate bug).
443 o Updated KLVFill UL version element to 0x02.
444 o Type change to support Xerces-C 3.x. (Thanks to Matt Sheby).
445 o Some internal API changes to KLV types. Does not affect
447 o Added NetworkLocator type to MXF metadata types.
448 o Added file offset display to klvwalk.
451 2010.09.09 - bug fixes, enhancements, v1.7.39
452 o Fixed bug in JP2K PictureDescriptor initialization in
453 JP2K::MXFReader::OpenRead() and JP2K::MXFSReader::OpenRead()
454 o Once again fiddling with AvgBbs. How can something so simple
455 be such a constant cause of trouble? Tested with 1-, 2- and
456 6-channel input Wav files.
457 o asdcp-test now accepts a directory name when making PCM
458 files (-c). The directory name should be the only filename
459 argument. All files in the directory must be Wav files
460 (mixed channel sizes OK). Files are sorted alphabetically by
461 filename. Hint: use numeric name infix to define order:
470 2010.07.20 - bug fixes, v1.6.37
471 o Fixed TimedTextResourceSubDescriptor UL value.
474 2010.06.16 - bug fixes, v1.6.36
475 o Added support for new Edit Rates to asdcp-test.cpp.
476 o Expanded timed-text file reader in asdcp-test.cpp.
477 o Fixed large BER value encoding (plaintext) and decoding
478 (plaintext and ciphertext). This feature was introduced in
480 o Fixed AvgBps value for multi-channel Wave input.
483 2010.05.13 - bug fixes, enhancements, v1.6.34
484 o ST 429-5 files have corrected ULs for DCTimedTextDescriptor and
485 GenericStream DataElement. Files made with previous versions of
486 the library are incompatible with this and future versions.
487 o Fixed File Package TrackNumber values. Th
489 o Added edit rate constants to AS_DCP.h (25, 30, 50, 60).
490 o Changed AudioDescriptor "SampleRate" element name to "EditRate"
491 to make it consistent with the other types.
492 o Now builds with XercesC 3.x.
493 o KM_memio.h has better const behavior.
494 o Fixed a bug in KM_memio.h string archiving.
497 2010.01.05 - bug fixes, enhancements, v1.5.32
498 o Re-fixed swapped Interop and SMPTE OP Atom UL values. The swap
499 introduced in v1.5.31 was done in error.
500 o Added -z,-Z options to asdcp-test (j2c parameter checking)
501 o Reformed jp2k-test as j2c-test, added help and list processing,
502 added to standard install target.
505 2009.12.31 - bug fixes, enhancements, v1.5.31
506 o Fixed swapped Interop and SMPTE OP Atom UL values.
507 o Added get_BER_length_for_value() subroutine.
508 o Modified ASDCP::h__Writer::WriteEKLVPacket() to allow larger BER
509 lengths for KLV packets larger than 16 MB. This was required to
510 support large font files in the SMPTE 429-5 implementation.
513 2009.11.06 - bug fixes, enhancements, v1.5.29
514 o Fixed a bug that could cause HMAC values to be incorrectly
515 stored in MXF files. Files created with versions of asdcplib
516 prior to this version may have incorrect HMAC values.
517 o Improved handing of XML files for MXF wrapping.
518 o Jpeg2000 codestream EditRate and SampleRate mismatches
519 now warns instead of returning an error.
520 o Improved error handling in Jpeg2000 sequence parsing routines.
521 o Added two methods to Kumu::Timestamp, AddSeconds(), to add (or
522 subtract) seconds to a time value, and GetSecondsSinceEpoch()
523 to get the number of seconds since the unix epoch.
524 o Added new option to asdcp-test, '-a', to specify a UUID when
526 o Added support for specifying the intrinsic duration of MXF files
527 containing timed text.
528 o Added new option to wavesplit, '-i', to display WAV file metadata.
531 2009.05.21 - bug fixes, v.1.4.24
532 o Fixed a bug that caused incorrect SubDescriptors UL values to be
533 written into interop format MXF track files. Note that this involved
534 a substantial reorganization of MXF internals. Please test thoroughly
535 in your application before using in production. Note that this is a
536 significant bug fix and track files created with 1.4.22 may be incompatible
540 2009.04.09 - SMPTE format fixes, enhancements and bug fixes, v.1.4.22
541 o asdcplib now uses GNU autotools on POSIX systems to configure
542 and build. See "./configure" for details. Note that two options,
543 --enable-freedist and --with-python are not enabled in the free
544 version of asdcplib and should not be used.
545 o Added build option (CONFIG_RANDOM_UUID) to enable mixed case UUID
546 generation when environment variable KM_USE_RANDOM_UUID is defined.
547 o Fixed a condition that could cause an error to occur when wrapping
548 SMPTE format timed text track files that do not define a starting
550 o Updated ULs for SMPTE format track files.
551 o SampleRate added to JP2K metadata
552 o Support for wrapping 96kHz WAV files added.
553 o Updated ULs for audio channel formats (ChannelFormat)
554 o Updated font subdescriptor MIME Types for TimedText Trackfiles.
555 o Changed time implementation to support dates beyond Jan 19th, 2038.
556 o Xerces-C XML parser support added.
557 o New build method for Windows (see win32/README.txt for details).
558 o Added new functionality in Kumu to recursively create and delete files
559 and directories, and get free disk space for a given volume path.
560 o Added a method to Kumu::Timestamp, AddMinutes(), to add (or subtract)
561 minutes to a time value.
562 o Improved how Kumu::Timestamp parses timestamps with offsets.
563 o Fixed a bug that caused incorrect HMAC values to be calculated.
566 2008.02.16 - SMPTE format fixes, bug fixes v.1.3.18
567 o Added correct SMPTE UL for StereoscopicPictureSubDescriptor.
568 o Exposed JP2K metadata parser as ParseMetadataIntoDesc().
569 o Added simple stereoscopic framebuffer to support paired ReadFrame()
570 and WriteFrame() methods (allows simpler integration with other
572 o Improved detection of JPEG Interop stereoscopic files.
573 o Win32 build fixes (Thanks to Mike Crowe at DTS).
574 o Added the WITH_MD macro to the makefile. Set this value to one
575 to build Win32 with /MD[d] instead of /MT[d].
576 o The Generic Container UL has been added to the EssenceContainers
577 set in the header partition pack for encrypted files. It has always
578 been there in plaintext files.
579 - Below this point the changes are internal and should not affect you
580 unless you use Kumu directly.
581 o Major refactoring of KM_log.[h|cpp].
582 o Fixed buffer re-sizing issue in Kumu::ByteString.
583 o Replaced type IdentifierList with ArchivableList.
584 o Added COPYING file to the release bundle.
587 2007.12.13 - Bug fixes v.1.2.17
588 o Changed Result_t implementation to use int instead of long, which
589 was causing trouble on some 64 bit platforms.
590 o Fixed EKLV HMAC. NOTE: Breaks backward compatibility with older
591 Interop files. To validate these files, use asdcplib-1.1.14. This
592 should not cause too much trouble since files with broken and
593 non-broken HMAC have been in the wild for years without issue.
594 o Fixed HMAC sequence numbering in encrypted stereoscopic files.
595 o Finished stereoscopic test targets in the makefile.
596 o Fixed the win32 build, now expects VS2005 compiler by default,
597 use WITH_VC6=1 top get VC6 flags.
598 o Stereoscopic and Timed Text modes now have SMPTE UL values.
599 NOTE: SMPTE 429-5 and 429-10 are not yet published. It is possible
600 that these UL values may change before publication. Please use
601 caution when using these features for production work.
602 o Changed a bunch of symbol names in the 429-5 implementation to
603 better match the spec.
604 o Added -U option to asdcp-test to dump the UL library to stdout.
605 o Fixed erroneous placement of the PictureEssenceCoding UL in JP2K
606 files (Interop and SMPTE modes).
609 2007.10.22 - Timed Text, Stereoscopic Picture and Bug fixes v.1.2.16
610 o Significant API changes have been made. Please read all entries
611 in this changelog to be sure you understand the changes. Also
612 note that some changes have been made to LS_MXF_SMPTE files that
613 are incompatible with earlier releases (e.g., EKLV HMAC). If
614 you are looking for a stable interop release, use v.1.1.14.
615 o Fixed RFC 2104 HMAC implementation for LS_MXF_SMPTE only. The
616 broken implementation has been maintained for Interop mode.
617 o Added support for draft SMPTE 429-5 Timed Text Track File. This
618 is still waiting for official SMPTE ULs, so do not use it for
619 shipping products. An XML parser is needed to create a Timed
620 Text Track File; Expat is now an optional part of the build.
621 Make with WITH_XML_PARSER=1 to link with Expat. If you do not
622 link with expat, you will get an error when using the TimedText::
623 DCSubtitleParser class. See also S429-5-cgi.cpp for an example
624 that shows how to serve plaintext MXF file elements directly via
626 o Added support for draft SMPTE 429-10 Stereoscopic Picture Track
627 File, including the JPEG Interop version. This is still waiting
628 for official SMPTE ULs, so do not use it with LS_MXF_SMPTE for
630 o Refactored the following files as a side-effect of the above
631 work: AS_DCP_JP2K.cpp AS_DCP_MPEG2.cpp AS_DCP_PCM.cpp
632 AS_DCP_MXF.cpp AS_DCP_internal.h MXF.[h|cpp] MXFTypes.[h|cpp]
633 Metadata.[h|cpp] h__Reader.cpp h__Writer.cpp klvwalk.cpp.
634 WARNING: While significant effort has been extended to make sure
635 that these changes do not affect existing stable file support,
636 users are cautioned to test this release thouroughly.
637 o Added a large set of filesystem path manglers to KM_fileio.h. See
638 path-test.cpp for example usage. The path manglers have not yet
639 been tested on win32 platforms (they are currently used only by
640 the Timed Text module.
641 o The PathIsFile(), PathIsDirectory() and FileSize() subroutines
642 have been modified to accept const std::string& instead of
644 o Added namespace and parsing support (Expat) to Kumu::XMLElement
645 (currently used only for Timed Text support). Also added some
647 o Altered MXF::UTF16String to use mbtowc() and wctomb().
650 2007.03.31 - Bug fixes v.1.1.14
651 o Fixed KeyFrameOffset value in MPEG wrapping to have negative
652 value. This is probably not yet complete for handling all
653 types of GOPs. Please send chunks of MPEG-2 VES that you
654 find which break this. Thanks to Doremi.
655 ** no other file format changes in this release **
656 o Fixed error in RIP interpretation when reading arbitrary (i.e.,
658 o Fixed a memory leak in ASDCP::MXF::OPAtomHeader when used
659 in read mode. Thanks to Mahesh Bajaj for pointing out this
660 bug and the one above.
661 o Removed asserts from KM_fileio, replaced with RESULT_WRITEFAIL
662 return value statements.
663 o Added -s and -p to the makefile install target.
664 o Altered ByteString behavior to use target Length() in copy
665 operations (instead of Capacity()).
666 o Added new Set() method to ByteString.
667 o Fixed a bug in ByteString::Unarchive() that caused the operation
668 to fail when the buffer was smaller than the read (i.e., when
669 Capacity() was called).
670 o Added IdentifierList class to KM_util.h.
671 o Changed some Error() messages to Debug() in Wav.cpp
672 o Revived jp2k-test.cpp and asdcp-mem-test.cpp (they both had
676 2007.02.15 - Bug fixes v1.1.13
677 o Removed 'VDescObj->SampleRate.Numerator = VDesc.FrameRate;'
678 from MPEG2_VDesc_to_MD() in AS_DCP_MPEG2.cpp, was line 76.
679 o Added KM_TEST_NULL_STR_L() and KM_TEST_NULL_L() macros to
680 KM_log.h. These versions log the location of the null value.
681 Macros are now used in any module that includes KM_log.h.
682 o MPEG2 VES with run of zero values at the head is now OK.
683 o Increased VESHeaderBufSize to 16K.
684 o Added makefile support for local OpenSSL in ../openssl, if
686 o The Kumu::PathIs*() functions now return false if a null or
687 empty string is given (used to be an assert).
688 o Cleaned up the install target in the makefile.
689 o Fixed SMPTE 429-6 HMAC -- FIPS 186-2 implementation was
690 laughably incorrect. Thanks to Doremi for pointing this out.
691 o Removed default parameter to HMACContext::InitKey().
692 o Cleaned up messages and CLI arg handling in asdcp-test.
695 2006.11.19 - Mo better stuff v1.1.12
696 o Changed read-only Result_t accessor methods to const.
697 o Added Base64 (-B) option to kmrandgen.
698 o Removed 16-bit alignment restriction from kmrandgen.
699 o Improved WAV file extraction speed (Thanks to Jim Radford
700 for pointing this out).
701 o Added single-channel split for WAV extraction (asdcp-test -1).
702 o Fixed remainder bug in h__RNG::fill_rand().
705 2006.11.03 - Bug fixes v1.1.11
706 o Increased index table entry list size to 5000.
707 o Added length checking to TLV writer (returns error if TLV
708 payload exceeds 64kB).
709 o Fixed partition header and RIP errors related to 2-partition
710 files (MXF Interop mode).
711 o Added -t option to asdcp-test (SHA-1 digest with Base64 output
713 o Fixed Sub Descriptor reference bug (Thanks to Denis Leconte
714 for dogged determination).
715 o Added directory-of-wav detection to RawEssenceType()
716 o Modified MXF::Partition::AddChildObject() to only generate
717 a UUID if the InstanceID is unset.
718 o Added ComponentMaxRef & ComponentMinRef to RGBAEssenceDescriptor.
720 o Added detection of 2K/4K jp2c, writing correct 4K metadata.
723 2006.10.05 - Bug fixes v1.1.10
724 o Changed RM_RELEASE to RL_RELEASE in MXFTypes.h.
725 o Changed the MXF writer to use RL_RELEASE (was RL_DEVELOPMENT).
726 o Really fixed source reference chain.
727 o Updated JP2K file package label.
728 o Changed location of JPEG2000PictureSubDescriptor in the
729 header (was erroneously before Preface).
730 o Altered LS_MXF_INTEROP to produce 2-partition files.
733 2006.09.25 - Bug fixes v1.1.9
734 o Fixed SourcePackageID value. All files will be 'original',
735 i.e. SourcePackageID will be all zeros. Let me know if you
736 want to set SourcePackageID.
737 o Fixed compiler warnings on some Linux platforms
738 o Fixed the build so that BUILD_DIR is no longer created
740 o Added duration detection to the raw essence parsers. The
741 MPEG parser uses a nasty approximation so don't use it
742 without paying close attention to the result.
743 o Modified PCMParserList to make it more useful as a base
745 o Fixed bugs and re-organized command-line help in asdcp-test
747 o Fixed two-partition file reads.
748 o Fixed Win32 PRNG initialization.
749 o Renamed asdcp-lf-test as kmfilegen.
750 o Added kmrandgen and kmuuidgen.
751 o Added string retrieval mechanism to Result_t.
752 o Refactored Kumu::Identifier and its sub-classes.
753 o Altered Kumu::PathIsFile to return true when the path
754 is a symbolic link (unix only).
755 o Altered Kumu::FileWriter::OpenWrite to use file creation
756 mode 0664 (was 0644) (unix only).
757 o Added Kumu::WriteStringIntoFile() subroutine.
760 2006.04.05 - Bug fixes and new stuff v1.1.7
761 o Fixed a bug in the MPEG parser that caused it to fail when
762 handling start codes spanning buffer boundaries
763 o Added wavesplit and blackwave utility programs
764 o Added support for revised SMPTE HMAC key derivation when
766 o Refactored platform compatibility and general utilities
767 into a new sub-library "Kumu". There are no new build
768 steps or dependencies, but some important things have
770 + Result_t is no longer an enum, it is now a class.
771 Library result codes are now declared as const objects
774 const Kumu::Result_t RESULT_FORMAT (-101, "The file...");
776 The macros ASDCP_SUCCESS and ASDCP_FAILURE still work
777 the same way thanks to an operator overload for type long.
778 See KM_error.h for more information.
779 + The logging interface has been moved out of AS_DCP.h
781 o Some of the command line utilities that were using headers
782 other than AS_DCP.h have been changed to use the Kumu
783 equivalents. If you have code based on those utilities, you
784 will have to update by hand.
785 o Added new types to the EssenceType_t enum.
786 o The guard macro for Win32 code has changed from WIN32 to
790 2006.03.2x - new stuff
791 o Proper handling of stream-id byte of essence UL values
792 o writes 3-partition files, reads 2-part or 3-part
795 2006.03.16 - bug fixes plus
796 o Removed SMPTE_LABELS compile-time option. The reader will now
797 silently accept either SMPTE or MXF Interop labels, the writer
798 can be instructed which to use at runtime. Default is Interop.
799 o Added an AIFF reader. Support is preliminary, it works with the
800 AIFF files I have on hand.
801 o More code refactoring. More to come.
804 2006.03.09 - full read-write
805 o Removed ASDCP_WITHOUT_OPENSSL compile-time option.
806 o Full read/write now working on new MXF library
809 2005.00.00 - A New Hope
810 o The temporary mxf-lite has been removed. MXF files are now
811 managed via the objects in KLV.h, MXFTypes.h MXF.h and
812 Metadata.h. This release does not support writing MXF files.
813 o Fixed a header interpretation error in the Wav parser.
816 2005.00.00 - The Reformation
817 o Removed mxflib as a dependency by forking the necessary
818 functions and placing them in the mxf-lite subdirectory.
819 Please note that the very heavy modifications done here
820 render all comparisson to mxflib code a substantial task.
821 All errors are now mine and users are warned not to bug
822 Oliver or Matt for help with this code. The version of
823 mxflib at the time of the fork was: 0.5.1.3.
826 2005.06.03 - bug fixes v0.10.18
827 o Updated UL batch to include GC UL.
830 2005.05.27 - bug fixes v0.10.17
831 o Un-did essence container and compression descriptor changes.
832 The default build reflects MXF Interop decisions as of 26 May.
833 o Added note about build versions to README (see above).
834 o Added warnings to SMPTE_LABELS builds.
835 o Fixed JP2K essence container label.
838 2005.05.02 - bug fixes v0.10.16
839 o Reorganized internal files, added file reader object, added OS
840 portability header, removed and renamed some files. If you have a
841 patch against previous versions of the source, you should check
843 o Added RGBA attributes to JP2K descriptor.
844 o Changed interface to CodestreamParser.
845 o Added JP2K parser implementation. It is parsing each frame but is
846 not yet being used to populate the descriptor.
847 o Added 48fps option for `asdcp-test -p`.
848 o Added picture rate constants to AS_DCP.h (23.976, 24, 48).
849 o Added sample rate constant to AS_DCP.h (48k).
850 o Changed asdcp-test to encrypt picture headers by default
851 (plaintext offset will be 0), added -E option to allow
855 2005.04.28 - bug fixes v0.9.15
856 o The XML descriptors for the crypto DMS have moved in mxflib to
857 the file DMS_Crypto.xml (they were in DMS_DCPENC.xml). Older
858 installations should update the file from mxflib.
859 o Added Close() and Seek() to ~MyFileWriter(), cleaned up headers
860 o Added UUID generator output mode (-u).
861 o Added -S option to extract PCM essence into stereo wav files
862 o Added more UL testing and conformance checking.
863 o Added macro SMPTE_LABELS which causes the library to be built
864 with SMPTE (as opposed to MXF Interop) labels. This is not
865 set by default, and currently only affects the PCM container
866 label and encrypted element label.
867 o Cleaned up the GNUmakefile test targets, the source files
868 are now named with the TEST_FILE_PREFIX macro.
869 o enabled 23.976-framed PCM (2002 samples per frame)
870 o The size of the asdcp-test frame buffer for picture essence
871 may now be set from the command line (-b). The default is 4MB.
872 o h__Reader::ReadEKLVPacket() now tests the UL (duh) and switches
873 on the value, allowing plaintext and ciphertext frames to
874 be mixed in the file.
875 o Fixed error in UUID generator format.
876 o JP2K files now use the GenericPictureDescriptor to store
877 ContainerDuration and SampleRate. SampleRate is mapped
878 to EditRate in the PictureDescriptor struct. This fixes
879 the second caveat from the 0.8.13 release.
880 o Fxed bug in PCMParserList that was miscalculating the extent
881 of a PCM sample. This bug did not affect API users, it was
882 only present in asdcp-test.
883 o Fixed EditRate on PCM files (was showing sample rate)
884 o Fixed Encrypted Essence Container UL
885 o Fixed BlockAlign value for PCM essence
887 - The following changes were provided by Jeff Loewenguth
889 o Moved the DMS CryptographicFramework entry from the material
890 package to the source package
891 o Fixed erroneous Source Essence Container Label value
892 o Fixed broken sort of JP2K frames in JP2K parser
893 o Added FindFrameGOPStart() method to the MPEG2 MXFReader
894 o Added missing length values for EKLV packets without HMAC
895 o -x with JP2K essence writes to files with 6 digit names
897 o The Key ID may now be specified as an argument to asdcp-test
901 2004.12.30 - bug fixes + wav files v0.8.14
902 o Added WAV file write to asdcp-test (uses mxflib::waveheader_t).
903 o Three-partition files reading properly. adscplib still writes
905 o Changes in the mxflib WAV essence parser API had broken
906 asdcplib's ability to read essence from a WAV file. I have
907 fixed this bug, but at the expense of breaking compatibility
908 with older versions of mxflib. Beware!
909 o Removed redundant (but working) bin-text-bin conversions.
912 2004.12.23 - JPEG 2000 support v0.8.13
913 o Reads/writes JPEG 2000 essence in plaintext and ciphertext
914 with the following caveats:
915 - The Picture Essence Descriptor is empty.
916 - Because there is no essence descriptor, the reader code
917 in asdcp-test has no idea how many frames are in the file
918 and ends with an out-of-bounds frame error. This error
919 is being suppressed in asdcp-test for the current release.
920 o Still broken when reading three-partition files.
923 2004.10.22 - fixes and UL updates v0.7.11
924 WARNING: COMPATIBILITY BREAKPOINT
925 Files created with this and future versions of this library are
926 not compatible with previous versions of this library. As you
927 might suspect, files created with previous versions of this
928 library are not compatible with this and future versions.
930 o h__Reader will now open a three-partitition file (untested)
931 o Moved DMS from Material partition to File partition
932 o Added length fields to appropriate places in EKLV packet
935 2004.10.22 - fixes and UL updates v0.7.10
936 o fixed frame buffer handling of externally allocated buffer,
937 created unit test (asdcp-mem-test)
938 o added operator==() and operator!=() to Rational type
939 o fixed some type-related compiler warnings
940 o asdcp-test -p now works on unwrap
941 o updated some ULs to match documentation (thanks to Arun
943 o canonicalized line endings
946 2004.07.02 - full plaintext + ciphertext read/write v0.6.9
947 o HMAC, plaintext offest and raw ciphertext read supported
948 o back to proper CBR index
949 o MPEG temporal offset working
952 2004.07.01 - plaintext + ciphertext read/write v0.5.8
953 o encryption of MPEG and PCM essence supported with the
956 - no plaintext offest support
957 - no raw ciphertext read support
958 o moved to reflecting the whole KLV triplet in the CBR
959 index (now incompatible with mxflib, still searching
960 for info about what's "right")
961 o awaitng the following fixes/features:
962 - retrieve Temporal Offset from index in MPEG2::Reader
963 - test for correct ULs when reading frame triplets
964 - fix header metadata items for encrypted files
966 - plaintext offest support
967 - raw ciphertext read support
970 2004.06.14 - plaintext read/write w/key generator v0.4.5
971 o Project now uses OpenSSL (tested with 0.9.7d on win32, Linux, Darwin)
972 Use `make ASDCP_WITHOUT_OPENSSL=1` to make plaintext-only version
973 o Accepts interior I frames when parsing MPEG2 VES
974 o Improved error reporting on format errors
975 o Added support for encryption to asdcp-test
976 o Added RNG for asdcp-test (non-production use only, see notes in FortunaRNG.h)
977 o Implemented CBC encrypt, decrypt module
978 o Added partial TemporalOffset retrieval from MPEG2 parser
979 o Fixed win32 binmode bug
982 2004.05.12 - plaintext read/write v0.3.4
983 o Full read/write of plaintext MPEG-2 VES and WAV files
984 (does not yet support mux from or demux to 2 channel pairs)
985 o Builds with autoconf-based mxflib
986 o Added ASDCP_ prefix to macros
987 o Updated documentation, fixed documentation errors
988 o Simplified API for MXF writer setup
989 o Decoupled essence parsers from MXF writers
990 o added raw ciphertext support to FrameBuffer
991 o Cleaned up Get/Set naming confusion
992 o Added missing const qualifiers
995 2004.04.27 - preview release v0.2.1
996 o hasty release for quick review
997 o this release may not build with mxflib using autoconf.
998 o writes plaintext AS-DCP MPEG2 essence files
999 o tested under win32 and linux. FreeBSD and Darwin do not work
1002 2004.02.04 - First release (v0.1.1):
1003 o asdcp-test is mostly complete. It should correctly provide
1004 access to the read and info capabilities of the library.
1005 o The MPEG2 reader is functional but not fully tested.
1006 o Some file format integrity tests remain to be coded.
1007 o The PCM reader is mostly complete, I am having difficulty
1008 getting a suitable test file from mxfwrap.
1009 o The makefile creates a static library module. The API
1010 will cleanly support a DSO (or DLL). Let me know if DSO
1011 support is important to you.
1012 o Nothing is thread safe. Thread safety was not a requirement
1013 in the initial project definition. Thread safety may be added
1014 above the mxflib/klvlib level. Let me know if it is important
1016 o The files xmldict.xml and types.xml must be in the current
1017 directory when the program is run. The files are supplied
1018 with mxflib. Runtime location of the files is not currently
1019 a project goal. Comments on how best to handle this situation
1020 would be appreciated. See AS_DCP.cpp at init_mxf_types()
1021 for a more detailed discussion.