STYLE: Fix typo in GetFilenameLastExtension docs
[cmake.git] / Modules / FindOpenAL.cmake
blobd9cb7c1806da595b9b5be5b036f4aa40b1ee3074
1 # Locate OpenAL
2 # This module defines
3 # OPENAL_LIBRARY
4 # OPENAL_FOUND, if false, do not try to link to OpenAL 
5 # OPENAL_INCLUDE_DIR, where to find the headers
7 # $OPENALDIR is an environment variable that would
8 # correspond to the ./configure --prefix=$OPENALDIR
9 # used in building OpenAL.
11 # Created by Eric Wing. This was influenced by the FindSDL.cmake module.
13 # This makes the presumption that you are include al.h like
14 # #include "al.h"
15 # and not 
16 # #include <AL/al.h>
17 # The reason for this is that the latter is not entirely portable.
18 # Windows/Creative Labs does not by default put their headers in AL/ and 
19 # OS X uses the convention <OpenAL/al.h>.
20
21 # For Windows, Creative Labs seems to have added a registry key for their 
22 # OpenAL 1.1 installer. I have added that key to the list of search paths,
23 # however, the key looks like it could be a little fragile depending on 
24 # if they decide to change the 1.00.0000 number for bug fix releases.
25 # Also, they seem to have laid down groundwork for multiple library platforms
26 # which puts the library in an extra subdirectory. Currently there is only
27 # Win32 and I have hardcoded that here. This may need to be adjusted as 
28 # platforms are introduced.
29 # The OpenAL 1.0 installer doesn't seem to have a useful key I can use.
30 # I do not know if the Nvidia OpenAL SDK has a registry key.
31
32 # For OS X, remember that OpenAL was added by Apple in 10.4 (Tiger). 
33 # To support the framework, I originally wrote special framework detection 
34 # code in this module which I have now removed with CMake's introduction
35 # of native support for frameworks.
36 # In addition, OpenAL is open source, and it is possible to compile on Panther. 
37 # Furthermore, due to bugs in the initial OpenAL release, and the 
38 # transition to OpenAL 1.1, it is common to need to override the built-in
39 # framework. 
40 # Per my request, CMake should search for frameworks first in
41 # the following order:
42 # ~/Library/Frameworks/OpenAL.framework/Headers
43 # /Library/Frameworks/OpenAL.framework/Headers
44 # /System/Library/Frameworks/OpenAL.framework/Headers
46 # On OS X, this will prefer the Framework version (if found) over others.
47 # People will have to manually change the cache values of 
48 # OPENAL_LIBRARY to override this selection or set the CMake environment
49 # CMAKE_INCLUDE_PATH to modify the search paths.
51 FIND_PATH(OPENAL_INCLUDE_DIR al.h
52   HINTS
53   $ENV{OPENALDIR}
54   PATH_SUFFIXES include/AL include/OpenAL include
55   PATHS
56   ~/Library/Frameworks
57   /Library/Frameworks
58   /usr/local
59   /usr
60   /sw # Fink
61   /opt/local # DarwinPorts
62   /opt/csw # Blastwave
63   /opt
64   [HKEY_LOCAL_MACHINE\\SOFTWARE\\Creative\ Labs\\OpenAL\ 1.1\ Software\ Development\ Kit\\1.00.0000;InstallDir]
67 FIND_LIBRARY(OPENAL_LIBRARY 
68   NAMES OpenAL al openal OpenAL32
69   HINTS
70   $ENV{OPENALDIR}
71   PATH_SUFFIXES lib64 lib libs64 libs libs/Win32 libs/Win64
72   PATHS
73   ~/Library/Frameworks
74   /Library/Frameworks
75   /usr/local
76   /usr
77   /sw
78   /opt/local
79   /opt/csw
80   /opt
81   [HKEY_LOCAL_MACHINE\\SOFTWARE\\Creative\ Labs\\OpenAL\ 1.1\ Software\ Development\ Kit\\1.00.0000;InstallDir]
85 SET(OPENAL_FOUND "NO")
86 IF(OPENAL_LIBRARY AND OPENAL_INCLUDE_DIR)
87   SET(OPENAL_FOUND "YES")
88 ENDIF(OPENAL_LIBRARY AND OPENAL_INCLUDE_DIR)