eclass/gstreamer.eclass

   1 # Copyright 1999-2020 Gentoo Authors
   2 # Distributed under the terms of the GNU General Public License v2
   3
   4 # @ECLASS: gstreamer.eclass
   5 # @MAINTAINER:
   6 # gstreamer@gentoo.org
   7 # @AUTHOR:
   8 # Michał Górny <mgorny@gentoo.org>
   9 # Gilles Dartiguelongue <eva@gentoo.org>
  10 # Saleem Abdulrasool <compnerd@gentoo.org>
  11 # foser <foser@gentoo.org>
  12 # zaheerm <zaheerm@gentoo.org>
  13 # @SUPPORTED_EAPIS: 5 6
  14 # @BLURB: Helps building core & split gstreamer plugins.
  15 # @DESCRIPTION:
  16 # Eclass to make external gst-plugins emergable on a per-plugin basis
  17 # and to solve the problem with gst-plugins generating far too much
  18 # unneeded dependencies.
  19 #
  20 # GStreamer consuming applications should depend on the specific plugins
  21 # they need as defined in their source code. Usually you can find that
  22 # out by grepping the source tree for 'factory_make'. If it uses playbin
  23 # plugin, consider adding media-plugins/gst-plugins-meta dependency, but
  24 # also list any packages that provide explicitly requested plugins.
  25
  26 inherit eutils ltprune multilib multilib-minimal toolchain-funcs versionator xdg-utils
  27
  28 case "${EAPI:-0}" in
  29         5|6)
  30                 ;;
  31         0|1|2|3|4)
  32                 die "EAPI=\"${EAPI:-0}\" is not supported anymore"
  33                 ;;
  34         *)
  35                 die "EAPI=\"${EAPI}\" is not supported yet"
  36                 ;;
  37 esac
  38
  39 # @ECLASS-VARIABLE: GST_PLUGINS_BUILD
  40 # @DESCRIPTION:
  41 # Defines the plugins to be built.
  42 # May be set by an ebuild and contain more than one indentifier, space
  43 # seperated (only src_configure can handle mutiple plugins at this time).
  44 : ${GST_PLUGINS_BUILD:=${PN/gst-plugins-/}}
  45
  46 # @ECLASS-VARIABLE: GST_PLUGINS_BUILD_DIR
  47 # @DESCRIPTION:
  48 # Actual build directory of the plugin.
  49 # Most often the same as the configure switch name.
  50 : ${GST_PLUGINS_BUILD_DIR:=${PN/gst-plugins-/}}
  51
  52 # @ECLASS-VARIABLE: GST_TARBALL_SUFFIX
  53 # @DESCRIPTION:
  54 # Most projects hosted on gstreamer.freedesktop.org mirrors provide
  55 # tarballs as tar.bz2 or tar.xz. This eclass defaults to xz. This is
  56 # because the gstreamer mirrors are moving to only have xz tarballs for
  57 # new releases.
  58 : ${GST_TARBALL_SUFFIX:="xz"}
  59
  60 # Even though xz-utils are in @system, they must still be added to DEPEND; see
  61 # https://archives.gentoo.org/gentoo-dev/msg_a0d4833eb314d1be5d5802a3b710e0a4.xml
  62 if [[ ${GST_TARBALL_SUFFIX} == "xz" ]]; then
  63         DEPEND="${DEPEND} app-arch/xz-utils"
  64 fi
  65
  66 # @ECLASS-VARIABLE: GST_ORG_MODULE
  67 # @DESCRIPTION:
  68 # Name of the module as hosted on gstreamer.freedesktop.org mirrors.
  69 # Leave unset if package name matches module name.
  70 : ${GST_ORG_MODULE:=$PN}
  71
  72 # @ECLASS-VARIABLE: GST_ORG_PVP
  73 # @INTERNAL
  74 # @DESCRIPTION:
  75 # Major and minor numbers of the version number.
  76 : ${GST_ORG_PVP:=$(get_version_component_range 1-2)}
  77
  78
  79 DESCRIPTION="${BUILD_GST_PLUGINS} plugin for gstreamer"
  80 HOMEPAGE="https://gstreamer.freedesktop.org/"
  81 SRC_URI="https://gstreamer.freedesktop.org/src/${GST_ORG_MODULE}/${GST_ORG_MODULE}-${PV}.tar.${GST_TARBALL_SUFFIX}"
  82
  83 LICENSE="GPL-2"
  84 case ${GST_ORG_PVP} in
  85         0.10) SLOT="0.10"; GST_MIN_PV="0.10.36-r2" ;;
  86         1.*) SLOT="1.0"; GST_MIN_PV="1.2.4-r1" ;;
  87         *) die "Unkown gstreamer release."
  88 esac
  89
  90 S="${WORKDIR}/${GST_ORG_MODULE}-${PV}"
  91
  92 RDEPEND="
  93         >=dev-libs/glib-2.38.2-r1:2[${MULTILIB_USEDEP}]
  94         >=media-libs/gstreamer-${GST_MIN_PV}:${SLOT}[${MULTILIB_USEDEP}]
  95 "
  96 DEPEND="
  97         >=sys-apps/sed-4
  98         >=virtual/pkgconfig-0-r1[${MULTILIB_USEDEP}]
  99 "
 100
 101 # Export common multilib phases.
 102 multilib_src_configure() { gstreamer_multilib_src_configure; }
 103
 104 if [[ ${PN} != ${GST_ORG_MODULE} ]]; then
 105         # Do not run test phase for invididual plugin ebuilds.
 106         RESTRICT="test"
 107         RDEPEND="${RDEPEND}
 108                 >=media-libs/${GST_ORG_MODULE}-${PV}:${SLOT}[${MULTILIB_USEDEP}]"
 109
 110         # Export multilib phases used for split builds.
 111         multilib_src_compile() { gstreamer_multilib_src_compile; }
 112         multilib_src_install() { gstreamer_multilib_src_install; }
 113         multilib_src_install_all() { gstreamer_multilib_src_install_all; }
 114 else
 115         IUSE="nls"
 116         DEPEND="${DEPEND} nls? ( >=sys-devel/gettext-0.17 )"
 117 fi
 118
 119 DEPEND="${DEPEND} ${RDEPEND}"
 120
 121 # @FUNCTION: gstreamer_environment_reset
 122 # @INTERNAL
 123 # @DESCRIPTION:
 124 # Clean up environment for clean builds.
 125 # >=dev-lang/orc-0.4.23 rely on environment variables to find a place to
 126 # allocate files to mmap.
 127 gstreamer_environment_reset() {
 128         xdg_environment_reset
 129 }
 130
 131 # @FUNCTION: gstreamer_get_plugins
 132 # @INTERNAL
 133 # @DESCRIPTION:
 134 # Get the list of plugins requiring external dependencies.
 135 gstreamer_get_plugins() {
 136         # Must be called from src_prepare/src_configure
 137         GST_PLUGINS_LIST=$(sed -rn 's/^AG_GST_CHECK_FEATURE\((\w+),.*/ \1 /p' \
 138                 "${ECONF_SOURCE:-${S}}"/configure.* | LC_ALL='C' tr '[:upper:]' '[:lower:]')
 139 }
 140
 141 # @FUNCTION: gstreamer_get_plugin_dir
 142 # @USAGE: [build_dir]
 143 # @INTERNAL
 144 # @DESCRIPTION:
 145 # Finds plugin build directory and output it.
 146 # Defaults to ${GST_PLUGINS_BUILD_DIR} if argument is not provided
 147 gstreamer_get_plugin_dir() {
 148         local build_dir=${1:-${GST_PLUGINS_BUILD_DIR}}
 149
 150         if [[ ! -d ${S}/ext/${build_dir} ]]; then
 151                 if [[ ! -d ${S}/sys/${build_dir} ]]; then
 152                         ewarn "No such plugin directory"
 153                         die
 154                 fi
 155                 einfo "Building system plugin in ${build_dir}..." >&2
 156                 echo sys/${build_dir}
 157         else
 158                 einfo "Building external plugin in ${build_dir}..." >&2
 159                 echo ext/${build_dir}
 160         fi
 161 }
 162
 163 # @FUNCTION: gstreamer_system_link
 164 # @USAGE: <gst-libs/gst/audio:gstreamer-audio> [...]
 165 # @DESCRIPTION:
 166 # Walks through makefiles in order to make sure build will link against system
 167 # libraries.
 168 # Takes a list of path fragments and corresponding pkgconfig libraries
 169 # separated by colon (:). Will replace the path fragment by the output of
 170 # pkgconfig.
 171 gstreamer_system_link() {
 172         local pdir directory libs pkgconfig pc tuple
 173         pkgconfig=$(tc-getPKG_CONFIG)
 174
 175         for plugin_dir in ${GST_PLUGINS_BUILD_DIR} ; do
 176                 pdir=$(gstreamer_get_plugin_dir ${plugin_dir})
 177
 178                 for tuple in $@ ; do
 179                         directory=${tuple%:*}
 180                         pc=${tuple#*:}-${SLOT}
 181                         libs="$(${pkgconfig} --libs-only-l ${pc} || die)"
 182                         sed -e "s:\$(top_builddir)/${directory}/.*\.la:${libs}:" \
 183                                 -i "${pdir}"/Makefile.{am,in} || die
 184                 done
 185         done
 186 }
 187
 188 # @FUNCTION: gstreamer_multilib_src_configure
 189 # @DESCRIPTION:
 190 # Handles logic common to configuring gstreamer plugins
 191 gstreamer_multilib_src_configure() {
 192         local plugin gst_conf=() ECONF_SOURCE=${ECONF_SOURCE:-${S}}
 193
 194         gstreamer_get_plugins
 195         gstreamer_environment_reset
 196
 197         for plugin in ${GST_PLUGINS_LIST} ; do
 198                 if has ${plugin} ${GST_PLUGINS_BUILD} ; then
 199                         gst_conf+=( --enable-${plugin} )
 200                 else
 201                         gst_conf+=( --disable-${plugin} )
 202                 fi
 203         done
 204
 205         if grep -q "ORC_CHECK" "${ECONF_SOURCE}"/configure.* ; then
 206                 if in_iuse orc ; then
 207                         gst_conf+=( $(use_enable orc) )
 208                 else
 209                         gst_conf+=( --disable-orc )
 210                 fi
 211         fi
 212
 213         if grep -q "AM_MAINTAINER_MODE" "${ECONF_SOURCE}"/configure.* ; then
 214                 gst_conf+=( --disable-maintainer-mode )
 215         fi
 216
 217         if grep -q "disable-schemas-compile" "${ECONF_SOURCE}"/configure ; then
 218                 gst_conf+=( --disable-schemas-compile )
 219         fi
 220
 221         if [[ ${PN} == ${GST_ORG_MODULE} ]]; then
 222                 gst_conf+=( $(use_enable nls) )
 223         fi
 224
 225         einfo "Configuring to build ${GST_PLUGINS_BUILD} plugin(s) ..."
 226         econf \
 227                 --with-package-name="Gentoo GStreamer ebuild" \
 228                 --with-package-origin="https://www.gentoo.org" \
 229                 "${gst_conf[@]}" "${@}"
 230 }
 231
 232 # @FUNCTION: gstreamer_multilib_src_compile
 233 # @DESCRIPTION:
 234 # Compiles requested gstreamer plugin.
 235 gstreamer_multilib_src_compile() {
 236         local plugin_dir
 237
 238         for plugin_dir in ${GST_PLUGINS_BUILD_DIR} ; do
 239                 emake -C "$(gstreamer_get_plugin_dir ${plugin_dir})"
 240         done
 241 }
 242
 243 # @FUNCTION: gstreamer_multilib_src_install
 244 # @DESCRIPTION:
 245 # Installs requested gstreamer plugin.
 246 gstreamer_multilib_src_install() {
 247         local plugin_dir
 248
 249         for plugin_dir in ${GST_PLUGINS_BUILD_DIR} ; do
 250                 emake -C "$(gstreamer_get_plugin_dir ${plugin_dir})" \
 251                         DESTDIR="${D}" install
 252         done
 253 }
 254
 255 # @FUNCTION: gstreamer_multilib_src_install_all
 256 # @DESCRIPTION:
 257 # Installs documentation for requested gstreamer plugin, and removes .la
 258 # files.
 259 gstreamer_multilib_src_install_all() {
 260         local plugin_dir
 261
 262         for plugin_dir in ${GST_PLUGINS_BUILD_DIR} ; do
 263                 local dir=$(gstreamer_get_plugin_dir ${plugin_dir})
 264                 [[ -e ${dir}/README ]] && dodoc "${dir}"/README
 265         done
 266
 267         prune_libtool_files --modules
 268 }