updates for version bump
[asdcplib.git] / README
1
2 $Id$
3
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.
8
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.
13
14 **The asdcplib project was originally housed on SourceForge.
15 The project has moved to http://www.cinecert.com/asdcplib/
16
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.
24
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.
30
31
32 Design Notes
33
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.
44
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
51 services.
52
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.
59
60
61 Build Instructions
62
63 On more-or-less POSIX systems (OS X, Linux, and BSD), GNU make is
64 required to build asdcplib. The same configure script will also
65 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.
69
70 OpenSSL is also required, version 0.9.8k is recommended. See 
71 http://www.openssl.org/ for more information and download 
72 instructions.
73
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.
77
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.
81
82 I have tested this build on win32, Linux, OpenBSD, and Darwin
83 platforms. Others may work as well.
84
85
86
87
88 Utilities
89
90 asdcp-test - Writes, reads and verifies AS-DCP (MXF) track files.
91
92 kmfilegen - Writes and verifies large files using a platform-
93 independent format. Use it to test issues related to large files.
94
95 kmuuidgen, kmrandgen - generate UUID values and random numbers.
96
97 wavesplit - Splits a WAVE file into two or more output files. Used
98   to untangle incorrectly-paired DCDM sound files.
99
100 blackwave - Write a WAVE file full of zeros,  Used to make filler
101   tracks (though you would be better off modifying asdcp-test if
102   this is a common use case).
103
104
105 Documentation
106
107 The API documentation is mostly in AS_DCP.h. Read that file for
108 a detailed description of the library's capabilities. Read
109 asdcp-test.cpp for library usage examples. The command-line
110 utilities all respond to -h.
111
112
113 Change History
114
115 2010.07.20 -  bug fixes, v1.6.37
116  o Fixed TimedTextResourceSubDescriptor UL value.
117
118
119 2010.06.16 -  bug fixes, v1.6.36
120  o Added support for new Edit Rates to asdcp-test.cpp.
121  o Expanded timed-text file reader in asdcp-test.cpp.
122  o Fixed large BER value encoding (plaintext) and decoding
123    (plaintext and ciphertext). This feature was introduced in
124    v1.5.31).
125  o Fixed AvgBps value for multi-channel Wave input.
126
127
128 2010.05.13 -  bug fixes, enhancements, v1.6.34
129  o ST 429-5 files have corrected ULs for DCTimedTextDescriptor and
130    GenericStream DataElement. Files made with previous versions of
131    the library are incompatible with this and future versions.
132  o Fixed File Package TrackNumber values. Thanks to Sankar.
133  o Added edit rate constants to AS_DCP.h (25, 30, 50, 60).
134  o Changed AudioDescriptor "SampelRate" element name to "EditRate"
135    to make it consistent with the other types.
136  o Now builds with XercesC 3.x.
137  o KM_memio.h has better const behavior.
138  o Fixed a bug in KM_memio.h string archiving.
139
140
141 2010.01.05 -  bug fixes, enhancements, v1.5.32
142  o Re-fixed swapped Interop and SMPTE OP Atom UL values. The swap
143    introduced in v1.5.31 was done in error.
144  o Added -z,-Z options to asdcp-test (j2c parameter checking)
145  o Reformed jp2k-test as j2c-test, added help and list processing,
146    added to standard install target.
147
148
149 2009.12.31 -  bug fixes, enhancements, v1.5.31
150  o Fixed swapped Interop and SMPTE OP Atom UL values.
151  o Added get_BER_length_for_value() subroutine.
152  o Modified ASDCP::h__Writer::WriteEKLVPacket() to allow larger BER
153    lengths for KLV packets larger than 16 MB. This was required to
154    support large font files in the SMPTE 429-5 implementation.
155
156
157 2009.11.06 - bug fixes, enhancements, v1.5.29
158  o Fixed a bug that could cause HMAC values to be incorrectly
159    stored in MXF files.  Files created with versions of asdcplib
160    prior to this version may have incorrect HMAC values. 
161  o Improved handing of XML files for MXF wrapping.  
162  o Jpeg2000 codestream EditRate and SampleRate mismatches
163    now warns instead of returning an error. 
164  o Improved error handling in Jpeg2000 sequence parsing routines.  
165  o Added two methods to Kumu::Timestamp, AddSeconds(), to add (or
166    subtract) seconds to a time value, and GetSecondsSinceEpoch()
167    to get the number of seconds since the unix epoch.
168  o Added new option to asdcp-test, '-a', to specify a UUID when
169    creating MXF files.
170  o Added support for specifying the intrinsic duration of MXF files
171    containing timed text.
172  o Added new option to wavesplit, '-i', to display WAV file metadata.
173
174
175 2009.05.21 - bug fixes, v.1.4.24
176  o Fixed a bug that caused incorrect SubDescriptors UL values to be 
177    written into interop format MXF track files.  Note that this involved
178    a substantial reorganization of MXF internals.  Please test thoroughly
179    in your application before using in production.  Note that this is a 
180    significant bug fix and track files created with 1.4.22 may be incompatible
181    with other systems.  
182
183
184 2009.04.09 - SMPTE format fixes, enhancements and bug fixes, v.1.4.22
185  o asdcplib now uses GNU autotools on POSIX systems to configure 
186    and build.  See "./configure" for details.  Note that two options, 
187    --enable-freedist and --with-python are not enabled in the free
188    version of asdcplib and should not be used.  
189  o Added build option (CONFIG_RANDOM_UUID) to enable mixed case UUID
190    generation when environment variable KM_USE_RANDOM_UUID is defined.
191  o Fixed a condition that could cause an error to occur when wrapping 
192    SMPTE format timed text track files that do not define a starting 
193    frame.
194  o Updated ULs for SMPTE format track files.
195  o SampleRate added to JP2K metadata
196  o Support for wrapping 96kHz WAV files added.
197  o Updated ULs for audio channel formats  (ChannelFormat)  
198  o Updated font subdescriptor MIME Types for TimedText Trackfiles.
199  o Changed time implementation to support dates beyond Jan 19th, 2038.
200  o Xerces-C XML parser support added.  
201  o New build method for Windows (see win32/README.txt for details).
202  o Added new functionality in Kumu to recursively create and delete files 
203    and directories, and get free disk space for a given volume path.
204  o Added a method to Kumu::Timestamp, AddMinutes(), to add (or subtract) 
205    minutes to a time value.  
206  o Improved how Kumu::Timestamp parses timestamps with offsets. 
207  o Fixed a bug that caused incorrect HMAC values to be calculated.
208
209
210 2008.02.16 - SMPTE format fixes, bug fixes v.1.3.18
211  o Added correct SMPTE UL for StereoscopicPictureSubDescriptor.
212  o Exposed JP2K metadata parser as ParseMetadataIntoDesc().
213  o Added simple stereoscopic framebuffer to support paired ReadFrame()
214    and WriteFrame() methods (allows simpler integration with other
215    single-buffer code).
216  o Improved detection of JPEG Interop stereoscopic files.
217  o Win32 build fixes (Thanks to Mike Crowe at DTS).
218  o Added the WITH_MD macro to the makefile. Set this value to one
219    to build Win32 with /MD[d] instead of /MT[d].
220  o The Generic Container UL has been added to the EssenceContainers
221    set in the header partition pack for encrypted files. It has always
222    been there in plaintext files.
223  - Below this point the changes are internal and should not affect you
224    unless you use Kumu directly.
225  o Major refactoring of KM_log.[h|cpp].
226  o Fixed buffer re-sizing issue in Kumu::ByteString.
227  o Replaced type IdentifierList with ArchivableList.
228  o Added COPYING file to the release bundle.
229
230
231 2007.12.13 - Bug fixes v.1.2.17
232  o Changed Result_t implementation to use int instead of long, which
233    was causing trouble on some 64 bit platforms.
234  o Fixed EKLV HMAC. NOTE: Breaks backward compatibility with older
235    Interop files. To validate these files, use asdcplib-1.1.14. This
236    should not cause too much trouble since files with broken and
237    non-broken HMAC have been in the wild for years without issue.
238  o Fixed HMAC sequence numbering in encrypted stereoscopic files.
239  o Finished stereoscopic test targets in the makefile.
240  o Fixed the win32 build, now expects VS2005 compiler by default,
241    use WITH_VC6=1 top get VC6 flags.
242  o Stereoscopic and Timed Text modes now have SMPTE UL values.
243    NOTE: SMPTE 429-5 and 429-10 are not yet published. It is possible
244    that these UL values may change before publication. Please use
245    caution when using these features for production work.
246  o Changed a bunch of symbol names in the 429-5 implementation to
247    better match the spec.
248  o Added -U option to asdcp-test to dump the UL library to stdout.
249  o Fixed erroneous placement of the PictureEssenceCoding UL in JP2K
250    files (Interop and SMPTE modes).
251
252
253 2007.10.22 - Timed Text, Stereoscopic Picture and Bug fixes v.1.2.16
254  o Significant API changes have been made. Please read all entries
255    in this changelog to be sure you understand the changes. Also
256    note that some changes have been made to LS_MXF_SMPTE files that
257    are incompatible with earlier releases (e.g., EKLV HMAC). If
258    you are looking for a stable interop release, use  v.1.1.14.
259  o Fixed RFC 2104 HMAC implementation for LS_MXF_SMPTE only. The
260    broken implementation has been maintained for Interop mode.
261  o Added support for draft SMPTE 429-5 Timed Text Track File. This
262    is still waiting for official SMPTE ULs, so do not use it for
263    shipping products.  An XML parser is needed to create a Timed
264    Text Track File; Expat is now an optional part of the build.
265    Make with WITH_XML_PARSER=1 to link with Expat. If you do not
266    link with expat, you will get an error when using the TimedText::
267    DCSubtitleParser class. See also S429-5-cgi.cpp for an example
268    that shows how to serve plaintext MXF file elements directly via
269    HTTP.
270  o Added support for draft SMPTE 429-10 Stereoscopic Picture Track
271    File, including the JPEG Interop version. This is still waiting
272    for official SMPTE ULs, so do not use it with LS_MXF_SMPTE for
273    shipping products.  
274  o Refactored the following files as a side-effect of the above
275    work: AS_DCP_JP2K.cpp AS_DCP_MPEG2.cpp AS_DCP_PCM.cpp
276    AS_DCP_MXF.cpp AS_DCP_internal.h MXF.[h|cpp] MXFTypes.[h|cpp]
277    Metadata.[h|cpp] h__Reader.cpp h__Writer.cpp klvwalk.cpp.
278    WARNING: While significant effort has been extended to make sure
279    that these changes do not affect existing stable file support,
280    users are cautioned to test this release thouroughly.
281  o Added a large set of filesystem path manglers to KM_fileio.h. See
282    path-test.cpp for example usage. The path manglers have not yet
283    been tested on win32 platforms (they are currently used only by
284    the Timed Text module.
285  o The PathIsFile(), PathIsDirectory() and FileSize() subroutines
286    have been modified to accept const std::string& instead of
287    const char*.
288  o Added namespace and parsing support (Expat) to Kumu::XMLElement
289    (currently used only for Timed Text support). Also added some
290    new accessors.
291  o Altered MXF::UTF16String to use mbtowc() and wctomb().
292
293
294 2007.03.31 - Bug fixes v.1.1.14
295  o Fixed KeyFrameOffset value in MPEG wrapping to have negative
296    value. This is probably not yet complete for handling all
297    types of GOPs. Please send chunks of MPEG-2 VES that you
298    find which break this. Thanks to Doremi.
299  ** no other file format changes in this release **
300  o Fixed error in RIP interpretation when reading arbitrary (i.e.,
301    non-MXF) files.
302  o Fixed a memory leak in ASDCP::MXF::OPAtomHeader when used
303    in read mode. Thanks to Mahesh Bajaj for pointing out this
304    bug and the one above.
305  o Removed asserts from KM_fileio, replaced with RESULT_WRITEFAIL
306    return value statements.
307  o Added -s and -p to the makefile install target.
308  o Altered ByteString behavior to use target Length() in copy
309    operations (instead of Capacity()).
310  o Added new Set() method to ByteString.
311  o Fixed a bug in ByteString::Unarchive() that caused the operation
312    to fail when the buffer was smaller than the read (i.e., when
313    Capacity() was called).
314  o Added IdentifierList class to KM_util.h.
315  o Changed some Error() messages to Debug() in Wav.cpp
316  o Revived jp2k-test.cpp and asdcp-mem-test.cpp (they both had
317    stale #includes).
318
319
320 2007.02.15 - Bug fixes v1.1.13
321  o Removed 'VDescObj->SampleRate.Numerator = VDesc.FrameRate;'
322    from MPEG2_VDesc_to_MD() in AS_DCP_MPEG2.cpp, was line 76.
323  o Added KM_TEST_NULL_STR_L() and KM_TEST_NULL_L() macros to
324    KM_log.h. These versions log the location of the null value.
325    Macros are now used in any module that includes KM_log.h.
326  o MPEG2 VES with run of zero values at the head is now OK.
327  o Increased VESHeaderBufSize to 16K.
328  o Added makefile support for local OpenSSL in ../openssl, if
329    present.
330  o The Kumu::PathIs*() functions now return false if a null or
331    empty string is given (used to be an assert).
332  o Cleaned up the install target in the makefile.
333  o Fixed SMPTE 429-6 HMAC -- FIPS 186-2 implementation was
334    laughably incorrect. Thanks to Doremi for pointing this out.
335  o Removed default parameter to HMACContext::InitKey().
336  o Cleaned up messages and CLI arg handling in asdcp-test.
337
338
339 2006.11.19 - Mo better stuff v1.1.12
340  o Changed read-only Result_t accessor methods to const.
341  o Added Base64 (-B) option to kmrandgen.
342  o Removed 16-bit alignment restriction from kmrandgen.
343  o Improved WAV file extraction speed (Thanks to Jim Radford
344    for pointing this out).
345  o Added single-channel split for WAV extraction (asdcp-test -1).
346  o Fixed remainder bug in h__RNG::fill_rand().
347
348
349 2006.11.03 - Bug fixes v1.1.11
350  o Increased index table entry list size to 5000.
351  o Added length checking to TLV writer (returns error if TLV
352    payload exceeds 64kB).
353  o Fixed partition header and RIP errors related to 2-partition
354    files (MXF Interop mode).
355  o Added -t option to asdcp-test (SHA-1 digest with Base64 output
356    on stdout).
357  o Fixed Sub Descriptor reference bug (Thanks to Denis Leconte
358    for dogged determination).
359  o Added directory-of-wav detection to RawEssenceType()
360  o Modified MXF::Partition::AddChildObject() to only generate
361    a UUID if the InstanceID is unset.
362  o Added ComponentMaxRef & ComponentMinRef to RGBAEssenceDescriptor.
363    More to follow.
364  o Added detection of 2K/4K jp2c, writing correct 4K metadata.
365
366
367 2006.10.05 - Bug fixes v1.1.10
368  o Changed RM_RELEASE to RL_RELEASE in MXFTypes.h.
369  o Changed the MXF writer to use RL_RELEASE (was RL_DEVELOPMENT).
370  o Really fixed source reference chain.
371  o Updated JP2K file package label.
372  o Changed location of JPEG2000PictureSubDescriptor in the
373    header (was erroneously before Preface).
374  o Altered LS_MXF_INTEROP to produce 2-partition files.
375
376
377 2006.09.25 - Bug fixes v1.1.9
378  o Fixed SourcePackageID value. All files will be 'original',
379    i.e. SourcePackageID will be all zeros. Let me know if you
380    want to set SourcePackageID.
381  o Fixed compiler warnings on some Linux platforms
382  o Fixed the build so that BUILD_DIR is no longer created
383    as a dependency.
384  o Added duration detection to the raw essence parsers. The
385    MPEG parser uses a nasty approximation so don't use it
386    without paying close attention to the result.
387  o Modified PCMParserList to make it more useful as a base
388    class.
389  o Fixed bugs and re-organized command-line help in asdcp-test
390    and klvwalk.
391  o Fixed two-partition file reads.
392  o Fixed Win32 PRNG initialization.
393  o Renamed asdcp-lf-test as kmfilegen.
394  o Added kmrandgen and kmuuidgen.
395  o Added string retrieval mechanism to Result_t.
396  o Refactored Kumu::Identifier and its sub-classes.
397  o Altered Kumu::PathIsFile to return true when the path
398    is a symbolic link (unix only).
399  o Altered Kumu::FileWriter::OpenWrite to use file creation
400    mode 0664 (was 0644) (unix only).
401  o Added Kumu::WriteStringIntoFile() subroutine.
402
403
404 2006.04.05 - Bug fixes and new stuff v1.1.7
405  o Fixed a bug in the MPEG parser that caused it to fail when
406    handling start codes spanning buffer boundaries
407  o Added wavesplit and blackwave utility programs
408  o Added support for revised SMPTE HMAC key derivation when
409    using LS_MXF_SMPTE
410  o Refactored platform compatibility and general utilities
411    into a new sub-library "Kumu". There are no new build
412    steps or dependencies, but some important things have
413    changed:
414    + Result_t is no longer an enum, it is now a class.
415      Library result codes are now declared as const objects
416      like this:
417
418      const Kumu::Result_t RESULT_FORMAT (-101, "The file...");
419
420      The macros ASDCP_SUCCESS and ASDCP_FAILURE still work
421      the same way thanks to an operator overload for type long.
422      See KM_error.h for more information.
423    + The logging interface has been moved out of AS_DCP.h
424      and into KM_log.h
425  o Some of the command line utilities that were using headers
426    other than AS_DCP.h have been changed to use the Kumu
427    equivalents. If you have code based on those utilities, you
428    will have to update by hand.
429  o Added new types to the EssenceType_t enum.
430  o The guard macro for Win32 code has changed from WIN32 to
431    KM_WIN32.
432
433
434 2006.03.2x - new stuff
435  o Proper handling of stream-id byte of essence UL values
436  o writes 3-partition files, reads 2-part or 3-part
437
438
439 2006.03.16 - bug fixes plus
440  o Removed SMPTE_LABELS compile-time option. The reader will now
441    silently accept either SMPTE or MXF Interop labels, the writer
442    can be instructed which to use at runtime. Default is Interop.
443  o Added an AIFF reader. Support is preliminary, it works with the
444    AIFF files I have on hand.
445  o More code refactoring. More to come.
446
447
448 2006.03.09 - full read-write
449  o Removed ASDCP_WITHOUT_OPENSSL compile-time option.
450  o Full read/write now working on new MXF library
451
452
453 2005.00.00 - A New Hope
454  o The temporary mxf-lite has been removed. MXF files are now 
455    managed via the objects in KLV.h, MXFTypes.h MXF.h and
456    Metadata.h. This release does not support writing MXF files.
457  o Fixed a header interpretation error in the Wav parser.
458
459
460 2005.00.00 - The Reformation
461  o Removed mxflib as a dependency by forking the necessary
462    functions and placing them in the mxf-lite subdirectory.
463    Please note that the very heavy modifications done here
464    render all comparisson to mxflib code a substantial task.
465    All errors are now mine and users are warned not to bug
466    Oliver or Matt for help with this code. The version of
467    mxflib at the time of the fork was: 0.5.1.3.
468
469
470 2005.06.03 - bug fixes v0.10.18
471  o Updated UL batch to include GC UL.
472
473
474 2005.05.27 - bug fixes v0.10.17
475  o Un-did essence container and compression descriptor changes.
476    The default build reflects MXF Interop decisions as of 26 May.
477  o Added note about build versions to README (see above).
478  o Added warnings to SMPTE_LABELS builds.
479  o Fixed JP2K essence container label.
480
481
482 2005.05.02 - bug fixes v0.10.16
483  o Reorganized internal files, added file reader object, added OS
484    portability header, removed and renamed some files. If you have a
485    patch against previous versions of the source, you should check
486    it thoroughly.
487  o Added RGBA attributes to JP2K descriptor.
488  o Changed interface to CodestreamParser.
489  o Added JP2K parser implementation. It is parsing each frame but is
490    not yet being used to populate the descriptor.
491  o Added 48fps option for `asdcp-test -p`.
492  o Added picture rate constants to AS_DCP.h (23.976, 24, 48).
493  o Added sample rate constant to AS_DCP.h (48k).
494  o Changed asdcp-test to encrypt picture headers by default
495    (plaintext offset will be 0), added -E option to allow
496    plaintext headers.
497
498
499 2005.04.28 - bug fixes v0.9.15
500  o The XML descriptors for the crypto DMS have moved in mxflib to
501    the file DMS_Crypto.xml (they were in DMS_DCPENC.xml).  Older
502    installations should update the file from mxflib.
503  o Added Close() and Seek() to ~MyFileWriter(), cleaned up headers
504  o Added UUID generator output mode (-u).
505  o Added -S option to extract PCM essence into stereo wav files
506  o Added more UL testing and conformance checking.
507  o Added macro SMPTE_LABELS which causes the library to be built
508    with SMPTE (as opposed to MXF Interop) labels. This is not
509    set by default, and currently only affects the PCM container
510    label and encrypted element label.
511  o Cleaned up the GNUmakefile test targets, the source files
512    are now named with the TEST_FILE_PREFIX macro.
513  o enabled 23.976-framed PCM (2002 samples per frame)
514  o The size of the asdcp-test frame buffer for picture essence
515    may now be set from the command line (-b).  The default is 4MB.
516  o h__Reader::ReadEKLVPacket() now tests the UL (duh) and switches
517    on the value, allowing plaintext and ciphertext frames to
518    be mixed in the file.
519  o Fixed error in UUID generator format.
520  o JP2K files now use the GenericPictureDescriptor to store
521    ContainerDuration and SampleRate. SampleRate is mapped
522    to EditRate in the PictureDescriptor struct. This fixes
523    the second caveat from the 0.8.13 release.
524  o Fxed bug in PCMParserList that was miscalculating the extent
525    of a PCM sample.  This bug did not affect API users, it was
526    only present in asdcp-test.
527  o Fixed EditRate on PCM files (was showing sample rate)
528  o Fixed Encrypted Essence Container UL
529  o Fixed BlockAlign value for PCM essence
530
531  - The following changes were provided by Jeff Loewenguth
532  - Thanks Jeff!
533  o Moved the DMS CryptographicFramework entry from the material
534    package to the source package
535  o Fixed erroneous Source Essence Container Label value
536  o Fixed broken sort of JP2K frames in JP2K parser
537  o Added FindFrameGOPStart() method to the MPEG2 MXFReader
538  o Added missing length values for EKLV packets without HMAC
539  o -x with JP2K essence writes to files with 6 digit names
540    (up from 5 digits).
541  o The Key ID may now be specified as an argument to asdcp-test
542     (-j <key-id-string>)
543
544
545 2004.12.30 - bug fixes + wav files v0.8.14
546  o Added WAV file write to asdcp-test (uses mxflib::waveheader_t).
547  o Three-partition files reading properly.  adscplib still writes
548    two-partition files.
549  o Changes in the mxflib WAV essence parser API had broken
550    asdcplib's ability to read essence from a WAV file.  I have
551    fixed this bug, but at the expense of breaking compatibility
552    with older versions of mxflib. Beware!
553  o Removed redundant (but working) bin-text-bin conversions.
554
555
556 2004.12.23 - JPEG 2000 support v0.8.13
557  o Reads/writes JPEG 2000 essence in plaintext and ciphertext
558    with the following caveats:
559     - The Picture Essence Descriptor is empty.
560     - Because there is no essence descriptor, the reader code
561       in asdcp-test has no idea how many frames are in the file
562       and ends with an out-of-bounds frame error.  This error
563       is being suppressed in asdcp-test for the current release.
564  o Still broken when reading three-partition files.
565
566
567 2004.10.22 - fixes and UL updates v0.7.11
568  WARNING: COMPATIBILITY BREAKPOINT
569  Files created with this and future versions of this library are
570  not compatible with previous versions of this library.  As you
571  might suspect, files created with previous versions of this
572  library are not compatible with  this and future versions.
573
574  o h__Reader will now open a three-partitition file (untested)
575  o Moved DMS from Material partition to File partition
576  o Added length fields to appropriate places in EKLV packet 
577
578
579 2004.10.22 - fixes and UL updates v0.7.10
580  o fixed frame buffer handling of externally allocated buffer,
581    created unit test (asdcp-mem-test)
582  o added operator==() and operator!=() to Rational type
583  o fixed some type-related compiler warnings
584  o asdcp-test -p now works on unwrap
585  o updated some ULs to match documentation (thanks to Arun
586    for the submission)
587  o canonicalized line endings
588
589
590 2004.07.02 - full plaintext + ciphertext read/write v0.6.9
591  o HMAC, plaintext offest and raw ciphertext read supported
592  o back to proper CBR index
593  o MPEG temporal offset working
594
595
596 2004.07.01 - plaintext + ciphertext read/write v0.5.8
597  o encryption of MPEG and PCM essence supported with the
598    following caveats:
599    - no HMAC support
600    - no plaintext offest support
601    - no raw ciphertext read support
602  o moved to reflecting the whole KLV triplet in the CBR
603    index (now incompatible with mxflib, still searching
604    for info about what's "right")
605  o awaitng the following fixes/features:
606    - retrieve Temporal Offset from index in MPEG2::Reader
607    - test for correct ULs when reading frame triplets
608    - fix header metadata items for encrypted files
609    - HMAC support
610    - plaintext offest support
611    - raw ciphertext read support
612
613
614 2004.06.14 - plaintext read/write w/key generator v0.4.5
615  o Project now uses OpenSSL (tested with 0.9.7d on win32, Linux, Darwin)
616    Use `make ASDCP_WITHOUT_OPENSSL=1` to make plaintext-only version
617  o Accepts interior I frames when parsing MPEG2 VES
618  o Improved error reporting on format errors
619  o Added support for encryption to asdcp-test
620  o Added RNG for asdcp-test (non-production use only, see notes in FortunaRNG.h)
621  o Implemented CBC encrypt, decrypt module
622  o Added partial TemporalOffset retrieval from MPEG2 parser
623  o Fixed win32 binmode bug
624
625
626 2004.05.12 - plaintext read/write v0.3.4
627  o Full read/write of plaintext MPEG-2 VES and WAV files
628    (does not yet support mux from or demux to 2 channel pairs)
629  o Builds with autoconf-based mxflib
630  o Added ASDCP_ prefix to macros
631  o Updated documentation, fixed documentation errors
632  o Simplified API for MXF writer setup
633  o Decoupled essence parsers from MXF writers
634  o added raw ciphertext support to FrameBuffer
635  o Cleaned up Get/Set naming confusion
636  o Added missing const qualifiers
637
638
639 2004.04.27 - preview release v0.2.1
640  o hasty release for quick review
641  o this release may not build with mxflib using autoconf.
642  o writes plaintext AS-DCP MPEG2 essence files
643  o tested under win32 and linux. FreeBSD and Darwin do not work
644
645
646 2004.02.04 - First release (v0.1.1):
647  o asdcp-test is mostly complete. It should correctly provide
648    access to the read and info capabilities of the library.
649  o The MPEG2 reader is functional but not fully tested.
650  o Some file format integrity tests remain to be coded.
651  o The PCM reader is mostly complete, I am having difficulty
652    getting a suitable test file from mxfwrap.
653  o The makefile creates a static library module. The API
654    will cleanly support a DSO (or DLL). Let me know if DSO
655    support is important to you.
656  o Nothing is thread safe. Thread safety was not a requirement
657    in the initial project definition. Thread safety may be added
658    above the mxflib/klvlib level. Let me know if it is important
659    to you.
660  o The files xmldict.xml and types.xml must be in the current
661    directory when the program is run. The files are supplied
662    with mxflib. Runtime location of the files is not currently
663    a project goal. Comments on how best to handle this situation
664    would be appreciated. See AS_DCP.cpp at init_mxf_types()
665    for a more detailed discussion.
666
667 --