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