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

[macOS] v0.2.1 can't process audio files, generating resource packs with missing audio #13

Closed
AlexTMjugador opened this issue Apr 6, 2021 · 1 comment
Assignees
Labels
bug Something isn't working

Comments

@AlexTMjugador
Copy link
Member

AlexTMjugador commented Apr 6, 2021

Describe the bug
Due to how the pitch shifting feature was added in PackSquash v0.2.1, users of the macOS version of PackSquash that try to squash resource packs with audio files will note that PackSquash shows an error for every audio file, and generates resource packs with missing sounds.

To reproduce

  1. Download or create a valid resource pack with sound files.
  2. Optimize it with PackSquash, using the default settings.
  3. Observe that the optimized resource pack that PackSquash generates misses all the sounds.

Expected behavior
The sound files should be processed and included in the result like any other file.

Additional context
The root cause of this issue is that PackSquash always tries to perform pitch shifting on audio files, and the library that is used for it isn't included in the macOS Homebrew package of the bad GStreamer plugin collection, where it should belong.

This bug has not been discovered before because, as stated in the installation guide:

Note that PackSquash macOS support is limited to a best-effort: it is known to build successfully, but it has not actually been run on the computer of a repository maintainer.

However, WIP builds of PackSquash v0.3.0 added unit tests that actually run in a GitHub Actions macOS environment and showed the problem. macOS support continues to be in a best-effort basis, though.

Workarounds

  • Temporarily downgrade PackSquash to v0.2.0 until v0.3.0 is released, as that older version doesn't have the pitch shifting feature and doesn't depend on the problematic GStreamer plugin. v0.3.0 will include a fix for this (see below).
  • Use another operating system with PackSquash. You can use a virtual machine if you prefer.
  • Only use OGG audio files in your resource pack, and then set the transcode_ogg setting to false. This way PackSquash will just copy your OGG files as-is, without any GStreamer involvement, but you'll lose any optimizations or features that PackSquash offers for audio files.

Fix
v0.3.0 will fix this issue by only using the problematic plugin when pitch shifting is actually requested, not always. Therefore, macOS users will be able to use PackSquash as normal for the most part. They still won't be able to use the pitch shifting feature, but that's an upstream problem, and there's not much that PackSquash can do about it, because that plugin is the only viable way to implement this feature.

If you use macOS and have the time and know-how, you can contribute fixes upstream to include SoundTouch in the GStreamer bad plugins Homebrew package, which would inmediately fix these issues after upgrading the Homebrew package.

@AlexTMjugador AlexTMjugador added the bug Something isn't working label Apr 6, 2021
@AlexTMjugador AlexTMjugador added this to the PackSquash v0.3.0 milestone Apr 6, 2021
@AlexTMjugador AlexTMjugador self-assigned this Apr 6, 2021
@AlexTMjugador AlexTMjugador pinned this issue Apr 6, 2021
@AlexTMjugador AlexTMjugador changed the title macOS - v0.2.1 can't process audio files, generating resource packs with missing audio [macOS] v0.2.1 can't process audio files, generating resource packs with missing audio Apr 6, 2021
@AlexTMjugador
Copy link
Member Author

v0.3.0-rc.1 (a public pre-release for v0.3.0, the version that fixes this issue) is complete and will be available to download in some minutes, so I'm closing this.

@AlexTMjugador AlexTMjugador unpinned this issue Jul 8, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
Development

No branches or pull requests

1 participant