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