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. Subsequent efforts have been funded by
11 Deluxe Laboratories, Doremi Labs, and others.
13 **The asdcplib project is housed on SourceForge. The project
14 home page is at http://sourceforge.net/projects/asdcplib.
15 There is not much there other than CVS because I don't
16 really have the time to master SourceForge administration.
17 Feel free to email with questions or to request a tar file.
19 The project used to depend upon the mxflib project. Because
20 of the focus on covering the whole of the MXF spscifications,
21 mxflib is considerably larger and more complex that what I
22 require for this application. For this reason I have created
23 a dedicated MXF implementation that is now part of this
24 library. Special thanks to Matt Beard and Oliver Morgan for
25 their great work and support.
27 Thanks also to the members of the SMPTE DC-28.20 packaging
28 ad-hoc group and the members of the MXF Interop Initiative
29 for their encouragement and support. Special thanks to
30 Jim Whittlesey and Howard Lukk at DCI for proposing and
31 supporting this project.
36 This library is intended (but of course not limited) for
37 use by developers of commercial D-Cinema products. It is
38 designed to be easily integrated into a wide variety of
39 development environments. Commercial users are strongly
40 urged to use static linking (at least where you use this
41 library) to prevent malicious in-field replacement of
42 critical system modules. This recommendation should be
43 considered wherever Open Source or Free software is being
44 used for applications having non-trivial security
47 The author strives mightily to provide an API that is
48 completely independent of operating system and other
49 library dependencies, and which allows selective replacement
50 of some modules for local needs. Specifically, the essence
51 parsers and OpenSSL crypto functions can be replaced by
52 linking to alternative implementations of the ASDCP::
53 objects which provide those services.
55 AS_DCP.h contains the entire API. You do not need to read
56 any of the other files, except maybe asdcp-test.cpp which
57 contains detailed usage examples of each of the API's
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 There are two flavors of build: the default build and the
89 "SMPTE_LABELS" build. Unless you are specifically working on
90 emerging SMPTE standards for D-Cinema content, you will certainly
91 want the default build. If you are developing support for the MXF
92 Interop Initiative standards, the default build is for you!
94 If you are not aiming for MXF Interop and if you are working
95 on developing support for the very latest versions of the SMPTE
96 draft standards, then you want the SMPTE_LABELS build:
100 NOTE: If you choose the SMPTE_LABELS build, you will be creating
101 files that may not work on MXF Interop systems. In the case of
102 encryption, incompatibility with MXF Interop is guaranteed! You
108 Currently, the documentation is mostly in AS_DCP.h. Read
109 that file for a detailed description of the library's
110 capabilities. Read asdcp-test.cpp for library usage
111 examples. More detailed documentation will be written RSN.
115 2006.03.09 - full read-write
116 o Removed ASDCP_WITHOUT_OPENSSL compile-time option.
117 o Full read/write now working on new MXF library
119 2005.00.00 - A New Hope
120 o The temporary mxf-lite has been removed. MXF files are now
121 managed via the objects in KLV.h, MXFTypes.h MXF.h and
122 Metadata.h. This release does not support writing MXF files.
123 o Fixed a header interpretation error in the Wav parser.
126 2005.00.00 - The Reformation
127 o Removed mxflib as a dependency by forking the necessary
128 functions and placing them in the mxf-lite subdirectory.
129 Please note that the very heavy modifications done here
130 render all comparisson to mxflib code a substantial task.
131 All errors are now mine and users are warned not to bug
132 Oliver or Matt for help with this code. The version of
133 mxflib at the time of the fork was: 0.5.1.3.
136 2005.06.03 - bug fixes v0.10.18
137 o Updated UL batch to include GC UL.
140 2005.05.27 - bug fixes v0.10.17
141 o Un-did essence container and compression descriptor changes.
142 The default build reflects MXF Interop decisions as of 26 May.
143 o Added note about build versions to README (see above).
144 o Added warnings to SMPTE_LABELS builds.
145 o Fixed JP2K essence container label.
148 2005.05.02 - bug fixes v0.10.16
149 o Reorganized internal files, added file reader object, added OS
150 portability header, removed and renamed some files. If you have a
151 patch against previous versions of the source, you should check
153 o Added RGBA attributes to JP2K descriptor.
154 o Changed interface to CodestreamParser.
155 o Added JP2K parser implementation. It is parsing each frame but is
156 not yet being used to populate the descriptor.
157 o Added 48fps option for `asdcp-test -p`.
158 o Added picture rate constants to AS_DCP.h (23.976, 24, 48).
159 o Added sample rate constant to AS_DCP.h (48k).
160 o Changed asdcp-test to encrypt picture headers by default
161 (plaintext offset will be 0), added -E option to allow
165 2005.04.28 - bug fixes v0.9.15
166 o The XML descriptors for the crypto DMS have moved in mxflib to
167 the file DMS_Crypto.xml (they were in DMS_DCPENC.xml). Older
168 installations should update the file from mxflib.
169 o Added Close() and Seek() to ~MyFileWriter(), cleaned up headers
170 o Added UUID generator output mode (-u).
171 o Added -S option to extract PCM essence into stereo wav files
172 o Added more UL testing and conformance checking.
173 o Added macro SMPTE_LABELS which causes the library to be built
174 with SMPTE (as opposed to MXF Interop) labels. This is not
175 set by default, and currently only affects the PCM container
176 label and encrypted element label.
177 o Cleaned up the GNUmakefile test targets, the source files
178 are now named with the TEST_FILE_PREFIX macro.
179 o enabled 23.976-framed PCM (2002 samples per frame)
180 o The size of the asdcp-test frame buffer for picture essence
181 may now be set from the command line (-b). The default is 4MB.
182 o h__Reader::ReadEKLVPacket() now tests the UL (duh) and switches
183 on the value, allowing plaintext and ciphertext frames to
184 be mixed in the file.
185 o Fixed error in UUID generator format.
186 o JP2K files now use the GenericPictureDescriptor to store
187 ContainerDuration and SampleRate. SampleRate is mapped
188 to EditRate in the PictureDescriptor struct. This fixes
189 the second caveat from the 0.8.13 release.
190 o Fxed bug in PCMParserList that was miscalculating the extent
191 of a PCM sample. This bug did not affect API users, it was
192 only present in asdcp-test.
193 o Fixed EditRate on PCM files (was showing sample rate)
194 o Fixed Encrypted Essence Container UL
195 o Fixed BlockAlign value for PCM essence
197 - The following changes were provided by Jeff Loewenguth
199 o Moved the DMS CryptographicFramework entry from the material
200 package to the source package
201 o Fixed erroneous Source Essence Container Label value
202 o Fixed broken sort of JP2K frames in JP2K parser
203 o Added FindFrameGOPStart() method to the MPEG2 MXFReader
204 o Added missing length values for EKLV packets without HMAC
205 o -x with JP2K essence writes to files with 6 digit names
207 o The Key ID may now be specified as an argument to asdcp-test
211 2004.12.30 - bug fixes + wav files v0.8.14
212 o Added WAV file write to asdcp-test (uses mxflib::waveheader_t).
213 o Three-partition files reading properly. adscplib still writes
215 o Changes in the mxflib WAV essence parser API had broken
216 asdcplib's ability to read essence from a WAV file. I have
217 fixed this bug, but at the expense of breaking compatibility
218 with older versions of mxflib. Beware!
219 o Removed redundant (but working) bin-text-bin conversions.
222 2004.12.23 - JPEG 2000 support v0.8.13
223 o Reads/writes JPEG 2000 essence in plaintext and ciphertext
224 with the following caveats:
225 - The Picture Essence Descriptor is empty.
226 - Because there is no essence descriptor, the reader code
227 in asdcp-test has no idea how many frames are in the file
228 and ends with an out-of-bounds frame error. This error
229 is being suppressed in asdcp-test for the current release.
230 o Still broken when reading three-partition files.
233 2004.10.22 - fixes and UL updates v0.7.11
234 WARNING: COMPATIBILITY BREAKPOINT
235 Files created with this and future versions of this library are
236 not compatible with previous versions of this library. As you
237 might suspect, files created with previous versions of this
238 library are not compatible with this and future versions.
240 o h__Reader will now open a three-partitition file (untested)
241 o Moved DMS from Material partition to File partition
242 o Added length fields to appropriate places in EKLV packet
245 2004.10.22 - fixes and UL updates v0.7.10
246 o fixed frame buffer handling of externally allocated buffer,
247 created unit test (asdcp-mem-test)
248 o added operator==() and operator!=() to Rational type
249 o fixed some type-related compiler warnings
250 o asdcp-test -p now works on unwrap
251 o updated some ULs to match documentation (thanks to Arun
253 o canonicalized line endings
256 2004.07.02 - full plaintext + ciphertext read/write v0.6.9
257 o HMAC, plaintext offest and raw ciphertext read supported
258 o back to proper CBR index
259 o MPEG temporal offset working
262 2004.07.01 - plaintext + ciphertext read/write v0.5.8
263 o encryption of MPEG and PCM essence supported with the
266 - no plaintext offest support
267 - no raw ciphertext read support
268 o moved to reflecting the whole KLV triplet in the CBR
269 index (now incompatible with mxflib, still searching
270 for info about what's "right")
271 o awaitng the following fixes/features:
272 - retrieve Temporal Offset from index in MPEG2::Reader
273 - test for correct ULs when reading frame triplets
274 - fix header metadata items for encrypted files
276 - plaintext offest support
277 - raw ciphertext read support
280 2004.06.14 - plaintext read/write w/key generator v0.4.5
281 o Project now uses OpenSSL (tested with 0.9.7d on win32, Linux, Darwin)
282 Use `make ASDCP_WITHOUT_OPENSSL=1` to make plaintext-only version
283 o Accepts interior I frames when parsing MPEG2 VES
284 o Improved error reporting on format errors
285 o Added support for encryption to asdcp-test
286 o Added RNG for asdcp-test (non-production use only, see notes in FortunaRNG.h)
287 o Implemented CBC encrypt, decrypt module
288 o Added partial TemporalOffset retrieval from MPEG2 parser
289 o Fixed win32 binmode bug
292 2004.05.12 - plaintext read/write v0.3.4
293 o Full read/write of plaintext MPEG-2 VES and WAV files
294 (does not yet support mux from or demux to 2 channel pairs)
295 o Builds with autoconf-based mxflib
296 o Added ASDCP_ prefix to macros
297 o Updated documentation, fixed documentation errors
298 o Simplified API for MXF writer setup
299 o Decoupled essence parsers from MXF writers
300 o added raw ciphertext support to FrameBuffer
301 o Cleaned up Get/Set naming confusion
302 o Added missing const qualifiers
305 2004.04.27 - preview release v0.2.1
306 o hasty release for quick review
307 o this release may not build with mxflib using autoconf.
308 o writes plaintext AS-DCP MPEG2 essence files
309 o tested under win32 and linux. FreeBSD and Darwin do not work
312 2004.02.04 - First release (v0.1.1):
313 o asdcp-test is mostly complete. It should correctly provide
314 access to the read and info capabilities of the library.
315 o The MPEG2 reader is functional but not fully tested.
316 o Some file format integrity tests remain to be coded.
317 o The PCM reader is mostly complete, I am having difficulty
318 getting a suitable test file from mxfwrap.
319 o The makefile creates a static library module. The API
320 will cleanly support a DSO (or DLL). Let me know if DSO
321 support is important to you.
322 o Nothing is thread safe. Thread safety was not a requirement
323 in the initial project definition. Thread safety may be added
324 above the mxflib/klvlib level. Let me know if it is important
326 o The files xmldict.xml and types.xml must be in the current
327 directory when the program is run. The files are supplied
328 with mxflib. Runtime location of the files is not currently
329 a project goal. Comments on how best to handle this situation
330 would be appreciated. See AS_DCP.cpp at init_mxf_types()
331 for a more detailed discussion.