Report the EAX last error as settable
[dsound-openal.git] / readme.txt
blob17cf80097a1a97509c3bb6b0f0735b027d57970c
1 About
2 =====
4 This project is for a DirectSound DLL replacement. It implements the
5 DirectSound interfaces by translating the calls to OpenAL, and fools
6 applications into thinking there is a hardware accelerated sound device. EAX is
7 also implemented (up to version 4) by using OpenAL's EFX extension, allowing
8 for environmental reverb with sound obstruction and occlusion effects.
10 Ultimately, this enables DirectSound applications to enable their DirectSound3D
11 acceleration path, and turn on EAX. The actual processing is being done by
12 OpenAL with no hardware acceleration requirement, allowing it to work on
13 systems where audio acceleration is not otherwise available.
15 Or more succinctly: it enables DirectSound3D surround sound and EAX for systems
16 without the requisite hardware.
19 Source Code
20 ===========
22 To build the source, you will need CMake 2.6 or newer (you can get it from
23 <http://www.cmake.org/>). You can either use the CMake GUI, specifying the
24 directories for the source and where the build files should go, or using one of
25 the command-line programs, for example by first making sure to be in an empty
26 directory where the build files will go (such as the provided build/ sub-
27 directory) and running cmake with the path to the source.
29 Once successfully built, it should have created dsound.dll.
32 Usage
33 =====
35 Once built, copy dsound.dll to the same location as the desired application's
36 executable. You must also provide an OpenAL DLL in the same location, named as
37 dsoal-aldrv.dll, or else the DLL will fail to work. Some applications may need
38 to be configured to use DirectSound3D acceleration and EAX, but it otherwise
39 goes to work the next time the application is run.
42 Source releases, the Git repository, and Windows binaries for OpenAL Soft are
43 available at its homepage <http://kcat.strangesoft.met/openal.html>.
44 Instructions are also provided there.