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