## Table of Contents
- [1 Description](#1description)
- [2 Requirements](#2requirements)
- [3 Inputs](#3inputs)
- [3.1 Video](#31video)
- [3.2 Audio](#32audio)
- [3.3 Image](#33image)
- [3.4 GIF](#34gif)
- [4 Options](#4options)
- [4.1 Miscellaneous](#41miscellaneous)
- [4.2 Aesthetic](#42aesthetic)
- [4.3 Encoding](#43encoding)
- [4.4 Containers](#44containers)
- [5 Output Settings](#5outputsettings)
- [5.1 Video](#51video)
- [5.1.1 Basic Quality Presets](#511basicqualitypresets)
- [5.1.2 Advanced](#512advanced)
- [5.1.2.1 Start Time and Duration](#5121starttimeandduration)
- [5.1.2.2 Speed](#5122speed)
- [5.1.2.3 Text](#5123text)
- [5.1.2.4 Color](#5124color)
- [5.1.2.5 Stretch](#5125stretch)
- [5.1.2.6 Corruption](#5126corruption)
- [5.1.2.7 Duration Spoofing](#5127durationspoofing)
- [5.1.2.8 Variable Resolution / "Bouncy WebM"](#5128variableresolutionbouncywebm)
- [5.1.2.9 Resampling and Interpolation](#5129resamplingandinterpolation)
- [5.1.2.10 Frying](#51210frying)
- [5.1.2.11 Frame Stutter](#51211framestutter)
- [5.1.2.12 Misc. Filters](#51212miscfilters)
- [5.1.2.12.1 Erosion](#512121erosion)
- [5.1.2.12.2 Lagfun](#512122lagfun)
- [5.1.2.12.3 Negate](#512123negate)
- [5.1.2.12.4 Interlace](#512124interlace)
- [5.1.2.12.5 Edgedetect](#512125edgedetect)
- [5.1.2.12.6 Shufflepixels](#512126shufflepixels)
- [5.1.2.12.7 Guided](#512127guided)
- [5.2 Audio (With Video)](#52audiowithvideo)
- [5.2.1 Basic Quality Presets](#521basicqualitypresets)
- [5.2.2 Advanced](#522advanced)
- [5.2.2.1 Start Time and Duration](#5221starttimeandduration)
- [5.2.2.2 Speed](#5222speed)
- [5.2.2.3 Distortion / "Earrape"](#5223distortionearrape)
- [5.2.2.3.1 Simple Distortion](#52231simpledistortion)
- [5.2.2.3.2 Advanced Distortion](#52232advanceddistortion)
- [5.2.2.4 Text to Speech](#5224texttospeech)
- [5.2.2.5 Replacing](#5225replacing)
- [5.3 Audio (Without Video)](#53audiowithoutvideo)
- [5.3.1 Bitrate](#531bitrate)
- [5.3.2 Start Time and Duration](#532starttimeandduration)
- [5.3.3 Speed](#533speed)
- [5.3.4 Distortion / "Earrape"](#534distortionearrape)
- [5.3.4.1 Simple Distortion](#5341simpledistortion)
- [5.3.4.2 Advanced Distortion](#5342advanceddistortion)
- [5.3.5 Text to Speech](#535texttospeech)
- [5.4 Images and GIFS](#54imagesandgifs)
- [5.4.1 Old](#541old)
- [5.4.1.1 Quality](#5411quality)
- [5.4.1.2 Scale](#5412scale)
- [5.4.1.3 Frying](#5413frying)
- [5.4.2 New](#542new)
- [5.4.2.1 Times to Compress](#5421timestocompress)
- [5.4.2.2 Quality](#5422quality)
- [5.4.2.3 Scale](#5423scale)
- [6 Multiqueue](#6multiqueue)
- [7 Config Files](#7configfiles)
- [8 Updating](#8updating)
- [8.1 Auto-Updating](#81autoupdating)
- [8.2 Force Update / Repair](#82forceupdaterepair)
- [9 Developers](#9developers)
- [10 Contact](#10contact)
# 1 Description
This is the documentation for Quality Muncher. This documentation is **not** for the [Python version of Quality Muncher](https://github.com/qm-org/qm-py).
# 2 Requirements
- Windows 10 or 11 (untested on earlier versions)
- Command Prompt ([Windows Terminal](https://github.com/microsoft/terminal) has been known to cause issues)
- FFmpeg installed and added to PATH (with libflite enabled)
- [gyan.dev has a full version which I recommend](https://www.gyan.dev/ffmpeg/builds/), but make sure you're installing **full**, not essentials.
# 3 Inputs
Quality Muncher works with pretty much any media format, as long as it's [supported by FFmpeg](https://ffmpeg.org/ffmpeg-codecs.html#Decoders).
## 3.1 Video
Any video that is supported by FFmpeg and has at least one functional video stream will work and be recognized as a video.
## 3.2 Audio
Any audio format that is supported by FFmpeg will work. If it has a video stream, it will be grouped with video, otherwise it will skip any video-related options.
## 3.3 Image
Any image format using any of the following containers will work:
- .png
- .jpg
- .jpeg
- .jfif
- .jpe
- .jif
- .jfi
- .pjpeg
- .bmp
- .tiff
- .tif
- .raw
- .heif
- .heic
- .webp
- .jp2
- .j2k
- .jpx
- .jpm
- .jpm
- .mj2
- .gif
## 3.4 GIF
Any GIF using the .gif container will work.
# 4 Options
## 4.1 Miscellaneous
- autoupdatecheck
- whether or not to check for updates when launched
- can be set to `y` or `n`
- default value is `y`
- loggingdir
- where logs should go
- can be set to any valid file path, or blank
- by default this option has no value
- stayopen
- whether or not to stay open after done rendering
- can be set to `y` or `n`
- default value is `y`
## 4.2 Aesthetic
- showtitle
- whether or not to show the title
- can be set to `y` or `n`
- default value is `y`
- cleanmode
- whether questions should be cleared or not after answered
- can be set to `y` or `n`
- default value is `y`
- animate
- whether or not to show an animation when opening and closing
- can be set to `y` or `n`
- default value is `n`
- animatespeed
- the speed that animations play
- can be set to any natural number
- default value is `5`
## 4.3 Encoding
- encodingspeed
- the preset speed used when encoding
- can be set to `ultrafast`, `superfast`, `veryfast`, `faster`, `fast`, `medium`, `slow`, `slower`, `veryslow`, or `placebo`
- default value is `ultrafast`
- scalingalg
- the algorithm to use when scaling
- can be set to `fast_bilinear`, `bilinear`, `bicubic`, `expiramental`, `neighbor`, `area`, `bicublin`, `gauss`, `sinc`, `lanczos`, or `spline`
- default value is `neighbor`
- updatespeed
- the speed that stats are updated
- can be set to any rational number greater than 0
- default value is `0.05`
- values below `0.05` may cause performance issues
## 4.4 Containers
- container
- the container used for videos
- can be set to most video containers that support x264
- default value is `.mp4`
- audiocontainer
- the container used for audio
- can be set to most audio containers that support AAC, but when set to `mp3`, libmp3lame is used for encoding audio
- default value is `.mp3`
- imagecontainer
- the container used for images
- can be set to most containers that support mjpeg
- default value is `.jpg`
# 5 Output Settings
These are settings that can be modified to alter the appearance of a video. Some may be hardly noticable, some may be extremely apparant.
## 5.1 Video
### 5.1.1 Basic Quality Presets
These are presets that help set the framerate, video and audio bitrate, and resolution. They have 4 values:
`framerate`
The framerate of the video
`videobr`
How visually bad the video bitrate should be, higher is worse
`audiobr`
How bad the audio bitrate should sound, higher is worse
`scale`
The amount to divide the original resolution by
The options for quality are as follows:
`decent`
framerate: 24
videobr: 3
audiobr: 3
scale: 2
`bad`
framerate: 12
videobr: 5
audiobr: 5
scale: 4
`terrible`
framerate: 6
videobr: 8
audiobr: 8
scale: 8
`unbearable`
framerate: 1
videobr: 16
audiobr: 9
scale: 12
`custom`
*All values are chosen by user*
`random`
*All values are randomly chosen*
### 5.1.2 Advanced
These are more advanced and specific options that the user can choose to unlock through the main menu.
#### 5.1.2.1 Start Time and Duration
The start time and duration of the video.
#### 5.1.2.2 Speed
The speed of the video, from 0.5 to 100.
#### 5.1.2.3 Text
2 texts that can be applied to the video, with 4 options that are individual for each text:
`size`
Big, medium, small, or very small
`text`
Any text that doesn't contain any batch poison characters will work
`position`
Any number 1 through 9, each corresponding to a third of the screen, going left to right, top to bottom
#### 5.1.2.4 Color
Color filters that can be applied to the video.
`contrast`
Any float from -1000 to 1000, default is 1
`saturation`
Any float from 0 to 3, default is 1
`brightness`
Any float from -1 to 1, default is 0
#### 5.1.2.5 Stretch
Stretches the width and height of the video individually, with any natural number being an accepted input.
#### 5.1.2.6 Corruption
Corrupts the bitstream of the video with noise.
`corruptsev`
Any natural number between 1 and 10
#### 5.1.2.7 Duration Spoofing
Spoofs the duration of the video by editing the raw hexadecimal values. Users can pick from super long duration, super long negative duration, and ever-increasing duration.
#### 5.1.2.8 Variable Resolution / "Bouncy WebM"
Sets a variable resolution for the video, using a cosine graph as the scale. A visualisation can be found [here](https://www.desmos.com/calculator/vl9mpjnqhm).
`bouncingspeed`
The rate of change
`minimumbounce`
The minimum relative scale the resolution will decrease to, from 0 to 1 (0.5 for example would be half of the original size).
`bouncetype`
The axis to apply the changes too, `width`, `height`, or `both`
#### 5.1.2.9 Resampling and Interpolation
If this is enabled, there are 3 possible outcomes, dependant on the input and output framerates.
If the output framerate is **greater than** the input framerate:
the video will be interpolated to the output framerate (which creates extra frames using an algorithm)
If the output framerate is **equal to** the input framerate:
the video framerate will not be changed or modified in any way
If the output framerate is **less than** the input framerate:
the video will be resampled to the output framerate (which combines frames together)
#### 5.1.2.10 Frying
This effect is akin to what is commonly referred to as "deep frying". This effect warps the video using a noise map for displacement and changes colors.
`level`
The strength of the distortion
`colorchanges`
Whether or not to apply effects such as contrast and saturation to the video
#### 5.1.2.11 Frame Stutter
Randomizes the order of frames of a video from an internal cache (group).
`stutteramount`
A number 2-512 that dictates the frames in the internal cache
#### 5.1.2.12 Misc. Filters
These are miscellaneous filters that don't have any options besides a toggle. The description for these are all paraphrased from FFmpeg's [filter documentation](https://ffmpeg.org/ffmpeg-filters.html), so go there if you want a more in-depth explanation.
Each filter has an image at the end of the description showing its effects. Here is the original image for reference:
##### 5.1.2.12.1 Erosion
Replaces the pixel by the local(3x3) minimum.
##### 5.1.2.12.2 Lagfun
This filter makes short flashes of light appear longer.
##### 5.1.2.12.3 Negate
Negate (invert) the input video.
##### 5.1.2.12.4 Interlace
Simple interlacing filter from progressive contents. This interleaves upper (or lower) lines from odd frames with lower (or upper) lines from even frames, halving the frame rate and preserving image height.
##### 5.1.2.12.5 Edgedetect
Detect and draw edges. The filter uses the Canny Edge Detection algorithm.
##### 5.1.2.12.6 Shufflepixels
Reorder pixels in video frames.
##### 5.1.2.12.7 Guided
Apply guided filter for edge-preserving smoothing, dehazing and so on.
## 5.2 Audio (With Video)
### 5.2.1 Basic Quality Presets
See [5.1.1 Basic Quality Presets](#511basicqualitypresets).
### 5.2.2 Advanced
Advanced options for audio.
#### 5.2.2.1 Start Time and Duration
Dictated by the video start
#### 5.2.2.2 Speed
The speed of the audio, from 0.5 to 100.
#### 5.2.2.3 Distortion / "Earrape"
Distorts the audio using one of two methods.
##### 5.2.2.3.1 Simple Distortion
Boosts specific frequencies.
`distortionseverity`
Severity of distortion, from 1 to 10.
##### 5.2.2.3.2 Advanced Distortion
Boosts specific frequencies, adds individual delay to channels, swaps the left and right channel, and adds echo.
`distortionseverity`
Severity of distortion, from 1 to 10.
#### 5.2.2.4 Text to Speech
Text that is spoken and combined with the existing audio. Your FFmpeg installation must have libflite enabled for this to work. This uses flite's kal16 voice.
`ttstext`
The text that is spoken
`volume`
The boost, in dB, added to the text to speech.
#### 5.2.2.5 Replacing
Replaces the audio with the audio from another file
`starttime`
The time in the audio file that is played from when the video starts.
## 5.3 Audio (Without Video)
### 5.3.1 Bitrate
A value from 1-10 that dictates the bitrate of the audio, 10 being worse.
### 5.3.2 Start Time and Duration
The start time and duration of the audio.
### 5.3.3 Speed
See [5.2.2.2 Speed](#5222speed).
### 5.3.4 Distortion
See [5.2.2.3 Distortion / "Earrape"](#5223Distortion/%22earrape%22).
#### 5.3.4.1 Simple Distortion
See [5.2.2.3.1 Simple Distortion](#52231simpledistortion).
#### 5.3.4.2 Advanced Distortion
See [5.2.2.3.2 Advanced Distortion](#52232advanceddistortion).
### 5.3.5 Text to Speech
See [5.2.2.4 Text to Speech](#5224texttospeech).
## 5.4 Images and GIFs
### 5.4.1 Old
The older, faster way to munch images.
#### 5.4.1.1 Quality
`quality`
The quality of the image/GIF, 1-10, 1 being the highest quality
#### 5.4.1.2 Scale
`scale`
The amount to divide the image/GIF by.
#### 5.4.1.3 Frying
See [5.1.2.10 Frying](#51210frying).
### 5.4.2 New
The newer method to munch images. It is slower yet more effective at reducing quality.
#### 5.4.2.1 Times to Compress
The amount of times to compress the image, which can be anywhere from 1 to 32767.
#### 5.4.2.2 Quality
See [5.4.1.1 Quality](#5411quality).
#### 5.4.2.3 Scale
See [5.4.1.2 Scale](#5412scale).
# 6 Multiqueue
Multiqueue is supported for all input types, but all inputs must be the same type, except for images and GIFs, which can be queued together.
# 7 Config Files
*As of version 1.4.6, only videos support config files.*
After answering all of the output settings, users are asked if they want to create a config file with the selected options. These config files can be used to skip answering most questions, and automatically set the values that were used to make the file. Config files work both with and without multiqueue.
# 8 Updating
Updating through the app can be done in two ways, auto-updating and forcing an update.
## 8.1 Auto-Updating
Unless the option is set to false in the file, every time Quality Muncher is opened, it will try to check for updates automatically. If your version is different from the most recent one, it will ask if you want to update or skip updating. If you choose to update, you are given the choice between overwriting your current version, copying the current version and *then* overwriting, or going back and not updating at all.
## 8.2 Force Update / Repair
Forcing an update, or repairing, can be done by opening Quality Muncher, pressing "C" to check for updates, then pressing "F". This will then ask you if you want to proceed, copy the file and then proceed, or go back. Choose either of the first two will forcibly update Quality Muncher.
# 9 Developers
Quality Muncher is developer by [Frost](https://github.com/Thqrn), or Frost#5872 on Discord. The Python version is developed by [Atzur](https://github.com/atzuur), or atzur#3938 on Discord.
# 10 Contact
You can contact us in our [Discord Server](https://discord.qualitymuncher.lgbt), or by emailing us at qualitymuncher@gmail.com.