Kerokero - SF2000 BGM Tool

Kerokero is a tool designed to streamline the process of creating seamless looping audio clips. With support for both .WAV and .MP3 formats, it allows users to easily set 'in' and 'out' points, preview clips, and save their work in various formats, including a custom format specific to the Data Frog SF2000 retro handheld.

Features

• Load Audio Files: Supports loading and playback of audio files in .WAV and .MP3 formats.
• Set In and Out Points: Allows users to define the start ('in') and end ('out') points of the audio clip with millisecond precision.
• Preview Clips: Users can preview the entire clip or just the section where the repeat occurs (at the start/end of the file).
• Save in Various Formats: The edited clip can be saved in a format specific to Data Frog SF2000, as well as in .WAV or .MP3 formats.
• Adjust Gain Level: Users have the ability to adjust the gain level for both the preview and the processed audio, ensuring the output is just right.

How to Use

• Load an Audio File: Start by loading an audio file in either .WAV or .MP3 format. It can be anything you wish.
• Set In and Out Points: Define the 'in' and 'out' points of your clip using the respective fields. The clip can be a maximum of 90 seconds.
• Preview the Clip: Use the preview feature to listen to the entire clip or just the section where the repeat occurs. This helps in making precise edits.
• Refine In and Out Points: Using the preview, refine your in and out points until the loop transition is seamless.
• Adjust Gain Level: If necessary, adjust the gain level to increase or decrease the volume of the audio.
• Save the Clip: Once satisfied with the edits, save the clip in the desired format - SF2000 format ('pagefile.sys'), .WAV, or .MP3.

Installation & Usage

1. Ensure you have Python and the required packages installed (see below)
2. Download the latest release from the releases page
3. Run the script by double-clicking on kerokero.pyw

NOTE: If the script doesn't load, see 'Pre-Requisites' below.

Pre-Requisites

Before you can run the script, you need to install Python as well as several Python packages. Here's how you can install them:

Python

Ensure that you have Python 3.x installed on your system. You can verify your Python installation by opening a command prompt and typing:

python --version

Installing Packages

This script requires several packages. To install the necessary packages, run the following command in your terminal or command prompt:

pip install numpy simpleaudio pydub PyQt5

NOTE: SimpleAudio requires Microsoft Visual C++ 14.0 or greater to be installed. You can download it here: https://visualstudio.microsoft.com/visual-cpp-build-tools/

Package Requirements

NumPy: A powerful library for working with arrays and matrices of numeric data. In this script, it is used to manipulate audio data as arrays.

SimpleAudio: A library that provides a simple way to play audio. It is used to play the audio previews in the script.

Pydub: A high-level audio library that makes it easy to work with audio files. It is used to load and manipulate audio data in the script.

PyQt5: A set of Python bindings for The Qt Company’s Qt application framework. It is used to create the graphical user interface for the script.

About the Name "Kerokero"

The name "Kerokero" is inspired by the onomatopoeic representation of a frog's croak in Japanese. In the context of this project, it symbolizes the script's ability to seamlessly loop audio clips, akin to the repetitive croaking of a frog. It embodies the script's core functionality of creating continuous, looping audio, providing users with a tool that can create immersive and uninterrupted audio experiences, much like the echoing croaks of frogs in nature.

Contributing

Feel free to fork the repository and submit pull requests for any improvements or bug fixes.

License

CC0 1.0 Universal

Acknowledgements

• Thanks to notv37 and bnister for their initial research and technical insights into the SF2000's audio format.
• Application icon 'kerokero.ico' is from @ptra on Pixabay: https://pixabay.com/vectors/frog-animal-comic-comic-drawing-3241108/

More Information about the Data Frog SF2000

• SF2000 Information Repository by VonMillhausen contains comprehensive information about the SF2000 retro handheld
• SF2000 Collection by Zerter is a great place to customize your Froggy
• tadpole by EricGoldsteinNz and BeastGriever is the best GUI app to manage your SF2000
• frogtool by taizou is a handy Python script for managing your SF2000 game library
• Retro Handhelds Discord in the #🐸data-frog-sf2000 (Other Devices category) is the best place to find up-to-date info and chat with other Froggy enthusiasts