Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make gdk-pixbuf support avif #102189

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Make gdk-pixbuf support avif #102189

wants to merge 3 commits into from

Conversation

@mkg20001
Copy link
Member

@mkg20001 mkg20001 commented Oct 30, 2020

Motivation for this change

Staying up-to-date with technical progress

Things done
  • Tested using sandboxing (nix.useSandbox on NixOS, or option sandbox in nix.conf on non-NixOS linux)
  • Built on platform(s)
    • NixOS
    • macOS
    • other Linux distributions
  • Tested via one or more NixOS test(s) if existing and applicable for the change (look inside nixos/tests)
  • Tested compilation of all pkgs that depend on this change using nix-shell -p nixpkgs-review --run "nixpkgs-review wip"
  • Tested execution of all binary files (usually in ./result/bin/)
  • Determined the impact on package closure size (by running nix path-info -S before and after)
  • Ensured that relevant documentation is up to date
  • Fits CONTRIBUTING.md.
@mkg20001
Copy link
Member Author

@mkg20001 mkg20001 commented Oct 30, 2020

Build fails as it tries to copy to ${GDK_PIXBUF_MODULEDIR} which is inside the pixbuf package

Which directory should it store the loader in?

@mkg20001
Copy link
Member Author

@mkg20001 mkg20001 commented Oct 30, 2020

Also should libavif be propagated in any way so that it's automatically "just there"? Adding it to gdk-pixbuf causes infinite recursion, since that's a dep of libavif

@SuperSandro2000
Copy link
Member

@SuperSandro2000 SuperSandro2000 commented Oct 30, 2020

Also should libavif be propagated in any way so that it's automatically "just there"? Adding it to gdk-pixbuf causes infinite recursion, since that's a dep of libavif

This should be detected automatically if a so is linked against it. If this does not happen add it to propagatedBuildInputs.

Build fails as it tries to copy to ${GDK_PIXBUF_MODULEDIR} which is inside the pixbuf package

You can replace that path with ${gdk-pixbuf}/some/path.

Which directory should it store the loader in?

It should be copied to $out. I am not sure where it lives under systems like Debian but /var/share should be $out/share.

@mkg20001
Copy link
Member Author

@mkg20001 mkg20001 commented Oct 30, 2020

We're building libavif here, we can't write to gdk-pixbuf because that's already built

Or are you saying I'm supposed to build the loader in gdk-pixbuf?

@SuperSandro2000
Copy link
Member

@SuperSandro2000 SuperSandro2000 commented Oct 30, 2020

We're building libavif here, we can't write to gdk-pixbuf because that's already built

Than I was misunderstanding you. Sorry.

Or are you saying I'm supposed to build the loader in gdk-pixbuf?

I am not sure. I am not very familiar with this library. A third option would be to add another package and build it there.

@jtojnar
Copy link
Contributor

@jtojnar jtojnar commented Oct 31, 2020

You can change the path using environment variable:

PKG_CONFIG_GDK_PIXBUF_2_0_GDK_PIXBUF_MODULEDIR = "${placeholder "out"}/${gdk-pixbuf.moduleDir}";

But loading will still be a problem, see the docs in https://github.com/NixOS/nixpkgs/pull/101537/files

@mkg20001
Copy link
Member Author

@mkg20001 mkg20001 commented Oct 31, 2020

<package>gdk-pixbuf</package> setup hook will populate <envar>GDK_PIXBUF_MODULE_FILE</envar> with the path to biggest <filename>loaders.cache</filename> file from the dependencies containing <link xlink:href="ssec-gnome-gdk-pixbuf-loaders">GdkPixbuf loaders</link>.

WHAT THE FUCK? That's like counting corona cases based on the weight of the paper.

Isn't there some method to merge all the loader caches?

@jtojnar
Copy link
Contributor

@jtojnar jtojnar commented Oct 31, 2020

Sure, the docs mention the module

# Generate the cache file by running gdk-pixbuf-query-loaders for each
# package and concatenating the results.
loadersCache = pkgs.runCommand "gdk-pixbuf-loaders.cache" { preferLocalBuild = true; } ''
(
for package in ${concatStringsSep " " effectivePackages}; do
module_dir="$package/${pkgs.gdk-pixbuf.moduleDir}"
if [[ ! -d $module_dir ]]; then
echo "Warning (services.xserver.gdk-pixbuf): missing module directory $module_dir" 1>&2
continue
fi
GDK_PIXBUF_MODULEDIR="$module_dir" \
${pkgs.stdenv.hostPlatform.emulator pkgs.buildPackages} ${pkgs.gdk-pixbuf.dev}/bin/gdk-pixbuf-query-loaders
done
) > "$out"
'';
, we would need to make wrapGAppsHook do that and include the cache file in each derivation using wrapGAppsHook.

@mkg20001
Copy link
Member Author

@mkg20001 mkg20001 commented Nov 2, 2020

Setting services.xserver.gdk-pixbuf.modulePackages = with pkgs; [ libavif ]; should be enough to get it working, right?

What is the cache then used for in the package itself?

Why should we have both? (cache in package and generated cache per nixOS options)

@jtojnar
Copy link
Contributor

@jtojnar jtojnar commented Nov 2, 2020

Setting services.xserver.gdk-pixbuf.modulePackages = with pkgs; [ libavif ]; should be enough to get it working, right?

No, packages using wrapGAppsHook will override the environment variable so they will not see it.

What is the cache then used for in the package itself?

The environment variable is set in the wrapper to make it more hermetic. Images would not work otherwise on systems that do not set the environment variable globally.

Why should we have both? (cache in package and generated cache per nixOS options)

I do not think we should have the NixOS option but some people disagree. Edit: #42562

@mkg20001
Copy link
Member Author

@mkg20001 mkg20001 commented Nov 2, 2020

I see gdk-pixbuf modules from the prespective of a nixOS user installing avif support (for ex) globally, so that the file-manager can render thumbnails.

Having it per package makes it weird for the edge case that there's multiple cache files in the system.

Setting the loaders cache by default with wrapGAppsHook doesn't make too much sense if no extra loaders are included, assuming default ones always loaded.

It could be changed so that only packages that have a hard-requirement on specific loaders have their own cache shipped that doesn't interfere with the global configuration.

@jtojnar
Copy link
Contributor

@jtojnar jtojnar commented Nov 2, 2020

I see gdk-pixbuf modules from the prespective of a nixOS user installing avif support (for ex) globally, so that the file-manager can render thumbnails.

Yeah, this is hard.

Having it per package makes it weird for the edge case that there's multiple cache files in the system.

🤷‍♀️

Setting the loaders cache by default with wrapGAppsHook doesn't make too much sense if no extra loaders are included, assuming default ones always loaded.

We are loading the librsvg wrapper, which all GTK apps need to render window close button and other icons.

It could be changed so that only packages that have a hard-requirement on specific loaders have their own cache shipped that doesn't interfere with the global configuration.

🤷‍♀️

Also with global flag you get delightful bugs like #54278 and #60254.

pkgs/development/libraries/libavif/default.nix Outdated Show resolved Hide resolved
pkgs/development/libraries/libavif/default.nix Outdated Show resolved Hide resolved
@@ -0,0 +1,5 @@
[Thumbnailer Entry]
TryExec=@bindir@/gdk-pixbuf-thumbnailer
Exec=@bindir@/gdk-pixbuf-thumbnailer -s %s %u %o
Copy link
Contributor

@jtojnar jtojnar Nov 2, 2020

As discussed on IRC, you will need to generate a loaders.cache file and pass it to the program through environment.

@@ -22,11 +23,14 @@ stdenv.mkDerivation rec {

# reco: encode libaom slowest but best, decode dav1d fastest

PKG_CONFIG_GDK_PIXBUF_2_0_GDK_PIXBUF_MODULEDIR = "${placeholder "gdkPixbufLoader"}/${gdk-pixbuf.moduleDir}";
Copy link
Contributor

@jtojnar jtojnar Nov 2, 2020

Environment variables typically go down, but this expression is already a bit lopsided.

Co-authored-by: Jan Tojnar <jtojnar@gmail.com>
@SuperSandro2000
Copy link
Member

@SuperSandro2000 SuperSandro2000 commented Jan 18, 2021

@mkg20001 ping

@stale
Copy link

@stale stale bot commented Jul 21, 2021

I marked this as stale due to inactivity. → More info

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

3 participants