diff options
| -rw-r--r-- | README.md | 85 | ||||
| -rwxr-xr-x | tmw-crunch-sfx | 103 |
2 files changed, 109 insertions, 79 deletions
@@ -1,92 +1,19 @@ # tmw-crunch-sfx - -## Getting started - -To make it easy for you to get started with GitLab, here's a list of recommended next steps. - -Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)! - -## Add your files - -- [ ] [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files -- [ ] [Add files using the command line](https://docs.gitlab.com/ee/gitlab-basics/add-file.html#add-a-file-using-the-command-line) or push an existing Git repository with the following command: - -``` -cd existing_repo -git remote add origin https://git.themanaworld.org/legacy/tmw-crunch-sfx.git -git branch -M master -git push -uf origin master -``` - -## Integrate with your tools - -- [ ] [Set up project integrations](https://git.themanaworld.org/legacy/tmw-crunch-sfx/-/settings/integrations) - -## Collaborate with your team - -- [ ] [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/) -- [ ] [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html) -- [ ] [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically) -- [ ] [Enable merge request approvals](https://docs.gitlab.com/ee/user/project/merge_requests/approvals/) -- [ ] [Automatically merge when pipeline succeeds](https://docs.gitlab.com/ee/user/project/merge_requests/merge_when_pipeline_succeeds.html) - -## Test and Deploy - -Use the built-in continuous integration in GitLab. - -- [ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/index.html) -- [ ] [Analyze your code for known vulnerabilities with Static Application Security Testing(SAST)](https://docs.gitlab.com/ee/user/application_security/sast/) -- [ ] [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/ee/topics/autodevops/requirements.html) -- [ ] [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/ee/user/clusters/agent/) -- [ ] [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html) - -*** - -# Editing this README - -When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thank you to [makeareadme.com](https://www.makeareadme.com/) for this template. - -## Suggestions for a good README -Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information. - ## Name -Choose a self-explaining name for your project. +TMW Crunch SFX ## Description -Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors. - -## Badges -On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge. - -## Visuals -Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method. - -## Installation -Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection. +Variables can be set in the script for samplerate, mono bitrate, stereo bitrate and number of channels preferred(though CHANNELS should remain at a value of 1 and should not be +changed at this point in time) ## Usage -Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README. - -## Support -Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc. - -## Roadmap -If you have ideas for releases in the future, it is a good idea to list them in the README. - -## Contributing -State if you are open to contributions and what your requirements are for accepting them. - -For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self. - -You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser. +Edit the script variables if standards differ from the defaults set. cd to the sound effect directory and run the script. e.g. `cd ~/Desktop/sfx` `~/Desktop/tmw-crunch-sfx` ## Authors and acknowledgment -Show your appreciation to those who have contributed to the project. +Ledmitz (2023) ## License -For open source projects, say how it is licensed. +Still deciding on one that is very open -## Project status -If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers. diff --git a/tmw-crunch-sfx b/tmw-crunch-sfx new file mode 100755 index 0000000..7f96d18 --- /dev/null +++ b/tmw-crunch-sfx @@ -0,0 +1,103 @@ +#!/bin/bash + + +##Ledmitz (2022) +##For use with TMW Classic (AKA Legacy); Mass compression of SFX ogg files, recursively. Defaults to 64 kbps if already in mono and list stereo SFX +#and be prompted for each one after monos are compressed. + +#Required apps check +REQUIRED_APPS='awk dirname ffprobe ffmpeg grep sed' + for APP in $REQUIRED_APPS; do + REQ_APP_CHECK=$(find '/bin' '/usr/bin' -name "$APP") + if [[ "$REQ_APP_CHECK" == '' ]]; then + echo -e "$APP must be installed in order for toob to work\nRequired Apps: $REQUIRED_APPS" >&2 + exit 0 + fi + done + +#Audio sample rate (Default: 44100) +SAMPRATE='44100' +#Audio bitrate in kbps (Default: 64) +BITRATE='64' +#Audio bitrate in kbps (Default: 160) +STEREO_BITRATE='160' +#Number of channels (Default: 1 (mono) - do not change. for possible future changes) +CHANNELS='1' + +while :; do + echo "Warning: Make backups before running this script. The changes to the original source files are permanent." + echo '' + grep '^TYPE_COMPRESSED' "$0" + grep '^SAMPRATE' "$0" + grep '^BITRATE' "$0" + grep '^CHANNELS' "$0" + read -r -p "This will convert all mono ogg vorbis audio over $BITRATE kbps in \"$PWD\", recursively, to a $SAMPRATE Hz / $BITRATE kbps / $CHANNELS channel ogg and prompt for action when stereo files are encountered. Are you sure you wish to continue?(\"yes\" to continue. Others answers quit)" ANS1 + if [[ "$ANS1" == 'yes' ]]; then + break + else + exit 0 + fi +done + +#Find oggs and convert them if criteria is met +#find . -type f -iname "*.ogg" | +#while IFS= read -r FILE; do +for FILE in $(find . -type f -iname "*.ogg"); do + NAME=${FILE//.ogg/} + SRC_BITRATE=$(ffprobe -hide_banner "$FILE" 2>&1 | grep 'Audio: vorbis' | grep -Eo '[0-9]+ kb/s' | sed 's/ kb\/s//g') + SRC_SAMPRATE=$(ffprobe -hide_banner "$FILE" 2>&1 | grep 'Audio: vorbis' | grep -Eo '[0-9]+ Hz' | sed 's/ Hz//g') + SRC_CHANNELS=$(ffprobe -hide_banner "$FILE" 2>&1 | grep 'Audio: vorbis' | awk '{print $7}' | sed 's/,$//') + #Bitrate and samplerate check + if [[ "$SRC_BITRATE" -gt "$BITRATE" ]] && [[ "$SRC_SAMPRATE" -ge "$SAMPRATE" ]]; then + #Mono check + if [[ "$SRC_CHANNELS" == 'mono' ]]; then + ffmpeg -hide_banner -loglevel 'error' -stats -nostdin -i "$FILE" -vn -ar "$SAMPRATE" -ac "$CHANNELS" -b:a "$BITRATE"'k' "$NAME"'_tmp.ogg' + mv "$NAME"'_tmp.ogg' "$NAME"'.ogg' + elif [[ "$SRC_CHANNELS" == 'stereo' ]]; then + ffprobe -hide_banner "$FILE" 2>&1 + while :; do + read -r -p "Stereo file: $NAME.ogg. Do you wish to proceed with conversion to mono?" STEREO_ANS1 + case $STEREO_ANS1 in + [Yy]* ) ffmpeg -hide_banner -loglevel 'error' -stats -nostdin -i "$FILE" -vn -ar "$SAMPRATE" -ac "$CHANNELS" -b:a "$BITRATE"'k' "$NAME"'_tmp.ogg' + mv "$NAME"'_tmp.ogg' "$NAME"'.ogg' + break + ;; + [Nn]* ) if [[ "$SRC_BITRATE" -gt "$STEREO_BITRATE" ]]; then + ffmpeg -hide_banner -loglevel 'error' -stats -nostdin -i "$FILE" -vn -ar "$SAMPRATE" -ac '2' -b:a "$STEREO_BITRATE"'k' "$NAME"'_tmp.ogg' + mv "$NAME"'_tmp.ogg' "$NAME"'.ogg' + fi + break + ;; + * ) echo "Invalid response: Y/y(anything) for yes or N/n(anything) for no." + continue + ;; + esac + done + fi + elif [[ "$SRC_BITRATE" -gt "$BITRATE" ]] && [[ "$SRC_SAMPRATE" -lt "$SAMPRATE" ]] && [[ "$SRC_CHANNELS" == 'mono' ]]; then + #convert with src samplerate if lower than target samplerate + ffmpeg -hide_banner -loglevel 'error' -stats -nostdin -i "$FILE" -vn -ar "$SRC_SAMPRATE" -ac "$CHANNELS" -b:a "$BITRATE"'k' "$NAME"'_tmp.ogg' + mv "$NAME"'_tmp.ogg' "$NAME"'.ogg' + elif [[ "$SRC_BITRATE" -gt "$BITRATE" ]] && [[ "$SRC_SAMPRATE" -lt "$SAMPRATE" ]] && [[ "$SRC_CHANNELS" == 'stereo' ]]; then + ffprobe -hide_banner "$FILE" 2>&1 + while :; do + read -r -p "Stereo File with low samplerate: $NAME.ogg. Do you wish to proceed with conversion to mono at $SRC_SAMPRATE Hz?" STEREO_ANS1 + case $STEREO_ANS1 in + [Yy]* ) ffmpeg -hide_banner -loglevel 'error' -stats -nostdin -i "$FILE" -vn -ar "$SRC_SAMPRATE" -ac "$CHANNELS" -b:a "$BITRATE"'k' "$NAME"'_tmp.ogg' + mv "$NAME"'_tmp.ogg' "$NAME"'.ogg' + break + ;; + [Nn]* ) if [[ "$SRC_BITRATE" -gt "$STEREO_BITRATE" ]]; then + ffmpeg -hide_banner -loglevel 'error' -stats -nostdin -i "$FILE" -vn -ar "$SAMPRATE" -ac '2' -b:a "$STEREO_BITRATE"'k' "$NAME"'_tmp.ogg' + mv "$NAME"'_tmp.ogg' "$NAME"'.ogg' + fi + break + ;; + * ) echo "Invalid response: Y/y(anything) for yes or N/n(anything) for no." + continue + ;; + esac + done + fi +done + |