CMake: Make the FindFFMPEG interface mirror the vcpkg-shipped one

2 files changed, 166 insertions, 186 deletions

diff --git a/cmake/modules/FindFFMPEG.cmake b/cmake/modules/FindFFMPEG.cmake
new file mode 100644
index 0000000000..cd1ebe34c8
--- /dev/null
+++ b/cmake/modules/FindFFMPEG.cmake
@@ -0,0 +1,166 @@
+#.rst:
+# FindFFMPEG
+# ----------
+#
+# Try to find the required ffmpeg components (default: libavformat, libavutil, libavcodec)
+#
+# Next variables can be used to hint FFMPEG libs search:
+#
+# ::
+#
+#   PC_<component>_LIBRARY_DIRS
+#   PC_FFMPEG_LIBRARY_DIRS
+#   PC_<component>_INCLUDE_DIRS
+#   PC_FFMPEG_INCLUDE_DIRS
+#
+# Once done this will define
+#
+# ::
+#
+#   FFMPEG_FOUND         - System has the all required components.
+#   FFMPEG_INCLUDE_DIRS  - Include directory necessary for using the required components headers.
+#   FFMPEG_LIBRARIES     - Link these to use the required ffmpeg components.
+#   FFMPEG_DEFINITIONS   - Compiler switches required for using the required ffmpeg components.
+#
+# For each of the components it will additionally set.
+#
+# ::
+#
+#   libavcodec
+#   libavdevice
+#   libavformat
+#   libavfilter
+#   libavutil
+#   libpostproc
+#   libswscale
+#
+# the following variables will be defined
+#
+# ::
+#
+#   <component>_FOUND        - System has <component>
+#   <component>_INCLUDE_DIRS - Include directory necessary for using the <component> headers
+#   <component>_LIBRARIES    - Link these to use <component>
+#   <component>_DEFINITIONS  - Compiler switches required for using <component>
+#   <component>_VERSION      - The components version
+#
+# the following import targets is created
+#
+# ::
+#
+#   FFMPEG::FFMPEG - for all components
+#   FFMPEG::<component> - where <component> in lower case (FFMPEG::avcodec) for each components
+#
+# Copyright (c) 2006, Matthias Kretz, <kretz@kde.org>
+# Copyright (c) 2008, Alexander Neundorf, <neundorf@kde.org>
+# Copyright (c) 2011, Michael Jansen, <kde@michael-jansen.biz>
+# Copyright (c) 2017, Alexander Drozdov, <adrozdoff@gmail.com>
+# Copyright (c) 2019, Jan Holthuis, <holthuis.jan@googlemail.com>
+#
+# Redistribution and use is allowed according to the terms of the BSD license.
+# For details see the accompanying COPYING-CMAKE-SCRIPTS file.
+
+include(FindPackageHandleStandardArgs)
+
+# The default components were taken from a survey over other FindFFMPEG.cmake files
+if (NOT FFMPEG_FIND_COMPONENTS)
+  set(FFMPEG_FIND_COMPONENTS libavcodec libavformat libavutil)
+endif ()
+
+#
+### Macro: find_component
+#
+# Checks for the given component by invoking pkgconfig and then looking up the libraries and
+# include directories.
+#
+macro(find_component _component _pkgconfig _library _header)
+
+   # use pkg-config to get the directories and then use these values
+   # in the FIND_PATH() and FIND_LIBRARY() calls
+   find_package(PkgConfig QUIET)
+   if (PkgConfig_FOUND)
+     pkg_check_modules(PC_FFMPEG_${_component} QUIET ${_pkgconfig})
+   endif ()
+
+  find_path(FFMPEG_${_component}_INCLUDE_DIRS ${_header}
+    HINTS
+      ${PC_FFMPEG_${_component}_INCLUDEDIR}
+      ${PC_FFMPEG_${_component}_INCLUDE_DIRS}
+      ${PC_FFMPEG_INCLUDE_DIRS}
+    PATH_SUFFIXES
+      ffmpeg
+  )
+
+  find_library(FFMPEG_${_component}_LIBRARIES NAMES ${PC_FFMPEG_${_component}_LIBRARIES} ${_library}
+      HINTS
+      ${PC_FFMPEG_${_component}_LIBDIR}
+      ${PC_FFMPEG_${_component}_LIBRARY_DIRS}
+      ${PC_FFMPEG_LIBRARY_DIRS}
+  )
+
+  #message(STATUS ${FFMPEG_${_component}_LIBRARIES})
+  #message(STATUS ${PC_FFMPEG_${_component}_LIBRARIES})
+
+  set(FFMPEG_${_component}_DEFINITIONS  ${PC_FFMPEG_${_component}_CFLAGS_OTHER} CACHE STRING "The ${_component} CFLAGS.")
+  set(FFMPEG_${_component}_VERSION      ${PC_FFMPEG_${_component}_VERSION}      CACHE STRING "The ${_component} version number.")
+
+  if (FFMPEG_${_component}_LIBRARIES AND FFMPEG_${_component}_INCLUDE_DIRS)
+    # message(STATUS "  - ${_component} found.")
+    set(FFMPEG_${_component}_FOUND TRUE)
+  else ()
+    # message(STATUS "  - ${_component} not found.")
+  endif ()
+
+  mark_as_advanced(
+    FFMPEG_${_component}_INCLUDE_DIRS
+    FFMPEG_${_component}_LIBRARIES
+    FFMPEG_${_component}_DEFINITIONS
+    FFMPEG_${_component}_VERSION)
+
+endmacro()
+
+
+# Check for all possible component.
+find_component(libavcodec    libavcodec    avcodec  libavcodec/avcodec.h)
+find_component(libavformat   libavformat   avformat libavformat/avformat.h)
+find_component(libavdevice   libavdevice   avdevice libavdevice/avdevice.h)
+find_component(libavutil     libavutil     avutil   libavutil/avutil.h)
+find_component(libavfilter   libavfilter   avfilter libavfilter/avfilter.h)
+find_component(libswscale    libswscale    swscale  libswscale/swscale.h)
+find_component(libpostproc   libpostproc   postproc libpostproc/postprocess.h)
+find_component(libswresample libswresample swresample libswresample/swresample.h)
+
+set(FFMPEG_LIBRARIES "")
+set(FFMPEG_DEFINITIONS "")
+# Check if the required components were found and add their stuff to the FFMPEG_* vars.
+foreach (_component ${FFMPEG_FIND_COMPONENTS})
+  if (FFMPEG_${_component}_FOUND)
+    #message(STATUS "Required component ${_component} present.")
+    set(FFMPEG_LIBRARIES   ${FFMPEG_LIBRARIES}   ${FFMPEG_${_component}_LIBRARIES})
+    set(FFMPEG_DEFINITIONS ${FFMPEG_DEFINITIONS} ${FFMPEG_${_component}_DEFINITIONS})
+    list(APPEND FFMPEG_INCLUDE_DIRS ${FFMPEG_${_component}_INCLUDE_DIRS})
+  endif()
+endforeach ()
+
+# Build the include path with duplicates removed.
+if (FFMPEG_INCLUDE_DIRS)
+  list(REMOVE_DUPLICATES FFMPEG_INCLUDE_DIRS)
+endif ()
+
+# cache the vars.
+set(FFMPEG_INCLUDE_DIRS ${FFMPEG_INCLUDE_DIRS} CACHE STRING "The FFMPEG include directories." FORCE)
+set(FFMPEG_LIBRARIES    ${FFMPEG_LIBRARIES}    CACHE STRING "The FFMPEG libraries." FORCE)
+set(FFMPEG_DEFINITIONS  ${FFMPEG_DEFINITIONS}  CACHE STRING "The FFMPEG cflags." FORCE)
+
+mark_as_advanced(FFMPEG_INCLUDE_DIRS
+                 FFMPEG_LIBRARIES
+                 FFMPEG_DEFINITIONS)
+
+# Compile the list of required vars
+set(_FFMPEG_REQUIRED_VARS FFMPEG_LIBRARIES FFMPEG_INCLUDE_DIRS)
+foreach (_component ${FFMPEG_FIND_COMPONENTS})
+    list(APPEND _FFMPEG_REQUIRED_VARS FFMPEG_${_component}_LIBRARIES FFMPEG_${_component}_INCLUDE_DIRS)
+endforeach ()
+
+# Give a nice error message if some of the required vars are missing.
+find_package_handle_standard_args(FFMPEG DEFAULT_MSG ${_FFMPEG_REQUIRED_VARS})
diff --git a/cmake/modules/FindFFmpeg.cmake b/cmake/modules/FindFFmpeg.cmake
deleted file mode 100644
index 2126aed73e..0000000000
--- a/cmake/modules/FindFFmpeg.cmake
+++ /dev/null
@@ -1,186 +0,0 @@
-#.rst:
-# FindFFmpeg
-# ----------
-#
-# Try to find the required ffmpeg components (default: AVFORMAT, AVUTIL, AVCODEC)
-#
-# Next variables can be used to hint FFmpeg libs search:
-#
-# ::
-#
-#   PC_<component>_LIBRARY_DIRS
-#   PC_FFMPEG_LIBRARY_DIRS
-#   PC_<component>_INCLUDE_DIRS
-#   PC_FFMPEG_INCLUDE_DIRS
-#
-# Once done this will define
-#
-# ::
-#
-#   FFMPEG_FOUND         - System has the all required components.
-#   FFMPEG_INCLUDE_DIRS  - Include directory necessary for using the required components headers.
-#   FFMPEG_LIBRARIES     - Link these to use the required ffmpeg components.
-#   FFMPEG_DEFINITIONS   - Compiler switches required for using the required ffmpeg components.
-#
-# For each of the components it will additionally set.
-#
-# ::
-#
-#   AVCODEC
-#   AVDEVICE
-#   AVFORMAT
-#   AVFILTER
-#   AVUTIL
-#   POSTPROC
-#   SWSCALE
-#
-# the following variables will be defined
-#
-# ::
-#
-#   <component>_FOUND        - System has <component>
-#   <component>_INCLUDE_DIRS - Include directory necessary for using the <component> headers
-#   <component>_LIBRARIES    - Link these to use <component>
-#   <component>_DEFINITIONS  - Compiler switches required for using <component>
-#   <component>_VERSION      - The components version
-#
-# the following import targets is created
-#
-# ::
-#
-#   FFmpeg::FFmpeg - for all components
-#   FFmpeg::<component> - where <component> in lower case (FFmpeg::avcodec) for each components
-#
-# Copyright (c) 2006, Matthias Kretz, <kretz@kde.org>
-# Copyright (c) 2008, Alexander Neundorf, <neundorf@kde.org>
-# Copyright (c) 2011, Michael Jansen, <kde@michael-jansen.biz>
-# Copyright (c) 2017, Alexander Drozdov, <adrozdoff@gmail.com>
-# Copyright (c) 2019, Jan Holthuis, <holthuis.jan@googlemail.com>
-#
-# Redistribution and use is allowed according to the terms of the BSD license.
-# For details see the accompanying COPYING-CMAKE-SCRIPTS file.
-
-include(FindPackageHandleStandardArgs)
-
-# The default components were taken from a survey over other FindFFMPEG.cmake files
-if (NOT FFmpeg_FIND_COMPONENTS)
-  set(FFmpeg_FIND_COMPONENTS AVCODEC AVFORMAT AVUTIL)
-endif ()
-
-#
-### Macro: find_component
-#
-# Checks for the given component by invoking pkgconfig and then looking up the libraries and
-# include directories.
-#
-macro(find_component _component _pkgconfig _library _header)
-
-   # use pkg-config to get the directories and then use these values
-   # in the FIND_PATH() and FIND_LIBRARY() calls
-   find_package(PkgConfig QUIET)
-   if (PkgConfig_FOUND)
-     pkg_check_modules(PC_${_component} QUIET ${_pkgconfig})
-   endif ()
-
-  find_path(${_component}_INCLUDE_DIRS ${_header}
-    HINTS
-      ${PC_${_component}_INCLUDEDIR}
-      ${PC_${_component}_INCLUDE_DIRS}
-      ${PC_FFMPEG_INCLUDE_DIRS}
-    PATH_SUFFIXES
-      ffmpeg
-  )
-
-  find_library(${_component}_LIBRARIES NAMES ${PC_${_component}_LIBRARIES} ${_library}
-      HINTS
-      ${PC_${_component}_LIBDIR}
-      ${PC_${_component}_LIBRARY_DIRS}
-      ${PC_FFMPEG_LIBRARY_DIRS}
-  )
-
-  #message(STATUS ${${_component}_LIBRARIES})
-  #message(STATUS ${PC_${_component}_LIBRARIES})
-
-  set(${_component}_DEFINITIONS  ${PC_${_component}_CFLAGS_OTHER} CACHE STRING "The ${_component} CFLAGS.")
-  set(${_component}_VERSION      ${PC_${_component}_VERSION}      CACHE STRING "The ${_component} version number.")
-
-  if (${_component}_LIBRARIES AND ${_component}_INCLUDE_DIRS)
-    # message(STATUS "  - ${_component} found.")
-    set(${_component}_FOUND TRUE)
-  else ()
-    # message(STATUS "  - ${_component} not found.")
-  endif ()
-
-  mark_as_advanced(
-    ${_component}_INCLUDE_DIRS
-    ${_component}_LIBRARIES
-    ${_component}_DEFINITIONS
-    ${_component}_VERSION)
-
-endmacro()
-
-
-# Check for all possible component.
-find_component(AVCODEC    libavcodec    avcodec  libavcodec/avcodec.h)
-find_component(AVFORMAT   libavformat   avformat libavformat/avformat.h)
-find_component(AVDEVICE   libavdevice   avdevice libavdevice/avdevice.h)
-find_component(AVUTIL     libavutil     avutil   libavutil/avutil.h)
-find_component(AVFILTER   libavfilter   avfilter libavfilter/avfilter.h)
-find_component(SWSCALE    libswscale    swscale  libswscale/swscale.h)
-find_component(POSTPROC   libpostproc   postproc libpostproc/postprocess.h)
-find_component(SWRESAMPLE libswresample swresample libswresample/swresample.h)
-
-set(FFMPEG_LIBRARIES "")
-set(FFMPEG_DEFINITIONS "")
-# Check if the required components were found and add their stuff to the FFMPEG_* vars.
-foreach (_component ${FFmpeg_FIND_COMPONENTS})
-  if (${_component}_FOUND)
-    # message(STATUS "Required component ${_component} present.")
-    set(FFMPEG_LIBRARIES   ${FFMPEG_LIBRARIES}   ${${_component}_LIBRARIES})
-    set(FFMPEG_DEFINITIONS ${FFMPEG_DEFINITIONS} ${${_component}_DEFINITIONS})
-    list(APPEND FFMPEG_INCLUDE_DIRS ${${_component}_INCLUDE_DIRS})
-
-    string(TOLOWER ${_component} _lowerComponent)
-    if (NOT TARGET FFmpeg::${_lowerComponent})
-      add_library(FFmpeg::${_lowerComponent} INTERFACE IMPORTED)
-      set_target_properties(FFmpeg::${_lowerComponent} PROPERTIES
-          INTERFACE_COMPILE_OPTIONS "${${_component}_DEFINITIONS}"
-          INTERFACE_INCLUDE_DIRECTORIES ${${_component}_INCLUDE_DIRS}
-          INTERFACE_LINK_LIBRARIES "${${_component}_LIBRARIES}")
-    endif()
-
-  else ()
-    # message(STATUS "Required component ${_component} missing.")
-  endif ()
-endforeach ()
-
-# Build the include path with duplicates removed.
-if (FFMPEG_INCLUDE_DIRS)
-  list(REMOVE_DUPLICATES FFMPEG_INCLUDE_DIRS)
-endif ()
-
-# cache the vars.
-set(FFMPEG_INCLUDE_DIRS ${FFMPEG_INCLUDE_DIRS} CACHE STRING "The FFmpeg include directories." FORCE)
-set(FFMPEG_LIBRARIES    ${FFMPEG_LIBRARIES}    CACHE STRING "The FFmpeg libraries." FORCE)
-set(FFMPEG_DEFINITIONS  ${FFMPEG_DEFINITIONS}  CACHE STRING "The FFmpeg cflags." FORCE)
-
-mark_as_advanced(FFMPEG_INCLUDE_DIRS
-                 FFMPEG_LIBRARIES
-                 FFMPEG_DEFINITIONS)
-
-if (NOT TARGET FFmpeg::FFmpeg)
-  add_library(FFmpeg::FFmpeg INTERFACE IMPORTED)
-  set_target_properties(FFmpeg::FFmpeg PROPERTIES
-      INTERFACE_COMPILE_OPTIONS "${FFMPEG_DEFINITIONS}"
-      INTERFACE_INCLUDE_DIRECTORIES "${FFMPEG_INCLUDE_DIRS}"
-      INTERFACE_LINK_LIBRARIES "${FFMPEG_LIBRARIES}")
-endif()
-
-# Compile the list of required vars
-set(_FFmpeg_REQUIRED_VARS FFMPEG_LIBRARIES FFMPEG_INCLUDE_DIRS)
-foreach (_component ${FFmpeg_FIND_COMPONENTS})
-  list(APPEND _FFmpeg_REQUIRED_VARS ${_component}_LIBRARIES ${_component}_INCLUDE_DIRS)
-endforeach ()
-
-# Give a nice error message if some of the required vars are missing.
-find_package_handle_standard_args(FFmpeg DEFAULT_MSG ${_FFmpeg_REQUIRED_VARS})