win32/README.win32

   1 $Id$
   2 $Name$
   3
   4 Win32 port of audiofile, August 2001,  Chris Wolf <cwolf@starclass.com>
   5 ===========================================================================
   6 This is the win32 port of the audiofile library and utilities.
   7 It has only been tested using MSVC v6 on Windows 2000 server, but
   8 should build on other win32 platforms as long as MCVC v6 is used.
   9
  10 BUILDING
  11
  12   Before running either the command-line build, or IDE build, run the
  13   script "prebuild.bat".  This will create the required working directories.
  14
  15   Command line build:
  16   The libraries and executables may be built by invoking "build_all.bat".
  17
  18   Note that the makefiles are generated from the IDE, and are thus a
  19   reflection of the workspace and project file states.  It is strongly
  20   recommended to make changes via the IDE and export the makefiles,
  21   rather than tweaking the makefiles directly.
  22
  23   IDE build:
  24   Load the "all.dsw" workspace.  This workspace loads and manages the
  25   the dependent project files.  To perform a build, from the "build"
  26   menu, select the "build" menu item.
  27
  28
  29 DIRECTORIES
  30
  31   Debug and release versions of both the static and dynamic (DLL) libraries
  32   will be created in the win32/lib directory.
  33
  34   The debug and release versions of the statically and dynamically linked
  35   versions of the executables will be created in the following directories:
  36
  37   Debug/bin/static
  38   Debug/bin/dynamic
  39   Relase/bin/static
  40   Relase/bin/dynamic
  41
  42   N.B. In order to execute the dynamically linked executables, the
  43        corresponding DLL's must be in the PATH.  There are two options:
  44
  45        1.) put the fully qualified path of "win32/lib" in the PATH.
  46
  47        2.) copy "audiofile.dll" and/or "audiofileD.dll" to a directory
  48            which is already in the PATH.
  49
  50
  51 LIBRARY NAMING CONVENTIONS
  52
  53   There is an ambiguity with Microsoft's naming convention; a file with
  54   a "*.lib" extension could either be a static library, or a DLL export
  55   library, therefore the following naming convention is adopted to resolve
  56   the ambiguity:
  57
  58   Static Library:      libBASENAME.lib   e.g. libaudiofile.lib
  59   DLL export Library:  BASENAME.lib      e.g. audiofile.lib
  60
  61   In addition, appending "D" to the basename denotes a debug version of
  62   the library. e.g. libaudiofileD.lib, audiofileD.dll
  63
  64   The module definition file (audiofile.def) does not explicitly name
  65   the library, in order for the linker to set the name based on the
  66   type of build.