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