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