Read me for ARToolKit_2.68.
===========================


Contents.
---------
About this archive.
Building on Windows.
Building on Linux / SGI Irix.
Building on Mac OS X.
Changes in version 2.68.2.
Changes in version 2.68.1.
Changes in version 2.68.


About this archive.
-------------------
This archive contains the ARToolKit libraries, utilities and examples, version 2.68.
It will build on Windows, Linux, SGI Irix, and Macintosh OS X platforms.

This package is available as either a .zip compressed archive or a .tar.gz format archive.
The contents of these archives is substantially identical, with the major exception that the .tar.gz format archive does not include any Windows Visual Studio project files or binaries.
In all other respects however the files contained in each archive are identical.

As at 204-07-22, this package does not include support for the ARToolKit VRML renderer. Support will be forthcoming as a separate package at a later date.

This archive was assembled by:
	Philip Lamb
	HIT Lab NZ
	http://www.hitlabnz.org
	2004-07-22


Building on Windows.
--------------------
In order to  compile applications with the  ARToolKit Library you will have to have the following installed:
	Microsoft's Visual Studio C++ 6.0 or Visual Studio .NET 2003.
	The GLUT library (which can be downloaded from http://www.opengl.org/developers/documentation/glut/).
	DirectX 9.0b runtime (which can be downloaded from http://www.microsoft.com/windows/directx/).

Unpack the ARToolKit_2.68.2.zip file into a convenient location, and run the file configure.win32.bat. Then open the ARToolKit.sln file (Visual Studio .NET 2003) or ARToolkit.dsw file (Visual Studio 6.0) and build the solution.

The windows builds use DSVideoLib. Prebuilt binaries for DSVideoLib are supplied: Prior to running anything you will need to copy DSVideoLib.dll and DSVideoLibd.dll from ARToolKit/DSVideoLib/bin.vc{6|7}0 into ARToolKit/bin. You will also need to run the script register_filter.bat in the same directory. 
If you wish to rebuild DSVidoLib, you will need Microsoft's DirectShow SDK (which can be downloaded from http://www.microsoft.com/windows/directx/). You may also need to build the DirectShow base classes (strmbase.lib, strmbasd.lib) using the project file  C:\DXSDK\Samples\C++\DirectShow\BaseClasses\baseclasses.vcproj.


Building on Linux / SGI Irix.
-----------------------------
Assuming the ARToolKit_2.68.2.tar.gz file is in your home directory, open a terminal window and type the following commands:
	cd ~
	tar zxvf ARToolKit_2.68.2.tar.gz
	cd ARToolKit_2.68
	./Configure
	make
Following a successful build, to run a binary such as simpleTest, add these commands:
	cd bin
	./simpleTest


Building on Mac OS X.
---------------------------
You will need to have Apple's Developer Tools installed in order to build ARToolKit. These can be downloaded freely from http://developer.apple.com. The library can either be built using (1) the XCode IDE or (2) from the command line:

1) Unpack the archive to a convenient location using StuffIt Expander, and open the ARToolKit.xproj file in XCode. (A prebuilt config.h file is in the archive and will use accelerated and rectangular texturing by default. If you wish to change these defaults, run the ./Configure script as in option (2) below.)
XCode will build the binaries in ARToolKit/bin. This must also be the working directory when the binaries are run, but by default XCode runs executables with the working directory set to Build/. In order for the binaries to be able to be run from within XCode you will need to edit the "Working directory path" of the XCode executable to point the installed ARToolKit/bin directory on your system.

2) Drop the ARToolKit_2.68.2.tar.gz file onto the Desktop and then open a Terminal window and type the following commands:
	cd ~/Desktop
	gunzip ARToolKit_2.68.2.tar.gz
	cd ARToolKit_2.68
	./Configure
	make
Following a successful build, to run a binary such as simpleTest, add these commands:
	cd bin
	./simpleTest
	
Mac OS X 10.3 and later include an inbuilt IIDC FireWire camera driver. Firewire camera drivers for pre-10.3 systems and USB camera drivers and can be obtained from ioXperts at http://www.ioxperts.com.
 

Changes in version 2.68.2.
--------------------------
- VideoWin32DirectShow uses DSVideoLib 0.0.4 (was 0.0.3). The samples now correct the vertical orientation of video from DSVideoLib by specifying the "flipV" parameter by default. An alternative is to use the WDM capture settings dialog 'Mirror horizontally' parameter and rotate the camera 180 degrees.
- Rewrite of Windows AR/video.h interface to follow same scheme for multiple cameras as used on other platforms (i.e. using the ar2Video*() set of functions).
- All platforms now support the arVideoDispOptions() call, which prints acceptable options for arVideoOpen()'s configuration string to the standard output. New applications using ARToolKit should provide a way for a user to specify a preferred configuration string at runtime (rather than compile time), and to see the output of arVideoDispOptions() so that he or she can learn possible configuration strings.
- Optimisations in arLabelling.c and arGetCode.c by Thomas Pintaric.
- gsub libraries compile correctly on platforms with older OpenGL headers. Removed extraneous glPixelStorei(GL_UNPACK_IMAGE_HEIGHT,...) calls.
- New function arglDispImageStateful() in gsub_lite for special effects.
- Removed the obsolete graphicsTest example.


Changes in version 2.68.1.
--------------------------
- Mac video settings dialog can now be disabled by adding "-nodialog" to options string passed to arVideoOpen().
- Fixed some build bugs.


Changes in version 2.68.
--------------------------
Version 2.65 of ARToolKit incorporated the enhanced Windows video capture library created by Thomas Pintaric (http://www.ims.tuwien.ac.at/~thomas/artoolkit.php). Version 2.68 is based on 2.65f with the following changes:
- New gsub_lite library designed to allow easier use of ARToolKit in existing applications, plus complete documentation in HTML format in doc/gsub_lite.
- New high-performance Macintosh video capture library by Philip Lamb.
- Support throughout the toolkit for three extra pixel formats including two packed-pixel YCbCr types (Mac pixel format codes 'ARGB', '2vuy', 'yuvs'). 
- Several minor changes for compiler correctness, such as return values from main() and const declarations in some function parameter lists.
- Fix for bug in arGetTransMat2.c identified by Joerg Stoecklein (http://www.hitl.washington.edu/artoolkit/mail-archive/message-thread-00627--variable--s1--not-initi.html).
- Fix for bug in VideoLinuxDV/video.c identified by Tobias Laubach (http://www.hitl.washington.edu/artoolkit/mail-archive/message-thread-00626-Segmentation-error---fix.html).

--
EOF