Skip to content

andreacfromtheapp/freesound-credits

Freesound credits

A command line utility to help you credit Freesound samples for a given project more easily.

Commitlint Trufflehog CI CD Release Crates.io License: Apache-2.0

Rationale

Giving credits in the Creative Commons community is often the sole requirement to freely use samples in your creations. This tool helps you abide to Copyleft and credit the generous artists whom contribute to Freesound, helping your creativity.

Giving credits may have been a cumbersome and tedious process you begrudged. This may have been stopping you from giving credits altogether. Not anymore!

Thanks to freesound-credits it takes seconds now! Read on for instructions.

Install

Note

Currently the latest crates.io and releases tags do not match due to a cargo dist bug. Once this is solved upstream, I will publish the refactored code and release version 1.0 as I'm pretty happy with the new codebase maturity and feature-wise.

For the time being GitHub builds fail while crates.io has the latest tag. This mismatch makes installing with cargo and homebrew fail. However, no functionality is lost. Newer tags only comprised minor changes and Dependabot merges. You can keep using whatever release you already have or download from the release page.

Once version 1.0 is released, all things will be back to normal. Apologies.

Releases

All currently available builds for Linux, macOS, and Windows, are available on the releases page

Cargo

Use cargo binstall to install freesound-credits directly from GitHub:

cargo binstall freesound-credits

To compile freesound-credits from source, run:

cargo install freesound-credits

Homebrew

On Linux and macOS homebrew is also available:

brew install andreacfromtheapp/tap/freesound-credits

Usage

The command line comes with a straight-forward usage function:

freesound-credits -h

Usage example

  1. open your favorite terminal.
  2. cd to the folder where you want to save the credits file.
  3. run freesound-credits on your desired samples folder.
  4. if necessary, use the absolute path to the samples folder.

Ableton Example

Running against an Ableton Samples/Imported directory, will generate a markdown file named field-notes-credits.md in the current directory.

freesound-credits -p Samples/Imported/ -t "Field Notes" -a "Aner Andros" -d "2025-01-09"

Supported file names

freesound-credits matches samples adhering to Freesound naming standard that kept their original samples names per downloads from the platform. For example:

  • new standard with double underscore: 69604__timkahn__subverse_whisper.wav
  • old standard with single underscore: 2166_suburban_grilla_bowl_struck.flac

Supported DAWs

freesound-credits should work for any samples stored in a flat folder. freesound-credits filters out metadata files associated with audio imports. To add more DAWs and associated metadata or extraction, please file an issue.

DAW Samples Folder Metadata Extraction Notes
Ableton Samples/Imported .asd no
Reaper Audio Files .reapeaks no
Renoise SamplesData no unzip extraction
Logic Pro X Audio Files no no Package vs Folder

Adding more DAWs

I did the best I could with what I have. I've tested it with Ableton, Reaper, and Renoise projects on macOS. Logic Pro X uses no metadata and a clean Audio files folder, thus I decided to add it but it hasn't been tested.

However, any DAW with these characteristics should work out of the box. I would appreciate anybody confirming more DAWs or adding new ones. When you do request or add a new DAW, please keep the above table and the extra steps section in mind for any extra information.

Extra DAWs steps

Renoise extraction

Extract with unzip your_project.xrns first. Once unzipped, you will find a Song.xml file and a SamplesData directory containing each Instrument.

Contributing

Thanks for your help improving the project! 🎈 Happy to have you! Peruse the contributing guide to help you get involved in the project.

Contributors 4

  •  
  •  
  •  
  •  

Languages