build: use git version info in plugins and build ZIP package

CMakeLists.txt

@@ -1,8 +1,29 @@
 cmake_minimum_required(VERSION "2.8.0")
 
+project(gst-plugins-vision)
+
+# add local cmake modules
 list(APPEND CMAKE_MODULE_PATH ${CMAKE_SOURCE_DIR}/cmake/modules)
 
-project(gst-plugins-vision)
+# get git version info
+include(GetGitRevisionDescription)
+git_describe(GIT_DESCRIBE --dirty)
+add_definitions(-DPACKAGE_VERSION="${GIT_DESCRIBE}")
+
+# configure CPack
+set(CPACK_GENERATOR "ZIP")
+set(CPACK_ARCHIVE_COMPONENT_INSTALL ON)
+set(CPACK_COMPONENTS_GROUPING IGNORE)
+set(CPACK_COMPONENTS_ALL pdb Unspecified)
+set(CPACK_PACKAGE_VERSION ${GIT_DESCRIBE})
+if (CMAKE_SIZEOF_VOID_P EQUAL 8)
+  set(CPACK_PACKAGE_FILE_NAME "${CMAKE_PROJECT_NAME}-${CPACK_PACKAGE_VERSION}-x86_64")
+else ()
+  set(CPACK_PACKAGE_FILE_NAME "${CPACK_PACKAGE_NAME}-${CPACK_PACKAGE_VERSION}-x86")
+endif ()
+set(CPACK_ARCHIVE_PDB_FILE_NAME "${CPACK_PACKAGE_FILE_NAME}-pdbs")
+set(CPACK_ARCHIVE_UNSPECIFIED_FILE_NAME "${CPACK_PACKAGE_FILE_NAME}")
+include(CPack)
 
 include(MacroLogFeature)
 

cmake/modules/GetGitRevisionDescription.cmake

@@ -0,0 +1,130 @@
+# - Returns a version string from Git
+#
+# These functions force a re-configure on each git commit so that you can
+# trust the values of the variables in your build system.
+#
+#  get_git_head_revision(<refspecvar> <hashvar> [<additional arguments to git describe> ...])
+#
+# Returns the refspec and sha hash of the current head revision
+#
+#  git_describe(<var> [<additional arguments to git describe> ...])
+#
+# Returns the results of git describe on the source tree, and adjusting
+# the output so that it tests false if an error occurs.
+#
+#  git_get_exact_tag(<var> [<additional arguments to git describe> ...])
+#
+# Returns the results of git describe --exact-match on the source tree,
+# and adjusting the output so that it tests false if there was no exact
+# matching tag.
+#
+# Requires CMake 2.6 or newer (uses the 'function' command)
+#
+# Original Author:
+# 2009-2010 Ryan Pavlik <rpavlik@iastate.edu> <abiryan@ryand.net>
+# http://academic.cleardefinition.com
+# Iowa State University HCI Graduate Program/VRAC
+#
+# Copyright Iowa State University 2009-2010.
+# Distributed under the Boost Software License, Version 1.0.
+# (See accompanying file LICENSE_1_0.txt or copy at
+# http://www.boost.org/LICENSE_1_0.txt)
+
+if(__get_git_revision_description)
+	return()
+endif()
+set(__get_git_revision_description YES)
+
+# We must run the following at "include" time, not at function call time,
+# to find the path to this module rather than the path to a calling list file
+get_filename_component(_gitdescmoddir ${CMAKE_CURRENT_LIST_FILE} PATH)
+
+function(get_git_head_revision _refspecvar _hashvar)
+	set(GIT_PARENT_DIR "${CMAKE_CURRENT_SOURCE_DIR}")
+	set(GIT_DIR "${GIT_PARENT_DIR}/.git")
+	while(NOT EXISTS "${GIT_DIR}")	# .git dir not found, search parent directories
+		set(GIT_PREVIOUS_PARENT "${GIT_PARENT_DIR}")
+		get_filename_component(GIT_PARENT_DIR ${GIT_PARENT_DIR} PATH)
+		if(GIT_PARENT_DIR STREQUAL GIT_PREVIOUS_PARENT)
+			# We have reached the root directory, we are not in git
+			set(${_refspecvar} "GITDIR-NOTFOUND" PARENT_SCOPE)
+			set(${_hashvar} "GITDIR-NOTFOUND" PARENT_SCOPE)
+			return()
+		endif()
+		set(GIT_DIR "${GIT_PARENT_DIR}/.git")
+	endwhile()
+	# check if this is a submodule
+	if(NOT IS_DIRECTORY ${GIT_DIR})
+		file(READ ${GIT_DIR} submodule)
+		string(REGEX REPLACE "gitdir: (.*)\n$" "\\1" GIT_DIR_RELATIVE ${submodule})
+		get_filename_component(SUBMODULE_DIR ${GIT_DIR} PATH)
+		get_filename_component(GIT_DIR ${SUBMODULE_DIR}/${GIT_DIR_RELATIVE} ABSOLUTE)
+	endif()
+	set(GIT_DATA "${CMAKE_CURRENT_BINARY_DIR}/CMakeFiles/git-data")
+	if(NOT EXISTS "${GIT_DATA}")
+		file(MAKE_DIRECTORY "${GIT_DATA}")
+	endif()
+
+	if(NOT EXISTS "${GIT_DIR}/HEAD")
+		return()
+	endif()
+	set(HEAD_FILE "${GIT_DATA}/HEAD")
+	configure_file("${GIT_DIR}/HEAD" "${HEAD_FILE}" COPYONLY)
+
+	configure_file("${_gitdescmoddir}/GetGitRevisionDescription.cmake.in"
+		"${GIT_DATA}/grabRef.cmake"
+		@ONLY)
+	include("${GIT_DATA}/grabRef.cmake")
+
+	set(${_refspecvar} "${HEAD_REF}" PARENT_SCOPE)
+	set(${_hashvar} "${HEAD_HASH}" PARENT_SCOPE)
+endfunction()
+
+function(git_describe _var)
+	if(NOT GIT_FOUND)
+		find_package(Git QUIET)
+	endif()
+	get_git_head_revision(refspec hash)
+	if(NOT GIT_FOUND)
+		set(${_var} "GIT-NOTFOUND" PARENT_SCOPE)
+		return()
+	endif()
+	if(NOT hash)
+		set(${_var} "HEAD-HASH-NOTFOUND" PARENT_SCOPE)
+		return()
+	endif()
+
+	# TODO sanitize
+	#if((${ARGN}" MATCHES "&&") OR
+	#	(ARGN MATCHES "||") OR
+	#	(ARGN MATCHES "\\;"))
+	#	message("Please report the following error to the project!")
+	#	message(FATAL_ERROR "Looks like someone's doing something nefarious with git_describe! Passed arguments ${ARGN}")
+	#endif()
+
+	#message(STATUS "Arguments to execute_process: ${ARGN}")
+
+	execute_process(COMMAND
+		"${GIT_EXECUTABLE}"
+		describe
+		# ${hash} # doesn't make sense to specify hash and --dirty
+		${ARGN}
+		WORKING_DIRECTORY
+		"${CMAKE_SOURCE_DIR}"
+		RESULT_VARIABLE
+		res
+		OUTPUT_VARIABLE
+		out
+		#ERROR_QUIET
+		OUTPUT_STRIP_TRAILING_WHITESPACE)
+	if(NOT res EQUAL 0)
+		set(out "${out}-${res}-NOTFOUND")
+	endif()
+
+	set(${_var} "${out}" PARENT_SCOPE)
+endfunction()
+
+function(git_get_exact_tag _var)
+	git_describe(out --exact-match ${ARGN})
+	set(${_var} "${out}" PARENT_SCOPE)
+endfunction()

cmake/modules/GetGitRevisionDescription.cmake.in

@@ -0,0 +1,38 @@
+# 
+# Internal file for GetGitRevisionDescription.cmake
+#
+# Requires CMake 2.6 or newer (uses the 'function' command)
+#
+# Original Author:
+# 2009-2010 Ryan Pavlik <rpavlik@iastate.edu> <abiryan@ryand.net>
+# http://academic.cleardefinition.com
+# Iowa State University HCI Graduate Program/VRAC
+#
+# Copyright Iowa State University 2009-2010.
+# Distributed under the Boost Software License, Version 1.0.
+# (See accompanying file LICENSE_1_0.txt or copy at
+# http://www.boost.org/LICENSE_1_0.txt)
+
+set(HEAD_HASH)
+
+file(READ "@HEAD_FILE@" HEAD_CONTENTS LIMIT 1024)
+
+string(STRIP "${HEAD_CONTENTS}" HEAD_CONTENTS)
+if(HEAD_CONTENTS MATCHES "ref")
+	# named branch
+	string(REPLACE "ref: " "" HEAD_REF "${HEAD_CONTENTS}")
+	if(EXISTS "@GIT_DIR@/${HEAD_REF}")
+		configure_file("@GIT_DIR@/${HEAD_REF}" "@GIT_DATA@/head-ref" COPYONLY)
+	elseif(EXISTS "@GIT_DIR@/logs/${HEAD_REF}")
+		configure_file("@GIT_DIR@/logs/${HEAD_REF}" "@GIT_DATA@/head-ref" COPYONLY)
+		set(HEAD_HASH "${HEAD_REF}")
+	endif()
+else()
+	# detached HEAD
+	configure_file("@GIT_DIR@/HEAD" "@GIT_DATA@/head-ref" COPYONLY)
+endif()
+
+if(NOT HEAD_HASH)
+	file(READ "@GIT_DATA@/head-ref" HEAD_HASH LIMIT 1024)
+	string(STRIP "${HEAD_HASH}" HEAD_HASH)
+endif()

config.h

@@ -7,7 +7,4 @@
 /* package origin */
 #define GST_PACKAGE_ORIGIN "Unknown package origin"
 
-/* Version number of package */
-#define VERSION "0.10.0.1"
-
 #define PACKAGE "gst-plugins-vision"

gst/extractcolor/CMakeLists.txt

@@ -25,6 +25,6 @@ target_link_libraries (${libname}
   ${GSTREAMER_VIDEO_LIBRARY})
   
 set (pdbfile "${CMAKE_CURRENT_BINARY_DIR}/\${CMAKE_INSTALL_CONFIG_NAME}/${libname}.pdb")
-install (FILES ${pdbfile} DESTINATION lib/gstreamer-1.0)
+install (FILES ${pdbfile} DESTINATION lib/gstreamer-1.0 COMPONENT pdb)
 install(TARGETS ${libname}
   LIBRARY DESTINATION lib/gstreamer-1.0)

gst/extractcolor/gstextractcolor.c

@@ -449,4 +449,4 @@ GST_PLUGIN_DEFINE (GST_VERSION_MAJOR,
     GST_VERSION_MINOR,
     extract_color,
     "Filter that applies various hacks to a video stream",
-    plugin_init, VERSION, GST_LICENSE, PACKAGE_NAME, GST_PACKAGE_ORIGIN);
+    plugin_init, PACKAGE_VERSION, GST_LICENSE, PACKAGE_NAME, GST_PACKAGE_ORIGIN);

gst/videoadjust/CMakeLists.txt

@@ -21,6 +21,6 @@ target_link_libraries (${libname}
   ${GSTREAMER_VIDEO_LIBRARY})
 
 set (pdbfile "${CMAKE_CURRENT_BINARY_DIR}/\${CMAKE_INSTALL_CONFIG_NAME}/${libname}.pdb")
-install (FILES ${pdbfile} DESTINATION lib/gstreamer-1.0)
+install (FILES ${pdbfile} DESTINATION lib/gstreamer-1.0 COMPONENT pdb)
 install (TARGETS ${libname}
     LIBRARY DESTINATION lib/gstreamer-1.0)

gst/videoadjust/gstvideoadjust.c

@@ -30,4 +30,4 @@ GST_PLUGIN_DEFINE (GST_VERSION_MAJOR,
     GST_VERSION_MINOR,
     videoadjust,
     "Filters that apply transform from 16-bit to 8-bit video",
-    plugin_init, VERSION, GST_LICENSE, PACKAGE_NAME, GST_PACKAGE_ORIGIN);
+    plugin_init, PACKAGE_VERSION, GST_LICENSE, PACKAGE_NAME, GST_PACKAGE_ORIGIN);

sys/bitflow/CMakeLists.txt

@@ -24,6 +24,6 @@ target_link_libraries (${libname}
   ${BITFLOW_LIBRARIES})
 
 set (pdbfile "${CMAKE_CURRENT_BINARY_DIR}/\${CMAKE_INSTALL_CONFIG_NAME}/${libname}.pdb")
-install (FILES ${pdbfile} DESTINATION lib/gstreamer-1.0)
+install (FILES ${pdbfile} DESTINATION lib/gstreamer-1.0 COMPONENT pdb)
 install(TARGETS ${libname}
   LIBRARY DESTINATION lib/gstreamer-1.0)

sys/bitflow/gstbitflowsrc.c

@@ -643,4 +643,4 @@ GST_PLUGIN_DEFINE (GST_VERSION_MAJOR,
     GST_VERSION_MINOR,
     bitflow,
     "BitFlow frame grabber source",
-    plugin_init, VERSION, "LGPL", PACKAGE_NAME, GST_PACKAGE_ORIGIN)
+    plugin_init, PACKAGE_VERSION, "LGPL", PACKAGE_NAME, GST_PACKAGE_ORIGIN)

sys/edt/CMakeLists.txt

@@ -27,6 +27,6 @@ target_link_libraries (${libname}
   ${EDT_LIBRARIES})
   
 set (pdbfile "${CMAKE_CURRENT_BINARY_DIR}/\${CMAKE_INSTALL_CONFIG_NAME}/${libname}.pdb")
-install (FILES ${pdbfile} DESTINATION lib/gstreamer-1.0)
+install (FILES ${pdbfile} DESTINATION lib/gstreamer-1.0 COMPONENT pdb)
 install(TARGETS ${libname}
   LIBRARY DESTINATION lib/gstreamer-1.0)

sys/edt/gstedt.c

@@ -31,4 +31,4 @@ GST_PLUGIN_DEFINE (GST_VERSION_MAJOR,
     GST_VERSION_MINOR,
     edt,
     "EDT PDV elements",
-    plugin_init, VERSION, "LGPL", PACKAGE_NAME, GST_PACKAGE_ORIGIN)
+    plugin_init, PACKAGE_VERSION, "LGPL", PACKAGE_NAME, GST_PACKAGE_ORIGIN)

sys/euresys/CMakeLists.txt

@@ -24,6 +24,6 @@ target_link_libraries (${libname}
   ${EURESYS_LIBRARIES})
   
 set (pdbfile "${CMAKE_CURRENT_BINARY_DIR}/\${CMAKE_INSTALL_CONFIG_NAME}/${libname}.pdb")
-install (FILES ${pdbfile} DESTINATION lib/gstreamer-1.0)
+install (FILES ${pdbfile} DESTINATION lib/gstreamer-1.0 COMPONENT pdb)
 install (TARGETS ${libname}
   LIBRARY DESTINATION lib/gstreamer-1.0)

sys/euresys/gsteuresyssrc.c

@@ -774,4 +774,4 @@ GST_PLUGIN_DEFINE (GST_VERSION_MAJOR,
     GST_VERSION_MINOR,
     euresys,
     "Euresys Multicam source",
-    plugin_init, VERSION, "LGPL", PACKAGE_NAME, GST_PACKAGE_ORIGIN)
+    plugin_init, PACKAGE_VERSION, "LGPL", PACKAGE_NAME, GST_PACKAGE_ORIGIN)

sys/idsueye/CMakeLists.txt

@@ -24,6 +24,6 @@ target_link_libraries (${libname}
   ${IDSUEYE_LIBRARIES})
 
 set (pdbfile "${CMAKE_CURRENT_BINARY_DIR}/\${CMAKE_INSTALL_CONFIG_NAME}/${libname}.pdb")
-install (FILES ${pdbfile} DESTINATION lib/gstreamer-1.0)
+install (FILES ${pdbfile} DESTINATION lib/gstreamer-1.0 COMPONENT pdb)
 install(TARGETS ${libname}
   LIBRARY DESTINATION lib/gstreamer-1.0)

sys/idsueye/gstidsueyesrc.c

@@ -747,4 +747,4 @@ GST_PLUGIN_DEFINE (GST_VERSION_MAJOR,
     GST_VERSION_MINOR,
     idsueye,
     "IDS uEye frame grabber source",
-    plugin_init, VERSION, "LGPL", PACKAGE_NAME, GST_PACKAGE_ORIGIN)
+    plugin_init, PACKAGE_VERSION, "LGPL", PACKAGE_NAME, GST_PACKAGE_ORIGIN)

sys/imperx/CMakeLists.txt

@@ -24,6 +24,6 @@ target_link_libraries (${libname}
   ${IMPERX_FLEX_LIBRARIES})
 
 set (pdbfile "${CMAKE_CURRENT_BINARY_DIR}/\${CMAKE_INSTALL_CONFIG_NAME}/${libname}.pdb")
-install (FILES ${pdbfile} DESTINATION lib/gstreamer-1.0)
+install (FILES ${pdbfile} DESTINATION lib/gstreamer-1.0 COMPONENT pdb)
 install(TARGETS ${libname}
   LIBRARY DESTINATION lib/gstreamer-1.0)

sys/imperx/gstframelinksrc.c

@@ -766,4 +766,4 @@ GST_PLUGIN_DEFINE (GST_VERSION_MAJOR,
     GST_VERSION_MINOR,
     imperx,
     "IMPERX FrameLink Express frame grabber source",
-    plugin_init, VERSION, "LGPL", PACKAGE_NAME, GST_PACKAGE_ORIGIN)
+    plugin_init, PACKAGE_VERSION, "LGPL", PACKAGE_NAME, GST_PACKAGE_ORIGIN)

sys/matrox/CMakeLists.txt

@@ -24,6 +24,6 @@ target_link_libraries (${libname}
   ${MATROX_LIBRARIES})
 
 set (pdbfile "${CMAKE_CURRENT_BINARY_DIR}/\${CMAKE_INSTALL_CONFIG_NAME}/${libname}.pdb")
-install (FILES ${pdbfile} DESTINATION lib/gstreamer-1.0)
+install (FILES ${pdbfile} DESTINATION lib/gstreamer-1.0 COMPONENT pdb)
 install(TARGETS ${libname}
   LIBRARY DESTINATION lib/gstreamer-1.0)

sys/matrox/gstmatroxsrc.c

@@ -816,4 +816,4 @@ GST_PLUGIN_DEFINE (GST_VERSION_MAJOR,
     GST_VERSION_MINOR,
     matrox,
     "Matrox Imaging Library video source",
-    plugin_init, VERSION, "LGPL", PACKAGE_NAME, GST_PACKAGE_ORIGIN)
+    plugin_init, PACKAGE_VERSION, "LGPL", PACKAGE_NAME, GST_PACKAGE_ORIGIN)

sys/niimaq/CMakeLists.txt

@@ -24,6 +24,6 @@ target_link_libraries (${libname}
   ${NIIMAQ_LIBRARIES})
   
 set (pdbfile "${CMAKE_CURRENT_BINARY_DIR}/\${CMAKE_INSTALL_CONFIG_NAME}/${libname}.pdb")
-install (FILES ${pdbfile} DESTINATION lib/gstreamer-1.0)
+install (FILES ${pdbfile} DESTINATION lib/gstreamer-1.0 COMPONENT pdb)
 install(TARGETS ${libname}
   LIBRARY DESTINATION lib/gstreamer-1.0)

sys/niimaq/gstniimaq.c

@@ -946,5 +946,5 @@ plugin_init (GstPlugin * plugin)
 }
 
 GST_PLUGIN_DEFINE (GST_VERSION_MAJOR, GST_VERSION_MINOR, niimaq,
-    "NI-IMAQ source element", plugin_init, VERSION, GST_LICENSE, PACKAGE_NAME,
+    "NI-IMAQ source element", plugin_init, PACKAGE_VERSION, GST_LICENSE, PACKAGE_NAME,
     GST_PACKAGE_ORIGIN)

sys/niimaqdx/CMakeLists.txt

@@ -29,6 +29,6 @@ target_link_libraries (${libname}
   ${NIIMAQDX_LIBRARIES})
   
 set (pdbfile "${CMAKE_CURRENT_BINARY_DIR}/\${CMAKE_INSTALL_CONFIG_NAME}/${libname}.pdb")
-install (FILES ${pdbfile} DESTINATION lib/gstreamer-1.0)
+install (FILES ${pdbfile} DESTINATION lib/gstreamer-1.0 COMPONENT pdb)
 install(TARGETS ${libname}
   LIBRARY DESTINATION lib/gstreamer-1.0)

sys/niimaqdx/gstniimaqdx.c

@@ -1255,5 +1255,5 @@ plugin_init (GstPlugin * plugin)
 }
 
 GST_PLUGIN_DEFINE (GST_VERSION_MAJOR, GST_VERSION_MINOR, niimaqdx,
-    "NI-IMAQdx source element", plugin_init, VERSION, GST_LICENSE, PACKAGE_NAME,
+    "NI-IMAQdx source element", plugin_init, PACKAGE_VERSION, GST_LICENSE, PACKAGE_NAME,
     GST_PACKAGE_ORIGIN)

sys/phoenix/CMakeLists.txt

@@ -24,6 +24,6 @@ target_link_libraries (${libname}
   ${PHOENIX_LIBRARIES})
   
 set (pdbfile "${CMAKE_CURRENT_BINARY_DIR}/\${CMAKE_INSTALL_CONFIG_NAME}/${libname}.pdb")
-install (FILES ${pdbfile} DESTINATION lib/gstreamer-1.0)
+install (FILES ${pdbfile} DESTINATION lib/gstreamer-1.0 COMPONENT pdb)
 install(TARGETS ${libname}
   LIBRARY DESTINATION lib/gstreamer-1.0)

sys/phoenix/gstphoenixsrc.c

@@ -905,4 +905,4 @@ GST_PLUGIN_DEFINE (GST_VERSION_MAJOR,
     GST_VERSION_MINOR,
     phoenix,
     "Phoenix frame grabber source",
-    plugin_init, VERSION, "LGPL", PACKAGE_NAME, GST_PACKAGE_ORIGIN)
+    plugin_init, PACKAGE_VERSION, "LGPL", PACKAGE_NAME, GST_PACKAGE_ORIGIN)

sys/pixci/CMakeLists.txt

@@ -24,6 +24,6 @@ target_link_libraries (${libname}
   ${XCLIB_LIBRARIES})
   
 set (pdbfile "${CMAKE_CURRENT_BINARY_DIR}/\${CMAKE_INSTALL_CONFIG_NAME}/${libname}.pdb")
-install (FILES ${pdbfile} DESTINATION lib/gstreamer-1.0)
+install (FILES ${pdbfile} DESTINATION lib/gstreamer-1.0 COMPONENT pdb)
 install(TARGETS ${libname}
   LIBRARY DESTINATION lib/gstreamer-1.0)

sys/pixci/gstpixcisrc.c

@@ -784,4 +784,4 @@ GST_PLUGIN_DEFINE (GST_VERSION_MAJOR,
     GST_VERSION_MINOR,
     pixci,
     "Pixci frame grabber source",
-    plugin_init, VERSION, "LGPL", PACKAGE_NAME, GST_PACKAGE_ORIGIN)
+    plugin_init, PACKAGE_VERSION, "LGPL", PACKAGE_NAME, GST_PACKAGE_ORIGIN)

sys/sapera/CMakeLists.txt

@@ -24,6 +24,6 @@ target_link_libraries (${libname}
   ${SAPERA_LIBRARIES})
 
 set (pdbfile "${CMAKE_CURRENT_BINARY_DIR}/\${CMAKE_INSTALL_CONFIG_NAME}/${libname}.pdb")
-install (FILES ${pdbfile} DESTINATION lib/gstreamer-1.0)
+install (FILES ${pdbfile} DESTINATION lib/gstreamer-1.0 COMPONENT pdb)
 install(TARGETS ${libname}
   LIBRARY DESTINATION lib/gstreamer-1.0)

sys/sapera/gstsaperasrc.cpp

@@ -768,4 +768,4 @@ GST_PLUGIN_DEFINE (GST_VERSION_MAJOR,
     GST_VERSION_MINOR,
     sapera,
     "Teledyne DALSA Sapera frame grabber source",
-    plugin_init, VERSION, "LGPL", PACKAGE_NAME, GST_PACKAGE_ORIGIN)
+    plugin_init, PACKAGE_VERSION, "LGPL", PACKAGE_NAME, GST_PACKAGE_ORIGIN)