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