documentation re-org, take 2
authorjhurst <jhurst@cinecert.com>
Fri, 22 Feb 2019 19:04:33 +0000 (11:04 -0800)
committerjhurst <jhurst@cinecert.com>
Fri, 22 Feb 2019 19:04:33 +0000 (11:04 -0800)
CHANGES

diff --git a/CHANGES b/CHANGES
index ab7cb60011266f2646b9172fbde1c730884c5fa5..34957a78e336a362899909354d4ee850559332d4 100755 (executable)
--- a/CHANGES
+++ b/CHANGES
@@ -1,157 +1,7 @@
 
-$Id$
-
-The asdcplib library is a set of objects that offer
-simplified access to files conforming to the sound and
-picture track file formats developed by the SMPTE Working
-Group DC28.20 (now TC 21DC).
-
-Recently, support has also been added for SMPTE draft ST
-2067-5 "IMF Essence Component", AKA "AS-02".  This code was
-donated by Fraunhofer IIS.  It carries additional copyright
-information which should be listed whenever you link the
-AS-02 elements of the library.  Please look at the top of
-the AS-02 files to see this copyright information.
-
-AS-02 support is carried in separate object modules, so
-unless you #include <AS_02.h> and link libas-02.so you are
-still using plain old asdcp.
-
-This work was originally funded by Digital Cinema Initiatives,
-LLC (DCI). Subsequent efforts have been funded by Deluxe
-Laboratories, Doremi Labs, CineCert LLC, Avica Technology
-and others.
-
-**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,
-mxflib is considerably larger and more complex that what I
-require for this application. For this reason I have created
-a dedicated MXF implementation that is now part of this
-library. Special thanks to Matt Beard and Oliver Morgan for
-their great work and support.
-
-Thanks also to the members of the SMPTE DC28.20 packaging
-ad-hoc group and the members of the MXF Interop Initiative
-for their encouragement and support. Special thanks to
-Jim Whittlesey and Howard Lukk at DCI for proposing and
-supporting this project.
-
-
-Design Notes
-
-This library is intended (but of course not limited) for
-use by developers of commercial D-Cinema products (and now
-IMF!).  It is designed to be easily integrated into a wide
-variety of development environments.  Commercial users are
-strongly 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 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.
-
-AS_DCP.h contains the entire AS-DCP API.  You do not need to
-read any of the other files, except maybe asdcp-test.cpp which
-contains detailed usage examples of each of the API's services.
-The KM_* files may be of interest for general development
-support, but may be ignored if all you want is simple AS-DCP
-support.
-
-Likewise, draft 2067-5 "IMF Essence Component" (AS-02) support
-is entirely contained in AS-02.h
-
-
-Build Instructions
-
-On more-or-less POSIX systems (OS X, Linux, and BSD), GNU make and 
-autotools are 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, any recent version should be fine. See
-http://www.openssl.org/ for more information and download instructions.
-
-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.
-
-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.  AS-02 support can be enabled with 
- --enable-as-02.  
-
-I have tested this build on win32, Linux, OpenBSD, and Darwin
-platforms. Others may work as well.
-
-
-
-
-Utilities
-
-asdcp-test -  Writes, reads and verifies AS-DCP (MXF) track files.
-
-asdcp-wrap - Writes AS-DCP (MXF) track files.
-
-asdcp-unwrap - Extracts essence from AS-DCP (MXF) track files.
-
-asdcp-info - Displays information about AS-DCP (MXF) track files.
-
-asdcp-util - Calculates digests and generates random numbers and UUIDs.
-
-as-02-wrap - Writes AS-02 Essence Component files.
-
-as-02-unwrap - Extracts essence from AS-02 Essence Component 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.
-
-wavesplit - Splits a WAVE file into two or more output files. Used
-  to untangle incorrectly-paired DCDM sound files.
-
-blackwave - Write a WAVE file of zeros.
-
-pinkwave - Write a WAVE file of SMPTE ST 2095 pink noise.
-
-j2c-test - Displays information about JP2K codestreams.
-
-Experimental feature: Prototype for High Dynamic Range is a wrapper
-for the IMF application that allows JPEG-2000 codestreams to be paired
-with opaque blobs of metadata.  AS-02 support must be enabled to
-build this feature, so --enable-as-02 must be enabled if
---enable-phdr is to be used.  The following executable programs will be
-built:
-
-phdr-wrap - Writes AS-02 PHDR Essence Component files.
-
-phdr-unwrap - Extracts essence from AS-02 PHDR Essence Component files.
-
-
-Documentation
-
-The API documentation is mostly in AS_DCP.h. and AS_02.h  Read those
-files for a detailed description of the library's capabilities. Read
-asdcp-*.cpp and as-02-*.cpp files for library usage examples. The
-command-line utilities all respond to -h.
-
-
 Change History
 
-2019-02-12 - 2.10.32 -- bug fixes
+2019-02-22 - 2.10.32 -- bug fixes
  o Fixed parsing of as-02-wrap -tfr (ACES) option value
  o Fixed ISXD bugs:
     o Incorrect UTF_8_Text_DataEssenceCoding UL
@@ -161,6 +11,7 @@ Change History
  o Added wide-char support for filenames on Win32, allows UTF-8 characters in
    calls to Kumu::File*::Open*(). The macro KM_WIN32_UTF8 must be defined to
    enable this feature.
+ o CMake fixed to extract version form configure.ac
 
 
 2018-10-15 - 2.10.31