FindImageMagick.cmake 11 KB
Newer Older
1 2 3 4 5 6 7 8 9
#.rst:
# FindImageMagick
# ---------------
#
# Find the ImageMagick binary suite.
#
# This module will search for a set of ImageMagick tools specified as
# components in the FIND_PACKAGE call.  Typical components include, but
# are not limited to (future versions of ImageMagick might have
10
# additional components not listed here):
11
#
12 13 14 15 16 17 18 19 20 21 22 23 24 25 26
# ::
#
#   animate
#   compare
#   composite
#   conjure
#   convert
#   display
#   identify
#   import
#   mogrify
#   montage
#   stream
#
#
27
#
28
# If no component is specified in the FIND_PACKAGE call, then it only
29
# searches for the ImageMagick executable directory.  This code defines
30 31
# the following variables:
#
32 33 34 35 36 37 38 39 40 41
# ::
#
#   ImageMagick_FOUND                  - TRUE if all components are found.
#   ImageMagick_EXECUTABLE_DIR         - Full path to executables directory.
#   ImageMagick_<component>_FOUND      - TRUE if <component> is found.
#   ImageMagick_<component>_EXECUTABLE - Full path to <component> executable.
#   ImageMagick_VERSION_STRING         - the version of ImageMagick found
#                                        (since CMake 2.8.8)
#
#
42
#
43 44
# ImageMagick_VERSION_STRING will not work for old versions like 5.2.3.
#
45 46
# There are also components for the following ImageMagick APIs:
#
47 48 49 50 51 52 53
# ::
#
#   Magick++
#   MagickWand
#   MagickCore
#
#
54 55 56
#
# For these components the following variables are set:
#
57 58 59 60 61 62 63 64 65 66
# ::
#
#   ImageMagick_FOUND                    - TRUE if all components are found.
#   ImageMagick_INCLUDE_DIRS             - Full paths to all include dirs.
#   ImageMagick_LIBRARIES                - Full paths to all libraries.
#   ImageMagick_<component>_FOUND        - TRUE if <component> is found.
#   ImageMagick_<component>_INCLUDE_DIRS - Full path to <component> include dirs.
#   ImageMagick_<component>_LIBRARIES    - Full path to <component> libraries.
#
#
67 68
#
# Example Usages:
69 70 71 72 73 74 75 76 77 78 79 80 81
#
# ::
#
#   find_package(ImageMagick)
#   find_package(ImageMagick COMPONENTS convert)
#   find_package(ImageMagick COMPONENTS convert mogrify display)
#   find_package(ImageMagick COMPONENTS Magick++)
#   find_package(ImageMagick COMPONENTS Magick++ convert)
#
#
#
# Note that the standard FIND_PACKAGE features are supported (i.e.,
# QUIET, REQUIRED, etc.).
82

83 84 85
#=============================================================================
# Copyright 2007-2009 Kitware, Inc.
# Copyright 2007-2008 Miguel A. Figueroa-Villanueva <miguelf at ieee dot org>
86
# Copyright 2012 Rolf Eike Beer <eike@sf-mail.de>
87
#
88 89 90 91 92 93 94
# 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.
#=============================================================================
95
# (To distribute this file outside of CMake, substitute the full
96
#  License text for the above reference.)
97

98 99
find_package(PkgConfig QUIET)

100 101 102
#---------------------------------------------------------------------
# Helper functions
#---------------------------------------------------------------------
103 104
function(FIND_IMAGEMAGICK_API component header)
  set(ImageMagick_${component}_FOUND FALSE PARENT_SCOPE)
105

106 107
  pkg_check_modules(PC_${component} QUIET ${component})

108
  find_path(ImageMagick_${component}_INCLUDE_DIR
109
    NAMES ${header}
110 111 112
    HINTS
      ${PC_${component}_INCLUDEDIR}
      ${PC_${component}_INCLUDE_DIRS}
113 114 115 116
    PATHS
      ${ImageMagick_INCLUDE_DIRS}
      "[HKEY_LOCAL_MACHINE\\SOFTWARE\\ImageMagick\\Current;BinPath]/include"
    PATH_SUFFIXES
117
      ImageMagick ImageMagick-6
118 119 120 121 122 123 124 125 126 127 128 129 130
    DOC "Path to the ImageMagick arch-independent include dir."
    )
  find_path(ImageMagick_${component}_ARCH_INCLUDE_DIR
    NAMES magick/magick-baseconfig.h
    HINTS
      ${PC_${component}_INCLUDEDIR}
      ${PC_${component}_INCLUDE_DIRS}
    PATHS
      ${ImageMagick_INCLUDE_DIRS}
      "[HKEY_LOCAL_MACHINE\\SOFTWARE\\ImageMagick\\Current;BinPath]/include"
    PATH_SUFFIXES
      ImageMagick ImageMagick-6
    DOC "Path to the ImageMagick arch-specific include dir."
131
    )
132
  find_library(ImageMagick_${component}_LIBRARY
133
    NAMES ${ARGN}
134 135 136
    HINTS
      ${PC_${component}_LIBDIR}
      ${PC_${component}_LIB_DIRS}
137 138 139 140
    PATHS
      "[HKEY_LOCAL_MACHINE\\SOFTWARE\\ImageMagick\\Current;BinPath]/lib"
    DOC "Path to the ImageMagick Magick++ library."
    )
141

142
  # old version have only indep dir
143 144
  if(ImageMagick_${component}_INCLUDE_DIR AND ImageMagick_${component}_LIBRARY)
    set(ImageMagick_${component}_FOUND TRUE PARENT_SCOPE)
145

146 147
    # Construct per-component include directories.
    set(ImageMagick_${component}_INCLUDE_DIRS
148 149
      ${ImageMagick_${component}_INCLUDE_DIR}
      )
150
    if(ImageMagick_${component}_ARCH_INCLUDE_DIR)
151
      list(APPEND ImageMagick_${component}_INCLUDE_DIRS
152 153
        ${ImageMagick_${component}_ARCH_INCLUDE_DIR})
    endif()
154 155 156 157 158 159
    list(REMOVE_DUPLICATES ImageMagick_${component}_INCLUDE_DIRS)
    set(ImageMagick_${component}_INCLUDE_DIRS
      ${ImageMagick_${component}_INCLUDE_DIRS} PARENT_SCOPE)

    # Add the per-component include directories to the full include dirs.
    list(APPEND ImageMagick_INCLUDE_DIRS ${ImageMagick_${component}_INCLUDE_DIRS})
160 161
    list(REMOVE_DUPLICATES ImageMagick_INCLUDE_DIRS)
    set(ImageMagick_INCLUDE_DIRS ${ImageMagick_INCLUDE_DIRS} PARENT_SCOPE)
162

163
    list(APPEND ImageMagick_LIBRARIES
164 165
      ${ImageMagick_${component}_LIBRARY}
      )
166
    set(ImageMagick_LIBRARIES ${ImageMagick_LIBRARIES} PARENT_SCOPE)
167 168
  endif()
endfunction()
169

170 171
function(FIND_IMAGEMAGICK_EXE component)
  set(_IMAGEMAGICK_EXECUTABLE
172
    ${ImageMagick_EXECUTABLE_DIR}/${component}${CMAKE_EXECUTABLE_SUFFIX})
173 174
  if(EXISTS ${_IMAGEMAGICK_EXECUTABLE})
    set(ImageMagick_${component}_EXECUTABLE
175 176 177
      ${_IMAGEMAGICK_EXECUTABLE}
       PARENT_SCOPE
       )
178
    set(ImageMagick_${component}_FOUND TRUE PARENT_SCOPE)
179
  else()
180
    set(ImageMagick_${component}_FOUND FALSE PARENT_SCOPE)
181 182
  endif()
endfunction()
183

184 185 186 187
#---------------------------------------------------------------------
# Start Actual Work
#---------------------------------------------------------------------
# Try to find a ImageMagick installation binary path.
188
find_path(ImageMagick_EXECUTABLE_DIR
189 190 191 192 193 194
  NAMES mogrify${CMAKE_EXECUTABLE_SUFFIX}
  PATHS
    "[HKEY_LOCAL_MACHINE\\SOFTWARE\\ImageMagick\\Current;BinPath]"
  DOC "Path to the ImageMagick binary directory."
  NO_DEFAULT_PATH
  )
195
find_path(ImageMagick_EXECUTABLE_DIR
196
  NAMES mogrify${CMAKE_EXECUTABLE_SUFFIX}
197 198
  )

199 200 201
# Find each component. Search for all tools in same dir
# <ImageMagick_EXECUTABLE_DIR>; otherwise they should be found
# independently and not in a cohesive module such as this one.
202 203 204
unset(ImageMagick_REQUIRED_VARS)
unset(ImageMagick_DEFAULT_EXECUTABLES)
foreach(component ${ImageMagick_FIND_COMPONENTS}
205 206 207
    # DEPRECATED: forced components for backward compatibility
    convert mogrify import montage composite
    )
208
  if(component STREQUAL "Magick++")
209
    FIND_IMAGEMAGICK_API(Magick++ Magick++.h
210
      Magick++ CORE_RL_Magick++_ Magick++-6.Q16 Magick++-Q16 Magick++-6.Q8 Magick++-Q8 Magick++-6.Q16HDRI Magick++-Q16HDRI Magick++-6.Q8HDRI Magick++-Q8HDRI
211
      )
212 213
    list(APPEND ImageMagick_REQUIRED_VARS ImageMagick_Magick++_LIBRARY)
  elseif(component STREQUAL "MagickWand")
214
    FIND_IMAGEMAGICK_API(MagickWand wand/MagickWand.h
215
      Wand MagickWand CORE_RL_wand_ MagickWand-6.Q16 MagickWand-Q16 MagickWand-6.Q8 MagickWand-Q8 MagickWand-6.Q16HDRI MagickWand-Q16HDRI MagickWand-6.Q8HDRI MagickWand-Q8HDRI
216
      )
217 218
    list(APPEND ImageMagick_REQUIRED_VARS ImageMagick_MagickWand_LIBRARY)
  elseif(component STREQUAL "MagickCore")
219
    FIND_IMAGEMAGICK_API(MagickCore magick/MagickCore.h
220
      Magick MagickCore CORE_RL_magick_ MagickCore-6.Q16 MagickCore-Q16 MagickCore-6.Q8 MagickCore-Q8 MagickCore-6.Q16HDRI MagickCore-Q16HDRI MagickCore-6.Q8HDRI MagickCore-Q8HDRI
221
      )
222
    list(APPEND ImageMagick_REQUIRED_VARS ImageMagick_MagickCore_LIBRARY)
223
  else()
224
    if(ImageMagick_EXECUTABLE_DIR)
225
      FIND_IMAGEMAGICK_EXE(${component})
226
    endif()
227

228 229 230 231
    if(ImageMagick_FIND_COMPONENTS)
      list(FIND ImageMagick_FIND_COMPONENTS ${component} is_requested)
      if(is_requested GREATER -1)
        list(APPEND ImageMagick_REQUIRED_VARS ImageMagick_${component}_EXECUTABLE)
232
      endif()
233
    elseif(ImageMagick_${component}_EXECUTABLE)
234
      # if no components were requested explicitly put all (default) executables
235
      # in the list
236
      list(APPEND ImageMagick_DEFAULT_EXECUTABLES ImageMagick_${component}_EXECUTABLE)
237 238 239
    endif()
  endif()
endforeach()
240

241
if(NOT ImageMagick_FIND_COMPONENTS AND NOT ImageMagick_DEFAULT_EXECUTABLES)
242 243 244
  # No components were requested, and none of the default components were
  # found. Just insert mogrify into the list of the default components to
  # find so FPHSA below has something to check
245 246 247 248
  list(APPEND ImageMagick_REQUIRED_VARS ImageMagick_mogrify_EXECUTABLE)
elseif(ImageMagick_DEFAULT_EXECUTABLES)
  list(APPEND ImageMagick_REQUIRED_VARS ${ImageMagick_DEFAULT_EXECUTABLES})
endif()
249

250 251
set(ImageMagick_INCLUDE_DIRS ${ImageMagick_INCLUDE_DIRS})
set(ImageMagick_LIBRARIES ${ImageMagick_LIBRARIES})
252

253 254
if(ImageMagick_mogrify_EXECUTABLE)
  execute_process(COMMAND ${ImageMagick_mogrify_EXECUTABLE} -version
255 256 257
                  OUTPUT_VARIABLE imagemagick_version
                  ERROR_QUIET
                  OUTPUT_STRIP_TRAILING_WHITESPACE)
258 259
  if(imagemagick_version MATCHES "^Version: ImageMagick ([-0-9\\.]+)")
    set(ImageMagick_VERSION_STRING "${CMAKE_MATCH_1}")
260 261
  endif()
  unset(imagemagick_version)
262
endif()
263

264 265 266
#---------------------------------------------------------------------
# Standard Package Output
#---------------------------------------------------------------------
267
include(${CMAKE_CURRENT_LIST_DIR}/FindPackageHandleStandardArgs.cmake)
268 269 270
FIND_PACKAGE_HANDLE_STANDARD_ARGS(ImageMagick
                                  REQUIRED_VARS ${ImageMagick_REQUIRED_VARS}
                                  VERSION_VAR ImageMagick_VERSION_STRING
271 272
  )
# Maintain consistency with all other variables.
273
set(ImageMagick_FOUND ${IMAGEMAGICK_FOUND})
274

275 276 277
#---------------------------------------------------------------------
# DEPRECATED: Setting variables for backward compatibility.
#---------------------------------------------------------------------
278
set(IMAGEMAGICK_BINARY_PATH          ${ImageMagick_EXECUTABLE_DIR}
279
    CACHE PATH "Path to the ImageMagick binary directory.")
280
set(IMAGEMAGICK_CONVERT_EXECUTABLE   ${ImageMagick_convert_EXECUTABLE}
281
    CACHE FILEPATH "Path to ImageMagick's convert executable.")
282
set(IMAGEMAGICK_MOGRIFY_EXECUTABLE   ${ImageMagick_mogrify_EXECUTABLE}
283
    CACHE FILEPATH "Path to ImageMagick's mogrify executable.")
284
set(IMAGEMAGICK_IMPORT_EXECUTABLE    ${ImageMagick_import_EXECUTABLE}
285
    CACHE FILEPATH "Path to ImageMagick's import executable.")
286
set(IMAGEMAGICK_MONTAGE_EXECUTABLE   ${ImageMagick_montage_EXECUTABLE}
287
    CACHE FILEPATH "Path to ImageMagick's montage executable.")
288
set(IMAGEMAGICK_COMPOSITE_EXECUTABLE ${ImageMagick_composite_EXECUTABLE}
289
    CACHE FILEPATH "Path to ImageMagick's composite executable.")
290
mark_as_advanced(
291 292 293 294 295 296
  IMAGEMAGICK_BINARY_PATH
  IMAGEMAGICK_CONVERT_EXECUTABLE
  IMAGEMAGICK_MOGRIFY_EXECUTABLE
  IMAGEMAGICK_IMPORT_EXECUTABLE
  IMAGEMAGICK_MONTAGE_EXECUTABLE
  IMAGEMAGICK_COMPOSITE_EXECUTABLE
297
  )