Modules/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 # This makes the presumption that you are include al.h like
  27 # #include "al.h"
  28 # and not
  29 # #include <AL/al.h>
  30 # The reason for this is that the latter is not entirely portable.
  31 # Windows/Creative Labs does not by default put their headers in AL/ and
  32 # OS X uses the convention <OpenAL/al.h>.
  33 #
  34 # For Windows, Creative Labs seems to have added a registry key for their
  35 # OpenAL 1.1 installer. I have added that key to the list of search paths,
  36 # however, the key looks like it could be a little fragile depending on
  37 # if they decide to change the 1.00.0000 number for bug fix releases.
  38 # Also, they seem to have laid down groundwork for multiple library platforms
  39 # which puts the library in an extra subdirectory. Currently there is only
  40 # Win32 and I have hardcoded that here. This may need to be adjusted as
  41 # platforms are introduced.
  42 # The OpenAL 1.0 installer doesn't seem to have a useful key I can use.
  43 # I do not know if the Nvidia OpenAL SDK has a registry key.
  44 #
  45 # For OS X, remember that OpenAL was added by Apple in 10.4 (Tiger).
  46 # To support the framework, I originally wrote special framework detection
  47 # code in this module which I have now removed with CMake's introduction
  48 # of native support for frameworks.
  49 # In addition, OpenAL is open source, and it is possible to compile on Panther.
  50 # Furthermore, due to bugs in the initial OpenAL release, and the
  51 # transition to OpenAL 1.1, it is common to need to override the built-in
  52 # framework.
  53 # Per my request, CMake should search for frameworks first in
  54 # the following order:
  55 # ~/Library/Frameworks/OpenAL.framework/Headers
  56 # /Library/Frameworks/OpenAL.framework/Headers
  57 # /System/Library/Frameworks/OpenAL.framework/Headers
  58 #
  59 # On OS X, this will prefer the Framework version (if found) over others.
  60 # People will have to manually change the cache values of
  61 # OPENAL_LIBRARY to override this selection or set the CMake environment
  62 # CMAKE_INCLUDE_PATH to modify the search paths.
  63
  64 find_path(OPENAL_INCLUDE_DIR al.h
  65   HINTS
  66     ENV OPENALDIR
  67   PATH_SUFFIXES include/AL include/OpenAL include
  68   PATHS
  69   ~/Library/Frameworks
  70   /Library/Frameworks
  71   /sw # Fink
  72   /opt/local # DarwinPorts
  73   /opt/csw # Blastwave
  74   /opt
  75   [HKEY_LOCAL_MACHINE\\SOFTWARE\\Creative\ Labs\\OpenAL\ 1.1\ Software\ Development\ Kit\\1.00.0000;InstallDir]
  76 )
  77
  78 find_library(OPENAL_LIBRARY
  79   NAMES OpenAL al openal OpenAL32
  80   HINTS
  81     ENV OPENALDIR
  82   PATH_SUFFIXES lib64 lib libs64 libs libs/Win32 libs/Win64
  83   PATHS
  84   ~/Library/Frameworks
  85   /Library/Frameworks
  86   /sw
  87   /opt/local
  88   /opt/csw
  89   /opt
  90   [HKEY_LOCAL_MACHINE\\SOFTWARE\\Creative\ Labs\\OpenAL\ 1.1\ Software\ Development\ Kit\\1.00.0000;InstallDir]
  91 )
  92
  93
  94 # handle the QUIETLY and REQUIRED arguments and set OPENAL_FOUND to TRUE if
  95 # all listed variables are TRUE
  96 include(${CMAKE_CURRENT_LIST_DIR}/FindPackageHandleStandardArgs.cmake)
  97 FIND_PACKAGE_HANDLE_STANDARD_ARGS(OpenAL  DEFAULT_MSG  OPENAL_LIBRARY OPENAL_INCLUDE_DIR)
  98
  99 mark_as_advanced(OPENAL_LIBRARY OPENAL_INCLUDE_DIR)