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
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 DC28.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. Unpack
73 it into the same parent directory as asdcplib/, and rename the
74 directory as 'openssl':
78 drwxr-xr-x 1 jhurst None 0 Feb 3 16:37 asdcplib
79 drwxr-xr-x 56 jhurst None 0 Feb 2 16:35 openssl
81 To build, type 'make'. There are several test targets but you
82 need to assemble a set of test files to use them.
84 I have tested this build on win32, Linux, OpenBSD and Darwin
85 platforms. Others may work as well.
92 asdcp-test - Writes, reads and verifies AS-DCP (MXF) track files.
94 kmfilegen - Writes and verifies large files using a platform-
95 independent format. Use it to test issues related to large files.
97 kmuuidgen, kmrandgen - generate UUID values and random numbers
99 wavesplit - Splits a WAVE file into two or more output files. Used
100 to untangle incorrectly-paired DCDM sound files.
102 blackwave - Write a WAVE file full of zeros, Used to make filler
103 tracks (though you would be better off modifying asdcp-test if
104 this is a common use case).
109 Currently, the API documentation is mostly in AS_DCP.h. Read
110 that file for a detailed description of the library's capabilities.
111 Read asdcp-test.cpp for library usage examples. The command-line
112 utilities all respond to -h and there are manual pages in man/.
116 2006.09.25 - Bug fixes v1.1.9
117 o Fixed SourcePackageID value. All files will be 'original',
118 i.e. SourcePackageID will be all zeros. Let me know if you
119 want to set SourcePackageID.
120 o Fixed compiler warnings on some Linux platforms
121 o Fixed the build so that BUILD_DIR is no longer created
123 o Added duration detection to the raw essence parsers. The
124 MPEG parser uses a nasty approximation so don't use it
125 without paying close attention to the result.
126 o Modified PCMParserList to make it more useful as a base
128 o Fixed bugs and re-organized command-line help in asdcp-test
130 o Fixed two-partition file reads.
131 o Fixed Win32 PRNG initialization.
132 o Renamed asdcp-lf-test as kmfilegen.
133 o Added kmrandgen and kmuuidgen.
134 o Added string retrieval mechanism to Result_t.
135 o Refactored Kumu::Identifier and its sub-classes.
136 o Altered Kumu::PathIsFile to return true when the path
137 is a symbolic link (unix only).
138 o Altered Kumu::FileWriter::OpenWrite to use file creation
139 mode 0664 (was 0644) (unix only).
140 o Added Kumu::WriteStringIntoFile() subroutine.
143 2006.04.05 - Bug fixes and new stuff v1.1.7
144 o Fixed a bug in the MPEG parser that caused it to fail when
145 handling start codes spanning buffer boundaries
146 o Added wavesplit and blackwave utility programs
147 o Added support for revised SMPTE HMAC key derivation when
149 o Refactored platform compatibility and general utilities
150 into a new sub-library "Kumu". There are no new build
151 steps or dependencies, but some important things have
153 + Result_t is no longer an enum, it is now a class.
154 Library result codes are now declared as const objects
157 const Kumu::Result_t RESULT_FORMAT (-101, "The file...");
159 The macros ASDCP_SUCCESS and ASDCP_FAILURE still work
160 the same way thanks to an operator overload for type long.
161 See KM_error.h for more information.
162 + The logging interface has been moved out of AS_DCP.h
164 o Some of the command line utilities that were using headers
165 other than AS_DCP.h have been changed to use the Kumu
166 equivalents. If you have code based on those utilities, you
167 will have to update by hand.
168 o Added new types to the EssenceType_t enum.
169 o The guard macro for Win32 code has changed from WIN32 to
173 2006.03.2x - new stuff
174 o Proper handling of stream-id byte of essence UL values
175 o writes 3-partition files, reads 2-part or 3-part
178 2006.03.16 - bug fixes plus
179 o Removed SMPTE_LABELS compile-time option. The reader will now
180 silently accept either SMPTE or MXF Interop labels, the writer
181 can be instructed which to use at runtime. Default is Interop.
182 o Added an AIFF reader. Support is preliminary, it works with the
183 AIFF files I have on hand.
184 o More code refactoring. More to come.
187 2006.03.09 - full read-write
188 o Removed ASDCP_WITHOUT_OPENSSL compile-time option.
189 o Full read/write now working on new MXF library
192 2005.00.00 - A New Hope
193 o The temporary mxf-lite has been removed. MXF files are now
194 managed via the objects in KLV.h, MXFTypes.h MXF.h and
195 Metadata.h. This release does not support writing MXF files.
196 o Fixed a header interpretation error in the Wav parser.
199 2005.00.00 - The Reformation
200 o Removed mxflib as a dependency by forking the necessary
201 functions and placing them in the mxf-lite subdirectory.
202 Please note that the very heavy modifications done here
203 render all comparisson to mxflib code a substantial task.
204 All errors are now mine and users are warned not to bug
205 Oliver or Matt for help with this code. The version of
206 mxflib at the time of the fork was: 0.5.1.3.
209 2005.06.03 - bug fixes v0.10.18
210 o Updated UL batch to include GC UL.
213 2005.05.27 - bug fixes v0.10.17
214 o Un-did essence container and compression descriptor changes.
215 The default build reflects MXF Interop decisions as of 26 May.
216 o Added note about build versions to README (see above).
217 o Added warnings to SMPTE_LABELS builds.
218 o Fixed JP2K essence container label.
221 2005.05.02 - bug fixes v0.10.16
222 o Reorganized internal files, added file reader object, added OS
223 portability header, removed and renamed some files. If you have a
224 patch against previous versions of the source, you should check
226 o Added RGBA attributes to JP2K descriptor.
227 o Changed interface to CodestreamParser.
228 o Added JP2K parser implementation. It is parsing each frame but is
229 not yet being used to populate the descriptor.
230 o Added 48fps option for `asdcp-test -p`.
231 o Added picture rate constants to AS_DCP.h (23.976, 24, 48).
232 o Added sample rate constant to AS_DCP.h (48k).
233 o Changed asdcp-test to encrypt picture headers by default
234 (plaintext offset will be 0), added -E option to allow
238 2005.04.28 - bug fixes v0.9.15
239 o The XML descriptors for the crypto DMS have moved in mxflib to
240 the file DMS_Crypto.xml (they were in DMS_DCPENC.xml). Older
241 installations should update the file from mxflib.
242 o Added Close() and Seek() to ~MyFileWriter(), cleaned up headers
243 o Added UUID generator output mode (-u).
244 o Added -S option to extract PCM essence into stereo wav files
245 o Added more UL testing and conformance checking.
246 o Added macro SMPTE_LABELS which causes the library to be built
247 with SMPTE (as opposed to MXF Interop) labels. This is not
248 set by default, and currently only affects the PCM container
249 label and encrypted element label.
250 o Cleaned up the GNUmakefile test targets, the source files
251 are now named with the TEST_FILE_PREFIX macro.
252 o enabled 23.976-framed PCM (2002 samples per frame)
253 o The size of the asdcp-test frame buffer for picture essence
254 may now be set from the command line (-b). The default is 4MB.
255 o h__Reader::ReadEKLVPacket() now tests the UL (duh) and switches
256 on the value, allowing plaintext and ciphertext frames to
257 be mixed in the file.
258 o Fixed error in UUID generator format.
259 o JP2K files now use the GenericPictureDescriptor to store
260 ContainerDuration and SampleRate. SampleRate is mapped
261 to EditRate in the PictureDescriptor struct. This fixes
262 the second caveat from the 0.8.13 release.
263 o Fxed bug in PCMParserList that was miscalculating the extent
264 of a PCM sample. This bug did not affect API users, it was
265 only present in asdcp-test.
266 o Fixed EditRate on PCM files (was showing sample rate)
267 o Fixed Encrypted Essence Container UL
268 o Fixed BlockAlign value for PCM essence
270 - The following changes were provided by Jeff Loewenguth
272 o Moved the DMS CryptographicFramework entry from the material
273 package to the source package
274 o Fixed erroneous Source Essence Container Label value
275 o Fixed broken sort of JP2K frames in JP2K parser
276 o Added FindFrameGOPStart() method to the MPEG2 MXFReader
277 o Added missing length values for EKLV packets without HMAC
278 o -x with JP2K essence writes to files with 6 digit names
280 o The Key ID may now be specified as an argument to asdcp-test
284 2004.12.30 - bug fixes + wav files v0.8.14
285 o Added WAV file write to asdcp-test (uses mxflib::waveheader_t).
286 o Three-partition files reading properly. adscplib still writes
288 o Changes in the mxflib WAV essence parser API had broken
289 asdcplib's ability to read essence from a WAV file. I have
290 fixed this bug, but at the expense of breaking compatibility
291 with older versions of mxflib. Beware!
292 o Removed redundant (but working) bin-text-bin conversions.
295 2004.12.23 - JPEG 2000 support v0.8.13
296 o Reads/writes JPEG 2000 essence in plaintext and ciphertext
297 with the following caveats:
298 - The Picture Essence Descriptor is empty.
299 - Because there is no essence descriptor, the reader code
300 in asdcp-test has no idea how many frames are in the file
301 and ends with an out-of-bounds frame error. This error
302 is being suppressed in asdcp-test for the current release.
303 o Still broken when reading three-partition files.
306 2004.10.22 - fixes and UL updates v0.7.11
307 WARNING: COMPATIBILITY BREAKPOINT
308 Files created with this and future versions of this library are
309 not compatible with previous versions of this library. As you
310 might suspect, files created with previous versions of this
311 library are not compatible with this and future versions.
313 o h__Reader will now open a three-partitition file (untested)
314 o Moved DMS from Material partition to File partition
315 o Added length fields to appropriate places in EKLV packet
318 2004.10.22 - fixes and UL updates v0.7.10
319 o fixed frame buffer handling of externally allocated buffer,
320 created unit test (asdcp-mem-test)
321 o added operator==() and operator!=() to Rational type
322 o fixed some type-related compiler warnings
323 o asdcp-test -p now works on unwrap
324 o updated some ULs to match documentation (thanks to Arun
326 o canonicalized line endings
329 2004.07.02 - full plaintext + ciphertext read/write v0.6.9
330 o HMAC, plaintext offest and raw ciphertext read supported
331 o back to proper CBR index
332 o MPEG temporal offset working
335 2004.07.01 - plaintext + ciphertext read/write v0.5.8
336 o encryption of MPEG and PCM essence supported with the
339 - no plaintext offest support
340 - no raw ciphertext read support
341 o moved to reflecting the whole KLV triplet in the CBR
342 index (now incompatible with mxflib, still searching
343 for info about what's "right")
344 o awaitng the following fixes/features:
345 - retrieve Temporal Offset from index in MPEG2::Reader
346 - test for correct ULs when reading frame triplets
347 - fix header metadata items for encrypted files
349 - plaintext offest support
350 - raw ciphertext read support
353 2004.06.14 - plaintext read/write w/key generator v0.4.5
354 o Project now uses OpenSSL (tested with 0.9.7d on win32, Linux, Darwin)
355 Use `make ASDCP_WITHOUT_OPENSSL=1` to make plaintext-only version
356 o Accepts interior I frames when parsing MPEG2 VES
357 o Improved error reporting on format errors
358 o Added support for encryption to asdcp-test
359 o Added RNG for asdcp-test (non-production use only, see notes in FortunaRNG.h)
360 o Implemented CBC encrypt, decrypt module
361 o Added partial TemporalOffset retrieval from MPEG2 parser
362 o Fixed win32 binmode bug
365 2004.05.12 - plaintext read/write v0.3.4
366 o Full read/write of plaintext MPEG-2 VES and WAV files
367 (does not yet support mux from or demux to 2 channel pairs)
368 o Builds with autoconf-based mxflib
369 o Added ASDCP_ prefix to macros
370 o Updated documentation, fixed documentation errors
371 o Simplified API for MXF writer setup
372 o Decoupled essence parsers from MXF writers
373 o added raw ciphertext support to FrameBuffer
374 o Cleaned up Get/Set naming confusion
375 o Added missing const qualifiers
378 2004.04.27 - preview release v0.2.1
379 o hasty release for quick review
380 o this release may not build with mxflib using autoconf.
381 o writes plaintext AS-DCP MPEG2 essence files
382 o tested under win32 and linux. FreeBSD and Darwin do not work
385 2004.02.04 - First release (v0.1.1):
386 o asdcp-test is mostly complete. It should correctly provide
387 access to the read and info capabilities of the library.
388 o The MPEG2 reader is functional but not fully tested.
389 o Some file format integrity tests remain to be coded.
390 o The PCM reader is mostly complete, I am having difficulty
391 getting a suitable test file from mxfwrap.
392 o The makefile creates a static library module. The API
393 will cleanly support a DSO (or DLL). Let me know if DSO
394 support is important to you.
395 o Nothing is thread safe. Thread safety was not a requirement
396 in the initial project definition. Thread safety may be added
397 above the mxflib/klvlib level. Let me know if it is important
399 o The files xmldict.xml and types.xml must be in the current
400 directory when the program is run. The files are supplied
401 with mxflib. Runtime location of the files is not currently
402 a project goal. Comments on how best to handle this situation
403 would be appreciated. See AS_DCP.cpp at init_mxf_types()
404 for a more detailed discussion.