eclass/gstreamer.eclass

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