Modules/FindSDL_sound.cmake

   1 # Locates the SDL_sound library
   2
   3 # This module depends on SDL being found and
   4 # must be called AFTER FindSDL.cmake is called.
   5
   6 # This module defines
   7 # SDL_SOUND_INCLUDE_DIR, where to find SDL_sound.h
   8 # SDL_SOUND_FOUND, if false, do not try to link to SDL
   9 # SDL_SOUND_LIBRARIES, this contains the list of libraries that you need
  10 # to link against. This is a read-only variable and is marked INTERNAL.
  11 # SDL_SOUND_EXTRAS, this is an optional variable for you to add your own
  12 # flags to SDL_SOUND_LIBRARIES. This is prepended to SDL_SOUND_LIBRARIES.
  13 # This is available mostly for cases this module failed to anticipate for
  14 # and you must add additional flags. This is marked as ADVANCED.
  15
  16 #
  17 # This module also defines (but you shouldn't need to use directly)
  18 # SDL_SOUND_LIBRARY, the name of just the SDL_sound library you would link
  19 # against. Use SDL_SOUND_LIBRARIES for you link instructions and not this one.
  20 # And might define the following as needed
  21 # MIKMOD_LIBRARY
  22 # MODPLUG_LIBRARY
  23 # OGG_LIBRARY
  24 # VORBIS_LIBRARY
  25 # SMPEG_LIBRARY
  26 # FLAC_LIBRARY
  27 # SPEEX_LIBRARY
  28 #
  29 # Typically, you should not use these variables directly, and you should use
  30 # SDL_SOUND_LIBRARIES which contains SDL_SOUND_LIBRARY and the other audio libraries
  31 # (if needed) to successfully compile on your system .
  32 #
  33 # Created by Eric Wing.
  34 # This module is a bit more complicated than the other FindSDL* family modules.
  35 # The reason is that SDL_sound can be compiled in a large variety of different ways
  36 # which are independent of platform. SDL_sound may dynamically link against other 3rd
  37 # party libraries to get additional codec support, such as Ogg Vorbis, SMPEG, ModPlug,
  38 # MikMod, FLAC, Speex, and potentially others.
  39 # Under some circumstances which I don't fully understand,
  40 # there seems to be a requirement
  41 # that dependent libraries of libraries you use must also be explicitly
  42 # linked against in order to successfully compile. SDL_sound does not currently
  43 # have any system in place to know how it was compiled.
  44 # So this CMake module does the hard work in trying to discover which 3rd party
  45 # libraries are required for building (if any).
  46 # This module uses a brute force approach to create a test program that uses SDL_sound,
  47 # and then tries to build it. If the build fails, it parses the error output for
  48 # known symbol names to figure out which libraries are needed.
  49 #
  50 # Responds to the $SDLDIR and $SDLSOUNDDIR environmental variable that would
  51 # correspond to the ./configure --prefix=$SDLDIR used in building SDL.
  52 #
  53 # On OSX, this will prefer the Framework version (if found) over others.
  54 # People will have to manually change the cache values of
  55 # SDL_LIBRARY to override this selectionor set the CMake environment
  56 # CMAKE_INCLUDE_PATH to modify the search paths.
  57 #
  58
  59
  60 SET(SDL_SOUND_EXTRAS "" CACHE STRING "SDL_sound extra flags")
  61 MARK_AS_ADVANCED(SDL_SOUND_EXTRAS)
  62
  63 # Find SDL_sound.h
  64 FIND_PATH(SDL_SOUND_INCLUDE_DIR SDL_sound.h
  65   HINTS
  66   $ENV{SDLSOUNDDIR}/include
  67   $ENV{SDLSOUNDDIR}
  68   $ENV{SDLDIR}/include
  69   $ENV{SDLDIR}
  70   PATHS
  71   /usr/local/include/SDL
  72   /usr/include/SDL
  73   /usr/local/include/SDL12
  74   /usr/local/include/SDL11 # FreeBSD ports
  75   /usr/include/SDL12
  76   /usr/include/SDL11
  77   /usr/local/include
  78   /usr/include
  79   /sw/include/SDL # Fink
  80   /sw/include
  81   /opt/local/include/SDL # DarwinPorts
  82   /opt/local/include
  83   /opt/csw/include/SDL # Blastwave
  84   /opt/csw/include
  85   /opt/include/SDL
  86   /opt/include
  87   )
  88
  89 FIND_LIBRARY(SDL_SOUND_LIBRARY
  90   NAMES SDL_sound
  91   HINTS
  92   $ENV{SDLSOUNDDIR}/lib
  93   $ENV{SDLSOUNDDIR}
  94   $ENV{SDLDIR}/lib
  95   $ENV{SDLDIR}
  96   PATHS
  97   /usr/local/lib
  98   /usr/lib
  99   /sw/lib
 100   /opt/local/lib
 101   /opt/csw/lib
 102   /opt/lib
 103   )
 104
 105 SET(SDL_SOUND_FOUND "NO")
 106 IF(SDL_FOUND AND SDL_SOUND_INCLUDE_DIR AND SDL_SOUND_LIBRARY)
 107
 108   # CMake is giving me problems using TRY_COMPILE with the CMAKE_FLAGS
 109   # for the :STRING syntax if I have multiple values contained in a
 110   # single variable. This is a problem for the SDL_LIBRARY variable
 111   # because it does just that. When I feed this variable to the command,
 112   # only the first value gets the appropriate modifier (e.g. -I) and
 113   # the rest get dropped.
 114   # To get multiple single variables to work, I must separate them with a "\;"
 115   # I could go back and modify the FindSDL.cmake module, but that's kind of painful.
 116   # The solution would be to try something like:
 117   # SET(SDL_TRY_COMPILE_LIBRARY_LIST "${SDL_TRY_COMPILE_LIBRARY_LIST}\;${CMAKE_THREAD_LIBS_INIT}")
 118   # Instead, it was suggested on the mailing list to write a temporary CMakeLists.txt
 119   # with a temporary test project and invoke that with TRY_COMPILE.
 120   # See message thread "Figuring out dependencies for a library in order to build"
 121   # 2005-07-16
 122   #     TRY_COMPILE(
 123   #             MY_RESULT
 124   #             ${CMAKE_BINARY_DIR}
 125   #             ${PROJECT_SOURCE_DIR}/DetermineSoundLibs.c
 126   #             CMAKE_FLAGS
 127   #                     -DINCLUDE_DIRECTORIES:STRING=${SDL_INCLUDE_DIR}\;${SDL_SOUND_INCLUDE_DIR}
 128   #                     -DLINK_LIBRARIES:STRING=${SDL_SOUND_LIBRARY}\;${SDL_LIBRARY}
 129   #             OUTPUT_VARIABLE MY_OUTPUT
 130   #     )
 131
 132   # To minimize external dependencies, create a sdlsound test program
 133   # which will be used to figure out if additional link dependencies are
 134   # required for the link phase.
 135   FILE(WRITE ${PROJECT_BINARY_DIR}/CMakeTmp/DetermineSoundLibs.c
 136     "#include \"SDL_sound.h\"
 137     #include \"SDL.h\"
 138     int main(int argc, char* argv[])
 139     {
 140         Sound_AudioInfo desired;
 141         Sound_Sample* sample;
 142
 143         SDL_Init(0);
 144         Sound_Init();
 145
 146         /* This doesn't actually have to work, but Init() is a no-op
 147          * for some of the decoders, so this should force more symbols
 148          * to be pulled in.
 149          */
 150         sample = Sound_NewSampleFromFile(argv[1], &desired, 4096);
 151
 152         Sound_Quit();
 153         SDL_Quit();
 154         return 0;
 155      }"
 156      )
 157
 158    # Calling
 159    # TARGET_LINK_LIBRARIES(DetermineSoundLibs "${SDL_SOUND_LIBRARY} ${SDL_LIBRARY})
 160    # causes problems when SDL_LIBRARY looks like
 161    # /Library/Frameworks/SDL.framework;-framework Cocoa
 162    # The ;-framework Cocoa seems to be confusing CMake once the OS X
 163    # framework support was added. I was told that breaking up the list
 164    # would fix the problem.
 165    SET(TMP_TRY_LIBS)
 166    FOREACH(lib ${SDL_SOUND_LIBRARY} ${SDL_LIBRARY})
 167      SET(TMP_TRY_LIBS "${TMP_TRY_LIBS} \"${lib}\"")
 168    ENDFOREACH(lib)
 169
 170    # MESSAGE("TMP_TRY_LIBS ${TMP_TRY_LIBS}")
 171
 172    # Write the CMakeLists.txt and test project
 173    # Weird, this is still sketchy. If I don't quote the variables
 174    # in the TARGET_LINK_LIBRARIES, I seem to loose everything
 175    # in the SDL_LIBRARY string after the "-framework".
 176    # But if I quote the stuff in INCLUDE_DIRECTORIES, it doesn't work.
 177    FILE(WRITE ${PROJECT_BINARY_DIR}/CMakeTmp/CMakeLists.txt
 178      "PROJECT(DetermineSoundLibs)
 179         INCLUDE_DIRECTORIES(${SDL_INCLUDE_DIR} ${SDL_SOUND_INCLUDE_DIR})
 180         ADD_EXECUTABLE(DetermineSoundLibs DetermineSoundLibs.c)
 181         TARGET_LINK_LIBRARIES(DetermineSoundLibs ${TMP_TRY_LIBS})"
 182      )
 183
 184    TRY_COMPILE(
 185      MY_RESULT
 186      ${PROJECT_BINARY_DIR}/CMakeTmp
 187      ${PROJECT_BINARY_DIR}/CMakeTmp
 188      DetermineSoundLibs
 189      OUTPUT_VARIABLE MY_OUTPUT
 190      )
 191
 192    # MESSAGE("${MY_RESULT}")
 193    # MESSAGE(${MY_OUTPUT})
 194
 195    IF(NOT MY_RESULT)
 196
 197      # I expect that MPGLIB, VOC, WAV, AIFF, and SHN are compiled in statically.
 198      # I think Timidity is also compiled in statically.
 199      # I've never had to explcitly link against Quicktime, so I'll skip that for now.
 200
 201      SET(SDL_SOUND_LIBRARIES_TMP ${SDL_SOUND_LIBRARY})
 202
 203      # Find MikMod
 204      IF("${MY_OUTPUT}" MATCHES "MikMod_")
 205      FIND_LIBRARY(MIKMOD_LIBRARY
 206          NAMES libmikmod-coreaudio mikmod
 207          PATHS
 208          $ENV{MIKMODDIR}/lib
 209          $ENV{MIKMODDIR}
 210          $ENV{SDLSOUNDDIR}/lib
 211          $ENV{SDLSOUNDDIR}
 212          $ENV{SDLDIR}/lib
 213          $ENV{SDLDIR}
 214          /usr/local/lib
 215          /usr/lib
 216          /sw/lib
 217          /opt/local/lib
 218          /opt/csw/lib
 219        /opt/lib
 220        )
 221        IF(MIKMOD_LIBRARY)
 222          SET(SDL_SOUND_LIBRARIES_TMP ${SDL_SOUND_LIBRARIES_TMP} ${MIKMOD_LIBRARY})
 223        ENDIF(MIKMOD_LIBRARY)
 224      ENDIF("${MY_OUTPUT}" MATCHES "MikMod_")
 225
 226      # Find ModPlug
 227      IF("${MY_OUTPUT}" MATCHES "MODPLUG_")
 228        FIND_LIBRARY(MODPLUG_LIBRARY
 229          NAMES modplug
 230          PATHS
 231          $ENV{MODPLUGDIR}/lib
 232          $ENV{MODPLUGDIR}
 233          $ENV{SDLSOUNDDIR}/lib
 234          $ENV{SDLSOUNDDIR}
 235          $ENV{SDLDIR}/lib
 236          $ENV{SDLDIR}
 237          /usr/local/lib
 238          /usr/lib
 239          /sw/lib
 240          /opt/local/lib
 241          /opt/csw/lib
 242        /opt/lib
 243        )
 244        IF(MODPLUG_LIBRARY)
 245          SET(SDL_SOUND_LIBRARIES_TMP ${SDL_SOUND_LIBRARIES_TMP} ${MODPLUG_LIBRARY})
 246        ENDIF(MODPLUG_LIBRARY)
 247      ENDIF("${MY_OUTPUT}" MATCHES "MODPLUG_")
 248
 249
 250      # Find Ogg and Vorbis
 251      IF("${MY_OUTPUT}" MATCHES "ov_")
 252        FIND_LIBRARY(VORBIS_LIBRARY
 253          NAMES vorbis Vorbis VORBIS
 254          PATHS
 255          $ENV{VORBISDIR}/lib
 256          $ENV{VORBISDIR}
 257          $ENV{OGGDIR}/lib
 258          $ENV{OGGDIR}
 259          $ENV{SDLSOUNDDIR}/lib
 260          $ENV{SDLSOUNDDIR}
 261          $ENV{SDLDIR}/lib
 262          $ENV{SDLDIR}
 263          /usr/local/lib
 264          /usr/lib
 265          /sw/lib
 266          /opt/local/lib
 267          /opt/csw/lib
 268        /opt/lib
 269          )
 270        IF(VORBIS_LIBRARY)
 271          SET(SDL_SOUND_LIBRARIES_TMP ${SDL_SOUND_LIBRARIES_TMP} ${VORBIS_LIBRARY})
 272        ENDIF(VORBIS_LIBRARY)
 273
 274        FIND_LIBRARY(OGG_LIBRARY
 275          NAMES ogg Ogg OGG
 276          PATHS
 277          $ENV{OGGDIR}/lib
 278          $ENV{OGGDIR}
 279          $ENV{VORBISDIR}/lib
 280          $ENV{VORBISDIR}
 281          $ENV{SDLSOUNDDIR}/lib
 282          $ENV{SDLSOUNDDIR}
 283          $ENV{SDLDIR}/lib
 284          $ENV{SDLDIR}
 285          /usr/local/lib
 286          /usr/lib
 287          /sw/lib
 288          /opt/local/lib
 289          /opt/csw/lib
 290        /opt/lib
 291          )
 292        IF(OGG_LIBRARY)
 293          SET(SDL_SOUND_LIBRARIES_TMP ${SDL_SOUND_LIBRARIES_TMP} ${OGG_LIBRARY})
 294        ENDIF(OGG_LIBRARY)
 295      ENDIF("${MY_OUTPUT}" MATCHES "ov_")
 296
 297
 298      # Find SMPEG
 299      IF("${MY_OUTPUT}" MATCHES "SMPEG_")
 300        FIND_LIBRARY(SMPEG_LIBRARY
 301          NAMES smpeg SMPEG Smpeg SMpeg
 302          PATHS
 303          $ENV{SMPEGDIR}/lib
 304          $ENV{SMPEGDIR}
 305          $ENV{SDLSOUNDDIR}/lib
 306          $ENV{SDLSOUNDDIR}
 307          $ENV{SDLDIR}/lib
 308          $ENV{SDLDIR}
 309          /usr/local/lib
 310          /usr/lib
 311          /sw/lib
 312          /opt/local/lib
 313          /opt/csw/lib
 314        /opt/lib
 315          )
 316        IF(SMPEG_LIBRARY)
 317          SET(SDL_SOUND_LIBRARIES_TMP ${SDL_SOUND_LIBRARIES_TMP} ${SMPEG_LIBRARY})
 318        ENDIF(SMPEG_LIBRARY)
 319      ENDIF("${MY_OUTPUT}" MATCHES "SMPEG_")
 320
 321
 322      # Find FLAC
 323      IF("${MY_OUTPUT}" MATCHES "FLAC_")
 324        FIND_LIBRARY(FLAC_LIBRARY
 325          NAMES flac FLAC
 326          PATHS
 327          $ENV{FLACDIR}/lib
 328          $ENV{FLACDIR}
 329          $ENV{SDLSOUNDDIR}/lib
 330          $ENV{SDLSOUNDDIR}
 331          $ENV{SDLDIR}/lib
 332          $ENV{SDLDIR}
 333          /usr/local/lib
 334          /usr/lib
 335          /sw/lib
 336          /opt/local/lib
 337          /opt/csw/lib
 338        /opt/lib
 339          )
 340        IF(FLAC_LIBRARY)
 341          SET(SDL_SOUND_LIBRARIES_TMP ${SDL_SOUND_LIBRARIES_TMP} ${FLAC_LIBRARY})
 342        ENDIF(FLAC_LIBRARY)
 343      ENDIF("${MY_OUTPUT}" MATCHES "FLAC_")
 344
 345
 346      # Hmmm...Speex seems to depend on Ogg. This might be a problem if
 347      # the TRY_COMPILE attempt gets blocked at SPEEX before it can pull
 348      # in the Ogg symbols. I'm not sure if I should duplicate the ogg stuff
 349      # above for here or if two ogg entries will screw up things.
 350      IF("${MY_OUTPUT}" MATCHES "speex_")
 351        FIND_LIBRARY(SPEEX_LIBRARY
 352          NAMES speex SPEEX
 353          PATHS
 354          $ENV{SPEEXDIR}/lib
 355          $ENV{SPEEXDIR}
 356          $ENV{SDLSOUNDDIR}/lib
 357          $ENV{SDLSOUNDDIR}
 358          $ENV{SDLDIR}/lib
 359          $ENV{SDLDIR}
 360          /usr/local/lib
 361          /usr/lib
 362          /sw/lib
 363          /opt/local/lib
 364          /opt/csw/lib
 365        /opt/lib
 366          )
 367        IF(SPEEX_LIBRARY)
 368          SET(SDL_SOUND_LIBRARIES_TMP ${SDL_SOUND_LIBRARIES_TMP} ${SPEEX_LIBRARY})
 369        ENDIF(SPEEX_LIBRARY)
 370
 371        # Find OGG (needed for Speex)
 372      # We might have already found Ogg for Vorbis, so skip it if so.
 373        IF(NOT OGG_LIBRARY)
 374          FIND_LIBRARY(OGG_LIBRARY
 375            NAMES ogg Ogg OGG
 376            PATHS
 377            $ENV{OGGDIR}/lib
 378            $ENV{OGGDIR}
 379            $ENV{VORBISDIR}/lib
 380            $ENV{VORBISDIR}
 381            $ENV{SPEEXDIR}/lib
 382            $ENV{SPEEXDIR}
 383            $ENV{SDLSOUNDDIR}/lib
 384            $ENV{SDLSOUNDDIR}
 385            $ENV{SDLDIR}/lib
 386            $ENV{SDLDIR}
 387            /usr/local/lib
 388            /usr/lib
 389            /sw/lib
 390            /opt/local/lib
 391            /opt/csw/lib
 392          /opt/lib
 393            )
 394          IF(OGG_LIBRARY)
 395            SET(SDL_SOUND_LIBRARIES_TMP ${SDL_SOUND_LIBRARIES_TMP} ${OGG_LIBRARY})
 396          ENDIF(OGG_LIBRARY)
 397        ENDIF(NOT OGG_LIBRARY)
 398      ENDIF("${MY_OUTPUT}" MATCHES "speex_")
 399
 400    ELSE(NOT MY_RESULT)
 401      SET(SDL_SOUND_LIBRARIES "${SDL_SOUND_EXTRAS} ${SDL_SOUND_LIBRARY}" CACHE INTERNAL "SDL_sound and dependent libraries")
 402    ENDIF(NOT MY_RESULT)
 403
 404    SET(SDL_SOUND_LIBRARIES "${SDL_SOUND_EXTRAS} ${SDL_SOUND_LIBRARIES_TMP}" CACHE INTERNAL "SDL_sound and dependent libraries")
 405    SET(SDL_SOUND_FOUND "YES")
 406  ENDIF(SDL_FOUND AND SDL_SOUND_INCLUDE_DIR AND SDL_SOUND_LIBRARY)
 407
 408  # MESSAGE("SDL_SOUND_LIBRARIES is ${SDL_SOUND_LIBRARIES}")
 409