===============================================================================
= Licensing
===============================================================================
Please see the corresponding license.txt file in the same
directory as this readme.txt file in the ffmpeg.jar module.

===============================================================================
= How to update the FFmpeg libraries contained in this jar.
===============================================================================
In compliance with section 6a of the LGPL license, a
copy of which is contained in the same directory as
this readme.txt file, we would like to inform you that
the ffmpeg.jar file itself serves as the object code for
the ffmpeg module, which uses the FFmpeg library that is
covered under the LGPL license. Section 6a preserves the
end user's right to replace the version of the FFmpeg
library inside the work that uses the library (the
Niagara AX ffmpeg module).
 
Here are some instructions on how to replace the FFmpeg /
AVCodec library files contained in this jar file with
your own (should you wish to do so):

1.) Build your dll files.
    - Use the following tutorial. It is the same one that we
      followed to create the FFmpeg library files contained
      in this jar:
      
      http://ffmpeg.arrozcru.org/wiki/index.php?title=Main_Page
      
2.) Use your favorite zip utility such as WinZip or 7-Zip.
    - Open this ffmpeg.jar file (it is also a zip file)
    - Replace the library files located in the 'nativeLib'
      folder with your own.
    - Extract the module.xml file in this jar file
      using your zip utility. Change the version to your
      own version number. For example, you can change it
      from 3.x.yyy to 1.0.0. Change the vendor from Tridium
      to your organization. Update the module.xml file in
      this jar using your zip utility.

===============================================================================
= What Source Did We Use To Compile The FFmpeg Libraries???
===============================================================================
The source code for FFmpeg is open and available to anybody! 
We used the free Turquoise SVN client to check out the
FFmpeg source code directly from the main FFmpeg repository.
We did not modify the source code at all. We did our check
out on or about August 20, 2009. 

A copy of the source code that we used to build the FFmpeg /
AVCodec libraries is included in this module (ffmpeg.jar)
in the "ffmpeg-library-src.zip" file in the "docs" directory.
You may use your favorite zip utility (such as WinZip or
7-Zip) to open the "ffmpeg.jar" and extract 
"ffmpeg-library-src.zip" from "ffmpeg.jar".

Please note that in some cases, Tridium's embedded servers
may strip out the "ffmpeg-library-src.zip" when an installation
technician installs the "ffmpeg.jar" module into the server.
This could happen to save flash storage space inside the
embedded server (aka. Tridium Jace). If your copy of
"ffmpeg.jar" does not include "ffmpeg-library-src.zip" then
please use the "ffmpeg.jar" directly from your Niagra AX
installation.

If you follow the instructions in the above-mentioned 
tutorial then it will show you how to acquire the
latest source code for the FFmpeg library as well as 
compile the source into dll files for use on a Windows OS.

We used the same options in the 'configure' script as those
provided in the above-mentioned tutorial for generating
FFmpeg / AVCodec using shared / dll libraries.

Here are the 'configure' script options from the tutorial.
These are the same as what we used to build the FFmpeg /
AVCodec dll files:

 ../svn/configure --enable-shared --disable-static --enable-memalign-hack
 
Once again, here is the URL of the tutorial:
 http://ffmpeg.arrozcru.org/wiki/index.php?title=Main_Page
 
 
===============================================================================
= Miscellaneous
===============================================================================

As a courtesy, we have included our .cpp and .h files as a
resource inside this jar file. This will allow the savvy
Java developer to see exactly how we implement the native
portions of the FfmpegAvCodecUtil and FfmpegSwsScaleUtil
classes that are provided in package org.baja.ffmpeg. This
shows exactly how we invoke the various functions that
this module provides access to in the FFmpeg / AVCodec
libraries.

For Niagara AX developers, we also include the full Java
source for this module inside the Niagara AX docSource.jar 
module for Niagara AX.
