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