490ced0532a01861b83de19ec34b9dca8d11ba02
[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 (now TC 21DC).
8
9 Recently, support has also been added for SMPTE draft ST
10 2067-5 "IMF Essence Component", AKA "AS-02".  This code was
11 donated by Fraunhofer IIS.  It carries additional copyright
12 information which should be listed whenever you link the
13 AS-02 elements of the library.  Please look at the top of
14 the AS-02 files to see this copyright information.
15
16 AS-02 support is carried in separate object modules, so
17 unless you #include <AS_02.h> and link libas-02.so you are
18 still using plain old asdcp.
19
20 This work was originally funded by Digital Cinema Initiatives,
21 LLC (DCI). Subsequent efforts have been funded by Deluxe
22 Laboratories, Doremi Labs, CineCert LLC, Avica Technology
23 and others.
24
25 **The asdcplib project was originally housed on SourceForge.
26 The project has moved to http://www.cinecert.com/asdcplib/
27
28 The project formerly depended upon the mxflib project. Because
29 of its focus on covering the whole of the MXF specifications,
30 mxflib is considerably larger and more complex that what I
31 require for this application. For this reason I have created
32 a dedicated MXF implementation that is now part of this
33 library. Special thanks to Matt Beard and Oliver Morgan for
34 their great work and support.
35
36 Thanks also to the members of the SMPTE DC28.20 packaging
37 ad-hoc group and the members of the MXF Interop Initiative
38 for their encouragement and support. Special thanks to
39 Jim Whittlesey and Howard Lukk at DCI for proposing and
40 supporting this project.
41
42
43 Design Notes
44
45 This library is intended (but of course not limited) for
46 use by developers of commercial D-Cinema products (and now
47 IMF!).  It is designed to be easily integrated into a wide
48 variety of development environments.  Commercial users are
49 strongly urged to use static linking (at least where you use
50 this library) to prevent malicious in-field replacement of
51 critical system modules. This recommendation should be
52 considered wherever Open Source or Free software is being
53 used in conjunction with critical security parameters, such
54 as cryptographic keys.
55
56 The author strives mightily to provide an API that is completely
57 independent of operating system and other library dependencies,
58 and which allows selective replacement of some modules for
59 local needs.  Specifically, the essence parsers and OpenSSL
60 crypto functions can be replaced by linking to alternative
61 implementations of the ASDCP:: objects which provide those
62 services.
63
64 AS_DCP.h contains the entire AS-DCP API.  You do not need to
65 read any of the other files, except maybe asdcp-test.cpp which
66 contains detailed usage examples of each of the API's services.
67 The KM_* files may be of interest for general development
68 support, but may be ignored if all you want is simple AS-DCP
69 support.
70
71 Likewise, draft 2067-5 "IMF Essence Component" (AS-02) support
72 is entirely contained in AS-02.h
73
74
75 Build Instructions
76
77 On more-or-less POSIX systems (OS X, Linux, and BSD), GNU make and 
78 autotools are required to build asdcplib. The same configure script 
79 will also build this package on Windows machines with Cygwin and
80 MinGW installed. For those Windows users who would prefer to build
81 this natively, an "nmake" build file and instructions can be found
82 in the win32 subdirectory.  
83
84 OpenSSL is also required, any recent version should be fine. See
85 http://www.openssl.org/ for more information and download instructions.
86
87 Optional support for writing Timed Text Track Files is supported by
88 either Xerces-C or Expat. See http://xerces.apache.org/xerces-c/ or
89 http://expat.sourceforge.net/ for source and build instructions.
90
91 To configure and build, type './configure' followed by 'make'. There
92 are several test targets on the POSIX side, but you need to assemble
93 a set of test files to use them.  AS-02 support can be enabled with 
94  --enable-as-02.  
95
96 I have tested this build on win32, Linux, OpenBSD, and Darwin
97 platforms. Others may work as well.
98
99
100
101
102 Utilities
103
104 asdcp-test -  Writes, reads and verifies AS-DCP (MXF) track files.
105
106 asdcp-wrap - Writes AS-DCP (MXF) track files.
107
108 asdcp-unwrap - Extracts essence from AS-DCP (MXF) track files.
109
110 asdcp-info - Displays information about AS-DCP (MXF) track files.
111
112 asdcp-util - Calculates digests and generates random numbers and UUIDs.
113
114 as-02-wrap - Writes AS-02 Essence Component files.
115
116 as-02-unwrap - Extracts essence from AS-02 Essence Component files.
117
118 kmfilegen - Writes and verifies large files using a platform-
119 independent format. Use it to test issues related to large files.
120
121 kmuuidgen, kmrandgen - generate UUID values and random numbers.
122
123 wavesplit - Splits a WAVE file into two or more output files. Used
124   to untangle incorrectly-paired DCDM sound files.
125
126 blackwave - Write a WAVE file full of zeros,  Used to make filler
127   tracks (though you would be better off modifying asdcp-test if
128   this is a common use case).
129
130 j2c-test - Displays information about JP2K codestreams.
131
132 Experimental feature: Prototype for High Dynamic Range is a wrapper
133 for the IMF application that allows JPEG-2000 codestreams to be paired
134 with opaque blobs of metadata.  AS-02 support must be enabled to
135 build this feature, so --enable-as-02 must be enabled if
136 --enable-phdr is to be used.  The following executable programs will be
137 built:
138
139 phdr-wrap - Writes AS-02 PHDR Essence Component files.
140
141 phdr-unwrap - Extracts essence from AS-02 PHDR Essence Component files.
142
143
144 Documentation
145
146 The API documentation is mostly in AS_DCP.h. and AS_02.h  Read those
147 files for a detailed description of the library's capabilities. Read
148 asdcp-*.cpp and as-02-*.cpp files for library usage examples. The
149 command-line utilities all respond to -h.
150
151
152 Change History
153
154
155 2016-08-11 - bug fixes, 2.5.15
156
157  o Modified as-02-wrap to pass WhiteRefLev, BlackRefLev and ColorRange
158     (contributed by Elmer Musser / Rod Bogart)
159  o Fixed a bug in the index reader that allowed an out-of-bounds vector index
160    to be used.
161  o Modified the IndexEntry parser to ignore additional bytes belonging to slice
162    values.
163
164 2016-05-06 - bug fixes, 2.5.14
165
166  o Release 2.5.12 caused two problems with Atoms and DTS-X wrapping that are
167    addressed by this release. The UL values that were changed to correct the
168    DCData (ST 429-14) implementation had two unintended side-effects:
169      1. v2.5.12 cannot read old DCData (and thus DTS-X) track files
170      2. v2.5.12 creates broken Atmos track files (incorrect ULs)
171    The fix for this involved the following changes:
172      1. ASDCP::DCData::(MXFReader|MXFWriter) are no longer base classes of
173         ASDCP::ATMOS::(MXFReader|MXFWriter).
174      2. New UL values have been added to carry the original Atoms UL values:
175         a. DolbyAtmosDCDataWrappingFrame
176         b. DolbyAtmosDCDataEssence
177         c. DolbyAtmosDCDataDescriptor
178      3. ASDCP::ATMOS::(MXFReader|MXFWriter) have been modified to use the
179         DolbyAtmosDCData* UL values.
180      4. ASDCP::DCData::MXFReader will parse files having either DCData* or
181         DolbyAtmosDCData* UL values.
182      5. ASDCP::DCData:: MXFWriter continues to use DCData* UL values from ST
183         429-14
184   o Some optional parameters of the MXF metadata packs were being erroneously
185     initialized with a value of zero (0), such as GenericPictureEssenceDescriptor
186     ::SignalStandard, GenericPictureEssenceDescriptor::SampledXOffset(0), etc.
187   o Added higher edit rates (96, 100, 120) to the cinema TimedText_Parser
188
189   o Defined bool ASDCP::UL::operator<(const UL& rhs) const, which is needed to
190     carry out the version-insensitive lookup policy when searching for ULs in a
191     std::map<> of UL entries.
192   o New files:  src/info.in src/CMakeLists.txt
193   o Removed filess:  AS_DCP_DCData_internal.h
194
195
196 2016-03-17 - bug fixes, 2.5.12
197  o Changed default UNIX file permissions to "666"
198  o Changed default UNIX file permissions to "777"
199  o Added missing initializer for caltime::offset
200  o Fixed UL values for Aux Data files (per ST 429-14)
201  o Added support for default TTML fonts (ST2052_TextParser)
202  o Added Solaris patch to KM_fileio (Thanks Mikey!)
203  o Fixed the version byte in UL DataEssenceCoding
204  o Fixed duplicate linkage error for symbol MIME2str
205  o Big patch from Wolfgang Ruppel:
206    o Corrected erroneous fixed-tag values in ActiveHeight, ActiveWidth,
207      ActiveXOffset, ActiveYOffset UL definitions.
208    o Provided a stub implementation for Kumu::DirScannerEx (A real
209      implementation will follow soon.)
210    o Added as-02-info program
211    o Added Seek() method to PCM parsers
212    o Added CMakeLists.txt
213
214
215 2015-11-10 - bug fixes, IMF text, pink noise, 2.5.11
216  o I moved personal dev environment from older gcc to newer clang.  Many
217    small changes were made to satisfy the new compiler:
218    - Altered many printf format codes to use the correct format for the
219      given integer type.
220    - Parenthesized some expressions to clarify previously ambiguous
221      expectation about precedence.
222    - Created macro KM_MACOSX for use in OS-specific code selection.
223    - Removed last uses of the old C-language abs(), now using Kumu::xabs().
224    - Removed last uses of the old C-language atoi(), not using strtol().
225  o Added platform-independent call Kumu::GetExecutablePath() (to be tested
226    on win32).
227  o Added new capabilities to Result_t.
228  o Added imlementation of SMPTE ST 2092-1 pink noise generator.
229  o Added pinkwave CLI utility.
230  o Added font support to the IMF timed-text wrapper.
231  o Fixed a bug that was causing Array properties to be written without
232    the (count, length) header (from PAL).
233  o General review of Batch/Array distinction throughout the project.
234  o Cleaned up definitions of optional properties in all MXF metadata packs.
235  o Fixed Win32 build (from Crowe).
236  o Fixed a bug that caused incorrect failure when parsing JPEG 2000
237    codestreams having fewer than five decomposition levels. (from Korneder).
238  o Fixed missing UUID generation in some instances of the MCALinkID property.
239  o Added -w option to asdcp-wrap to support use of WTF label with MCA.
240  o Altered asdcp-wrap to recognize "-C <UL>" when MCA is being used.
241  o Fixed broken -A <w>/<h> option in as-02-wrap and phdr-wrap.
242  o asdcp-wrap and as-02-wrap now allow split channel groups in MCA labels.
243
244
245 2015-02-23 - bug fixes, 2.4.10
246   o Fixed a new bug introduced by the fix to large numbers of subtitle ancillary
247     resources.
248   o Added support for generic Aux Data (ST 429-14) to asdcp-wrap.
249
250
251 2015-02-19 - PHDR feature, bug fixes, 2.4.9
252   o Modified PCMParser and PCMParserList to return partial frame buffers at the
253     end of a WAV input file.  This was needed to allow wrapping all samples into
254     an AS-02 audio file (which is clip-wrapped) in the case where the input file
255     has an odd number of samples with respect to the frame buffer size being
256     used.  If there is more than one input file the length of the last buffer
257     will be determined by PCMParserList to be the shortest of the input files.
258     Prior to this change, partial samples in an input WAV file have been
259     abandoned (i.e., not written out to the MXF file).  As a result, AS-DCP
260     applications will have to decide whether to abandon the partial last frame
261     (usually detected by testing frame_buffer.Size() != frame_buffer.Capacity())
262     or write it to the MXF file.  Programs written to the old API will write the
263     partial frame (i.e., new behavior.)  This should not be harmful since the
264     remainder of the buffer is zeroed and the output file will contain one
265     additional edit unit compared to the previous version.
266   o asdcp-wrap has been modified to test for the partial buffer and by default
267     will complain and abandon the buffer (i.e., same behavior but with a warning
268     message.)  A new command line switch (-g) alters this behavior and writes
269     the buffer to the MXF file (it still warns the user that this condition is
270     present.)
271   o as-02-wrap now wraps all samples from the input file to the MXF file. There
272     is no padding, the clip is exactly the set of samples from the input.
273   o as-02 unwrap is temporarily restricted to creating wav files that are
274     aligned with the frame buffer size.  This means that the output file will
275     be longer than the original WAV input in the case where the input file has
276     an odd number of samples with respect to the frame buffer size being used.
277     The pad samples are zero (silence).
278   o Modified CalcFramesFromDurationInSamples() to increment the count by one for
279     the case where the input file has an odd number of samples with respect to
280     the frame buffer size being used (previously it truncated the odd samples.)
281   o Fixed ST 429-5 / ST 2067-5 wrapping to increase header space when ancillary
282     resources are present (fixes a bug that cause the header to overflow the
283     allotted space when large numbers of PNG files were present.)
284   o Refactored GetXMLDocType() to use the XML parser.
285   o Added ParseFirstFromString() method to Kumu::XMLElement
286   o Removed Kumu::StringIsXML from the API.
287   o Added ASDCP::MXF::RGBALayout type
288   o Added J2CLayout property to JPEG2000PictureSubDescriptor
289   o Changed km_token_split() to retain empty elements in the output list
290   o Added PHDR wrapping for AS-02.
291   o Added J2CLayout property to the JPEG2000PictureSubDescriptor.  This
292     support is preliminary: the Raw data type is being used instead of
293     RGBALayout type, which will be in the next release.
294
295
296 2014-10-2 - Bug fixes and enhancements, 2.2.6
297   o Fixed erroneous 377-4 MCA identifier in AS_DCP_PCM dump routine
298   o Fixed erroneous byte 13 in
299     WaveAudioDescriptor_ReferenceAudioAlignmentLevel label
300   o Added missing implementation of -W option to as-02.unwrap
301   o Fixed erroneous use of d-cinema ChannelAssignment label in as-02-wrap
302
303
304 2014-10-01 - Bug fixes and enhancements, 2.2.5
305   o Finished AS-02 text wrap/unwrap
306   o Fixed fractional seconds parsing for Timestamp objects
307   o Updated KLVPacket to use 64-bit length; allows huge packets
308     in AS-02 PCM files
309   o cleaned up use of atoi() in the library
310
311
312 2014-07-09 - Additional IMF/AS-02 support, bug fixes and enhancements, 2.1.4
313   o Added IMF App 2 edit rates in AS_02 namespace: EditRate_29_97, 
314     EditRate_59_94. 
315   o Revised AEC CBC context objects to copy the key rather than  
316     keep the reference passed in to it.
317   o Addressed a bug that would allow unimpeded iteration of component 
318     values in a JP2K::PictureDescriptor object.
319   o Addressed a bug that was incorrectly recording the sequence Duration 
320     in MXF Track objects.
321   o Added ASDCP::AtmosSyncChannelMixer::AppendSilenceChannels()
322   o Added a QCD decoder to the j2c parser.
323   o Altered ASDCP::KLVPacket::HasUL() to use version-blind matching.
324   o Fixed an uninitialized variable in MemIOReader::ReadString() that  
325     caused unbounded reads.
326   o Fixed broken ByteString::ArchiveLength() method
327   o Fixed broken version numbers on SoundfieldGroupLinkID and  
328     GroupOfSoundfieldGroupsLinkID UL values.
329   o Added DBOXMotionCodePrimaryStream and DBOXMotionCodeSecondaryStream UL 
330     values to the internal dictionary.
331   o Added optional prefix handling to MCA label generator.
332   o Re-factored MCA label generator to include additional  
333     metadata (Thanks to Mike Radford).
334   o Added new options to as-02-wrap.
335
336
337 2014-01-06 â€“ Additional IMF/AS-02 support, bug fixes 2.1.1
338   o Fixed missing-index-partion bugs for AS-02 files.
339   o Moved LocalFilenameResolver into the AS_DCP public API so that it
340     can be used by other modules including AS-02.
341   o Did further refactoring of AS-02 Writer classes to separate CBR
342     and VBR indexing implementations.
343   o Fixed wave wrapping UL in clip-wrapped AS-02 files.  Renamed some
344     UL constants to reflect "clip" or "frame" wrapping.
345   o Re-factored JP2K_PDesc_to_MD() and MD_to_JP2K_PDesc() to work
346     with GenericPictureEssenceDescriptor objects.
347   o Fixed a bug that was suppressing PictureComponentSizing,
348     CodingStyleDefault and QuantizationDefault when writing the
349     essence descriptor in a JP2K file (AS-DCP and AS-02).
350   o Fixed the version byte on the following UL values:
351           StereoscopicPictureSubDescriptor
352           GenericPictureEssenceDescriptor_ColorPrimaries
353           GenericPictureEssenceDescriptor_ActiveHeight
354           GenericPictureEssenceDescriptor_ActiveWidth
355           GenericPictureEssenceDescriptor_ActiveXOffset
356           GenericPictureEssenceDescriptor_ActiveYOffset
357   o Added some essence descriptor options to as-02-wrap.
358   o Changed bit rate display in asdcp-info from mebi-bits/s to
359     mega-bits/s.
360   o Added "SMPTE" / "Interop" format type display to asdcp-info.
361   o Improved integration of ST 377-4 MCA concepts with ST 429-2 static
362     labels.
363   o Modified asdcp-wrap to assume -L when wrapping timed-text (since
364     there is no MXF text wrapping for Interop.)
365   o Added new EssenceType_t values for IMF/AS-02 track files.
366   o Added detection for AS-02 track files to ASDCP::EssenceType()
367   o Changed lots of "const char*" to "const std::string&" in the
368     APIs defined by KM_fileio.h and AS_DCP.h.
369   o Fixed VBR Delta Segment entries to correctly flag progressive
370     material.
371   o Fixed PCM unwrapping bugs in as-02-unwrap.
372   o Fixed missing return statement in ArchivableString::ArchiveLength
373     (thanks to both Kristof Provost and Franck Chopin) 
374   o Fixed broken sample alignment in RF64Writer (thanks to Wolfgang
375     Woehl and Dolby)
376   o Fixed win32 build (thanks to Dolby)
377   o fixed a bug that caused blackwave to only produce 96kHz WAV files.
378     (thanks to Stephane W)
379
380
381 2013-07-02 â€“ IMF/AS-02 support, bug fixes 2.0.0
382   o Massive refactoring of internals to allow easier implementation
383     of AS-02.  Some API changes were made as well (note that
384     OPAtomHeader is now OP1aHeader and RIP is no longer part of the
385     OP1aHeader.)  If you are using this project as a library (and
386     especially if you are keeping patches against it) PLEASE TAKE
387     TIME TO EVALUATE THIS RELEASE THOUROUGHLY BEFORE ADDING IT TO
388     YOUR RELEASE PATH.
389   o Final integration of Fraunhoffer IIS code contribution.  AS-02
390     files are now fully supported with some TODOs and two major
391     exceptions: LEAD indexes are not supported by the MXF writers
392     and interlace images are not yet supported.
393   o Added support for MCA labels (ST 428-12) to asdcp-wrap.  Note
394     that this project is still in the early stages of interop testing
395     so errors are likely present and don't expect any server to
396     make use of this feature.
397
398
399 2013-07-01 - Bug fixes, enhancements 1.12.50
400   o Fixed missing return statement in ArchivableString::ArchiveLength
401     (thanks to both Kristof Provost and Franck Chopin) 
402   o Fixed broken sample alignment in RF64Writer (thanks to Dolby)
403   o Fixed win32 build (thanks to Dolby)
404
405
406 2013-04-12 - Dolby Atmos support and more audio labels 1.11.49
407   o Significant code contribution from Dolby Laboratories to add
408     support for generic data track files as proposed in ST 21DC
409     and also Dolby Atmos track file support as a specialization.
410   o Added Dolby-contributed code to support generating the external
411     sync signal for d-cinema as proposed in ST 21DC.
412   o Added Dolby-contributed code to support RF64 WAVE files.
413   o Fixed UL error in ST 429-5 DM encoding (contributed by Dolby).
414   o Added ULs for ST 428-12 and Amd. 429-2 2013.  Please check!
415
416
417 2013-02-20 - bug fixes, enhancements 1.10.48
418  o Refactored internals of the AS-DCP file readers.  While no
419    changes in behavior are intended, users are cautioned to test
420    thouroughly before use in production.
421  o Fixed a bug in ReadAncillaryResource that was causing bogus HMAC
422    failures when reading resources from a file.
423  o Fixed premature-release bug in the Expat version of the XML parser.
424    Thanks to Carsten Feldheim (IIS) for the tip.
425  o Fixed -W option in asdcp-unwrap.  Thanks to RGB.
426  o Added P-HFR support to asdcp-wrap (see URL for details:
427    http://isdcf.com/papers/ISDCF-HighFrameRate-DCP.pdf).
428  o Added support for SMPTE ST 428-21 "Archival Frame Rates".
429  o Added -P option to asdcp-wrap (inserts arbitrary UL into the
430    PictureEssenceCoding property when wrapping JP2K files.)
431  o Added support for 96 kHz files to blackwave.
432  o Added new path and string manglers to Kumu.
433  o Updated MCA ULs (I warned you...).  Again please take some
434    time to proof this work against ST 477-4 including the latest
435    drafts of the registries.
436        Changed the version byte (8 0f 16) to 0x0e:
437            MCALabelSubDescriptor
438            AudioChannelLabelSubDescriptor
439            SoundfieldGroupLabelSubDescriptor
440            GroupOfSoundfieldGroupsLabelSubDescriptor
441            GroupOfSoundfieldGroupsLinkID
442        Changed bytes 8 and and 13 of SoundfieldGroupLinkID
443        Added items to the UL dictionary:
444            MCAPartitionKind
445            MCAPartitionNumber
446            MCATitle
447            MCATitleVersion
448            MCATitleSubVersion
449            MCAEpisode
450            MCAAudioContentKind
451            MCAAudioElementKind
452
453
454 2012-08-07 - bug fix, 1.10.46
455  o Added missing zero-initializers to time values when parsing a
456    timestamp string (in the case where the optional [Thh:mm.[:ss]]
457    syntax is not present in an encoded string).
458
459 2012-03-06 - bug fixes, enhancements 1.9.45
460  o Removed ASDCP::Timestamp, all items that were of that class are now 
461    of class Kumu::Timestamp
462  o Refactored Kumu::Timestamp to use KM_tai for internal representation 
463    (replaced public Y M D, h, m, s variables)
464  o Refactored Kumu::Timestamp to use KM_tai for WIN32 builds
465  o Added UTC offset awareness to Kumu::Timestamp
466  o Replaced "long GetSecondsSinceEpoch(void) const" with 
467    "ui64_t GetCTime() const"
468  o Corrected UL version segment in "7.1 DS" and "WTF" audio format
469    labels (corresponds with publication of ST 429-2:2011).
470  o Exposed MXF object interface (MXF.h, Metadata.h) via ASDCP MXFReader
471    and MXFWriter classes.
472  o Added UL values from ST 377-4:2012. >>>>NOTE: These are preliminary
473    values, subject to change upon final publication of not only ST 377-4
474    but also the relevant registries.  This is a good time to compare them
475    to the standard and complain if you think they are wrong!
476  o Added MCALabelSubDescriptor, AudioChannelLabelSubDescriptor,
477    SoundfieldGroupLabelSubDescriptor, and
478    GroupOfSoundfieldGroupsLabelSubDescriptor (from ST 377-4:2012) to
479    Metadata.h
480  o Changed some internals to make MXFWriter::OPAtomHeader() work correctly.
481  o Split asdcp-test into several different programs to help relieve
482    the impenetrable-list-of-arguments problem. asdcp-wrap, asdcp-unwrap
483    and asdcp-info take the place of asdcp-test's -c, -x and -i options,
484    respectively.  asdcp-util contains the remaining functions. Note that
485    asdcp-test is now DEPRECATED, new functionality and bug fixes will be
486    aimed at the new tools.  Also note that some options and calling
487    conventions are different for the new tools as compared to asdcp-test.
488    Please read the synopses and make sure you understand the new idioms.
489  o asdcp-wrap has a new argument, -C <UL>, that writes the given UL to the
490    ChannelAssignment item in the WaveAudioDescriptor (only useful when
491    writing PCM essence).
492
493
494 2011-11-30 - bug fixes v1.8.44
495  o Corrected a wrong decryption UL selection when unwrapping MXF.
496
497
498 2011-10-27 - bug fixes v1.8.43
499  o Corrected broken Essence UL matching. (Thanks to Michael Loder).
500
501
502 2011-08-31 - bug fixes v1.8.42
503  o Added missing HFR support for PCM essence reader/writer.
504
505
506 2011-08-30 - bug fixes, enhancements v1.8.41
507  o UL version byte now ignored when comparing UL values.
508  o Changed the version byte in the TimedTextEssence UL to 0x01.  There
509    is no published Essence Keys registry so it can't have a maintained
510    version number.
511  o JP2K Sequence Parser modified to skip directory entries that
512    are not files in the case where the parser is initialized with
513    a directory path.  When initialized with a list of file names
514    this check is not performed.  Based on a hint by Steve Quartly.
515  o Increased the size of the MPEG header parser buffer.
516  o Added missing FrameType() implementation to ASDCP::MPEG2::MXFReader.
517  o Added missing Close() implementations to MXF reader classes.
518  o Added missing Timestamp::Timestamp(const char* datestr) implementation.
519    (Thanks to Matt Sheby for this and the previous three items.)
520  o Fixed error in Kumu::FortunaRNG::FillRandom() that was returning the
521    end of the random buffer instead of the front (Thanks to Mike Radford).
522  o Added support for proposed sound channel format identifiers
523    '7.1DS' and 'WTF'.  Optimistically chose version '0x0c'.
524  o Added support for stereoscopic images in JP2K files at edit
525    rates of 48, 50 and 60 eups (96, 100 and 120 fps).
526
527
528 2010.11.15 - bug fixes, enhancements v1.7.40
529  o Fixed bug in long KLV packet support (Thanks to Jim Radford).
530  o Fixed AvgBps in PCM files, *again*. Sorry for the crazy.
531  o More fixes and changes in support of 25, 30, 50, 60 fps.
532    (Thanks to Hans K. for the TC rate bug).
533  o Updated KLVFill UL version element to 0x02.
534  o Type change to support Xerces-C 3.x. (Thanks to Matt Sheby).
535  o Some internal API changes to KLV types. Does not affect
536    operation.
537  o Added NetworkLocator type to MXF metadata types.
538  o Added file offset display to klvwalk.
539
540
541 2010.09.09 -  bug fixes, enhancements, v1.7.39
542  o Fixed bug in JP2K PictureDescriptor initialization in
543    JP2K::MXFReader::OpenRead() and JP2K::MXFSReader::OpenRead()
544  o Once again fiddling with AvgBbs. How can something so simple
545    be such a constant cause of trouble? Tested with 1-, 2- and
546    6-channel input Wav files.
547  o asdcp-test now accepts a directory name when making PCM
548    files (-c). The directory name should be the only filename
549    argument. All files in the directory must be Wav files
550    (mixed channel sizes OK). Files are sorted alphabetically by
551    filename. Hint: use numeric name infix to define order:
552    my_movie_00_L.wav
553    my_movie_01_R.wav
554    my_movie_02_C.wav
555    my_movie_03_LFE.wav
556    my_movie_04_LS.wav
557    my_movie_05_RS.wav
558
559
560 2010.07.20 -  bug fixes, v1.6.37
561  o Fixed TimedTextResourceSubDescriptor UL value.
562
563
564 2010.06.16 -  bug fixes, v1.6.36
565  o Added support for new Edit Rates to asdcp-test.cpp.
566  o Expanded timed-text file reader in asdcp-test.cpp.
567  o Fixed large BER value encoding (plaintext) and decoding
568    (plaintext and ciphertext). This feature was introduced in
569    v1.5.31).
570  o Fixed AvgBps value for multi-channel Wave input.
571
572
573 2010.05.13 -  bug fixes, enhancements, v1.6.34
574  o ST 429-5 files have corrected ULs for DCTimedTextDescriptor and
575    GenericStream DataElement. Files made with previous versions of
576    the library are incompatible with this and future versions.
577  o Fixed File Package TrackNumber values. Th
578 anks to Sankar.
579  o Added edit rate constants to AS_DCP.h (25, 30, 50, 60).
580  o Changed AudioDescriptor "SampleRate" element name to "EditRate"
581    to make it consistent with the other types.
582  o Now builds with XercesC 3.x.
583  o KM_memio.h has better const behavior.
584  o Fixed a bug in KM_memio.h string archiving.
585
586
587 2010.01.05 -  bug fixes, enhancements, v1.5.32
588  o Re-fixed swapped Interop and SMPTE OP Atom UL values. The swap
589    introduced in v1.5.31 was done in error.
590  o Added -z,-Z options to asdcp-test (j2c parameter checking)
591  o Reformed jp2k-test as j2c-test, added help and list processing,
592    added to standard install target.
593
594
595 2009.12.31 -  bug fixes, enhancements, v1.5.31
596  o Fixed swapped Interop and SMPTE OP Atom UL values.
597  o Added get_BER_length_for_value() subroutine.
598  o Modified ASDCP::h__Writer::WriteEKLVPacket() to allow larger BER
599    lengths for KLV packets larger than 16 MB. This was required to
600    support large font files in the SMPTE 429-5 implementation.
601
602
603 2009.11.06 - bug fixes, enhancements, v1.5.29
604  o Fixed a bug that could cause HMAC values to be incorrectly
605    stored in MXF files.  Files created with versions of asdcplib
606    prior to this version may have incorrect HMAC values. 
607  o Improved handing of XML files for MXF wrapping.  
608  o Jpeg2000 codestream EditRate and SampleRate mismatches
609    now warns instead of returning an error. 
610  o Improved error handling in Jpeg2000 sequence parsing routines.  
611  o Added two methods to Kumu::Timestamp, AddSeconds(), to add (or
612    subtract) seconds to a time value, and GetSecondsSinceEpoch()
613    to get the number of seconds since the unix epoch.
614  o Added new option to asdcp-test, '-a', to specify a UUID when
615    creating MXF files.
616  o Added support for specifying the intrinsic duration of MXF files
617    containing timed text.
618  o Added new option to wavesplit, '-i', to display WAV file metadata.
619
620
621 2009.05.21 - bug fixes, v.1.4.24
622  o Fixed a bug that caused incorrect SubDescriptors UL values to be 
623    written into interop format MXF track files.  Note that this involved
624    a substantial reorganization of MXF internals.  Please test thoroughly
625    in your application before using in production.  Note that this is a 
626    significant bug fix and track files created with 1.4.22 may be incompatible
627    with other systems.  
628
629
630 2009.04.09 - SMPTE format fixes, enhancements and bug fixes, v.1.4.22
631  o asdcplib now uses GNU autotools on POSIX systems to configure 
632    and build.  See "./configure" for details.  Note that two options, 
633    --enable-freedist and --with-python are not enabled in the free
634    version of asdcplib and should not be used.  
635  o Added build option (CONFIG_RANDOM_UUID) to enable mixed case UUID
636    generation when environment variable KM_USE_RANDOM_UUID is defined.
637  o Fixed a condition that could cause an error to occur when wrapping 
638    SMPTE format timed text track files that do not define a starting 
639    frame.
640  o Updated ULs for SMPTE format track files.
641  o SampleRate added to JP2K metadata
642  o Support for wrapping 96kHz WAV files added.
643  o Updated ULs for audio channel formats  (ChannelFormat)  
644  o Updated font subdescriptor MIME Types for TimedText Trackfiles.
645  o Changed time implementation to support dates beyond Jan 19th, 2038.
646  o Xerces-C XML parser support added.  
647  o New build method for Windows (see win32/README.txt for details).
648  o Added new functionality in Kumu to recursively create and delete files 
649    and directories, and get free disk space for a given volume path.
650  o Added a method to Kumu::Timestamp, AddMinutes(), to add (or subtract) 
651    minutes to a time value.  
652  o Improved how Kumu::Timestamp parses timestamps with offsets. 
653  o Fixed a bug that caused incorrect HMAC values to be calculated.
654
655
656 2008.02.16 - SMPTE format fixes, bug fixes v.1.3.18
657  o Added correct SMPTE UL for StereoscopicPictureSubDescriptor.
658  o Exposed JP2K metadata parser as ParseMetadataIntoDesc().
659  o Added simple stereoscopic framebuffer to support paired ReadFrame()
660    and WriteFrame() methods (allows simpler integration with other
661    single-buffer code).
662  o Improved detection of JPEG Interop stereoscopic files.
663  o Win32 build fixes (Thanks to Mike Crowe at DTS).
664  o Added the WITH_MD macro to the makefile. Set this value to one
665    to build Win32 with /MD[d] instead of /MT[d].
666  o The Generic Container UL has been added to the EssenceContainers
667    set in the header partition pack for encrypted files. It has always
668    been there in plaintext files.
669  - Below this point the changes are internal and should not affect you
670    unless you use Kumu directly.
671  o Major refactoring of KM_log.[h|cpp].
672  o Fixed buffer re-sizing issue in Kumu::ByteString.
673  o Replaced type IdentifierList with ArchivableList.
674  o Added COPYING file to the release bundle.
675
676
677 2007.12.13 - Bug fixes v.1.2.17
678  o Changed Result_t implementation to use int instead of long, which
679    was causing trouble on some 64 bit platforms.
680  o Fixed EKLV HMAC. NOTE: Breaks backward compatibility with older
681    Interop files. To validate these files, use asdcplib-1.1.14. This
682    should not cause too much trouble since files with broken and
683    non-broken HMAC have been in the wild for years without issue.
684  o Fixed HMAC sequence numbering in encrypted stereoscopic files.
685  o Finished stereoscopic test targets in the makefile.
686  o Fixed the win32 build, now expects VS2005 compiler by default,
687    use WITH_VC6=1 top get VC6 flags.
688  o Stereoscopic and Timed Text modes now have SMPTE UL values.
689    NOTE: SMPTE 429-5 and 429-10 are not yet published. It is possible
690    that these UL values may change before publication. Please use
691    caution when using these features for production work.
692  o Changed a bunch of symbol names in the 429-5 implementation to
693    better match the spec.
694  o Added -U option to asdcp-test to dump the UL library to stdout.
695  o Fixed erroneous placement of the PictureEssenceCoding UL in JP2K
696    files (Interop and SMPTE modes).
697
698
699 2007.10.22 - Timed Text, Stereoscopic Picture and Bug fixes v.1.2.16
700  o Significant API changes have been made. Please read all entries
701    in this changelog to be sure you understand the changes. Also
702    note that some changes have been made to LS_MXF_SMPTE files that
703    are incompatible with earlier releases (e.g., EKLV HMAC). If
704    you are looking for a stable interop release, use  v.1.1.14.
705  o Fixed RFC 2104 HMAC implementation for LS_MXF_SMPTE only. The
706    broken implementation has been maintained for Interop mode.
707  o Added support for draft SMPTE 429-5 Timed Text Track File. This
708    is still waiting for official SMPTE ULs, so do not use it for
709    shipping products.  An XML parser is needed to create a Timed
710    Text Track File; Expat is now an optional part of the build.
711    Make with WITH_XML_PARSER=1 to link with Expat. If you do not
712    link with expat, you will get an error when using the TimedText::
713    DCSubtitleParser class. See also S429-5-cgi.cpp for an example
714    that shows how to serve plaintext MXF file elements directly via
715    HTTP.
716  o Added support for draft SMPTE 429-10 Stereoscopic Picture Track
717    File, including the JPEG Interop version. This is still waiting
718    for official SMPTE ULs, so do not use it with LS_MXF_SMPTE for
719    shipping products.  
720  o Refactored the following files as a side-effect of the above
721    work: AS_DCP_JP2K.cpp AS_DCP_MPEG2.cpp AS_DCP_PCM.cpp
722    AS_DCP_MXF.cpp AS_DCP_internal.h MXF.[h|cpp] MXFTypes.[h|cpp]
723    Metadata.[h|cpp] h__Reader.cpp h__Writer.cpp klvwalk.cpp.
724    WARNING: While significant effort has been extended to make sure
725    that these changes do not affect existing stable file support,
726    users are cautioned to test this release thouroughly.
727  o Added a large set of filesystem path manglers to KM_fileio.h. See
728    path-test.cpp for example usage. The path manglers have not yet
729    been tested on win32 platforms (they are currently used only by
730    the Timed Text module.
731  o The PathIsFile(), PathIsDirectory() and FileSize() subroutines
732    have been modified to accept const std::string& instead of
733    const char*.
734  o Added namespace and parsing support (Expat) to Kumu::XMLElement
735    (currently used only for Timed Text support). Also added some
736    new accessors.
737  o Altered MXF::UTF16String to use mbtowc() and wctomb().
738
739
740 2007.03.31 - Bug fixes v.1.1.14
741  o Fixed KeyFrameOffset value in MPEG wrapping to have negative
742    value. This is probably not yet complete for handling all
743    types of GOPs. Please send chunks of MPEG-2 VES that you
744    find which break this. Thanks to Doremi.
745  ** no other file format changes in this release **
746  o Fixed error in RIP interpretation when reading arbitrary (i.e.,
747    non-MXF) files.
748  o Fixed a memory leak in ASDCP::MXF::OPAtomHeader when used
749    in read mode. Thanks to Mahesh Bajaj for pointing out this
750    bug and the one above.
751  o Removed asserts from KM_fileio, replaced with RESULT_WRITEFAIL
752    return value statements.
753  o Added -s and -p to the makefile install target.
754  o Altered ByteString behavior to use target Length() in copy
755    operations (instead of Capacity()).
756  o Added new Set() method to ByteString.
757  o Fixed a bug in ByteString::Unarchive() that caused the operation
758    to fail when the buffer was smaller than the read (i.e., when
759    Capacity() was called).
760  o Added IdentifierList class to KM_util.h.
761  o Changed some Error() messages to Debug() in Wav.cpp
762  o Revived jp2k-test.cpp and asdcp-mem-test.cpp (they both had
763    stale #includes).
764
765
766 2007.02.15 - Bug fixes v1.1.13
767  o Removed 'VDescObj->SampleRate.Numerator = VDesc.FrameRate;'
768    from MPEG2_VDesc_to_MD() in AS_DCP_MPEG2.cpp, was line 76.
769  o Added KM_TEST_NULL_STR_L() and KM_TEST_NULL_L() macros to
770    KM_log.h. These versions log the location of the null value.
771    Macros are now used in any module that includes KM_log.h.
772  o MPEG2 VES with run of zero values at the head is now OK.
773  o Increased VESHeaderBufSize to 16K.
774  o Added makefile support for local OpenSSL in ../openssl, if
775    present.
776  o The Kumu::PathIs*() functions now return false if a null or
777    empty string is given (used to be an assert).
778  o Cleaned up the install target in the makefile.
779  o Fixed SMPTE 429-6 HMAC -- FIPS 186-2 implementation was
780    laughably incorrect. Thanks to Doremi for pointing this out.
781  o Removed default parameter to HMACContext::InitKey().
782  o Cleaned up messages and CLI arg handling in asdcp-test.
783
784
785 2006.11.19 - Mo better stuff v1.1.12
786  o Changed read-only Result_t accessor methods to const.
787  o Added Base64 (-B) option to kmrandgen.
788  o Removed 16-bit alignment restriction from kmrandgen.
789  o Improved WAV file extraction speed (Thanks to Jim Radford
790    for pointing this out).
791  o Added single-channel split for WAV extraction (asdcp-test -1).
792  o Fixed remainder bug in h__RNG::fill_rand().
793
794
795 2006.11.03 - Bug fixes v1.1.11
796  o Increased index table entry list size to 5000.
797  o Added length checking to TLV writer (returns error if TLV
798    payload exceeds 64kB).
799  o Fixed partition header and RIP errors related to 2-partition
800    files (MXF Interop mode).
801  o Added -t option to asdcp-test (SHA-1 digest with Base64 output
802    on stdout).
803  o Fixed Sub Descriptor reference bug (Thanks to Denis Leconte
804    for dogged determination).
805  o Added directory-of-wav detection to RawEssenceType()
806  o Modified MXF::Partition::AddChildObject() to only generate
807    a UUID if the InstanceID is unset.
808  o Added ComponentMaxRef & ComponentMinRef to RGBAEssenceDescriptor.
809    More to follow.
810  o Added detection of 2K/4K jp2c, writing correct 4K metadata.
811
812
813 2006.10.05 - Bug fixes v1.1.10
814  o Changed RM_RELEASE to RL_RELEASE in MXFTypes.h.
815  o Changed the MXF writer to use RL_RELEASE (was RL_DEVELOPMENT).
816  o Really fixed source reference chain.
817  o Updated JP2K file package label.
818  o Changed location of JPEG2000PictureSubDescriptor in the
819    header (was erroneously before Preface).
820  o Altered LS_MXF_INTEROP to produce 2-partition files.
821
822
823 2006.09.25 - Bug fixes v1.1.9
824  o Fixed SourcePackageID value. All files will be 'original',
825    i.e. SourcePackageID will be all zeros. Let me know if you
826    want to set SourcePackageID.
827  o Fixed compiler warnings on some Linux platforms
828  o Fixed the build so that BUILD_DIR is no longer created
829    as a dependency.
830  o Added duration detection to the raw essence parsers. The
831    MPEG parser uses a nasty approximation so don't use it
832    without paying close attention to the result.
833  o Modified PCMParserList to make it more useful as a base
834    class.
835  o Fixed bugs and re-organized command-line help in asdcp-test
836    and klvwalk.
837  o Fixed two-partition file reads.
838  o Fixed Win32 PRNG initialization.
839  o Renamed asdcp-lf-test as kmfilegen.
840  o Added kmrandgen and kmuuidgen.
841  o Added string retrieval mechanism to Result_t.
842  o Refactored Kumu::Identifier and its sub-classes.
843  o Altered Kumu::PathIsFile to return true when the path
844    is a symbolic link (unix only).
845  o Altered Kumu::FileWriter::OpenWrite to use file creation
846    mode 0664 (was 0644) (unix only).
847  o Added Kumu::WriteStringIntoFile() subroutine.
848
849
850 2006.04.05 - Bug fixes and new stuff v1.1.7
851  o Fixed a bug in the MPEG parser that caused it to fail when
852    handling start codes spanning buffer boundaries
853  o Added wavesplit and blackwave utility programs
854  o Added support for revised SMPTE HMAC key derivation when
855    using LS_MXF_SMPTE
856  o Refactored platform compatibility and general utilities
857    into a new sub-library "Kumu". There are no new build
858    steps or dependencies, but some important things have
859    changed:
860    + Result_t is no longer an enum, it is now a class.
861      Library result codes are now declared as const objects
862      like this:
863
864      const Kumu::Result_t RESULT_FORMAT (-101, "The file...");
865
866      The macros ASDCP_SUCCESS and ASDCP_FAILURE still work
867      the same way thanks to an operator overload for type long.
868      See KM_error.h for more information.
869    + The logging interface has been moved out of AS_DCP.h
870      and into KM_log.h
871  o Some of the command line utilities that were using headers
872    other than AS_DCP.h have been changed to use the Kumu
873    equivalents. If you have code based on those utilities, you
874    will have to update by hand.
875  o Added new types to the EssenceType_t enum.
876  o The guard macro for Win32 code has changed from WIN32 to
877    KM_WIN32.
878
879
880 2006.03.2x - new stuff
881  o Proper handling of stream-id byte of essence UL values
882  o writes 3-partition files, reads 2-part or 3-part
883
884
885 2006.03.16 - bug fixes plus
886  o Removed SMPTE_LABELS compile-time option. The reader will now
887    silently accept either SMPTE or MXF Interop labels, the writer
888    can be instructed which to use at runtime. Default is Interop.
889  o Added an AIFF reader. Support is preliminary, it works with the
890    AIFF files I have on hand.
891  o More code refactoring. More to come.
892
893
894 2006.03.09 - full read-write
895  o Removed ASDCP_WITHOUT_OPENSSL compile-time option.
896  o Full read/write now working on new MXF library
897
898
899 2005.00.00 - A New Hope
900  o The temporary mxf-lite has been removed. MXF files are now 
901    managed via the objects in KLV.h, MXFTypes.h MXF.h and
902    Metadata.h. This release does not support writing MXF files.
903  o Fixed a header interpretation error in the Wav parser.
904
905
906 2005.00.00 - The Reformation
907  o Removed mxflib as a dependency by forking the necessary
908    functions and placing them in the mxf-lite subdirectory.
909    Please note that the very heavy modifications done here
910    render all comparisson to mxflib code a substantial task.
911    All errors are now mine and users are warned not to bug
912    Oliver or Matt for help with this code. The version of
913    mxflib at the time of the fork was: 0.5.1.3.
914
915
916 2005.06.03 - bug fixes v0.10.18
917  o Updated UL batch to include GC UL.
918
919
920 2005.05.27 - bug fixes v0.10.17
921  o Un-did essence container and compression descriptor changes.
922    The default build reflects MXF Interop decisions as of 26 May.
923  o Added note about build versions to README (see above).
924  o Added warnings to SMPTE_LABELS builds.
925  o Fixed JP2K essence container label.
926
927
928 2005.05.02 - bug fixes v0.10.16
929  o Reorganized internal files, added file reader object, added OS
930    portability header, removed and renamed some files. If you have a
931    patch against previous versions of the source, you should check
932    it thoroughly.
933  o Added RGBA attributes to JP2K descriptor.
934  o Changed interface to CodestreamParser.
935  o Added JP2K parser implementation. It is parsing each frame but is
936    not yet being used to populate the descriptor.
937  o Added 48fps option for `asdcp-test -p`.
938  o Added picture rate constants to AS_DCP.h (23.976, 24, 48).
939  o Added sample rate constant to AS_DCP.h (48k).
940  o Changed asdcp-test to encrypt picture headers by default
941    (plaintext offset will be 0), added -E option to allow
942    plaintext headers.
943
944
945 2005.04.28 - bug fixes v0.9.15
946  o The XML descriptors for the crypto DMS have moved in mxflib to
947    the file DMS_Crypto.xml (they were in DMS_DCPENC.xml).  Older
948    installations should update the file from mxflib.
949  o Added Close() and Seek() to ~MyFileWriter(), cleaned up headers
950  o Added UUID generator output mode (-u).
951  o Added -S option to extract PCM essence into stereo wav files
952  o Added more UL testing and conformance checking.
953  o Added macro SMPTE_LABELS which causes the library to be built
954    with SMPTE (as opposed to MXF Interop) labels. This is not
955    set by default, and currently only affects the PCM container
956    label and encrypted element label.
957  o Cleaned up the GNUmakefile test targets, the source files
958    are now named with the TEST_FILE_PREFIX macro.
959  o enabled 23.976-framed PCM (2002 samples per frame)
960  o The size of the asdcp-test frame buffer for picture essence
961    may now be set from the command line (-b).  The default is 4MB.
962  o h__Reader::ReadEKLVPacket() now tests the UL (duh) and switches
963    on the value, allowing plaintext and ciphertext frames to
964    be mixed in the file.
965  o Fixed error in UUID generator format.
966  o JP2K files now use the GenericPictureDescriptor to store
967    ContainerDuration and SampleRate. SampleRate is mapped
968    to EditRate in the PictureDescriptor struct. This fixes
969    the second caveat from the 0.8.13 release.
970  o Fxed bug in PCMParserList that was miscalculating the extent
971    of a PCM sample.  This bug did not affect API users, it was
972    only present in asdcp-test.
973  o Fixed EditRate on PCM files (was showing sample rate)
974  o Fixed Encrypted Essence Container UL
975  o Fixed BlockAlign value for PCM essence
976
977  - The following changes were provided by Jeff Loewenguth
978  - Thanks Jeff!
979  o Moved the DMS CryptographicFramework entry from the material
980    package to the source package
981  o Fixed erroneous Source Essence Container Label value
982  o Fixed broken sort of JP2K frames in JP2K parser
983  o Added FindFrameGOPStart() method to the MPEG2 MXFReader
984  o Added missing length values for EKLV packets without HMAC
985  o -x with JP2K essence writes to files with 6 digit names
986    (up from 5 digits).
987  o The Key ID may now be specified as an argument to asdcp-test
988     (-j <key-id-string>)
989
990
991 2004.12.30 - bug fixes + wav files v0.8.14
992  o Added WAV file write to asdcp-test (uses mxflib::waveheader_t).
993  o Three-partition files reading properly.  adscplib still writes
994    two-partition files.
995  o Changes in the mxflib WAV essence parser API had broken
996    asdcplib's ability to read essence from a WAV file.  I have
997    fixed this bug, but at the expense of breaking compatibility
998    with older versions of mxflib. Beware!
999  o Removed redundant (but working) bin-text-bin conversions.
1000
1001
1002 2004.12.23 - JPEG 2000 support v0.8.13
1003  o Reads/writes JPEG 2000 essence in plaintext and ciphertext
1004    with the following caveats:
1005     - The Picture Essence Descriptor is empty.
1006     - Because there is no essence descriptor, the reader code
1007       in asdcp-test has no idea how many frames are in the file
1008       and ends with an out-of-bounds frame error.  This error
1009       is being suppressed in asdcp-test for the current release.
1010  o Still broken when reading three-partition files.
1011
1012
1013 2004.10.22 - fixes and UL updates v0.7.11
1014  WARNING: COMPATIBILITY BREAKPOINT
1015  Files created with this and future versions of this library are
1016  not compatible with previous versions of this library.  As you
1017  might suspect, files created with previous versions of this
1018  library are not compatible with  this and future versions.
1019
1020  o h__Reader will now open a three-partitition file (untested)
1021  o Moved DMS from Material partition to File partition
1022  o Added length fields to appropriate places in EKLV packet 
1023
1024
1025 2004.10.22 - fixes and UL updates v0.7.10
1026  o fixed frame buffer handling of externally allocated buffer,
1027    created unit test (asdcp-mem-test)
1028  o added operator==() and operator!=() to Rational type
1029  o fixed some type-related compiler warnings
1030  o asdcp-test -p now works on unwrap
1031  o updated some ULs to match documentation (thanks to Arun
1032    for the submission)
1033  o canonicalized line endings
1034
1035
1036 2004.07.02 - full plaintext + ciphertext read/write v0.6.9
1037  o HMAC, plaintext offest and raw ciphertext read supported
1038  o back to proper CBR index
1039  o MPEG temporal offset working
1040
1041
1042 2004.07.01 - plaintext + ciphertext read/write v0.5.8
1043  o encryption of MPEG and PCM essence supported with the
1044    following caveats:
1045    - no HMAC support
1046    - no plaintext offest support
1047    - no raw ciphertext read support
1048  o moved to reflecting the whole KLV triplet in the CBR
1049    index (now incompatible with mxflib, still searching
1050    for info about what's "right")
1051  o awaitng the following fixes/features:
1052    - retrieve Temporal Offset from index in MPEG2::Reader
1053    - test for correct ULs when reading frame triplets
1054    - fix header metadata items for encrypted files
1055    - HMAC support
1056    - plaintext offest support
1057    - raw ciphertext read support
1058
1059
1060 2004.06.14 - plaintext read/write w/key generator v0.4.5
1061  o Project now uses OpenSSL (tested with 0.9.7d on win32, Linux, Darwin)
1062    Use `make ASDCP_WITHOUT_OPENSSL=1` to make plaintext-only version
1063  o Accepts interior I frames when parsing MPEG2 VES
1064  o Improved error reporting on format errors
1065  o Added support for encryption to asdcp-test
1066  o Added RNG for asdcp-test (non-production use only, see notes in FortunaRNG.h)
1067  o Implemented CBC encrypt, decrypt module
1068  o Added partial TemporalOffset retrieval from MPEG2 parser
1069  o Fixed win32 binmode bug
1070
1071
1072 2004.05.12 - plaintext read/write v0.3.4
1073  o Full read/write of plaintext MPEG-2 VES and WAV files
1074    (does not yet support mux from or demux to 2 channel pairs)
1075  o Builds with autoconf-based mxflib
1076  o Added ASDCP_ prefix to macros
1077  o Updated documentation, fixed documentation errors
1078  o Simplified API for MXF writer setup
1079  o Decoupled essence parsers from MXF writers
1080  o added raw ciphertext support to FrameBuffer
1081  o Cleaned up Get/Set naming confusion
1082  o Added missing const qualifiers
1083
1084
1085 2004.04.27 - preview release v0.2.1
1086  o hasty release for quick review
1087  o this release may not build with mxflib using autoconf.
1088  o writes plaintext AS-DCP MPEG2 essence files
1089  o tested under win32 and linux. FreeBSD and Darwin do not work
1090
1091
1092 2004.02.04 - First release (v0.1.1):
1093  o asdcp-test is mostly complete. It should correctly provide
1094    access to the read and info capabilities of the library.
1095  o The MPEG2 reader is functional but not fully tested.
1096  o Some file format integrity tests remain to be coded.
1097  o The PCM reader is mostly complete, I am having difficulty
1098    getting a suitable test file from mxfwrap.
1099  o The makefile creates a static library module. The API
1100    will cleanly support a DSO (or DLL). Let me know if DSO
1101    support is important to you.
1102  o Nothing is thread safe. Thread safety was not a requirement
1103    in the initial project definition. Thread safety may be added
1104    above the mxflib/klvlib level. Let me know if it is important
1105    to you.
1106  o The files xmldict.xml and types.xml must be in the current
1107    directory when the program is run. The files are supplied
1108    with mxflib. Runtime location of the files is not currently
1109    a project goal. Comments on how best to handle this situation
1110    would be appreciated. See AS_DCP.cpp at init_mxf_types()
1111    for a more detailed discussion.
1112
1113 --