2 $Id: README,v 1.75 2012/03/07 19:29:06 mikey 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
9 This work was originally funded by Digital Cinema
10 Initiatives, LLC (DCI). Subsequent efforts have been funded
11 by Deluxe Laboratories, Doremi Labs, CineCert LLC, Avica
12 Technology and others.
14 **The asdcplib project was originally housed on SourceForge.
15 The project has moved to http://www.cinecert.com/asdcplib/
17 The project formerly depended upon the mxflib project. Because
18 of its focus on covering the whole of the MXF specifications,
19 mxflib is considerably larger and more complex that what I
20 require for this application. For this reason I have created
21 a dedicated MXF implementation that is now part of this
22 library. Special thanks to Matt Beard and Oliver Morgan for
23 their great work and support.
25 Thanks also to the members of the SMPTE DC28.20 packaging
26 ad-hoc group and the members of the MXF Interop Initiative
27 for their encouragement and support. Special thanks to
28 Jim Whittlesey and Howard Lukk at DCI for proposing and
29 supporting this project.
34 This library is intended (but of course not limited) for
35 use by developers of commercial D-Cinema products. It is
36 designed to be easily integrated into a wide variety of
37 development environments. Commercial users are strongly
38 urged to use static linking (at least where you use this
39 library) to prevent malicious in-field replacement of
40 critical system modules. This recommendation should be
41 considered wherever Open Source or Free software is being
42 used in conjunction with critical security parameters, such
43 as cryptographic keys.
45 The author strives mightily to provide an API that is completely
46 independent of operating system and other library dependencies,
47 and which allows selective replacement of some modules for
48 local needs. Specifically, the essence parsers and OpenSSL
49 crypto functions can be replaced by linking to alternative
50 implementations of the ASDCP:: objects which provide those
53 AS_DCP.h contains the entire API. You do not need to read
54 any of the other files, except maybe asdcp-test.cpp which
55 contains detailed usage examples of each of the API's
56 services. The KM_* files may be of interest for general
57 development support, but may be ignored if all you want
58 is simple AS-DCP support.
63 On more-or-less POSIX systems (OS X, Linux, and BSD), GNU make and
64 autotools are required to build asdcplib. The same configure script
65 will also build this package on Windows machines with Cygwin and
66 MinGW installed. For those Windows users who would prefer to build
67 this natively, an "nmake" build file and instructions can be found
68 in the win32 subdirectory.
70 OpenSSL is also required, and the most recent version of v0.9.8
71 is recommended. See http://www.openssl.org/ for more information
72 and download instructions.
74 Optional support for writing Timed Text Track Files is supported by
75 either Xerces-C or Expat. See http://xerces.apache.org/xerces-c/ or
76 http://expat.sourceforge.net/ for source and build instructions.
78 To configure and build, type './configure' followed by 'make'. There
79 are several test targets on the POSIX side, but you need to assemble
80 a set of test files to use them.
82 I have tested this build on win32, Linux, OpenBSD, and Darwin
83 platforms. Others may work as well.
90 asdcp-test - Writes, reads and verifies AS-DCP (MXF) track files.
92 asdcp-wrap - Writes AS-DCP (MXF) track files.
94 asdcp-unwrap - Extracts essence from AS-DCP (MXF) track files.
96 asdcp-info - Displays information about AS-DCP (MXF) track files.
98 asdcp-util - Calculates digests and generates random numbers and UUIDs.
100 kmfilegen - Writes and verifies large files using a platform-
101 independent format. Use it to test issues related to large files.
103 kmuuidgen, kmrandgen - generate UUID values and random numbers.
105 wavesplit - Splits a WAVE file into two or more output files. Used
106 to untangle incorrectly-paired DCDM sound files.
108 blackwave - Write a WAVE file full of zeros, Used to make filler
109 tracks (though you would be better off modifying asdcp-test if
110 this is a common use case).
112 j2c-test - Displays information about JP2K codestreams.
117 The API documentation is mostly in AS_DCP.h. Read that file for
118 a detailed description of the library's capabilities. Read
119 asdcp-test.cpp for library usage examples. The command-line
120 utilities all respond to -h.
125 2012-03-06 - bug fixes, enhancements 1.9.45
126 o Removed ASDCP::Timestamp, all items that were of that class are now
127 of class Kumu::Timestamp
128 o Refactored Kumu::Timestamp to use KM_tai for internal representation
129 (replaced public Y M D, h, m, s variables)
130 o Refactored Kumu::Timestamp to use KM_tai for WIN32 builds
131 o Added UTC offset awareness to Kumu::Timestamp
132 o Replaced "long GetSecondsSinceEpoch(void) const" with
133 "ui64_t GetCTime() const"
134 o Corrected UL version segment in "7.1 DS" and "WTF" audio format
135 labels (corresponds with publication of ST 429-2:2011).
136 o Exposed MXF object interface (MXF.h, Metadata.h) via ASDCP MXFReader
137 and MXFWriter classes.
138 o Added UL values from ST 377-4:2012. >>>>NOTE: These are preliminary
139 values, subject to change upon final publication of not only ST 377-4
140 but also the relevant registries. This is a good time to compare them
141 to the standard and complain if you think they are wrong!
142 o Added MCALabelSubDescriptor, AudioChannelLabelSubDescriptor,
143 SoundfieldGroupLabelSubDescriptor, and
144 GroupOfSoundfieldGroupsLabelSubDescriptor (from ST 377-4:2012) to
146 o Changed some internals to make MXFWriter::OPAtomHeader() work correctly.
147 o Split asdcp-test into several different programs to help relieve
148 the impenetrable-list-of-arguments problem. asdcp-wrap, asdcp-unwrap
149 and asdcp-info take the place of asdcp-test's -c, -x and -i options,
150 respectively. asdcp-util contains the remaining functions. Note that
151 asdcp-test is now DEPRECATED, new functionality and bug fixes will be
152 aimed at the new tools. Also note that some options and calling
153 conventions are different for the new tools as compared to asdcp-test.
154 Please read the synopses and make sure you understand the new idioms.
155 o asdcp-wrap has a new argument, -C <UL>, that writes the given UL to the
156 ChannelAssignment item in the WaveAudioDescriptor (only useful when
157 writing PCM essence).
160 2011-11-30 - bug fixes v1.8.44
161 o Corrected a wrong decryption UL selection when unwrapping MXF.
164 2011-10-27 - bug fixes v1.8.43
165 o Corrected broken Essence UL matching. (Thanks to Michael Loder).
168 2011-08-31 - bug fixes v1.8.42
169 o Added missing HFR support for PCM essence reader/writer.
172 2011-08-30 - bug fixes, enhancements v1.8.41
173 o UL version byte now ignored when comparing UL values.
174 o Changed the version byte in the TimedTextEssence UL to 0x01. There
175 is no published Essence Keys registry so it can't have a maintained
177 o JP2K Sequence Parser modified to skip directory entries that
178 are not files in the case where the parser is initialized with
179 a directory path. When initialized with a list of file names
180 this check is not performed. Based on a hint by Steve Quartly.
181 o Increased the size of the MPEG header parser buffer.
182 o Added missing FrameType() implementation to ASDCP::MPEG2::MXFReader.
183 o Added missing Close() implementations to MXF reader classes.
184 o Added missing Timestamp::Timestamp(const char* datestr) implementation.
185 (Thanks to Matt Sheby for this and the previous three items.)
186 o Fixed error in Kumu::FortunaRNG::FillRandom() that was returning the
187 end of the random buffer instead of the front (Thanks to Mike Radford).
188 o Added support for proposed sound channel format identifiers
189 '7.1DS' and 'WTF'. Optimistically chose version '0x0c'.
190 o Added support for stereoscopic images in JP2K files at edit
191 rates of 48, 50 and 60 eups (96, 100 and 120 fps).
194 2010.11.15 - bug fixes, enhancements v1.7.40
195 o Fixed bug in long KLV packet support (Thanks to Jim Radford).
196 o Fixed AvgBps in PCM files, *again*. Sorry for the crazy.
197 o More fixes and changes in support of 25, 30, 50, 60 fps.
198 (Thanks to Hans K. for the TC rate bug).
199 o Updated KLVFill UL version element to 0x02.
200 o Type change to support Xerces-C 3.x. (Thanks to Matt Sheby).
201 o Some internal API changes to KLV types. Does not affect
203 o Added NetworkLocator type to MXF metadata types.
204 o Added file offset display to klvwalk.
207 2010.09.09 - bug fixes, enhancements, v1.7.39
208 o Fixed bug in JP2K PictureDescriptor initialization in
209 JP2K::MXFReader::OpenRead() and JP2K::MXFSReader::OpenRead()
210 o Once again fiddling with AvgBbs. How can something so simple
211 be such a constant cause of trouble? Tested with 1-, 2- and
212 6-channel input Wav files.
213 o asdcp-test now accepts a directory name when making PCM
214 files (-c). The directory name should be the only filename
215 argument. All files in the directory must be Wav files
216 (mixed channel sizes OK). Files are sorted alphabetically by
217 filename. Hint: use numeric name infix to define order:
226 2010.07.20 - bug fixes, v1.6.37
227 o Fixed TimedTextResourceSubDescriptor UL value.
230 2010.06.16 - bug fixes, v1.6.36
231 o Added support for new Edit Rates to asdcp-test.cpp.
232 o Expanded timed-text file reader in asdcp-test.cpp.
233 o Fixed large BER value encoding (plaintext) and decoding
234 (plaintext and ciphertext). This feature was introduced in
236 o Fixed AvgBps value for multi-channel Wave input.
239 2010.05.13 - bug fixes, enhancements, v1.6.34
240 o ST 429-5 files have corrected ULs for DCTimedTextDescriptor and
241 GenericStream DataElement. Files made with previous versions of
242 the library are incompatible with this and future versions.
243 o Fixed File Package TrackNumber values. Thanks to Sankar.
244 o Added edit rate constants to AS_DCP.h (25, 30, 50, 60).
245 o Changed AudioDescriptor "SampleRate" element name to "EditRate"
246 to make it consistent with the other types.
247 o Now builds with XercesC 3.x.
248 o KM_memio.h has better const behavior.
249 o Fixed a bug in KM_memio.h string archiving.
252 2010.01.05 - bug fixes, enhancements, v1.5.32
253 o Re-fixed swapped Interop and SMPTE OP Atom UL values. The swap
254 introduced in v1.5.31 was done in error.
255 o Added -z,-Z options to asdcp-test (j2c parameter checking)
256 o Reformed jp2k-test as j2c-test, added help and list processing,
257 added to standard install target.
260 2009.12.31 - bug fixes, enhancements, v1.5.31
261 o Fixed swapped Interop and SMPTE OP Atom UL values.
262 o Added get_BER_length_for_value() subroutine.
263 o Modified ASDCP::h__Writer::WriteEKLVPacket() to allow larger BER
264 lengths for KLV packets larger than 16 MB. This was required to
265 support large font files in the SMPTE 429-5 implementation.
268 2009.11.06 - bug fixes, enhancements, v1.5.29
269 o Fixed a bug that could cause HMAC values to be incorrectly
270 stored in MXF files. Files created with versions of asdcplib
271 prior to this version may have incorrect HMAC values.
272 o Improved handing of XML files for MXF wrapping.
273 o Jpeg2000 codestream EditRate and SampleRate mismatches
274 now warns instead of returning an error.
275 o Improved error handling in Jpeg2000 sequence parsing routines.
276 o Added two methods to Kumu::Timestamp, AddSeconds(), to add (or
277 subtract) seconds to a time value, and GetSecondsSinceEpoch()
278 to get the number of seconds since the unix epoch.
279 o Added new option to asdcp-test, '-a', to specify a UUID when
281 o Added support for specifying the intrinsic duration of MXF files
282 containing timed text.
283 o Added new option to wavesplit, '-i', to display WAV file metadata.
286 2009.05.21 - bug fixes, v.1.4.24
287 o Fixed a bug that caused incorrect SubDescriptors UL values to be
288 written into interop format MXF track files. Note that this involved
289 a substantial reorganization of MXF internals. Please test thoroughly
290 in your application before using in production. Note that this is a
291 significant bug fix and track files created with 1.4.22 may be incompatible
295 2009.04.09 - SMPTE format fixes, enhancements and bug fixes, v.1.4.22
296 o asdcplib now uses GNU autotools on POSIX systems to configure
297 and build. See "./configure" for details. Note that two options,
298 --enable-freedist and --with-python are not enabled in the free
299 version of asdcplib and should not be used.
300 o Added build option (CONFIG_RANDOM_UUID) to enable mixed case UUID
301 generation when environment variable KM_USE_RANDOM_UUID is defined.
302 o Fixed a condition that could cause an error to occur when wrapping
303 SMPTE format timed text track files that do not define a starting
305 o Updated ULs for SMPTE format track files.
306 o SampleRate added to JP2K metadata
307 o Support for wrapping 96kHz WAV files added.
308 o Updated ULs for audio channel formats (ChannelFormat)
309 o Updated font subdescriptor MIME Types for TimedText Trackfiles.
310 o Changed time implementation to support dates beyond Jan 19th, 2038.
311 o Xerces-C XML parser support added.
312 o New build method for Windows (see win32/README.txt for details).
313 o Added new functionality in Kumu to recursively create and delete files
314 and directories, and get free disk space for a given volume path.
315 o Added a method to Kumu::Timestamp, AddMinutes(), to add (or subtract)
316 minutes to a time value.
317 o Improved how Kumu::Timestamp parses timestamps with offsets.
318 o Fixed a bug that caused incorrect HMAC values to be calculated.
321 2008.02.16 - SMPTE format fixes, bug fixes v.1.3.18
322 o Added correct SMPTE UL for StereoscopicPictureSubDescriptor.
323 o Exposed JP2K metadata parser as ParseMetadataIntoDesc().
324 o Added simple stereoscopic framebuffer to support paired ReadFrame()
325 and WriteFrame() methods (allows simpler integration with other
327 o Improved detection of JPEG Interop stereoscopic files.
328 o Win32 build fixes (Thanks to Mike Crowe at DTS).
329 o Added the WITH_MD macro to the makefile. Set this value to one
330 to build Win32 with /MD[d] instead of /MT[d].
331 o The Generic Container UL has been added to the EssenceContainers
332 set in the header partition pack for encrypted files. It has always
333 been there in plaintext files.
334 - Below this point the changes are internal and should not affect you
335 unless you use Kumu directly.
336 o Major refactoring of KM_log.[h|cpp].
337 o Fixed buffer re-sizing issue in Kumu::ByteString.
338 o Replaced type IdentifierList with ArchivableList.
339 o Added COPYING file to the release bundle.
342 2007.12.13 - Bug fixes v.1.2.17
343 o Changed Result_t implementation to use int instead of long, which
344 was causing trouble on some 64 bit platforms.
345 o Fixed EKLV HMAC. NOTE: Breaks backward compatibility with older
346 Interop files. To validate these files, use asdcplib-1.1.14. This
347 should not cause too much trouble since files with broken and
348 non-broken HMAC have been in the wild for years without issue.
349 o Fixed HMAC sequence numbering in encrypted stereoscopic files.
350 o Finished stereoscopic test targets in the makefile.
351 o Fixed the win32 build, now expects VS2005 compiler by default,
352 use WITH_VC6=1 top get VC6 flags.
353 o Stereoscopic and Timed Text modes now have SMPTE UL values.
354 NOTE: SMPTE 429-5 and 429-10 are not yet published. It is possible
355 that these UL values may change before publication. Please use
356 caution when using these features for production work.
357 o Changed a bunch of symbol names in the 429-5 implementation to
358 better match the spec.
359 o Added -U option to asdcp-test to dump the UL library to stdout.
360 o Fixed erroneous placement of the PictureEssenceCoding UL in JP2K
361 files (Interop and SMPTE modes).
364 2007.10.22 - Timed Text, Stereoscopic Picture and Bug fixes v.1.2.16
365 o Significant API changes have been made. Please read all entries
366 in this changelog to be sure you understand the changes. Also
367 note that some changes have been made to LS_MXF_SMPTE files that
368 are incompatible with earlier releases (e.g., EKLV HMAC). If
369 you are looking for a stable interop release, use v.1.1.14.
370 o Fixed RFC 2104 HMAC implementation for LS_MXF_SMPTE only. The
371 broken implementation has been maintained for Interop mode.
372 o Added support for draft SMPTE 429-5 Timed Text Track File. This
373 is still waiting for official SMPTE ULs, so do not use it for
374 shipping products. An XML parser is needed to create a Timed
375 Text Track File; Expat is now an optional part of the build.
376 Make with WITH_XML_PARSER=1 to link with Expat. If you do not
377 link with expat, you will get an error when using the TimedText::
378 DCSubtitleParser class. See also S429-5-cgi.cpp for an example
379 that shows how to serve plaintext MXF file elements directly via
381 o Added support for draft SMPTE 429-10 Stereoscopic Picture Track
382 File, including the JPEG Interop version. This is still waiting
383 for official SMPTE ULs, so do not use it with LS_MXF_SMPTE for
385 o Refactored the following files as a side-effect of the above
386 work: AS_DCP_JP2K.cpp AS_DCP_MPEG2.cpp AS_DCP_PCM.cpp
387 AS_DCP_MXF.cpp AS_DCP_internal.h MXF.[h|cpp] MXFTypes.[h|cpp]
388 Metadata.[h|cpp] h__Reader.cpp h__Writer.cpp klvwalk.cpp.
389 WARNING: While significant effort has been extended to make sure
390 that these changes do not affect existing stable file support,
391 users are cautioned to test this release thouroughly.
392 o Added a large set of filesystem path manglers to KM_fileio.h. See
393 path-test.cpp for example usage. The path manglers have not yet
394 been tested on win32 platforms (they are currently used only by
395 the Timed Text module.
396 o The PathIsFile(), PathIsDirectory() and FileSize() subroutines
397 have been modified to accept const std::string& instead of
399 o Added namespace and parsing support (Expat) to Kumu::XMLElement
400 (currently used only for Timed Text support). Also added some
402 o Altered MXF::UTF16String to use mbtowc() and wctomb().
405 2007.03.31 - Bug fixes v.1.1.14
406 o Fixed KeyFrameOffset value in MPEG wrapping to have negative
407 value. This is probably not yet complete for handling all
408 types of GOPs. Please send chunks of MPEG-2 VES that you
409 find which break this. Thanks to Doremi.
410 ** no other file format changes in this release **
411 o Fixed error in RIP interpretation when reading arbitrary (i.e.,
413 o Fixed a memory leak in ASDCP::MXF::OPAtomHeader when used
414 in read mode. Thanks to Mahesh Bajaj for pointing out this
415 bug and the one above.
416 o Removed asserts from KM_fileio, replaced with RESULT_WRITEFAIL
417 return value statements.
418 o Added -s and -p to the makefile install target.
419 o Altered ByteString behavior to use target Length() in copy
420 operations (instead of Capacity()).
421 o Added new Set() method to ByteString.
422 o Fixed a bug in ByteString::Unarchive() that caused the operation
423 to fail when the buffer was smaller than the read (i.e., when
424 Capacity() was called).
425 o Added IdentifierList class to KM_util.h.
426 o Changed some Error() messages to Debug() in Wav.cpp
427 o Revived jp2k-test.cpp and asdcp-mem-test.cpp (they both had
431 2007.02.15 - Bug fixes v1.1.13
432 o Removed 'VDescObj->SampleRate.Numerator = VDesc.FrameRate;'
433 from MPEG2_VDesc_to_MD() in AS_DCP_MPEG2.cpp, was line 76.
434 o Added KM_TEST_NULL_STR_L() and KM_TEST_NULL_L() macros to
435 KM_log.h. These versions log the location of the null value.
436 Macros are now used in any module that includes KM_log.h.
437 o MPEG2 VES with run of zero values at the head is now OK.
438 o Increased VESHeaderBufSize to 16K.
439 o Added makefile support for local OpenSSL in ../openssl, if
441 o The Kumu::PathIs*() functions now return false if a null or
442 empty string is given (used to be an assert).
443 o Cleaned up the install target in the makefile.
444 o Fixed SMPTE 429-6 HMAC -- FIPS 186-2 implementation was
445 laughably incorrect. Thanks to Doremi for pointing this out.
446 o Removed default parameter to HMACContext::InitKey().
447 o Cleaned up messages and CLI arg handling in asdcp-test.
450 2006.11.19 - Mo better stuff v1.1.12
451 o Changed read-only Result_t accessor methods to const.
452 o Added Base64 (-B) option to kmrandgen.
453 o Removed 16-bit alignment restriction from kmrandgen.
454 o Improved WAV file extraction speed (Thanks to Jim Radford
455 for pointing this out).
456 o Added single-channel split for WAV extraction (asdcp-test -1).
457 o Fixed remainder bug in h__RNG::fill_rand().
460 2006.11.03 - Bug fixes v1.1.11
461 o Increased index table entry list size to 5000.
462 o Added length checking to TLV writer (returns error if TLV
463 payload exceeds 64kB).
464 o Fixed partition header and RIP errors related to 2-partition
465 files (MXF Interop mode).
466 o Added -t option to asdcp-test (SHA-1 digest with Base64 output
468 o Fixed Sub Descriptor reference bug (Thanks to Denis Leconte
469 for dogged determination).
470 o Added directory-of-wav detection to RawEssenceType()
471 o Modified MXF::Partition::AddChildObject() to only generate
472 a UUID if the InstanceID is unset.
473 o Added ComponentMaxRef & ComponentMinRef to RGBAEssenceDescriptor.
475 o Added detection of 2K/4K jp2c, writing correct 4K metadata.
478 2006.10.05 - Bug fixes v1.1.10
479 o Changed RM_RELEASE to RL_RELEASE in MXFTypes.h.
480 o Changed the MXF writer to use RL_RELEASE (was RL_DEVELOPMENT).
481 o Really fixed source reference chain.
482 o Updated JP2K file package label.
483 o Changed location of JPEG2000PictureSubDescriptor in the
484 header (was erroneously before Preface).
485 o Altered LS_MXF_INTEROP to produce 2-partition files.
488 2006.09.25 - Bug fixes v1.1.9
489 o Fixed SourcePackageID value. All files will be 'original',
490 i.e. SourcePackageID will be all zeros. Let me know if you
491 want to set SourcePackageID.
492 o Fixed compiler warnings on some Linux platforms
493 o Fixed the build so that BUILD_DIR is no longer created
495 o Added duration detection to the raw essence parsers. The
496 MPEG parser uses a nasty approximation so don't use it
497 without paying close attention to the result.
498 o Modified PCMParserList to make it more useful as a base
500 o Fixed bugs and re-organized command-line help in asdcp-test
502 o Fixed two-partition file reads.
503 o Fixed Win32 PRNG initialization.
504 o Renamed asdcp-lf-test as kmfilegen.
505 o Added kmrandgen and kmuuidgen.
506 o Added string retrieval mechanism to Result_t.
507 o Refactored Kumu::Identifier and its sub-classes.
508 o Altered Kumu::PathIsFile to return true when the path
509 is a symbolic link (unix only).
510 o Altered Kumu::FileWriter::OpenWrite to use file creation
511 mode 0664 (was 0644) (unix only).
512 o Added Kumu::WriteStringIntoFile() subroutine.
515 2006.04.05 - Bug fixes and new stuff v1.1.7
516 o Fixed a bug in the MPEG parser that caused it to fail when
517 handling start codes spanning buffer boundaries
518 o Added wavesplit and blackwave utility programs
519 o Added support for revised SMPTE HMAC key derivation when
521 o Refactored platform compatibility and general utilities
522 into a new sub-library "Kumu". There are no new build
523 steps or dependencies, but some important things have
525 + Result_t is no longer an enum, it is now a class.
526 Library result codes are now declared as const objects
529 const Kumu::Result_t RESULT_FORMAT (-101, "The file...");
531 The macros ASDCP_SUCCESS and ASDCP_FAILURE still work
532 the same way thanks to an operator overload for type long.
533 See KM_error.h for more information.
534 + The logging interface has been moved out of AS_DCP.h
536 o Some of the command line utilities that were using headers
537 other than AS_DCP.h have been changed to use the Kumu
538 equivalents. If you have code based on those utilities, you
539 will have to update by hand.
540 o Added new types to the EssenceType_t enum.
541 o The guard macro for Win32 code has changed from WIN32 to
545 2006.03.2x - new stuff
546 o Proper handling of stream-id byte of essence UL values
547 o writes 3-partition files, reads 2-part or 3-part
550 2006.03.16 - bug fixes plus
551 o Removed SMPTE_LABELS compile-time option. The reader will now
552 silently accept either SMPTE or MXF Interop labels, the writer
553 can be instructed which to use at runtime. Default is Interop.
554 o Added an AIFF reader. Support is preliminary, it works with the
555 AIFF files I have on hand.
556 o More code refactoring. More to come.
559 2006.03.09 - full read-write
560 o Removed ASDCP_WITHOUT_OPENSSL compile-time option.
561 o Full read/write now working on new MXF library
564 2005.00.00 - A New Hope
565 o The temporary mxf-lite has been removed. MXF files are now
566 managed via the objects in KLV.h, MXFTypes.h MXF.h and
567 Metadata.h. This release does not support writing MXF files.
568 o Fixed a header interpretation error in the Wav parser.
571 2005.00.00 - The Reformation
572 o Removed mxflib as a dependency by forking the necessary
573 functions and placing them in the mxf-lite subdirectory.
574 Please note that the very heavy modifications done here
575 render all comparisson to mxflib code a substantial task.
576 All errors are now mine and users are warned not to bug
577 Oliver or Matt for help with this code. The version of
578 mxflib at the time of the fork was: 0.5.1.3.
581 2005.06.03 - bug fixes v0.10.18
582 o Updated UL batch to include GC UL.
585 2005.05.27 - bug fixes v0.10.17
586 o Un-did essence container and compression descriptor changes.
587 The default build reflects MXF Interop decisions as of 26 May.
588 o Added note about build versions to README (see above).
589 o Added warnings to SMPTE_LABELS builds.
590 o Fixed JP2K essence container label.
593 2005.05.02 - bug fixes v0.10.16
594 o Reorganized internal files, added file reader object, added OS
595 portability header, removed and renamed some files. If you have a
596 patch against previous versions of the source, you should check
598 o Added RGBA attributes to JP2K descriptor.
599 o Changed interface to CodestreamParser.
600 o Added JP2K parser implementation. It is parsing each frame but is
601 not yet being used to populate the descriptor.
602 o Added 48fps option for `asdcp-test -p`.
603 o Added picture rate constants to AS_DCP.h (23.976, 24, 48).
604 o Added sample rate constant to AS_DCP.h (48k).
605 o Changed asdcp-test to encrypt picture headers by default
606 (plaintext offset will be 0), added -E option to allow
610 2005.04.28 - bug fixes v0.9.15
611 o The XML descriptors for the crypto DMS have moved in mxflib to
612 the file DMS_Crypto.xml (they were in DMS_DCPENC.xml). Older
613 installations should update the file from mxflib.
614 o Added Close() and Seek() to ~MyFileWriter(), cleaned up headers
615 o Added UUID generator output mode (-u).
616 o Added -S option to extract PCM essence into stereo wav files
617 o Added more UL testing and conformance checking.
618 o Added macro SMPTE_LABELS which causes the library to be built
619 with SMPTE (as opposed to MXF Interop) labels. This is not
620 set by default, and currently only affects the PCM container
621 label and encrypted element label.
622 o Cleaned up the GNUmakefile test targets, the source files
623 are now named with the TEST_FILE_PREFIX macro.
624 o enabled 23.976-framed PCM (2002 samples per frame)
625 o The size of the asdcp-test frame buffer for picture essence
626 may now be set from the command line (-b). The default is 4MB.
627 o h__Reader::ReadEKLVPacket() now tests the UL (duh) and switches
628 on the value, allowing plaintext and ciphertext frames to
629 be mixed in the file.
630 o Fixed error in UUID generator format.
631 o JP2K files now use the GenericPictureDescriptor to store
632 ContainerDuration and SampleRate. SampleRate is mapped
633 to EditRate in the PictureDescriptor struct. This fixes
634 the second caveat from the 0.8.13 release.
635 o Fxed bug in PCMParserList that was miscalculating the extent
636 of a PCM sample. This bug did not affect API users, it was
637 only present in asdcp-test.
638 o Fixed EditRate on PCM files (was showing sample rate)
639 o Fixed Encrypted Essence Container UL
640 o Fixed BlockAlign value for PCM essence
642 - The following changes were provided by Jeff Loewenguth
644 o Moved the DMS CryptographicFramework entry from the material
645 package to the source package
646 o Fixed erroneous Source Essence Container Label value
647 o Fixed broken sort of JP2K frames in JP2K parser
648 o Added FindFrameGOPStart() method to the MPEG2 MXFReader
649 o Added missing length values for EKLV packets without HMAC
650 o -x with JP2K essence writes to files with 6 digit names
652 o The Key ID may now be specified as an argument to asdcp-test
656 2004.12.30 - bug fixes + wav files v0.8.14
657 o Added WAV file write to asdcp-test (uses mxflib::waveheader_t).
658 o Three-partition files reading properly. adscplib still writes
660 o Changes in the mxflib WAV essence parser API had broken
661 asdcplib's ability to read essence from a WAV file. I have
662 fixed this bug, but at the expense of breaking compatibility
663 with older versions of mxflib. Beware!
664 o Removed redundant (but working) bin-text-bin conversions.
667 2004.12.23 - JPEG 2000 support v0.8.13
668 o Reads/writes JPEG 2000 essence in plaintext and ciphertext
669 with the following caveats:
670 - The Picture Essence Descriptor is empty.
671 - Because there is no essence descriptor, the reader code
672 in asdcp-test has no idea how many frames are in the file
673 and ends with an out-of-bounds frame error. This error
674 is being suppressed in asdcp-test for the current release.
675 o Still broken when reading three-partition files.
678 2004.10.22 - fixes and UL updates v0.7.11
679 WARNING: COMPATIBILITY BREAKPOINT
680 Files created with this and future versions of this library are
681 not compatible with previous versions of this library. As you
682 might suspect, files created with previous versions of this
683 library are not compatible with this and future versions.
685 o h__Reader will now open a three-partitition file (untested)
686 o Moved DMS from Material partition to File partition
687 o Added length fields to appropriate places in EKLV packet
690 2004.10.22 - fixes and UL updates v0.7.10
691 o fixed frame buffer handling of externally allocated buffer,
692 created unit test (asdcp-mem-test)
693 o added operator==() and operator!=() to Rational type
694 o fixed some type-related compiler warnings
695 o asdcp-test -p now works on unwrap
696 o updated some ULs to match documentation (thanks to Arun
698 o canonicalized line endings
701 2004.07.02 - full plaintext + ciphertext read/write v0.6.9
702 o HMAC, plaintext offest and raw ciphertext read supported
703 o back to proper CBR index
704 o MPEG temporal offset working
707 2004.07.01 - plaintext + ciphertext read/write v0.5.8
708 o encryption of MPEG and PCM essence supported with the
711 - no plaintext offest support
712 - no raw ciphertext read support
713 o moved to reflecting the whole KLV triplet in the CBR
714 index (now incompatible with mxflib, still searching
715 for info about what's "right")
716 o awaitng the following fixes/features:
717 - retrieve Temporal Offset from index in MPEG2::Reader
718 - test for correct ULs when reading frame triplets
719 - fix header metadata items for encrypted files
721 - plaintext offest support
722 - raw ciphertext read support
725 2004.06.14 - plaintext read/write w/key generator v0.4.5
726 o Project now uses OpenSSL (tested with 0.9.7d on win32, Linux, Darwin)
727 Use `make ASDCP_WITHOUT_OPENSSL=1` to make plaintext-only version
728 o Accepts interior I frames when parsing MPEG2 VES
729 o Improved error reporting on format errors
730 o Added support for encryption to asdcp-test
731 o Added RNG for asdcp-test (non-production use only, see notes in FortunaRNG.h)
732 o Implemented CBC encrypt, decrypt module
733 o Added partial TemporalOffset retrieval from MPEG2 parser
734 o Fixed win32 binmode bug
737 2004.05.12 - plaintext read/write v0.3.4
738 o Full read/write of plaintext MPEG-2 VES and WAV files
739 (does not yet support mux from or demux to 2 channel pairs)
740 o Builds with autoconf-based mxflib
741 o Added ASDCP_ prefix to macros
742 o Updated documentation, fixed documentation errors
743 o Simplified API for MXF writer setup
744 o Decoupled essence parsers from MXF writers
745 o added raw ciphertext support to FrameBuffer
746 o Cleaned up Get/Set naming confusion
747 o Added missing const qualifiers
750 2004.04.27 - preview release v0.2.1
751 o hasty release for quick review
752 o this release may not build with mxflib using autoconf.
753 o writes plaintext AS-DCP MPEG2 essence files
754 o tested under win32 and linux. FreeBSD and Darwin do not work
757 2004.02.04 - First release (v0.1.1):
758 o asdcp-test is mostly complete. It should correctly provide
759 access to the read and info capabilities of the library.
760 o The MPEG2 reader is functional but not fully tested.
761 o Some file format integrity tests remain to be coded.
762 o The PCM reader is mostly complete, I am having difficulty
763 getting a suitable test file from mxfwrap.
764 o The makefile creates a static library module. The API
765 will cleanly support a DSO (or DLL). Let me know if DSO
766 support is important to you.
767 o Nothing is thread safe. Thread safety was not a requirement
768 in the initial project definition. Thread safety may be added
769 above the mxflib/klvlib level. Let me know if it is important
771 o The files xmldict.xml and types.xml must be in the current
772 directory when the program is run. The files are supplied
773 with mxflib. Runtime location of the files is not currently
774 a project goal. Comments on how best to handle this situation
775 would be appreciated. See AS_DCP.cpp at init_mxf_types()
776 for a more detailed discussion.