aboutsummaryrefslogtreecommitdiffstats
path: root/cmake/FindSDL_sound.cmake
blob: 2dab1a1ca3a557b6d6afc6cb1b2b0140884e4205 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
# - Locates the SDL_sound library
#
# This module depends on SDL being found and
# must be called AFTER FindSDL.cmake or FindSDL2.cmake is called.
#
# This module defines
#  SDL_SOUND_INCLUDE_DIR, where to find SDL_sound.h
#  SDL_SOUND_FOUND, if false, do not try to link to SDL_sound
#  SDL_SOUND_LIBRARIES, this contains the list of libraries that you need
#    to link against. This is a read-only variable and is marked INTERNAL.
#  SDL_SOUND_EXTRAS, this is an optional variable for you to add your own
#    flags to SDL_SOUND_LIBRARIES. This is prepended to SDL_SOUND_LIBRARIES.
#    This is available mostly for cases this module failed to anticipate for
#    and you must add additional flags. This is marked as ADVANCED.
#  SDL_SOUND_VERSION_STRING, human-readable string containing the version of SDL_sound
#
# This module also defines (but you shouldn't need to use directly)
#   SDL_SOUND_LIBRARY, the name of just the SDL_sound library you would link
#   against. Use SDL_SOUND_LIBRARIES for you link instructions and not this one.
# And might define the following as needed
#   MIKMOD_LIBRARY
#   MODPLUG_LIBRARY
#   OGG_LIBRARY
#   VORBIS_LIBRARY
#   SMPEG_LIBRARY
#   FLAC_LIBRARY
#   SPEEX_LIBRARY
#
# Typically, you should not use these variables directly, and you should use
# SDL_SOUND_LIBRARIES which contains SDL_SOUND_LIBRARY and the other audio libraries
# (if needed) to successfully compile on your system.
#
# Created by Eric Wing.
# This module is a bit more complicated than the other FindSDL* family modules.
# The reason is that SDL_sound can be compiled in a large variety of different ways
# which are independent of platform. SDL_sound may dynamically link against other 3rd
# party libraries to get additional codec support, such as Ogg Vorbis, SMPEG, ModPlug,
# MikMod, FLAC, Speex, and potentially others.
# Under some circumstances which I don't fully understand,
# there seems to be a requirement
# that dependent libraries of libraries you use must also be explicitly
# linked against in order to successfully compile. SDL_sound does not currently
# have any system in place to know how it was compiled.
# So this CMake module does the hard work in trying to discover which 3rd party
# libraries are required for building (if any).
# This module uses a brute force approach to create a test program that uses SDL_sound,
# and then tries to build it. If the build fails, it parses the error output for
# known symbol names to figure out which libraries are needed.
#
# Responds to the $SDLDIR and $SDLSOUNDDIR environmental variable that would
# correspond to the ./configure --prefix=$SDLDIR used in building SDL.
#
# On OSX, this will prefer the Framework version (if found) over others.
# People will have to manually change the cache values of
# SDL_LIBRARY or SDL2_LIBRARY to override this selection or set the CMake
# environment CMAKE_INCLUDE_PATH to modify the search paths.

#=============================================================================
# Copyright 2005-2009 Kitware, Inc.
# Copyright 2012 Benjamin Eikel
#
# Distributed under the OSI-approved BSD License (the "License");
# see accompanying file Copyright.txt for details.
#
# This software is distributed WITHOUT ANY WARRANTY; without even the
# implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
# See the License for more information.
#=============================================================================
# (To distribute this file outside of CMake, substitute the full
#  License text for the above reference.)

set(SDL_SOUND_EXTRAS "" CACHE STRING "SDL_sound extra flags")
mark_as_advanced(SDL_SOUND_EXTRAS)

# Find SDL_sound.h
find_path(SDL_SOUND_INCLUDE_DIR SDL_sound.h
    HINTS
        ENV SDLSOUNDDIR
        ENV SDLDIR
    PATH_SUFFIXES SDL SDL12 SDL11
)

find_library(SDL_SOUND_LIBRARY
    NAMES SDL_sound
    HINTS
        ENV SDLSOUNDDIR
        ENV SDLDIR
)

if(SDL2_FOUND OR SDL_FOUND)
    if(SDL_SOUND_INCLUDE_DIR AND SDL_SOUND_LIBRARY)
        # CMake is giving me problems using TRY_COMPILE with the CMAKE_FLAGS
        # for the :STRING syntax if I have multiple values contained in a
        # single variable. This is a problem for the SDL2_LIBRARY variable
        # because it does just that. When I feed this variable to the command,
        # only the first value gets the appropriate modifier (e.g. -I) and
        # the rest get dropped.
        # To get multiple single variables to work, I must separate them with a "\;"
        # I could go back and modify the FindSDL2.cmake module, but that's kind of painful.
        # The solution would be to try something like:
        # set(SDL2_TRY_COMPILE_LIBRARY_LIST "${SDL2_TRY_COMPILE_LIBRARY_LIST}\;${CMAKE_THREAD_LIBS_INIT}")
        # Instead, it was suggested on the mailing list to write a temporary CMakeLists.txt
        # with a temporary test project and invoke that with TRY_COMPILE.
        # See message thread "Figuring out dependencies for a library in order to build"
        # 2005-07-16
        #     try_compile(
        #             MY_RESULT
        #             ${CMAKE_BINARY_DIR}
        #             ${PROJECT_SOURCE_DIR}/DetermineSoundLibs.c
        #             CMAKE_FLAGS
        #                     -DINCLUDE_DIRECTORIES:STRING=${SDL2_INCLUDE_DIR}\;${SDL_SOUND_INCLUDE_DIR}
        #                     -DLINK_LIBRARIES:STRING=${SDL_SOUND_LIBRARY}\;${SDL2_LIBRARY}
        #             OUTPUT_VARIABLE MY_OUTPUT
        #     )

        # To minimize external dependencies, create a sdlsound test program
        # which will be used to figure out if additional link dependencies are
        # required for the link phase.
        file(WRITE ${PROJECT_BINARY_DIR}/CMakeTmp/DetermineSoundLibs.c
            "#include \"SDL_sound.h\"
            #include \"SDL.h\"
            int main(int argc, char* argv[])
            {
                Sound_AudioInfo desired;
                Sound_Sample* sample;

                SDL_Init(0);
                Sound_Init();

                /* This doesn't actually have to work, but Init() is a no-op
                 * for some of the decoders, so this should force more symbols
                 * to be pulled in.
                 */
                sample = Sound_NewSampleFromFile(argv[1], &desired, 4096);

                Sound_Quit();
                SDL_Quit();
                return 0;
            }"
        )

        # Calling
        # target_link_libraries(DetermineSoundLibs "${SDL_SOUND_LIBRARY} ${SDL2_LIBRARY})
        # causes problems when SDL2_LIBRARY looks like
        # /Library/Frameworks/SDL2.framework;-framework Cocoa
        # The ;-framework Cocoa seems to be confusing CMake once the OS X
        # framework support was added. I was told that breaking up the list
        # would fix the problem.
        set(TMP_TRY_LIBS)
        if(SDL2_FOUND)
            foreach(lib ${SDL_SOUND_LIBRARY} ${SDL2_LIBRARY})
                set(TMP_TRY_LIBS "${TMP_TRY_LIBS} \"${lib}\"")
            endforeach()
            set(TMP_INCLUDE_DIRS ${SDL2_INCLUDE_DIR} ${SDL_SOUND_INCLUDE_DIR})
        else()
            foreach(lib ${SDL_SOUND_LIBRARY} ${SDL_LIBRARY})
                set(TMP_TRY_LIBS "${TMP_TRY_LIBS} \"${lib}\"")
            endforeach()
            set(TMP_INCLUDE_DIRS ${SDL_INCLUDE_DIR} ${SDL_SOUND_INCLUDE_DIR})
        endif()

        # message("TMP_TRY_LIBS ${TMP_TRY_LIBS}")

        # Write the CMakeLists.txt and test project
        # Weird, this is still sketchy. If I don't quote the variables
        # in the TARGET_LINK_LIBRARIES, I seem to loose everything
        # in the SDL2_LIBRARY string after the "-framework".
        # But if I quote the stuff in INCLUDE_DIRECTORIES, it doesn't work.
        file(WRITE ${PROJECT_BINARY_DIR}/CMakeTmp/CMakeLists.txt
            "cmake_minimum_required(VERSION 2.8)
            project(DetermineSoundLibs C)
            include_directories(${TMP_INCLUDE_DIRS})
            add_executable(DetermineSoundLibs DetermineSoundLibs.c)
            target_link_libraries(DetermineSoundLibs ${TMP_TRY_LIBS})"
        )
        unset(TMP_INCLUDE_DIRS)
        unset(TMP_TRY_LIBS)

        try_compile(
            MY_RESULT
            ${PROJECT_BINARY_DIR}/CMakeTmp
            ${PROJECT_BINARY_DIR}/CMakeTmp
            DetermineSoundLibs
            OUTPUT_VARIABLE MY_OUTPUT
        )
        # message("${MY_RESULT}")
        # message(${MY_OUTPUT})

        if(NOT MY_RESULT)
            # I expect that MPGLIB, VOC, WAV, AIFF, and SHN are compiled in statically.
            # I think Timidity is also compiled in statically.
            # I've never had to explcitly link against Quicktime, so I'll skip that for now.

            set(SDL_SOUND_LIBRARIES_TMP ${SDL_SOUND_LIBRARY})

            # Find MikMod
            if("${MY_OUTPUT}" MATCHES "MikMod_")
                find_library(MIKMOD_LIBRARY
                    NAMES libmikmod-coreaudio mikmod
                    PATHS
                        ENV MIKMODDIR
                        ENV SDLSOUNDDIR
                        ENV SDLDIR
                        /sw
                        /opt/local
                        /opt/csw
                        /opt
                    PATH_SUFFIXES lib
                )
                if(MIKMOD_LIBRARY)
                    set(SDL_SOUND_LIBRARIES_TMP ${SDL_SOUND_LIBRARIES_TMP} ${MIKMOD_LIBRARY})
                endif(MIKMOD_LIBRARY)
            endif("${MY_OUTPUT}" MATCHES "MikMod_")

            # Find ModPlug
            if("${MY_OUTPUT}" MATCHES "MODPLUG_")
                find_library(MODPLUG_LIBRARY
                    NAMES modplug
                    PATHS
                        ENV MODPLUGDIR
                        ENV SDLSOUNDDIR
                        ENV SDLDIR
                        /sw
                        /opt/local
                        /opt/csw
                        /opt
                    PATH_SUFFIXES lib
                )
                if(MODPLUG_LIBRARY)
                    set(SDL_SOUND_LIBRARIES_TMP ${SDL_SOUND_LIBRARIES_TMP} ${MODPLUG_LIBRARY})
                endif()
            endif()

            # Find Ogg and Vorbis
            if("${MY_OUTPUT}" MATCHES "ov_")
                find_library(VORBIS_LIBRARY
                    NAMES vorbis Vorbis VORBIS
                    PATHS
                        ENV VORBISDIR
                        ENV OGGDIR
                        ENV SDLSOUNDDIR
                        ENV SDLDIR
                        /sw
                        /opt/local
                        /opt/csw
                        /opt
                    PATH_SUFFIXES lib
                )
                if(VORBIS_LIBRARY)
                    set(SDL_SOUND_LIBRARIES_TMP ${SDL_SOUND_LIBRARIES_TMP} ${VORBIS_LIBRARY})
                endif()
                find_library(OGG_LIBRARY
                    NAMES ogg Ogg OGG
                    PATHS
                        ENV OGGDIR
                        ENV VORBISDIR
                        ENV SDLSOUNDDIR
                        ENV SDLDIR
                        /sw
                        /opt/local
                        /opt/csw
                        /opt
                    PATH_SUFFIXES lib
                )
                if(OGG_LIBRARY)
                    set(SDL_SOUND_LIBRARIES_TMP ${SDL_SOUND_LIBRARIES_TMP} ${OGG_LIBRARY})
                endif()
            endif()

            # Find SMPEG
            if("${MY_OUTPUT}" MATCHES "SMPEG_")
                find_library(SMPEG_LIBRARY
                    NAMES smpeg SMPEG Smpeg SMpeg
                    PATHS
                        ENV SMPEGDIR
                        ENV SDLSOUNDDIR
                        ENV SDLDIR
                        /sw
                        /opt/local
                        /opt/csw
                        /opt
                    PATH_SUFFIXES lib
                )
                if(SMPEG_LIBRARY)
                    set(SDL_SOUND_LIBRARIES_TMP ${SDL_SOUND_LIBRARIES_TMP} ${SMPEG_LIBRARY})
                endif()
            endif()


            # Find FLAC
            if("${MY_OUTPUT}" MATCHES "FLAC_")
                find_library(FLAC_LIBRARY
                    NAMES flac FLAC
                    PATHS
                        ENV FLACDIR
                        ENV SDLSOUNDDIR
                        ENV SDLDIR
                        /sw
                        /opt/local
                        /opt/csw
                        /opt
                    PATH_SUFFIXES lib
                )
                if(FLAC_LIBRARY)
                    set(SDL_SOUND_LIBRARIES_TMP ${SDL_SOUND_LIBRARIES_TMP} ${FLAC_LIBRARY})
                endif()
            endif()


            # Hmmm...Speex seems to depend on Ogg. This might be a problem if
            # the TRY_COMPILE attempt gets blocked at SPEEX before it can pull
            # in the Ogg symbols. I'm not sure if I should duplicate the ogg stuff
            # above for here or if two ogg entries will screw up things.
            if("${MY_OUTPUT}" MATCHES "speex_")
                find_library(SPEEX_LIBRARY
                    NAMES speex SPEEX
                    PATHS
                        ENV SPEEXDIR
                        ENV SDLSOUNDDIR
                        ENV SDLDIR
                        /sw
                        /opt/local
                        /opt/csw
                        /opt
                    PATH_SUFFIXES lib
                )
                if(SPEEX_LIBRARY)
                    set(SDL_SOUND_LIBRARIES_TMP ${SDL_SOUND_LIBRARIES_TMP} ${SPEEX_LIBRARY})
                endif()

                # Find OGG (needed for Speex)
                # We might have already found Ogg for Vorbis, so skip it if so.
                if(NOT OGG_LIBRARY)
                    find_library(OGG_LIBRARY
                        NAMES ogg Ogg OGG
                        PATHS
                            ENV OGGDIR
                            ENV VORBISDIR
                            ENV SPEEXDIR
                            ENV SDLSOUNDDIR
                            ENV SDLDIR
                            /sw
                            /opt/local
                            /opt/csw
                            /opt
                        PATH_SUFFIXES lib
                    )
                    if(OGG_LIBRARY)
                        set(SDL_SOUND_LIBRARIES_TMP ${SDL_SOUND_LIBRARIES_TMP} ${OGG_LIBRARY})
                    endif()
                endif()
            endif()

            set(SDL_SOUND_LIBRARIES ${SDL_SOUND_EXTRAS} ${SDL_SOUND_LIBRARIES_TMP} CACHE INTERNAL "SDL_sound and dependent libraries")
        else()
            set(SDL_SOUND_LIBRARIES ${SDL_SOUND_EXTRAS} ${SDL_SOUND_LIBRARY} CACHE INTERNAL "SDL_sound and dependent libraries")
        endif()
    endif()
endif()

if(SDL_SOUND_INCLUDE_DIR AND EXISTS "${SDL_SOUND_INCLUDE_DIR}/SDL_sound.h")
  file(STRINGS "${SDL_SOUND_INCLUDE_DIR}/SDL_sound.h" SDL_SOUND_VERSION_MAJOR_LINE REGEX "^#define[ \t]+SOUND_VER_MAJOR[ \t]+[0-9]+$")
  file(STRINGS "${SDL_SOUND_INCLUDE_DIR}/SDL_sound.h" SDL_SOUND_VERSION_MINOR_LINE REGEX "^#define[ \t]+SOUND_VER_MINOR[ \t]+[0-9]+$")
  file(STRINGS "${SDL_SOUND_INCLUDE_DIR}/SDL_sound.h" SDL_SOUND_VERSION_PATCH_LINE REGEX "^#define[ \t]+SOUND_VER_PATCH[ \t]+[0-9]+$")
  string(REGEX REPLACE "^#define[ \t]+SOUND_VER_MAJOR[ \t]+([0-9]+)$" "\\1" SDL_SOUND_VERSION_MAJOR "${SDL_SOUND_VERSION_MAJOR_LINE}")
  string(REGEX REPLACE "^#define[ \t]+SOUND_VER_MINOR[ \t]+([0-9]+)$" "\\1" SDL_SOUND_VERSION_MINOR "${SDL_SOUND_VERSION_MINOR_LINE}")
  string(REGEX REPLACE "^#define[ \t]+SOUND_VER_PATCH[ \t]+([0-9]+)$" "\\1" SDL_SOUND_VERSION_PATCH "${SDL_SOUND_VERSION_PATCH_LINE}")
  set(SDL_SOUND_VERSION_STRING ${SDL_SOUND_VERSION_MAJOR}.${SDL_SOUND_VERSION_MINOR}.${SDL_SOUND_VERSION_PATCH})
  unset(SDL_SOUND_VERSION_MAJOR_LINE)
  unset(SDL_SOUND_VERSION_MINOR_LINE)
  unset(SDL_SOUND_VERSION_PATCH_LINE)
  unset(SDL_SOUND_VERSION_MAJOR)
  unset(SDL_SOUND_VERSION_MINOR)
  unset(SDL_SOUND_VERSION_PATCH)
endif()

include(FindPackageHandleStandardArgs)
FIND_PACKAGE_HANDLE_STANDARD_ARGS(SDL_sound
                                  REQUIRED_VARS SDL_SOUND_LIBRARIES SDL_SOUND_INCLUDE_DIR
                                  VERSION_VAR SDL_SOUND_VERSION_STRING)