Sample Splitter v0.0.1
# Sample Splitter
Welcome to the documentation for Sample Splitter! This application is a useful tool designed to automatically split large audio files into smaller segments based on detected silence intervals. This makes it an invaluable tool for anyone working with large audio files, such as musicians, podcast editors, or speech-to-text transcribers.
## Table of Contents
1. [Installation](#installation)
2. [Getting Started](#getting-started)
3. [How to Use](#how-to-use)
4. [Troubleshooting](#troubleshooting)
5. [Contributing](#contributing)
6. [License](#license)
## Getting Started
In order to use the Sample Splitter application, you will need Python installed on your system, as well as a few specific Python libraries. Follow the steps below to set up your environment:
### Python Installation
Sample Splitter requires Python 3.7 or later. If you do not already have Python installed on your system, you can download it from the official Python website [here](https://www.python.org/downloads/).
Choose the appropriate installer for your system, download it, and then run the installer, following the on-screen instructions.
After the installation process is completed, you can verify the installation by opening a new command prompt or terminal window and typing:
```
python --version
```
This should display the installed Python version.
### Dependencies Installation
Sample Splitter also requires the following Python libraries:
- os
- tkinter
- ttkthemes
- pydub
- subprocess
- importlib.util
The os, tkinter, subprocess and importlib.util libraries are part of the standard Python library and should be available once Python is installed.
The ttkthemes and pydub libraries can be installed via Python's package installer, pip. We have provided a requirements.txt file that lists these libraries. To install these libraries, open a command prompt or terminal window, navigate to the directory where you have saved the Sample Splitter script and requirements.txt file, and type:
```
pip3 install -r requirements.txt
```
After the installation is completed, you should be able to run the Sample Splitter without any issues.
### Running Sample Splitter
Using the Sample Splitter application is easy and intuitive.
Step 1: Click on the Select a .wav or .mp3 file to be split button. This will open a file dialog, allowing you to navigate to the audio file you want to split.
Step 2: After selecting a file, you can enter a prefix for the output files in the text field labeled Enter output sample names. This prefix will be used as the base name for all the split samples. If no prefix is provided, the original file name will be used as the prefix.
Step 3: Click on the Split samples! button to begin the splitting process. The application will split the audio file at silent intervals and save each segment as a new file in the same directory as the original file.
Upon successful completion of the splitting process, a message box will appear informing you that the splitting has been completed successfully.
### Running Sample Splitter on macOS
If you are running the Sample Splitter on macOS, you may encounter a security warning preventing the program from running. This is due to macOS Gatekeeper security feature. To bypass this and run the Sample Splitter, follow these steps:
1. Open Finder and navigate to the directory containing the Sample Splitter script.
2. Control-click or right-click the Sample Splitter icon, then select Open from the shortcut menu.
3. Click Open in the dialog that appears.
You can now run Sample Splitter by double-clicking it just like any other app.
For any issues during this process, please refer to the [Troubleshooting](#troubleshooting) section.
## Troubleshooting
If you have any trouble running the application, here are a few common solutions:
The application won't start: Ensure that you have the necessary permissions to execute the .exe file in the folder where it's located. Try running the application as an administrator.
The splitting process fails: Check that the file you are trying to split is either a .wav or .mp3 file. These are the only two file types currently supported by Sample Splitter.
I don't see any output files: Ensure that the audio file you're trying to split actually contains silence intervals. If there are no silent intervals, the audio won't be split.
## Contributing
At this time, we're not accepting contributions to the project. However, we welcome you to check back in the future for updates regarding this.
## License
The Sample Splitter application is distributed under the MIT license. For more information, refer to the LICENSE file in the project repository.
Thank you for choosing Sample Splitter for your sample splitting needs! I hope this application proves to be a valuable tool in your audio editing arsenal.