X-Git-Url: https://git.carlh.net/gitweb/?a=blobdiff_plain;f=README;h=3684f70933497a12d581c385a84562b50c3310fa;hb=b7f0b8f115baf56bdfbceef303e4528433ec6092;hp=fe56d719fdc65e2568f2245318959c6e4d93e9c3;hpb=9f903fec9d68fc58399a925b0311af3dc9a3faf2;p=asdcplib.git diff --git a/README b/README index fe56d71..3684f70 100755 --- a/README +++ b/README @@ -11,8 +11,8 @@ Initiatives, LLC (DCI). Subsequent efforts have been funded by Deluxe Laboratories, Doremi Labs, CineCert LLC, Avica Technology and others. -**The asdcplib project was housed on SourceForge. The project -will be moving to a new home, to be announced here soon. +**The asdcplib project was originally housed on SourceForge. +The project has moved to http://www.cinecert.com/asdcplib/ The project formerly depended upon the mxflib project. Because of its focus on covering the whole of the MXF specifications, @@ -39,16 +39,16 @@ urged to use static linking (at least where you use this library) to prevent malicious in-field replacement of critical system modules. This recommendation should be considered wherever Open Source or Free software is being -used for applications having non-trivial security -requirements. +used in conjunction with critical security parameters, such +as cryptographic keys. -The author strives mightily to provide an API that is -completely independent of operating system and other -library dependencies, and which allows selective replacement -of some modules for local needs. Specifically, the essence -parsers and OpenSSL crypto functions can be replaced by -linking to alternative implementations of the ASDCP:: -objects which provide those services. +The author strives mightily to provide an API that is completely +independent of operating system and other library dependencies, +and which allows selective replacement of some modules for +local needs. Specifically, the essence parsers and OpenSSL +crypto functions can be replaced by linking to alternative +implementations of the ASDCP:: objects which provide those +services. AS_DCP.h contains the entire API. You do not need to read any of the other files, except maybe asdcp-test.cpp which @@ -60,28 +60,26 @@ is simple AS-DCP support. Build Instructions -GNU make is required to build asdcplib. The makefile will -work on win32 systems that have Cygwin. Other win32 gmake -packages may or may not work depending upon the availability -of standard POSIX shell commands. You will need gcc to rebuild -the dep.make file. +On more-or-less POSIX systems (OS X, Linux, and BSD), GNU make is +required to build asdcplib. The same configure script will also +build this package on Windows machines with Cygwin and +MinGW installed. For those Windows users who would prefer to build +this natively, an "nmake" build file and instructions can be found +in the win32 subdirectory. -OpenSSL is also required. See http://www.openssl.org +OpenSSL is also required, version 0.9.8k is recommended. See +http://www.openssl.org/ for more information and download +instructions. -If you are building on win32 or a unix with no OpenSSL library -support, you will have to also obtain and build OpenSSL. Unpack -it into the same parent directory as asdcplib/, and rename the -directory as 'openssl': +Optional support for writing Timed Text Track Files is supported by +either Xerces-C or Expat. See http://xerces.apache.org/xerces-c/ or +http://expat.sourceforge.net/ for source and build instructions. -myhost$ ls -l -total 1761 -drwxr-xr-x 1 jhurst None 0 Feb 3 16:37 asdcplib -drwxr-xr-x 56 jhurst None 0 Feb 2 16:35 openssl +To configure and build, type './configure' followed by 'make'. There +are several test targets on the POSIX side, but you need to assemble +a set of test files to use them. -To build, type 'make'. There are several test targets but you -need to assemble a set of test files to use them. - -I have tested this build on win32, Linux, OpenBSD and Darwin +I have tested this build on win32, Linux, OpenBSD, and Darwin platforms. Others may work as well. @@ -94,7 +92,7 @@ asdcp-test - Writes, reads and verifies AS-DCP (MXF) track files. kmfilegen - Writes and verifies large files using a platform- independent format. Use it to test issues related to large files. -kmuuidgen, kmrandgen - generate UUID values and random numbers +kmuuidgen, kmrandgen - generate UUID values and random numbers. wavesplit - Splits a WAVE file into two or more output files. Used to untangle incorrectly-paired DCDM sound files. @@ -106,22 +104,258 @@ blackwave - Write a WAVE file full of zeros, Used to make filler Documentation -Currently, the API documentation is mostly in AS_DCP.h. Read -that file for a detailed description of the library's capabilities. -Read asdcp-test.cpp for library usage examples. The command-line -utilities all respond to -h and there are manual pages in man/. +The API documentation is mostly in AS_DCP.h. Read that file for +a detailed description of the library's capabilities. Read +asdcp-test.cpp for library usage examples. The command-line +utilities all respond to -h. Change History + +2010.07.20 - bug fixes, v1.6.37 + o Fixed TimedTextResourceSubDescriptor UL value. + + +2010.06.16 - bug fixes, v1.6.36 + o Added support for new Edit Rates to asdcp-test.cpp. + o Expanded timed-text file reader in asdcp-test.cpp. + o Fixed large BER value encoding (plaintext) and decoding + (plaintext and ciphertext). This feature was introduced in + v1.5.31). + o Fixed AvgBps value for multi-channel Wave input. + + +2010.05.13 - bug fixes, enhancements, v1.6.34 + o ST 429-5 files have corrected ULs for DCTimedTextDescriptor and + GenericStream DataElement. Files made with previous versions of + the library are incompatible with this and future versions. + o Fixed File Package TrackNumber values. Thanks to Sankar. + o Added edit rate constants to AS_DCP.h (25, 30, 50, 60). + o Changed AudioDescriptor "SampelRate" element name to "EditRate" + to make it consistent with the other types. + o Now builds with XercesC 3.x. + o KM_memio.h has better const behavior. + o Fixed a bug in KM_memio.h string archiving. + + +2010.01.05 - bug fixes, enhancements, v1.5.32 + o Re-fixed swapped Interop and SMPTE OP Atom UL values. The swap + introduced in v1.5.31 was done in error. + o Added -z,-Z options to asdcp-test (j2c parameter checking) + o Reformed jp2k-test as j2c-test, added help and list processing, + added to standard install target. + + +2009.12.31 - bug fixes, enhancements, v1.5.31 + o Fixed swapped Interop and SMPTE OP Atom UL values. + o Added get_BER_length_for_value() subroutine. + o Modified ASDCP::h__Writer::WriteEKLVPacket() to allow larger BER + lengths for KLV packets larger than 16 MB. This was required to + support large font files in the SMPTE 429-5 implementation. + + +2009.11.06 - bug fixes, enhancements, v1.5.29 + o Fixed a bug that could cause HMAC values to be incorrectly + stored in MXF files. Files created with versions of asdcplib + prior to this version may have incorrect HMAC values. + o Improved handing of XML files for MXF wrapping. + o Jpeg2000 codestream EditRate and SampleRate mismatches + now warns instead of returning an error. + o Improved error handling in Jpeg2000 sequence parsing routines. + o Added two methods to Kumu::Timestamp, AddSeconds(), to add (or + subtract) seconds to a time value, and GetSecondsSinceEpoch() + to get the number of seconds since the unix epoch. + o Added new option to asdcp-test, '-a', to specify a UUID when + creating MXF files. + o Added support for specifying the intrinsic duration of MXF files + containing timed text. + o Added new option to wavesplit, '-i', to display WAV file metadata. + + +2009.05.21 - bug fixes, v.1.4.24 + o Fixed a bug that caused incorrect SubDescriptors UL values to be + written into interop format MXF track files. Note that this involved + a substantial reorganization of MXF internals. Please test thoroughly + in your application before using in production. Note that this is a + significant bug fix and track files created with 1.4.22 may be incompatible + with other systems. + + +2009.04.09 - SMPTE format fixes, enhancements and bug fixes, v.1.4.22 + o asdcplib now uses GNU autotools on POSIX systems to configure + and build. See "./configure" for details. Note that two options, + --enable-freedist and --with-python are not enabled in the free + version of asdcplib and should not be used. + o Added build option (CONFIG_RANDOM_UUID) to enable mixed case UUID + generation when environment variable KM_USE_RANDOM_UUID is defined. + o Fixed a condition that could cause an error to occur when wrapping + SMPTE format timed text track files that do not define a starting + frame. + o Updated ULs for SMPTE format track files. + o SampleRate added to JP2K metadata + o Support for wrapping 96kHz WAV files added. + o Updated ULs for audio channel formats (ChannelFormat) + o Updated font subdescriptor MIME Types for TimedText Trackfiles. + o Changed time implementation to support dates beyond Jan 19th, 2038. + o Xerces-C XML parser support added. + o New build method for Windows (see win32/README.txt for details). + o Added new functionality in Kumu to recursively create and delete files + and directories, and get free disk space for a given volume path. + o Added a method to Kumu::Timestamp, AddMinutes(), to add (or subtract) + minutes to a time value. + o Improved how Kumu::Timestamp parses timestamps with offsets. + o Fixed a bug that caused incorrect HMAC values to be calculated. + + +2008.02.16 - SMPTE format fixes, bug fixes v.1.3.18 + o Added correct SMPTE UL for StereoscopicPictureSubDescriptor. + o Exposed JP2K metadata parser as ParseMetadataIntoDesc(). + o Added simple stereoscopic framebuffer to support paired ReadFrame() + and WriteFrame() methods (allows simpler integration with other + single-buffer code). + o Improved detection of JPEG Interop stereoscopic files. + o Win32 build fixes (Thanks to Mike Crowe at DTS). + o Added the WITH_MD macro to the makefile. Set this value to one + to build Win32 with /MD[d] instead of /MT[d]. + o The Generic Container UL has been added to the EssenceContainers + set in the header partition pack for encrypted files. It has always + been there in plaintext files. + - Below this point the changes are internal and should not affect you + unless you use Kumu directly. + o Major refactoring of KM_log.[h|cpp]. + o Fixed buffer re-sizing issue in Kumu::ByteString. + o Replaced type IdentifierList with ArchivableList. + o Added COPYING file to the release bundle. + + +2007.12.13 - Bug fixes v.1.2.17 + o Changed Result_t implementation to use int instead of long, which + was causing trouble on some 64 bit platforms. + o Fixed EKLV HMAC. NOTE: Breaks backward compatibility with older + Interop files. To validate these files, use asdcplib-1.1.14. This + should not cause too much trouble since files with broken and + non-broken HMAC have been in the wild for years without issue. + o Fixed HMAC sequence numbering in encrypted stereoscopic files. + o Finished stereoscopic test targets in the makefile. + o Fixed the win32 build, now expects VS2005 compiler by default, + use WITH_VC6=1 top get VC6 flags. + o Stereoscopic and Timed Text modes now have SMPTE UL values. + NOTE: SMPTE 429-5 and 429-10 are not yet published. It is possible + that these UL values may change before publication. Please use + caution when using these features for production work. + o Changed a bunch of symbol names in the 429-5 implementation to + better match the spec. + o Added -U option to asdcp-test to dump the UL library to stdout. + o Fixed erroneous placement of the PictureEssenceCoding UL in JP2K + files (Interop and SMPTE modes). + + +2007.10.22 - Timed Text, Stereoscopic Picture and Bug fixes v.1.2.16 + o Significant API changes have been made. Please read all entries + in this changelog to be sure you understand the changes. Also + note that some changes have been made to LS_MXF_SMPTE files that + are incompatible with earlier releases (e.g., EKLV HMAC). If + you are looking for a stable interop release, use v.1.1.14. + o Fixed RFC 2104 HMAC implementation for LS_MXF_SMPTE only. The + broken implementation has been maintained for Interop mode. + o Added support for draft SMPTE 429-5 Timed Text Track File. This + is still waiting for official SMPTE ULs, so do not use it for + shipping products. An XML parser is needed to create a Timed + Text Track File; Expat is now an optional part of the build. + Make with WITH_XML_PARSER=1 to link with Expat. If you do not + link with expat, you will get an error when using the TimedText:: + DCSubtitleParser class. See also S429-5-cgi.cpp for an example + that shows how to serve plaintext MXF file elements directly via + HTTP. + o Added support for draft SMPTE 429-10 Stereoscopic Picture Track + File, including the JPEG Interop version. This is still waiting + for official SMPTE ULs, so do not use it with LS_MXF_SMPTE for + shipping products. + o Refactored the following files as a side-effect of the above + work: AS_DCP_JP2K.cpp AS_DCP_MPEG2.cpp AS_DCP_PCM.cpp + AS_DCP_MXF.cpp AS_DCP_internal.h MXF.[h|cpp] MXFTypes.[h|cpp] + Metadata.[h|cpp] h__Reader.cpp h__Writer.cpp klvwalk.cpp. + WARNING: While significant effort has been extended to make sure + that these changes do not affect existing stable file support, + users are cautioned to test this release thouroughly. + o Added a large set of filesystem path manglers to KM_fileio.h. See + path-test.cpp for example usage. The path manglers have not yet + been tested on win32 platforms (they are currently used only by + the Timed Text module. + o The PathIsFile(), PathIsDirectory() and FileSize() subroutines + have been modified to accept const std::string& instead of + const char*. + o Added namespace and parsing support (Expat) to Kumu::XMLElement + (currently used only for Timed Text support). Also added some + new accessors. + o Altered MXF::UTF16String to use mbtowc() and wctomb(). + + +2007.03.31 - Bug fixes v.1.1.14 + o Fixed KeyFrameOffset value in MPEG wrapping to have negative + value. This is probably not yet complete for handling all + types of GOPs. Please send chunks of MPEG-2 VES that you + find which break this. Thanks to Doremi. + ** no other file format changes in this release ** + o Fixed error in RIP interpretation when reading arbitrary (i.e., + non-MXF) files. + o Fixed a memory leak in ASDCP::MXF::OPAtomHeader when used + in read mode. Thanks to Mahesh Bajaj for pointing out this + bug and the one above. + o Removed asserts from KM_fileio, replaced with RESULT_WRITEFAIL + return value statements. + o Added -s and -p to the makefile install target. + o Altered ByteString behavior to use target Length() in copy + operations (instead of Capacity()). + o Added new Set() method to ByteString. + o Fixed a bug in ByteString::Unarchive() that caused the operation + to fail when the buffer was smaller than the read (i.e., when + Capacity() was called). + o Added IdentifierList class to KM_util.h. + o Changed some Error() messages to Debug() in Wav.cpp + o Revived jp2k-test.cpp and asdcp-mem-test.cpp (they both had + stale #includes). + + +2007.02.15 - Bug fixes v1.1.13 + o Removed 'VDescObj->SampleRate.Numerator = VDesc.FrameRate;' + from MPEG2_VDesc_to_MD() in AS_DCP_MPEG2.cpp, was line 76. + o Added KM_TEST_NULL_STR_L() and KM_TEST_NULL_L() macros to + KM_log.h. These versions log the location of the null value. + Macros are now used in any module that includes KM_log.h. + o MPEG2 VES with run of zero values at the head is now OK. + o Increased VESHeaderBufSize to 16K. + o Added makefile support for local OpenSSL in ../openssl, if + present. + o The Kumu::PathIs*() functions now return false if a null or + empty string is given (used to be an assert). + o Cleaned up the install target in the makefile. + o Fixed SMPTE 429-6 HMAC -- FIPS 186-2 implementation was + laughably incorrect. Thanks to Doremi for pointing this out. + o Removed default parameter to HMACContext::InitKey(). + o Cleaned up messages and CLI arg handling in asdcp-test. + + +2006.11.19 - Mo better stuff v1.1.12 + o Changed read-only Result_t accessor methods to const. + o Added Base64 (-B) option to kmrandgen. + o Removed 16-bit alignment restriction from kmrandgen. + o Improved WAV file extraction speed (Thanks to Jim Radford + for pointing this out). + o Added single-channel split for WAV extraction (asdcp-test -1). + o Fixed remainder bug in h__RNG::fill_rand(). + + 2006.11.03 - Bug fixes v1.1.11 o Increased index table entry list size to 5000. o Added length checking to TLV writer (returns error if TLV payload exceeds 64kB). o Fixed partition header and RIP errors related to 2-partition files (MXF Interop mode). - o Added -t option, SHA-1 digest with Base64 output on stdout. + o Added -t option to asdcp-test (SHA-1 digest with Base64 output + on stdout). o Fixed Sub Descriptor reference bug (Thanks to Denis Leconte - for dogged determination). + for dogged determination). o Added directory-of-wav detection to RawEssenceType() o Modified MXF::Partition::AddChildObject() to only generate a UUID if the InstanceID is unset.