Support alsa plugins for sound using pulseaudio/alsa-lib #2984
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,57 @@ | ||
| # Copyright Spack Project Developers. See COPYRIGHT file for details. | ||
| # | ||
| # SPDX-License-Identifier: (Apache-2.0 OR MIT) | ||
|
|
||
| import os | ||
|
|
||
| from spack_repo.builtin.build_systems.autotools import AutotoolsPackage | ||
|
|
||
| from spack.package import * | ||
|
|
||
|
|
||
| class AlsaPlugins(AutotoolsPackage): | ||
| """The ALSA Plugins package contains plugins for various audio libraries and sound servers.""" | ||
|
|
||
| homepage = "https://github.com/alsa-project/alsa-plugins" | ||
| url = "https://github.com/alsa-project/alsa-plugins" | ||
| git = "https://github.com/alsa-project/alsa-plugins" | ||
|
|
||
| # notify when the package is updated. | ||
| maintainers("biddisco") | ||
|
|
||
| license("LGPL-2.1-or-later", checked_by="biddisco") | ||
|
|
||
| version("1.2.12", tag="v1.2.12", commit="52574cb5ccbb8b546df2759e4b341a20332269b6") | ||
|
Contributor
There was a problem hiding this comment. Same question here about using a git tag instead of a download. |
||
|
|
||
| depends_on("c", type="build") | ||
| depends_on("autoconf", type="build") | ||
| depends_on("automake", type="build") | ||
| depends_on("libtool", type="build") | ||
|
|
||
| depends_on("alsa-lib") | ||
| depends_on("pulseaudio +alsa", when="+pulseaudio") | ||
|
|
||
| variant("pulseaudio", default=True, description="Enable pulseaudio support") | ||
|
Contributor
There was a problem hiding this comment. Often it is easier to set the default as False, except for really indispensable functionality. |
||
|
|
||
| conflicts("platform=darwin", msg="ALSA (+plugins) only works for Linux") | ||
|
|
||
| def configure_args(self): | ||
| args = [] | ||
| if "+pulseaudio" in self.spec: | ||
| args.append("--enable-pulseaudio") | ||
|
Contributor
There was a problem hiding this comment. Suggestion to use
Contributor
There was a problem hiding this comment. |
||
| return args | ||
|
|
||
| def setup_build_environment(self, env): | ||
| env.prepend_path("PKG_CONFIG_PATH", self.spec["alsa-lib"].prefix.lib64.pkgconfig) | ||
|
Contributor
There was a problem hiding this comment. Surprised that this is necessary. Normally this should be found automatically. Any reason you could identify for why it isn't? |
||
|
|
||
| def setup_run_environment(self, env): | ||
| # 1. ALSA plugin directory | ||
| alsa_plugin_dir = os.path.join(self.prefix.lib, "alsa-lib") | ||
| if os.path.exists(alsa_plugin_dir): | ||
| env.prepend_path("ALSA_PLUGIN_DIR", alsa_plugin_dir) | ||
|
|
||
| # 2. PulseAudio libraries (needed for dlopen dependencies) | ||
| if "pulseaudio" in self.spec: | ||
| pulseaudio_libdir = os.path.join(self.spec["pulseaudio"].prefix.lib64, "pulseaudio") | ||
| if os.path.exists(pulseaudio_libdir): | ||
| env.prepend_path("LD_LIBRARY_PATH", pulseaudio_libdir) | ||
|
Contributor
There was a problem hiding this comment. Is there no other variable that can be used and that alsa respects? LD_LIBRARY_PATH is a big hammer and this can lead to significant side effects (even though they are mitigated here by adding |
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -2,12 +2,15 @@ | |
| # | ||
| # SPDX-License-Identifier: (Apache-2.0 OR MIT) | ||
|
|
||
| import os | ||
|
|
||
| from spack_repo.builtin.build_systems.autotools import AutotoolsPackage | ||
| from spack_repo.builtin.build_systems.meson import MesonPackage | ||
|
|
||
| from spack.package import * | ||
|
|
||
|
|
||
| class Pulseaudio(AutotoolsPackage, MesonPackage): | ||
| """PulseAudio is a sound system for POSIX OSes, meaning that it is a proxy | ||
| for your sound applications. | ||
|
|
||
|
|
@@ -19,10 +22,15 @@ class Pulseaudio(AutotoolsPackage): | |
| achieved using a sound server.""" | ||
|
|
||
| homepage = "https://www.freedesktop.org/wiki/Software/PulseAudio/" | ||
| url = "https://freedesktop.org/software/pulseaudio/releases/pulseaudio-17.0.tar.xz" | ||
|
|
||
| license("LGPL-2.1-or-later") | ||
|
|
||
| build_system( | ||
| conditional("autotools", when="@:16"), conditional("meson", when="@17:"), default="meson" | ||
| ) | ||
|
|
||
| version("17.0", sha256="053794d6671a3e397d849e478a80b82a63cb9d8ca296bd35b73317bb5ceb87b5") | ||
| version("13.0", sha256="961b23ca1acfd28f2bc87414c27bb40e12436efcf2158d29721b1e89f3f28057") | ||
|
|
||
| variant("alsa", default=False, description="alsa support") | ||
|
|
@@ -32,6 +40,13 @@ class Pulseaudio(AutotoolsPackage): | |
|
|
||
| depends_on("c", type="build") # generated | ||
| depends_on("cxx", type="build") # generated | ||
| with when("build_system=autotools"): | ||
| depends_on("autoconf", type="build") | ||
| depends_on("automake", type="build") | ||
| depends_on("libtool", type="build") | ||
| with when("build_system=meson"): | ||
| depends_on("meson", type="build") | ||
| depends_on("gettext", type="build") | ||
|
|
||
| depends_on("[email protected]:", when="+alsa") | ||
| depends_on("[email protected]:") | ||
|
|
@@ -58,6 +73,9 @@ class Pulseaudio(AutotoolsPackage): | |
| depends_on("[email protected]:") | ||
| depends_on("m4", type="build") | ||
|
|
||
| # if spec.satisfies("%gcc@8:"): | ||
| os.environ["LDFLAGS"] = "-Wl,--copy-dt-needed-entries" | ||
|
Contributor
There was a problem hiding this comment. This is not canonical in spack. Modifications to the environment are not intended to leak outside the spack invocation (this does), and we have |
||
|
|
||
| def configure_args(self): | ||
|
Contributor
There was a problem hiding this comment. It is safer to add the configure_args and meson_args to separate builders, e.g. |
||
| args = [ | ||
| "--disable-systemd-daemon", | ||
|
|
@@ -71,8 +89,8 @@ def configure_args(self): | |
| "--with-systemduserunitdir=no", | ||
| "CPPFLAGS={0}".format(self.spec["libtool"].headers.cpp_flags), | ||
| "LDFLAGS={0}".format(self.spec["libtool"].libs.search_flags), | ||
| "--libdir={0}".format(self.prefix.lib64), | ||
| ] | ||
| # toggle based on variants | ||
| args += self.enable_or_disable("alsa") | ||
| args += self.enable_or_disable("openssl") | ||
|
|
@@ -97,3 +115,36 @@ def configure_args(self): | |
| ) | ||
|
|
||
| return args | ||
|
|
||
| def meson_args(self): | ||
| return [ | ||
| "-Ddatabase=gdbm", | ||
| "-Ddoxygen=false", | ||
| "-Dbluez5=disabled", | ||
| "-Dx11=disabled", | ||
| "-Dtests=false", | ||
| "-Ddefault_library=shared", | ||
| "-Dprefix={0}".format(self.prefix), | ||
| "-Dlibdir={0}/lib64".format(self.prefix), | ||
| "-Dbashcompletiondir={0}/share/bash-completion/completions".format(self.prefix), | ||
| "-Dsystemduserunitdir={0}/lib/systemd/user".format(self.prefix), | ||
| ] | ||
|
Comment on lines
+120
to
+131
Contributor
There was a problem hiding this comment. We typically try to make sure that two build systems of the same package at least in spirit behave the same way. In the case of configure, you have enable dbus and glib2, but that's not explicitly added for meson. Can you verify that? |
||
|
|
||
| def setup_build_environment(self, env): | ||
| if self.spec.satisfies("build_system=meson"): | ||
| env.append_flags("CPPFLAGS", "-I{0}".format(self.spec["libiconv"].prefix.include)) | ||
|
Contributor
There was a problem hiding this comment. Should this be CXXFLAGS? CPP is for the preprocessor. I am also surprised these are necessary if you depend on libiconv. Why does the build not find the right include directory? |
||
| env.append_flags("LDFLAGS", "-L{0} -liconv".format(self.spec["libiconv"].prefix.lib)) | ||
|
|
||
| def setup_run_environment(self, env): | ||
| # Always add ALSA plugin directory | ||
| env.prepend_path("ALSA_PLUGIN_DIR", join_path(self.prefix.lib, "alsa-lib")) | ||
|
|
||
| # If pulseaudio is in the spec, make sure its libraries are on the runtime linker path | ||
| if self.spec.satisfies("^pulseaudio"): | ||
| # 1️⃣ Standard lib64 dir | ||
|
Contributor
There was a problem hiding this comment. Try to stick to regular ascii charsets. |
||
| env.prepend_path("LD_LIBRARY_PATH", self.spec["pulseaudio"].prefix.lib64) | ||
|
|
||
| # 2️⃣ Also check for a pulseaudio subdirectory (some builds install here) | ||
| pulseaudio_libdir = join_path(self.spec["pulseaudio"].prefix.lib64, "pulseaudio") | ||
| if os.path.exists(pulseaudio_libdir): | ||
| env.prepend_path("LD_LIBRARY_PATH", pulseaudio_libdir) | ||
|
Contributor
There was a problem hiding this comment. Same comment as earlier about LD_LIBRARY_PATH. |
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just as an FYI, it is not necessary to update the
urleach time a new version is added. Spack determines this from older urls automatically.