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 proposed by the SMPTE working
9 This work was originally funded by Digital Cinema
10 Initiatives, LLC (DCI). Subsequent efforts have been funded
11 by Deluxe Laboratories, Doremi Labs, CineCert, LLC, Avica
12 Technology and others.
14 **The asdcplib project was housed on SourceForge. The project
15 will be moving to a new home, to be announced here soon.
17 The project formerly depended upon the mxflib project. Because
18 of its focus on covering the whole of the MXF specifications,
19 mxflib is considerably larger and more complex that what I
20 require for this application. For this reason I have created
21 a dedicated MXF implementation that is now part of this
22 library. Special thanks to Matt Beard and Oliver Morgan for
23 their great work and support.
25 Thanks also to the members of the SMPTE DC-28.20 packaging
26 ad-hoc group and the members of the MXF Interop Initiative
27 for their encouragement and support. Special thanks to
28 Jim Whittlesey and Howard Lukk at DCI for proposing and
29 supporting this project.
34 This library is intended (but of course not limited) for
35 use by developers of commercial D-Cinema products. It is
36 designed to be easily integrated into a wide variety of
37 development environments. Commercial users are strongly
38 urged to use static linking (at least where you use this
39 library) to prevent malicious in-field replacement of
40 critical system modules. This recommendation should be
41 considered wherever Open Source or Free software is being
42 used for applications having non-trivial security
45 The author strives mightily to provide an API that is
46 completely independent of operating system and other
47 library dependencies, and which allows selective replacement
48 of some modules for local needs. Specifically, the essence
49 parsers and OpenSSL crypto functions can be replaced by
50 linking to alternative implementations of the ASDCP::
51 objects which provide those services.
53 AS_DCP.h contains the entire API. You do not need to read
54 any of the other files, except maybe asdcp-test.cpp which
55 contains detailed usage examples of each of the API's
56 services. The KM_* files may be of interest for general
57 development support, but may be ignored if all you want
58 is simple AS-DCP support.
63 GNU make is required to build asdcplib. The makefile will
64 work on win32 systems that have Cygwin. Other win32 gmake
65 packages may or may not work depending upon the availability
66 of standard POSIX shell commands. You will need gcc to rebuild
69 OpenSSL is also required. See http://www.openssl.org
71 If you are building on win32 or a unix with no OpenSSL library
72 support, you will have to also obtain and build OpenSSL (I'm
73 using 0.9.7d on win32). Unpack it into the same parent directory
74 as asdcplib/, and rename the directory as (or make a sym link
79 drwxr-xr-x 1 jhurst None 0 Feb 3 16:37 asdcplib
80 drwxr-xr-x 56 jhurst None 0 Feb 2 16:35 openssl
82 I have tested this build on win32, Linux and Darwin platforms.
83 Others may work as well.
88 asdcp-test - Writes, reads and verifies AS-DCP (MXF) track files.
90 asdcp-lf-test - Writes and verifies large files using a platform-
91 independent format. Use it to test issues related to large files.
93 wavesplit - Splits a WAVE file into two or more output files. Used
94 to untangle incorrectly-paired DCDM sound files.
96 blackwave - Write a WAVE file full of zeros, Used to make filler
97 tracks (though you would be better off modifying asdcp-test if
98 this is a common use case).
103 Currently, the documentation is mostly in AS_DCP.h. Read
104 that file for a detailed description of the library's
105 capabilities. Read asdcp-test.cpp for library usage
106 examples. More detailed documentation will be written RSN.
110 2006.04.05 - Bug fixes and new stuff
111 o Fixed a bug in the MPEG parser that caused it to fail when
112 handling start codes spanning buffer boundaries
113 o Added wavesplit and blackwave utility programs
114 o Added support for revised SMPTE HMAC key derivation when
116 o Refactored platform compatibility and general utilities
117 into a new sub-library "Kumu". There are no new build
118 steps or dependencies, but some important things have
120 + Result_t is no longer an enum, it is now a class.
121 Library result codes are now declared as const objects
124 const Kumu::Result_t RESULT_FORMAT (-101, "The file...");
126 The macros ASDCP_SUCCESS and ASDCP_FAILURE still work
127 the same thanks to an operator overload for long. See
128 KM_error.h for more information.
129 + The logging interface has been moved out of AS_DCP.h
131 o Some of the command line utilities that were using headers
132 other than AS_DCP.h have been changed to us the Kumu
133 equivalents. If you have code based on those utilities, you
134 will have to update by hand.
135 o Added new types to the EssenceType_t enum.
136 o The guard macro for Win32 code has changed from WIN32 to
140 2006.03.2x - new stuff
141 o Proper handling of stream-id byte of essence UL values
142 o writes 3-partition files, reads 2-part or 3-part
145 2006.03.16 - bug fixes plus
146 o Removed SMPTE_LABELS compile-time option. The reader will now
147 silently accept either SMPTE or MXF Interop labels, the writer
148 can be instructed which to use at runtime. Default is Interop.
149 o Added an AIFF reader. Support is preliminary, it works with the
150 AIFF files I have on hand.
151 o More code refactoring. More to come.
154 2006.03.09 - full read-write
155 o Removed ASDCP_WITHOUT_OPENSSL compile-time option.
156 o Full read/write now working on new MXF library
159 2005.00.00 - A New Hope
160 o The temporary mxf-lite has been removed. MXF files are now
161 managed via the objects in KLV.h, MXFTypes.h MXF.h and
162 Metadata.h. This release does not support writing MXF files.
163 o Fixed a header interpretation error in the Wav parser.
166 2005.00.00 - The Reformation
167 o Removed mxflib as a dependency by forking the necessary
168 functions and placing them in the mxf-lite subdirectory.
169 Please note that the very heavy modifications done here
170 render all comparisson to mxflib code a substantial task.
171 All errors are now mine and users are warned not to bug
172 Oliver or Matt for help with this code. The version of
173 mxflib at the time of the fork was: 0.5.1.3.
176 2005.06.03 - bug fixes v0.10.18
177 o Updated UL batch to include GC UL.
180 2005.05.27 - bug fixes v0.10.17
181 o Un-did essence container and compression descriptor changes.
182 The default build reflects MXF Interop decisions as of 26 May.
183 o Added note about build versions to README (see above).
184 o Added warnings to SMPTE_LABELS builds.
185 o Fixed JP2K essence container label.
188 2005.05.02 - bug fixes v0.10.16
189 o Reorganized internal files, added file reader object, added OS
190 portability header, removed and renamed some files. If you have a
191 patch against previous versions of the source, you should check
193 o Added RGBA attributes to JP2K descriptor.
194 o Changed interface to CodestreamParser.
195 o Added JP2K parser implementation. It is parsing each frame but is
196 not yet being used to populate the descriptor.
197 o Added 48fps option for `asdcp-test -p`.
198 o Added picture rate constants to AS_DCP.h (23.976, 24, 48).
199 o Added sample rate constant to AS_DCP.h (48k).
200 o Changed asdcp-test to encrypt picture headers by default
201 (plaintext offset will be 0), added -E option to allow
205 2005.04.28 - bug fixes v0.9.15
206 o The XML descriptors for the crypto DMS have moved in mxflib to
207 the file DMS_Crypto.xml (they were in DMS_DCPENC.xml). Older
208 installations should update the file from mxflib.
209 o Added Close() and Seek() to ~MyFileWriter(), cleaned up headers
210 o Added UUID generator output mode (-u).
211 o Added -S option to extract PCM essence into stereo wav files
212 o Added more UL testing and conformance checking.
213 o Added macro SMPTE_LABELS which causes the library to be built
214 with SMPTE (as opposed to MXF Interop) labels. This is not
215 set by default, and currently only affects the PCM container
216 label and encrypted element label.
217 o Cleaned up the GNUmakefile test targets, the source files
218 are now named with the TEST_FILE_PREFIX macro.
219 o enabled 23.976-framed PCM (2002 samples per frame)
220 o The size of the asdcp-test frame buffer for picture essence
221 may now be set from the command line (-b). The default is 4MB.
222 o h__Reader::ReadEKLVPacket() now tests the UL (duh) and switches
223 on the value, allowing plaintext and ciphertext frames to
224 be mixed in the file.
225 o Fixed error in UUID generator format.
226 o JP2K files now use the GenericPictureDescriptor to store
227 ContainerDuration and SampleRate. SampleRate is mapped
228 to EditRate in the PictureDescriptor struct. This fixes
229 the second caveat from the 0.8.13 release.
230 o Fxed bug in PCMParserList that was miscalculating the extent
231 of a PCM sample. This bug did not affect API users, it was
232 only present in asdcp-test.
233 o Fixed EditRate on PCM files (was showing sample rate)
234 o Fixed Encrypted Essence Container UL
235 o Fixed BlockAlign value for PCM essence
237 - The following changes were provided by Jeff Loewenguth
239 o Moved the DMS CryptographicFramework entry from the material
240 package to the source package
241 o Fixed erroneous Source Essence Container Label value
242 o Fixed broken sort of JP2K frames in JP2K parser
243 o Added FindFrameGOPStart() method to the MPEG2 MXFReader
244 o Added missing length values for EKLV packets without HMAC
245 o -x with JP2K essence writes to files with 6 digit names
247 o The Key ID may now be specified as an argument to asdcp-test
251 2004.12.30 - bug fixes + wav files v0.8.14
252 o Added WAV file write to asdcp-test (uses mxflib::waveheader_t).
253 o Three-partition files reading properly. adscplib still writes
255 o Changes in the mxflib WAV essence parser API had broken
256 asdcplib's ability to read essence from a WAV file. I have
257 fixed this bug, but at the expense of breaking compatibility
258 with older versions of mxflib. Beware!
259 o Removed redundant (but working) bin-text-bin conversions.
262 2004.12.23 - JPEG 2000 support v0.8.13
263 o Reads/writes JPEG 2000 essence in plaintext and ciphertext
264 with the following caveats:
265 - The Picture Essence Descriptor is empty.
266 - Because there is no essence descriptor, the reader code
267 in asdcp-test has no idea how many frames are in the file
268 and ends with an out-of-bounds frame error. This error
269 is being suppressed in asdcp-test for the current release.
270 o Still broken when reading three-partition files.
273 2004.10.22 - fixes and UL updates v0.7.11
274 WARNING: COMPATIBILITY BREAKPOINT
275 Files created with this and future versions of this library are
276 not compatible with previous versions of this library. As you
277 might suspect, files created with previous versions of this
278 library are not compatible with this and future versions.
280 o h__Reader will now open a three-partitition file (untested)
281 o Moved DMS from Material partition to File partition
282 o Added length fields to appropriate places in EKLV packet
285 2004.10.22 - fixes and UL updates v0.7.10
286 o fixed frame buffer handling of externally allocated buffer,
287 created unit test (asdcp-mem-test)
288 o added operator==() and operator!=() to Rational type
289 o fixed some type-related compiler warnings
290 o asdcp-test -p now works on unwrap
291 o updated some ULs to match documentation (thanks to Arun
293 o canonicalized line endings
296 2004.07.02 - full plaintext + ciphertext read/write v0.6.9
297 o HMAC, plaintext offest and raw ciphertext read supported
298 o back to proper CBR index
299 o MPEG temporal offset working
302 2004.07.01 - plaintext + ciphertext read/write v0.5.8
303 o encryption of MPEG and PCM essence supported with the
306 - no plaintext offest support
307 - no raw ciphertext read support
308 o moved to reflecting the whole KLV triplet in the CBR
309 index (now incompatible with mxflib, still searching
310 for info about what's "right")
311 o awaitng the following fixes/features:
312 - retrieve Temporal Offset from index in MPEG2::Reader
313 - test for correct ULs when reading frame triplets
314 - fix header metadata items for encrypted files
316 - plaintext offest support
317 - raw ciphertext read support
320 2004.06.14 - plaintext read/write w/key generator v0.4.5
321 o Project now uses OpenSSL (tested with 0.9.7d on win32, Linux, Darwin)
322 Use `make ASDCP_WITHOUT_OPENSSL=1` to make plaintext-only version
323 o Accepts interior I frames when parsing MPEG2 VES
324 o Improved error reporting on format errors
325 o Added support for encryption to asdcp-test
326 o Added RNG for asdcp-test (non-production use only, see notes in FortunaRNG.h)
327 o Implemented CBC encrypt, decrypt module
328 o Added partial TemporalOffset retrieval from MPEG2 parser
329 o Fixed win32 binmode bug
332 2004.05.12 - plaintext read/write v0.3.4
333 o Full read/write of plaintext MPEG-2 VES and WAV files
334 (does not yet support mux from or demux to 2 channel pairs)
335 o Builds with autoconf-based mxflib
336 o Added ASDCP_ prefix to macros
337 o Updated documentation, fixed documentation errors
338 o Simplified API for MXF writer setup
339 o Decoupled essence parsers from MXF writers
340 o added raw ciphertext support to FrameBuffer
341 o Cleaned up Get/Set naming confusion
342 o Added missing const qualifiers
345 2004.04.27 - preview release v0.2.1
346 o hasty release for quick review
347 o this release may not build with mxflib using autoconf.
348 o writes plaintext AS-DCP MPEG2 essence files
349 o tested under win32 and linux. FreeBSD and Darwin do not work
352 2004.02.04 - First release (v0.1.1):
353 o asdcp-test is mostly complete. It should correctly provide
354 access to the read and info capabilities of the library.
355 o The MPEG2 reader is functional but not fully tested.
356 o Some file format integrity tests remain to be coded.
357 o The PCM reader is mostly complete, I am having difficulty
358 getting a suitable test file from mxfwrap.
359 o The makefile creates a static library module. The API
360 will cleanly support a DSO (or DLL). Let me know if DSO
361 support is important to you.
362 o Nothing is thread safe. Thread safety was not a requirement
363 in the initial project definition. Thread safety may be added
364 above the mxflib/klvlib level. Let me know if it is important
366 o The files xmldict.xml and types.xml must be in the current
367 directory when the program is run. The files are supplied
368 with mxflib. Runtime location of the files is not currently
369 a project goal. Comments on how best to handle this situation
370 would be appreciated. See AS_DCP.cpp at init_mxf_types()
371 for a more detailed discussion.