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