cmake/FindOpenAL.cmake

   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
   6 #
   7 # $OPENALDIR is an environment variable that would
   8 # correspond to the ./configure --prefix=$OPENALDIR
   9 # used in building OpenAL.
  10 #
  11 # Created by Eric Wing. This was influenced by the FindSDL.cmake module.
  12
  13 #=============================================================================
  14 # Copyright 2005-2009 Kitware, Inc.
  15 #
  16 # Distributed under the OSI-approved BSD License (the "License");
  17 # see accompanying file Copyright.txt for details.
  18 #
  19 # This software is distributed WITHOUT ANY WARRANTY; without even the
  20 # implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  21 # See the License for more information.
  22 #=============================================================================
  23 # (To distribute this file outside of CMake, substitute the full
  24 #  License text for the above reference.)
  25
  26 # For Windows, OpenAL would be included like
  27 # #include <al.h>
  28 # For Apple, you would include it like
  29 # #include <OpenAL/al.h>
  30 # Other systems include it like
  31 # #include <AL/al.h>
  32 # The reason for this is that Creative Labs does not by default put their
  33 # headers in AL/ for Windows, and other systems follow the OpenGL convention
  34 # (OpenAL/ for OSX, and AL/ for Linux and other Unixes).
  35 #
  36 # For Windows, Creative Labs seems to have added a registry key for their
  37 # OpenAL 1.1 installer. I have added that key to the list of search paths,
  38 # however, the key looks like it could be a little fragile depending on
  39 # if they decide to change the 1.00.0000 number for bug fix releases.
  40 # Also, they seem to have laid down groundwork for multiple library platforms
  41 # which puts the library in an extra subdirectory. Currently there is only
  42 # Win32 and I have hardcoded that here. This may need to be adjusted as
  43 # platforms are introduced.
  44 # The OpenAL 1.0 installer doesn't seem to have a useful key I can use.
  45 # I do not know if the Nvidia OpenAL SDK has a registry key.
  46 #
  47 # For OSX, remember that OpenAL was added by Apple in 10.4 (Tiger).
  48 # To support the framework, I originally wrote special framework detection
  49 # code in this module which I have now removed with CMake's introduction
  50 # of native support for frameworks.
  51 # In addition, OpenAL is open source, and it is possible to compile on Panther.
  52 # Furthermore, due to bugs in the initial OpenAL release, and the
  53 # transition to OpenAL 1.1, it is common to need to override the built-in
  54 # framework.
  55 # Per my request, CMake should search for frameworks first in
  56 # the following order:
  57 # ~/Library/Frameworks/OpenAL.framework/Headers
  58 # /Library/Frameworks/OpenAL.framework/Headers
  59 # /System/Library/Frameworks/OpenAL.framework/Headers
  60 #
  61 # On OSX, this will prefer the Framework version (if found) over others.
  62 # People will have to manually change the cache values of
  63 # OPENAL_LIBRARY to override this selection or set the CMake environment
  64 # CMAKE_INCLUDE_PATH to modify the search paths.
  65
  66 IF(WIN32)
  67     SET(AL_HEADER_PREFIX "")
  68 ELSEIF(APPLE)
  69     SET(AL_HEADER_PREFIX "OpenAL/")
  70 ELSE(WIN32)
  71     SET(AL_HEADER_PREFIX "AL/")
  72 ENDIF(WIN32)
  73
  74 FIND_PATH(OPENAL_INCLUDE_DIR "${AL_HEADER_PREFIX}al.h"
  75   HINTS
  76   $ENV{OPENALDIR}
  77   PATH_SUFFIXES include include/AL
  78   PATHS
  79   ~/Library/Frameworks
  80   /Library/Frameworks
  81   /usr/local
  82   /usr
  83   /sw # Fink
  84   /opt/local # DarwinPorts
  85   /opt/csw # Blastwave
  86   /opt
  87   [HKEY_LOCAL_MACHINE\\SOFTWARE\\Creative\ Labs\\OpenAL\ 1.1\ Software\ Development\ Kit\\1.00.0000;InstallDir]
  88 )
  89
  90 FIND_LIBRARY(OPENAL_LIBRARY
  91   NAMES OpenAL al openal OpenAL32
  92   HINTS
  93   $ENV{OPENALDIR}
  94   PATH_SUFFIXES lib64 lib libs64 libs libs/Win32 libs/Win64
  95   PATHS
  96   ~/Library/Frameworks
  97   /Library/Frameworks
  98   /usr/local
  99   /usr
 100   /sw
 101   /opt/local
 102   /opt/csw
 103   /opt
 104   [HKEY_LOCAL_MACHINE\\SOFTWARE\\Creative\ Labs\\OpenAL\ 1.1\ Software\ Development\ Kit\\1.00.0000;InstallDir]
 105 )
 106
 107
 108 # handle the QUIETLY and REQUIRED arguments and set OPENAL_FOUND to TRUE if
 109 # all listed variables are TRUE
 110 INCLUDE(FindPackageHandleStandardArgs)
 111 FIND_PACKAGE_HANDLE_STANDARD_ARGS(OpenAL  DEFAULT_MSG  OPENAL_LIBRARY OPENAL_INCLUDE_DIR)
 112
 113 MARK_AS_ADVANCED(OPENAL_LIBRARY OPENAL_INCLUDE_DIR)