ed-george/fukkit

A Kotlin application to censor profanity within an audio file using ffmpeg

---

---

A Kotlin application to censor profanity within an audio file using ffmpeg

Examples ❌🤬

Check out the examples folder for a sample input and a generated output of this application.

Setup ⚠️

This project relies on ffmpeg to modify audio and censor profanities.

This project also uses Google's Cloud Speech-to-Text API and as such, will require authentication to carry out any audio analysis.

After cloning and downloading the project, please follow this guide in order to have an enviroment that can run this application

ffmpeg Setup (Required)

Follow this excellent guide on how to install ffmpeg on your machine

Google Console Setup (Required)

Firstly, you will need to create an application within Google's Cloud Console and enable the Cloud Speech-to-Text API.

Once completed, follow these steps in order to correctly generate the auth file required:

1. Go to the Create service account key page in the GCP Console.

2. From the Service account drop-down list, select New service account.

3. Enter a name into the Service account name field.

4. From the Role drop-down list, select Project > Owner.

5. Click Create. A JSON file that contains your key downloads to your computer.

6. Within a terminal, create an environment variable GOOGLE_APPLICATION_CREDENTIALS that points to the path of the downloaded file.

Usage 🙊🗯

This project is still a work in progress, full usage details will be provided as soon as possible

Contributing 🛠

I welcome contributions and discussion for new features or bug fixes. It is recommended to file an issue first to prevent unnecessary efforts, but feel free to put in pull requests in the case of trivial changes. In any other case, please feel free to open discussion and I will get back to you when possible.

Thanks 💕

Thanks to Savvas Constantinides for the project idea!

fukkit's Issues

Update profanities from file

Please describe the feature/solution you would like to see
To ensure the filter works with multiple profanities and is customisable, a file should be used to populate the profanity list

Describe how the solution should work
Using a file such as this Banned Words text file should be used to populate the profanity filter