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.
95 I have tested this build on win32, Linux, OpenBSD, and Darwin
96 platforms. Others may work as well.
103 asdcp-test - Writes, reads and verifies AS-DCP (MXF) track files.
105 asdcp-wrap - Writes AS-DCP (MXF) track files.
107 asdcp-unwrap - Extracts essence from AS-DCP (MXF) track files.
109 asdcp-info - Displays information about AS-DCP (MXF) track files.
111 asdcp-util - Calculates digests and generates random numbers and UUIDs.
113 as-02-wrap - Writes AS-02 Essence Component files.
115 as-02-unwrap - Extracts essence from AS-02 Essence Component files.
117 kmfilegen - Writes and verifies large files using a platform-
118 independent format. Use it to test issues related to large files.
120 kmuuidgen, kmrandgen - generate UUID values and random numbers.
122 wavesplit - Splits a WAVE file into two or more output files. Used
123 to untangle incorrectly-paired DCDM sound files.
125 blackwave - Write a WAVE file full of zeros, Used to make filler
126 tracks (though you would be better off modifying asdcp-test if
127 this is a common use case).
129 j2c-test - Displays information about JP2K codestreams.
134 The API documentation is mostly in AS_DCP.h. and AS_02.h Read those
135 files for a detailed description of the library's capabilities. Read
136 asdcp-*.cpp and as-02-*.cpp files for library usage examples. The
137 command-line utilities all respond to -h.
142 YYYY-MM-DD - bug fixes, enhancements M.N.RR
143 o Refactored internals of the AS-DCP file readers. While no
144 changes in behavior are intended, users are cautioned to test
145 thouroughly before use in production.
146 o Fixed a bug in ReadAncillaryResource that was causing bogus HMAC
147 failures when reading resources from a file.
148 o Fixed premature-release bug in the Expat version of the XML parser.
149 Thanks to Carsten Feldheim (IIS) for the tip.
150 o Fixed -W option in asdcp-unwrap. Thanks to RGB.
151 o Added P-HFR support to asdcp-wrap (see URL for details:
152 http://isdcf.com/papers/ISDCF-HighFrameRate-DCP.pdf).
153 o Added support for SMPTE ST 428-21 "Archival Frame Rates".
154 o Added -P option to asdcp-wrap (inserts arbitrary UL into the
155 PictureEssenceCoding property when wrapping JP2K files.)
156 o Added support for 96 kHz files to blackwave.
157 o Added new path and string manglers to Kumu.
158 o Updated MCA ULs (I warned you...). Again please take some
159 time to proof this work against ST 477-4 including the latest
160 drafts of the registries.
161 Changed the version byte (8 0f 16) to 0x0e:
162 MCALabelSubDescriptor
163 AudioChannelLabelSubDescriptor
164 SoundfieldGroupLabelSubDescriptor
165 GroupOfSoundfieldGroupsLabelSubDescriptor
166 GroupOfSoundfieldGroupsLinkID
167 Changed bytes 8 and and 13 of SoundfieldGroupLinkID
168 Added items to the UL dictionary:
178 2012-08-07 - bug fix, 1.10.46
179 o Added missing zero-initializers to time values when parsing a
180 timestamp string (in the case where the optional [Thh:mm.[:ss]]
181 syntax is not present in an encoded string).
183 2012-03-06 - bug fixes, enhancements 1.9.45
184 o Removed ASDCP::Timestamp, all items that were of that class are now
185 of class Kumu::Timestamp
186 o Refactored Kumu::Timestamp to use KM_tai for internal representation
187 (replaced public Y M D, h, m, s variables)
188 o Refactored Kumu::Timestamp to use KM_tai for WIN32 builds
189 o Added UTC offset awareness to Kumu::Timestamp
190 o Replaced "long GetSecondsSinceEpoch(void) const" with
191 "ui64_t GetCTime() const"
192 o Corrected UL version segment in "7.1 DS" and "WTF" audio format
193 labels (corresponds with publication of ST 429-2:2011).
194 o Exposed MXF object interface (MXF.h, Metadata.h) via ASDCP MXFReader
195 and MXFWriter classes.
196 o Added UL values from ST 377-4:2012. >>>>NOTE: These are preliminary
197 values, subject to change upon final publication of not only ST 377-4
198 but also the relevant registries. This is a good time to compare them
199 to the standard and complain if you think they are wrong!
200 o Added MCALabelSubDescriptor, AudioChannelLabelSubDescriptor,
201 SoundfieldGroupLabelSubDescriptor, and
202 GroupOfSoundfieldGroupsLabelSubDescriptor (from ST 377-4:2012) to
204 o Changed some internals to make MXFWriter::OPAtomHeader() work correctly.
205 o Split asdcp-test into several different programs to help relieve
206 the impenetrable-list-of-arguments problem. asdcp-wrap, asdcp-unwrap
207 and asdcp-info take the place of asdcp-test's -c, -x and -i options,
208 respectively. asdcp-util contains the remaining functions. Note that
209 asdcp-test is now DEPRECATED, new functionality and bug fixes will be
210 aimed at the new tools. Also note that some options and calling
211 conventions are different for the new tools as compared to asdcp-test.
212 Please read the synopses and make sure you understand the new idioms.
213 o asdcp-wrap has a new argument, -C <UL>, that writes the given UL to the
214 ChannelAssignment item in the WaveAudioDescriptor (only useful when
215 writing PCM essence).
218 2011-11-30 - bug fixes v1.8.44
219 o Corrected a wrong decryption UL selection when unwrapping MXF.
222 2011-10-27 - bug fixes v1.8.43
223 o Corrected broken Essence UL matching. (Thanks to Michael Loder).
226 2011-08-31 - bug fixes v1.8.42
227 o Added missing HFR support for PCM essence reader/writer.
230 2011-08-30 - bug fixes, enhancements v1.8.41
231 o UL version byte now ignored when comparing UL values.
232 o Changed the version byte in the TimedTextEssence UL to 0x01. There
233 is no published Essence Keys registry so it can't have a maintained
235 o JP2K Sequence Parser modified to skip directory entries that
236 are not files in the case where the parser is initialized with
237 a directory path. When initialized with a list of file names
238 this check is not performed. Based on a hint by Steve Quartly.
239 o Increased the size of the MPEG header parser buffer.
240 o Added missing FrameType() implementation to ASDCP::MPEG2::MXFReader.
241 o Added missing Close() implementations to MXF reader classes.
242 o Added missing Timestamp::Timestamp(const char* datestr) implementation.
243 (Thanks to Matt Sheby for this and the previous three items.)
244 o Fixed error in Kumu::FortunaRNG::FillRandom() that was returning the
245 end of the random buffer instead of the front (Thanks to Mike Radford).
246 o Added support for proposed sound channel format identifiers
247 '7.1DS' and 'WTF'. Optimistically chose version '0x0c'.
248 o Added support for stereoscopic images in JP2K files at edit
249 rates of 48, 50 and 60 eups (96, 100 and 120 fps).
252 2010.11.15 - bug fixes, enhancements v1.7.40
253 o Fixed bug in long KLV packet support (Thanks to Jim Radford).
254 o Fixed AvgBps in PCM files, *again*. Sorry for the crazy.
255 o More fixes and changes in support of 25, 30, 50, 60 fps.
256 (Thanks to Hans K. for the TC rate bug).
257 o Updated KLVFill UL version element to 0x02.
258 o Type change to support Xerces-C 3.x. (Thanks to Matt Sheby).
259 o Some internal API changes to KLV types. Does not affect
261 o Added NetworkLocator type to MXF metadata types.
262 o Added file offset display to klvwalk.
265 2010.09.09 - bug fixes, enhancements, v1.7.39
266 o Fixed bug in JP2K PictureDescriptor initialization in
267 JP2K::MXFReader::OpenRead() and JP2K::MXFSReader::OpenRead()
268 o Once again fiddling with AvgBbs. How can something so simple
269 be such a constant cause of trouble? Tested with 1-, 2- and
270 6-channel input Wav files.
271 o asdcp-test now accepts a directory name when making PCM
272 files (-c). The directory name should be the only filename
273 argument. All files in the directory must be Wav files
274 (mixed channel sizes OK). Files are sorted alphabetically by
275 filename. Hint: use numeric name infix to define order:
284 2010.07.20 - bug fixes, v1.6.37
285 o Fixed TimedTextResourceSubDescriptor UL value.
288 2010.06.16 - bug fixes, v1.6.36
289 o Added support for new Edit Rates to asdcp-test.cpp.
290 o Expanded timed-text file reader in asdcp-test.cpp.
291 o Fixed large BER value encoding (plaintext) and decoding
292 (plaintext and ciphertext). This feature was introduced in
294 o Fixed AvgBps value for multi-channel Wave input.
297 2010.05.13 - bug fixes, enhancements, v1.6.34
298 o ST 429-5 files have corrected ULs for DCTimedTextDescriptor and
299 GenericStream DataElement. Files made with previous versions of
300 the library are incompatible with this and future versions.
301 o Fixed File Package TrackNumber values. Th
303 o Added edit rate constants to AS_DCP.h (25, 30, 50, 60).
304 o Changed AudioDescriptor "SampleRate" element name to "EditRate"
305 to make it consistent with the other types.
306 o Now builds with XercesC 3.x.
307 o KM_memio.h has better const behavior.
308 o Fixed a bug in KM_memio.h string archiving.
311 2010.01.05 - bug fixes, enhancements, v1.5.32
312 o Re-fixed swapped Interop and SMPTE OP Atom UL values. The swap
313 introduced in v1.5.31 was done in error.
314 o Added -z,-Z options to asdcp-test (j2c parameter checking)
315 o Reformed jp2k-test as j2c-test, added help and list processing,
316 added to standard install target.
319 2009.12.31 - bug fixes, enhancements, v1.5.31
320 o Fixed swapped Interop and SMPTE OP Atom UL values.
321 o Added get_BER_length_for_value() subroutine.
322 o Modified ASDCP::h__Writer::WriteEKLVPacket() to allow larger BER
323 lengths for KLV packets larger than 16 MB. This was required to
324 support large font files in the SMPTE 429-5 implementation.
327 2009.11.06 - bug fixes, enhancements, v1.5.29
328 o Fixed a bug that could cause HMAC values to be incorrectly
329 stored in MXF files. Files created with versions of asdcplib
330 prior to this version may have incorrect HMAC values.
331 o Improved handing of XML files for MXF wrapping.
332 o Jpeg2000 codestream EditRate and SampleRate mismatches
333 now warns instead of returning an error.
334 o Improved error handling in Jpeg2000 sequence parsing routines.
335 o Added two methods to Kumu::Timestamp, AddSeconds(), to add (or
336 subtract) seconds to a time value, and GetSecondsSinceEpoch()
337 to get the number of seconds since the unix epoch.
338 o Added new option to asdcp-test, '-a', to specify a UUID when
340 o Added support for specifying the intrinsic duration of MXF files
341 containing timed text.
342 o Added new option to wavesplit, '-i', to display WAV file metadata.
345 2009.05.21 - bug fixes, v.1.4.24
346 o Fixed a bug that caused incorrect SubDescriptors UL values to be
347 written into interop format MXF track files. Note that this involved
348 a substantial reorganization of MXF internals. Please test thoroughly
349 in your application before using in production. Note that this is a
350 significant bug fix and track files created with 1.4.22 may be incompatible
354 2009.04.09 - SMPTE format fixes, enhancements and bug fixes, v.1.4.22
355 o asdcplib now uses GNU autotools on POSIX systems to configure
356 and build. See "./configure" for details. Note that two options,
357 --enable-freedist and --with-python are not enabled in the free
358 version of asdcplib and should not be used.
359 o Added build option (CONFIG_RANDOM_UUID) to enable mixed case UUID
360 generation when environment variable KM_USE_RANDOM_UUID is defined.
361 o Fixed a condition that could cause an error to occur when wrapping
362 SMPTE format timed text track files that do not define a starting
364 o Updated ULs for SMPTE format track files.
365 o SampleRate added to JP2K metadata
366 o Support for wrapping 96kHz WAV files added.
367 o Updated ULs for audio channel formats (ChannelFormat)
368 o Updated font subdescriptor MIME Types for TimedText Trackfiles.
369 o Changed time implementation to support dates beyond Jan 19th, 2038.
370 o Xerces-C XML parser support added.
371 o New build method for Windows (see win32/README.txt for details).
372 o Added new functionality in Kumu to recursively create and delete files
373 and directories, and get free disk space for a given volume path.
374 o Added a method to Kumu::Timestamp, AddMinutes(), to add (or subtract)
375 minutes to a time value.
376 o Improved how Kumu::Timestamp parses timestamps with offsets.
377 o Fixed a bug that caused incorrect HMAC values to be calculated.
380 2008.02.16 - SMPTE format fixes, bug fixes v.1.3.18
381 o Added correct SMPTE UL for StereoscopicPictureSubDescriptor.
382 o Exposed JP2K metadata parser as ParseMetadataIntoDesc().
383 o Added simple stereoscopic framebuffer to support paired ReadFrame()
384 and WriteFrame() methods (allows simpler integration with other
386 o Improved detection of JPEG Interop stereoscopic files.
387 o Win32 build fixes (Thanks to Mike Crowe at DTS).
388 o Added the WITH_MD macro to the makefile. Set this value to one
389 to build Win32 with /MD[d] instead of /MT[d].
390 o The Generic Container UL has been added to the EssenceContainers
391 set in the header partition pack for encrypted files. It has always
392 been there in plaintext files.
393 - Below this point the changes are internal and should not affect you
394 unless you use Kumu directly.
395 o Major refactoring of KM_log.[h|cpp].
396 o Fixed buffer re-sizing issue in Kumu::ByteString.
397 o Replaced type IdentifierList with ArchivableList.
398 o Added COPYING file to the release bundle.
401 2007.12.13 - Bug fixes v.1.2.17
402 o Changed Result_t implementation to use int instead of long, which
403 was causing trouble on some 64 bit platforms.
404 o Fixed EKLV HMAC. NOTE: Breaks backward compatibility with older
405 Interop files. To validate these files, use asdcplib-1.1.14. This
406 should not cause too much trouble since files with broken and
407 non-broken HMAC have been in the wild for years without issue.
408 o Fixed HMAC sequence numbering in encrypted stereoscopic files.
409 o Finished stereoscopic test targets in the makefile.
410 o Fixed the win32 build, now expects VS2005 compiler by default,
411 use WITH_VC6=1 top get VC6 flags.
412 o Stereoscopic and Timed Text modes now have SMPTE UL values.
413 NOTE: SMPTE 429-5 and 429-10 are not yet published. It is possible
414 that these UL values may change before publication. Please use
415 caution when using these features for production work.
416 o Changed a bunch of symbol names in the 429-5 implementation to
417 better match the spec.
418 o Added -U option to asdcp-test to dump the UL library to stdout.
419 o Fixed erroneous placement of the PictureEssenceCoding UL in JP2K
420 files (Interop and SMPTE modes).
423 2007.10.22 - Timed Text, Stereoscopic Picture and Bug fixes v.1.2.16
424 o Significant API changes have been made. Please read all entries
425 in this changelog to be sure you understand the changes. Also
426 note that some changes have been made to LS_MXF_SMPTE files that
427 are incompatible with earlier releases (e.g., EKLV HMAC). If
428 you are looking for a stable interop release, use v.1.1.14.
429 o Fixed RFC 2104 HMAC implementation for LS_MXF_SMPTE only. The
430 broken implementation has been maintained for Interop mode.
431 o Added support for draft SMPTE 429-5 Timed Text Track File. This
432 is still waiting for official SMPTE ULs, so do not use it for
433 shipping products. An XML parser is needed to create a Timed
434 Text Track File; Expat is now an optional part of the build.
435 Make with WITH_XML_PARSER=1 to link with Expat. If you do not
436 link with expat, you will get an error when using the TimedText::
437 DCSubtitleParser class. See also S429-5-cgi.cpp for an example
438 that shows how to serve plaintext MXF file elements directly via
440 o Added support for draft SMPTE 429-10 Stereoscopic Picture Track
441 File, including the JPEG Interop version. This is still waiting
442 for official SMPTE ULs, so do not use it with LS_MXF_SMPTE for
444 o Refactored the following files as a side-effect of the above
445 work: AS_DCP_JP2K.cpp AS_DCP_MPEG2.cpp AS_DCP_PCM.cpp
446 AS_DCP_MXF.cpp AS_DCP_internal.h MXF.[h|cpp] MXFTypes.[h|cpp]
447 Metadata.[h|cpp] h__Reader.cpp h__Writer.cpp klvwalk.cpp.
448 WARNING: While significant effort has been extended to make sure
449 that these changes do not affect existing stable file support,
450 users are cautioned to test this release thouroughly.
451 o Added a large set of filesystem path manglers to KM_fileio.h. See
452 path-test.cpp for example usage. The path manglers have not yet
453 been tested on win32 platforms (they are currently used only by
454 the Timed Text module.
455 o The PathIsFile(), PathIsDirectory() and FileSize() subroutines
456 have been modified to accept const std::string& instead of
458 o Added namespace and parsing support (Expat) to Kumu::XMLElement
459 (currently used only for Timed Text support). Also added some
461 o Altered MXF::UTF16String to use mbtowc() and wctomb().
464 2007.03.31 - Bug fixes v.1.1.14
465 o Fixed KeyFrameOffset value in MPEG wrapping to have negative
466 value. This is probably not yet complete for handling all
467 types of GOPs. Please send chunks of MPEG-2 VES that you
468 find which break this. Thanks to Doremi.
469 ** no other file format changes in this release **
470 o Fixed error in RIP interpretation when reading arbitrary (i.e.,
472 o Fixed a memory leak in ASDCP::MXF::OPAtomHeader when used
473 in read mode. Thanks to Mahesh Bajaj for pointing out this
474 bug and the one above.
475 o Removed asserts from KM_fileio, replaced with RESULT_WRITEFAIL
476 return value statements.
477 o Added -s and -p to the makefile install target.
478 o Altered ByteString behavior to use target Length() in copy
479 operations (instead of Capacity()).
480 o Added new Set() method to ByteString.
481 o Fixed a bug in ByteString::Unarchive() that caused the operation
482 to fail when the buffer was smaller than the read (i.e., when
483 Capacity() was called).
484 o Added IdentifierList class to KM_util.h.
485 o Changed some Error() messages to Debug() in Wav.cpp
486 o Revived jp2k-test.cpp and asdcp-mem-test.cpp (they both had
490 2007.02.15 - Bug fixes v1.1.13
491 o Removed 'VDescObj->SampleRate.Numerator = VDesc.FrameRate;'
492 from MPEG2_VDesc_to_MD() in AS_DCP_MPEG2.cpp, was line 76.
493 o Added KM_TEST_NULL_STR_L() and KM_TEST_NULL_L() macros to
494 KM_log.h. These versions log the location of the null value.
495 Macros are now used in any module that includes KM_log.h.
496 o MPEG2 VES with run of zero values at the head is now OK.
497 o Increased VESHeaderBufSize to 16K.
498 o Added makefile support for local OpenSSL in ../openssl, if
500 o The Kumu::PathIs*() functions now return false if a null or
501 empty string is given (used to be an assert).
502 o Cleaned up the install target in the makefile.
503 o Fixed SMPTE 429-6 HMAC -- FIPS 186-2 implementation was
504 laughably incorrect. Thanks to Doremi for pointing this out.
505 o Removed default parameter to HMACContext::InitKey().
506 o Cleaned up messages and CLI arg handling in asdcp-test.
509 2006.11.19 - Mo better stuff v1.1.12
510 o Changed read-only Result_t accessor methods to const.
511 o Added Base64 (-B) option to kmrandgen.
512 o Removed 16-bit alignment restriction from kmrandgen.
513 o Improved WAV file extraction speed (Thanks to Jim Radford
514 for pointing this out).
515 o Added single-channel split for WAV extraction (asdcp-test -1).
516 o Fixed remainder bug in h__RNG::fill_rand().
519 2006.11.03 - Bug fixes v1.1.11
520 o Increased index table entry list size to 5000.
521 o Added length checking to TLV writer (returns error if TLV
522 payload exceeds 64kB).
523 o Fixed partition header and RIP errors related to 2-partition
524 files (MXF Interop mode).
525 o Added -t option to asdcp-test (SHA-1 digest with Base64 output
527 o Fixed Sub Descriptor reference bug (Thanks to Denis Leconte
528 for dogged determination).
529 o Added directory-of-wav detection to RawEssenceType()
530 o Modified MXF::Partition::AddChildObject() to only generate
531 a UUID if the InstanceID is unset.
532 o Added ComponentMaxRef & ComponentMinRef to RGBAEssenceDescriptor.
534 o Added detection of 2K/4K jp2c, writing correct 4K metadata.
537 2006.10.05 - Bug fixes v1.1.10
538 o Changed RM_RELEASE to RL_RELEASE in MXFTypes.h.
539 o Changed the MXF writer to use RL_RELEASE (was RL_DEVELOPMENT).
540 o Really fixed source reference chain.
541 o Updated JP2K file package label.
542 o Changed location of JPEG2000PictureSubDescriptor in the
543 header (was erroneously before Preface).
544 o Altered LS_MXF_INTEROP to produce 2-partition files.
547 2006.09.25 - Bug fixes v1.1.9
548 o Fixed SourcePackageID value. All files will be 'original',
549 i.e. SourcePackageID will be all zeros. Let me know if you
550 want to set SourcePackageID.
551 o Fixed compiler warnings on some Linux platforms
552 o Fixed the build so that BUILD_DIR is no longer created
554 o Added duration detection to the raw essence parsers. The
555 MPEG parser uses a nasty approximation so don't use it
556 without paying close attention to the result.
557 o Modified PCMParserList to make it more useful as a base
559 o Fixed bugs and re-organized command-line help in asdcp-test
561 o Fixed two-partition file reads.
562 o Fixed Win32 PRNG initialization.
563 o Renamed asdcp-lf-test as kmfilegen.
564 o Added kmrandgen and kmuuidgen.
565 o Added string retrieval mechanism to Result_t.
566 o Refactored Kumu::Identifier and its sub-classes.
567 o Altered Kumu::PathIsFile to return true when the path
568 is a symbolic link (unix only).
569 o Altered Kumu::FileWriter::OpenWrite to use file creation
570 mode 0664 (was 0644) (unix only).
571 o Added Kumu::WriteStringIntoFile() subroutine.
574 2006.04.05 - Bug fixes and new stuff v1.1.7
575 o Fixed a bug in the MPEG parser that caused it to fail when
576 handling start codes spanning buffer boundaries
577 o Added wavesplit and blackwave utility programs
578 o Added support for revised SMPTE HMAC key derivation when
580 o Refactored platform compatibility and general utilities
581 into a new sub-library "Kumu". There are no new build
582 steps or dependencies, but some important things have
584 + Result_t is no longer an enum, it is now a class.
585 Library result codes are now declared as const objects
588 const Kumu::Result_t RESULT_FORMAT (-101, "The file...");
590 The macros ASDCP_SUCCESS and ASDCP_FAILURE still work
591 the same way thanks to an operator overload for type long.
592 See KM_error.h for more information.
593 + The logging interface has been moved out of AS_DCP.h
595 o Some of the command line utilities that were using headers
596 other than AS_DCP.h have been changed to use the Kumu
597 equivalents. If you have code based on those utilities, you
598 will have to update by hand.
599 o Added new types to the EssenceType_t enum.
600 o The guard macro for Win32 code has changed from WIN32 to
604 2006.03.2x - new stuff
605 o Proper handling of stream-id byte of essence UL values
606 o writes 3-partition files, reads 2-part or 3-part
609 2006.03.16 - bug fixes plus
610 o Removed SMPTE_LABELS compile-time option. The reader will now
611 silently accept either SMPTE or MXF Interop labels, the writer
612 can be instructed which to use at runtime. Default is Interop.
613 o Added an AIFF reader. Support is preliminary, it works with the
614 AIFF files I have on hand.
615 o More code refactoring. More to come.
618 2006.03.09 - full read-write
619 o Removed ASDCP_WITHOUT_OPENSSL compile-time option.
620 o Full read/write now working on new MXF library
623 2005.00.00 - A New Hope
624 o The temporary mxf-lite has been removed. MXF files are now
625 managed via the objects in KLV.h, MXFTypes.h MXF.h and
626 Metadata.h. This release does not support writing MXF files.
627 o Fixed a header interpretation error in the Wav parser.
630 2005.00.00 - The Reformation
631 o Removed mxflib as a dependency by forking the necessary
632 functions and placing them in the mxf-lite subdirectory.
633 Please note that the very heavy modifications done here
634 render all comparisson to mxflib code a substantial task.
635 All errors are now mine and users are warned not to bug
636 Oliver or Matt for help with this code. The version of
637 mxflib at the time of the fork was: 0.5.1.3.
640 2005.06.03 - bug fixes v0.10.18
641 o Updated UL batch to include GC UL.
644 2005.05.27 - bug fixes v0.10.17
645 o Un-did essence container and compression descriptor changes.
646 The default build reflects MXF Interop decisions as of 26 May.
647 o Added note about build versions to README (see above).
648 o Added warnings to SMPTE_LABELS builds.
649 o Fixed JP2K essence container label.
652 2005.05.02 - bug fixes v0.10.16
653 o Reorganized internal files, added file reader object, added OS
654 portability header, removed and renamed some files. If you have a
655 patch against previous versions of the source, you should check
657 o Added RGBA attributes to JP2K descriptor.
658 o Changed interface to CodestreamParser.
659 o Added JP2K parser implementation. It is parsing each frame but is
660 not yet being used to populate the descriptor.
661 o Added 48fps option for `asdcp-test -p`.
662 o Added picture rate constants to AS_DCP.h (23.976, 24, 48).
663 o Added sample rate constant to AS_DCP.h (48k).
664 o Changed asdcp-test to encrypt picture headers by default
665 (plaintext offset will be 0), added -E option to allow
669 2005.04.28 - bug fixes v0.9.15
670 o The XML descriptors for the crypto DMS have moved in mxflib to
671 the file DMS_Crypto.xml (they were in DMS_DCPENC.xml). Older
672 installations should update the file from mxflib.
673 o Added Close() and Seek() to ~MyFileWriter(), cleaned up headers
674 o Added UUID generator output mode (-u).
675 o Added -S option to extract PCM essence into stereo wav files
676 o Added more UL testing and conformance checking.
677 o Added macro SMPTE_LABELS which causes the library to be built
678 with SMPTE (as opposed to MXF Interop) labels. This is not
679 set by default, and currently only affects the PCM container
680 label and encrypted element label.
681 o Cleaned up the GNUmakefile test targets, the source files
682 are now named with the TEST_FILE_PREFIX macro.
683 o enabled 23.976-framed PCM (2002 samples per frame)
684 o The size of the asdcp-test frame buffer for picture essence
685 may now be set from the command line (-b). The default is 4MB.
686 o h__Reader::ReadEKLVPacket() now tests the UL (duh) and switches
687 on the value, allowing plaintext and ciphertext frames to
688 be mixed in the file.
689 o Fixed error in UUID generator format.
690 o JP2K files now use the GenericPictureDescriptor to store
691 ContainerDuration and SampleRate. SampleRate is mapped
692 to EditRate in the PictureDescriptor struct. This fixes
693 the second caveat from the 0.8.13 release.
694 o Fxed bug in PCMParserList that was miscalculating the extent
695 of a PCM sample. This bug did not affect API users, it was
696 only present in asdcp-test.
697 o Fixed EditRate on PCM files (was showing sample rate)
698 o Fixed Encrypted Essence Container UL
699 o Fixed BlockAlign value for PCM essence
701 - The following changes were provided by Jeff Loewenguth
703 o Moved the DMS CryptographicFramework entry from the material
704 package to the source package
705 o Fixed erroneous Source Essence Container Label value
706 o Fixed broken sort of JP2K frames in JP2K parser
707 o Added FindFrameGOPStart() method to the MPEG2 MXFReader
708 o Added missing length values for EKLV packets without HMAC
709 o -x with JP2K essence writes to files with 6 digit names
711 o The Key ID may now be specified as an argument to asdcp-test
715 2004.12.30 - bug fixes + wav files v0.8.14
716 o Added WAV file write to asdcp-test (uses mxflib::waveheader_t).
717 o Three-partition files reading properly. adscplib still writes
719 o Changes in the mxflib WAV essence parser API had broken
720 asdcplib's ability to read essence from a WAV file. I have
721 fixed this bug, but at the expense of breaking compatibility
722 with older versions of mxflib. Beware!
723 o Removed redundant (but working) bin-text-bin conversions.
726 2004.12.23 - JPEG 2000 support v0.8.13
727 o Reads/writes JPEG 2000 essence in plaintext and ciphertext
728 with the following caveats:
729 - The Picture Essence Descriptor is empty.
730 - Because there is no essence descriptor, the reader code
731 in asdcp-test has no idea how many frames are in the file
732 and ends with an out-of-bounds frame error. This error
733 is being suppressed in asdcp-test for the current release.
734 o Still broken when reading three-partition files.
737 2004.10.22 - fixes and UL updates v0.7.11
738 WARNING: COMPATIBILITY BREAKPOINT
739 Files created with this and future versions of this library are
740 not compatible with previous versions of this library. As you
741 might suspect, files created with previous versions of this
742 library are not compatible with this and future versions.
744 o h__Reader will now open a three-partitition file (untested)
745 o Moved DMS from Material partition to File partition
746 o Added length fields to appropriate places in EKLV packet
749 2004.10.22 - fixes and UL updates v0.7.10
750 o fixed frame buffer handling of externally allocated buffer,
751 created unit test (asdcp-mem-test)
752 o added operator==() and operator!=() to Rational type
753 o fixed some type-related compiler warnings
754 o asdcp-test -p now works on unwrap
755 o updated some ULs to match documentation (thanks to Arun
757 o canonicalized line endings
760 2004.07.02 - full plaintext + ciphertext read/write v0.6.9
761 o HMAC, plaintext offest and raw ciphertext read supported
762 o back to proper CBR index
763 o MPEG temporal offset working
766 2004.07.01 - plaintext + ciphertext read/write v0.5.8
767 o encryption of MPEG and PCM essence supported with the
770 - no plaintext offest support
771 - no raw ciphertext read support
772 o moved to reflecting the whole KLV triplet in the CBR
773 index (now incompatible with mxflib, still searching
774 for info about what's "right")
775 o awaitng the following fixes/features:
776 - retrieve Temporal Offset from index in MPEG2::Reader
777 - test for correct ULs when reading frame triplets
778 - fix header metadata items for encrypted files
780 - plaintext offest support
781 - raw ciphertext read support
784 2004.06.14 - plaintext read/write w/key generator v0.4.5
785 o Project now uses OpenSSL (tested with 0.9.7d on win32, Linux, Darwin)
786 Use `make ASDCP_WITHOUT_OPENSSL=1` to make plaintext-only version
787 o Accepts interior I frames when parsing MPEG2 VES
788 o Improved error reporting on format errors
789 o Added support for encryption to asdcp-test
790 o Added RNG for asdcp-test (non-production use only, see notes in FortunaRNG.h)
791 o Implemented CBC encrypt, decrypt module
792 o Added partial TemporalOffset retrieval from MPEG2 parser
793 o Fixed win32 binmode bug
796 2004.05.12 - plaintext read/write v0.3.4
797 o Full read/write of plaintext MPEG-2 VES and WAV files
798 (does not yet support mux from or demux to 2 channel pairs)
799 o Builds with autoconf-based mxflib
800 o Added ASDCP_ prefix to macros
801 o Updated documentation, fixed documentation errors
802 o Simplified API for MXF writer setup
803 o Decoupled essence parsers from MXF writers
804 o added raw ciphertext support to FrameBuffer
805 o Cleaned up Get/Set naming confusion
806 o Added missing const qualifiers
809 2004.04.27 - preview release v0.2.1
810 o hasty release for quick review
811 o this release may not build with mxflib using autoconf.
812 o writes plaintext AS-DCP MPEG2 essence files
813 o tested under win32 and linux. FreeBSD and Darwin do not work
816 2004.02.04 - First release (v0.1.1):
817 o asdcp-test is mostly complete. It should correctly provide
818 access to the read and info capabilities of the library.
819 o The MPEG2 reader is functional but not fully tested.
820 o Some file format integrity tests remain to be coded.
821 o The PCM reader is mostly complete, I am having difficulty
822 getting a suitable test file from mxfwrap.
823 o The makefile creates a static library module. The API
824 will cleanly support a DSO (or DLL). Let me know if DSO
825 support is important to you.
826 o Nothing is thread safe. Thread safety was not a requirement
827 in the initial project definition. Thread safety may be added
828 above the mxflib/klvlib level. Let me know if it is important
830 o The files xmldict.xml and types.xml must be in the current
831 directory when the program is run. The files are supplied
832 with mxflib. Runtime location of the files is not currently
833 a project goal. Comments on how best to handle this situation
834 would be appreciated. See AS_DCP.cpp at init_mxf_types()
835 for a more detailed discussion.