|
1 | | -# FRAMEGUI IS NOW OBSOLETE, NO MORE SUPPORT IS AVAILIBLE |
2 | | -# THE NEW SUCCESSOR APPLICATION (ENCODEGUI) CAN BE FOUND BELOW |
3 | | -# [EncodeGUI](https://github.com/DaGooseYT/EncodeGUI) |
4 | | - |
5 | | -# FrameGUI |
| 1 | +# FrameGUI (NEW v2.0.0+) |
6 | 2 | ![alt text][fgui] |
7 | 3 |
|
8 | | -[fgui]: https://github.com/DaGooseYT/FrameGUI/blob/main/photos/frameGUI.PNG "FrameGUI" |
| 4 | +[fgui]: https://github.com/DaGooseYT/FrameGUI/blob/main/New/fgui.png "FrameGUI" |
9 | 5 |
|
10 | | -FrameGUI combines simplicity with advanced encoding features to accomplish tasks such as frame interpolation using the SVPFlow AviSynth plugins. Advanced options and custom input parameters are availible for those who are skilled with SVPFlow. There is also a simple layout for defining SVPFlow parameters for those who do not have knowledge of the SVPFlow parameters syntax. On top of that, FrameGUI has very advanced error event handlers so that solving problems with FFLoader, AviSynth+, and FFMpeg will not be a hassle. While the encoding is in progress, advanced conversion progress info (such as a progress bar, bitrate, and fps) will be displayed in the UI. |
| 6 | +FrameGUI (frame-gooey) is a free, very easy to use encoding utility featuring AI filters, based on the more comprehensive [EncodeGUI](https://github.com/DaGooseYT/EncodeGUI) encoding tool. |
11 | 7 |
|
12 | | -### Requirements |
13 | | -- A minimum of 6GB **availible** RAM must be allocated for FrameGUI. Note, **availible** RAM to use; not total RAM. Crashes are possible if there is not enough availible RAM and no error will be shown. |
14 | | -- Windows OS (64-bit). FrameGUI was only tested on Windows 10; older versions of Windows have not been tested and may not work. |
15 | | -- AviSynth+. If you don't have it installed already, FrameGUI will detect that and will open the AviSynth+ setup wizard for you. |
| 8 | +This repository only consists of the source code; no builds are hosted here. See https://encodegui.com/downloads.html for the latest builds. |
16 | 9 |
|
17 | 10 | # Features |
18 | | -- FFMpeg v4.4 GPL with AviSynth+ support (included in release). |
19 | | -- SVPFlow AviSynth plugins for frame interpolation of videos (included in release). |
20 | | -- AviSynth+, FFMpeg, and FFLoader error reporting for a rich user interface. |
21 | | -- Options to save user settings. |
22 | | -- Can copy FFMpeg command to clipboard. |
23 | | -- Advanced conversion progress info; live progress bar, real-time fps, real-time bitrate, duration left to process, and percentage complete. |
24 | | -- Noob friendly layout for selecting SVPFlow parameters with the alternative option to input custom parameters for SVPFlow (for advanced users). |
25 | | -- Output video format selection consists of the most popular video formats: .mp4, .mkv, .avi, .mov, .flv. |
26 | | -- Output audio format selection consists of the most popular audio formats: .aac, .mp3. |
27 | | - |
28 | | -### FFMpeg Specific Features |
29 | | -- Sharpen videos. |
30 | | -- Constant rate factor encoding mode (CRF). |
31 | | -- 1 Pass Average Bitrate encoding mode. |
32 | | -- Encoding/CPU preset selection. |
33 | | -- Options to change the video resolution and the resize algo. |
34 | | -- Change video frame rate (if SVPFlow isn't used). |
35 | | -- Set video encoding tune. |
36 | | -- Set audio bitrate. |
37 | | -- Set audio sample rate. |
| 11 | +Below is a list of key features in FrameGUI: |
| 12 | +- Supports nearly any video as an input. |
| 13 | +- Extreamly lightweight with a total installation size of only 240MB. |
| 14 | +- Advanced job queue with status indicators and an advanced control set. |
| 15 | +- Decluttered encoding settings layout allows you to start processes in as little as a few clicks. |
| 16 | +- Features RIFE v4.6 AI frame interpolation as the Convert FPS function. |
| 17 | +- Features SRMD super resolution AI upscaling. |
| 18 | +- AI filters can be used with ALL major GPU vendors: NVIDIA, AMD, INTEL (Intel iGPUs are not supported). |
| 19 | +- Features VapourSynth API for ALL included filters **which doesn't extract frames before rendering, allowing a faster render time than nearly all competing software.** |
38 | 20 |
|
39 | 21 | # Usage |
40 | | -If you do not like reading (like me), the official video tutorial for FrameGUI as an alternative can be found [here](https://youtu.be/Fs38PwpMdo4). Otherwise, continue reading for documentation and usage regarding FrameGUI. **This is not a noob guide.** |
41 | | - |
42 | | -### Select Input File |
43 | | -Start by selecting an input file on the `Main` tab. The supported input formats are as follows: .mp4, .mkv, .mov, .avi, .thp, .bik, .m2ts, .ts, .flv, .webm, .ogv |
44 | | - |
45 | | -![alt text][input] |
46 | | - |
47 | | -[input]: https://github.com/DaGooseYT/FrameGUI/blob/main/photos/input.PNG "Select Input File" |
48 | | - |
49 | | -### Select Video Encoding Options |
50 | | -Head over to the `Encoder Settings` tab where you will first be presented with the FFMpeg encoding options, or the `Video (x264)` tab. Set the settings to your desire. |
51 | | - |
52 | | - |
53 | | -![alt text][x264] |
54 | | - |
55 | | -[x264]: https://github.com/DaGooseYT/FrameGUI/blob/main/photos/x264.PNG "Select Video Encoding Options" |
56 | | - |
57 | | - |
58 | | -Options in red: Set these options to `0` to passthrough the value from the input video. |
59 | | - |
60 | | -- The maximum bitrate you can define is `80000kb/s`. |
61 | | -- The maximum resolution you can define is `3840x2160` (4K UHD). |
62 | | -- The maximum sharpening strength you can define is `5.0`. |
63 | | -- The maximum frame rate you can define is `240` fps. |
64 | | -- The maximum b-frames you can define is `14`. |
65 | | -- The maximum CRF value you can define is `51`. |
66 | | - |
67 | | -### Select Audio Encoding Options |
68 | | -Head over to the `Audio` tab where you will find the audio encoding options. As of now, these are the only options availible. More audio encoding options will come if there is a demand for them. |
69 | | - |
70 | | -![alt text][audio] |
71 | | - |
72 | | -[audio]: https://github.com/DaGooseYT/FrameGUI/blob/main/photos/audio.PNG "Select Audio Encoding Options" |
73 | | - |
74 | | -Note: the `aac` selection in `Audio Format` will use the FFMpeg native AAC encoder. Due to license resrictions, no other aac encoder was built with FFMpeg. |
75 | | - |
76 | | -### Select SVPFlow Parameters (optional) |
77 | | -1. Head over to the `SVPFlow/AviSynth+/Other` tab to set the SVPFlow parameters. |
78 | | -2. Select the `Use` checkbox (in the red box) to enable the options. FrameGUI will attempt to find the AviSynth+ files before enabling the options. If FrameGUI can't find the files, then a message box will show prompting you to install AviSynth+. Select yes and the AviSynth+ installer wizard will appear (no internet is required for this procedure). When defining the path of AviSynth+ in the setup wizard, **make sure it installs to the path: `C:\Program Files (x86)\AviSynth+` else FrameGUI will not find the files and will show the error again.** |
79 | | -3. The values in the green box can remain on their defaults, unless you need more memory or threads to AviSynth+. The maximum memory value unit is MB. The maximum amount of threads you can use is 25 and the maximum amount of memory you can allow is 4GB (4096 MB). If you already know the syntax of the SVPFlow parameters, skip steps 4, 5, 6 and enter the parameters in the `Smooth`, `Super`, and `Analyse` text boxes |
80 | | - |
81 | | -![alt text][svp] |
82 | | - |
83 | | -[svp]: https://github.com/DaGooseYT/FrameGUI/blob/main/photos/svpflow.PNG "Select SVPFlow Parameters (optional)" |
84 | | - |
85 | | -4. If you don't already know the syntax of the parameters and don't want to learn them, then you can have FrameGUI build the parameters for you. To do that, select the `Noob?` checkbox (in the blue box, above) to enable the simplified UI. You will need to specify the input fps as well as the output fps for the video. Enter the input fps of the video (in the red box, below) and then set the output fps (in the blue box, below). Due to safety measures of the encoder and AviSynth+, a minimum of 15 fps input video will be accepted and a maximum of 140 fps output will be accepted. |
86 | | -5. Define if you want to use the GPU for frame interpolation (**_the video encoding will still use x264; CPU encoding_**). You can do this by selecting or deselecting the `Use GPU?` checkbox (in the green box, below). It is **NOT** recommended to use the GPU at all becuase it will create more artefacts in the output video and it will not boost the encoding performance at all. |
87 | | -6. Finally, define the smoothness strength (in the orange checkbox). |
88 | | - |
89 | | -![alt text][noob] |
90 | | - |
91 | | -[noob]: https://github.com/DaGooseYT/FrameGUI/blob/main/photos/noob.PNG "Noob Parameters (optional)" |
92 | | - |
93 | | -7. Now that all settings are set, if you would like to save them then select the `Save Current Settings` button. FrameGUI will start up with the saved settings next time you open it. The settings below will be saved when the `Save Current Settings` button is clicked: |
94 | | - |
95 | | - * Output Video Format |
96 | | - * Frame Rate Value |
97 | | - * B-Frames Value |
98 | | - * Sharpen Checkbox Check |
99 | | - * Sharpening Value |
100 | | - * Encoding Mode Selection |
101 | | - * Video CRF Value/Bitrate |
102 | | - * Video Tune `Use` Checkbox Check |
103 | | - * Video Tune |
104 | | - * CPU Preset |
105 | | - * Change Resolution Checkbox Check |
106 | | - * Height Value |
107 | | - * Width Value |
108 | | - * Resize Algo Selection |
109 | | - * Audio Format Selection |
110 | | - * Audio Bitrate Selection |
111 | | - * Audio Sample Rate Selection |
112 | | - * AviSynth+ Threads Value |
113 | | - * AviSynth+ Maximum Memory |
114 | | - * Smooth Text Box |
115 | | - * Super Text Box |
116 | | - * Analyse Text Box |
117 | | - * Noob Checkbox Check |
118 | | - * Input FPS Value |
119 | | - * Output FPS Value |
120 | | - * `Use GPU?` Checkbox Check |
121 | | - * Smoothness (I Want) Selection |
122 | | - * Show Message Box Checkbox Check |
123 | | - |
124 | | -### Save Output Video & Start Encode |
125 | | -1. Now that all settings are set, go back to the `Main` tab and on the bottom, select the output video format (in the blue box). |
126 | | -2. Click the `Save Output` button (in the red box) to select the destination for the output video file. |
127 | | - |
128 | | -![alt text][saveout] |
129 | | - |
130 | | -[saveout]: https://github.com/DaGooseYT/FrameGUI/blob/main/photos/save.PNG "Save Output Video" |
131 | | - |
132 | | -3. Lastly, select the `Start Encode` button (in the green box) to start the encoding process. |
133 | | -4. Please wait up to 10 seconds for the process to start, then progress info will show at the bottom. |
134 | | -5. You can cancel the encoding process at any time while its running. Select the `Cancel` button (in the blue box) to do this. |
135 | | - |
136 | | -![alt text][progress] |
137 | | - |
138 | | -[progress]: https://github.com/DaGooseYT/FrameGUI/blob/main/photos/progress.PNG "Progress Info" |
139 | | - |
140 | | -6. All done! |
141 | | - |
142 | | -# Troubleshooting |
143 | | -FrameGUI consists of multiple error event handlers which makes it easy to detect problems and report them the the user when necessary. A log file of the FFMpeg console output is also created for each encoding process, regardless if there is a problem/error. Below is an FFLoader error sample: |
144 | | - |
145 | | -![alt text][ffloadererr] |
146 | | - |
147 | | -[ffloadererr]: https://github.com/DaGooseYT/FrameGUI/blob/main/photos/inputerr.PNG "FFLoader Error" |
148 | | - |
149 | | -Below is an AviSynth+ error sample: |
150 | | - |
151 | | -![alt text][avserr] |
152 | | - |
153 | | -[avserr]: https://github.com/DaGooseYT/FrameGUI/blob/main/photos/avserr.PNG "AviSynth+ Error" |
154 | | - |
155 | | -As you can see, the errors will define the problem which makes solving it easy. But in the case you don't know how to solve a problem, follow the steps below to properly send an issue or problem report. You can send problem or issue reports in the `Issues` section of this repository or in the comments section of the official video tutorial found [here](https://youtu.be/Fs38PwpMdo4) |
156 | | - |
157 | | -Required files and other info to properly report errors, problems, bugs, and issues are listed below. **_Issues and problem reports will not be accepted without these files and info!_** |
158 | | -1. The error message that you have received. |
159 | | -2. `ffmpeglogs.txt`. This can be found by clicking the `Open Logs Path` button located in the `Other Settings` section of SVPFlow. If no log file was generated or if it's blank, please state that when reporting the issue. |
160 | | -3. `aviscript.avs`. This can also be found by clicking the `Open Logs Path` button located in the `Other Settings` section of SVPFlow. If no AviSynth+ script was generated (e.g. you didn't use AviSynth+) then please state that when reporting the issue. |
161 | | -4. The settings that you have set in FrameGUI (If `ffmpeglogs.txt` was not generated). |
162 | | -5. What version OS you are using (Windows 10, Windows 7, etc.) |
| 22 | +Documentation including the basic usage guide can be found at https://encodegui.com/docs/documentation.html. The docs for FrameGUI are still being developed and will be released soon. |
163 | 23 |
|
164 | | -All of this information will help me solve the problem quicker and hopefully in one response. Thank you. |
| 24 | +# Support |
| 25 | +Support for issues and directions for how to submit a proper issue/bug report are available on https://encodegui.com/support.html. |
| 26 | +**No support is provided for legacy versions of FrameGUI (before v2.0.0).** |
165 | 27 |
|
166 | | -# License & Dependencies |
| 28 | +# Compilation |
| 29 | +Requires `Qt 6 SDK` and MS `Visual Studio` or `Cmake`. Install the Qt Visual Studio extension and compile using the built in Visual Studio tools. |
167 | 30 |
|
168 | | -### License |
169 | | -FrameGUI and FFLoader as stand-alone software are licensed under the GPL v3.0. A copy of this license is in `main\LICENSE`. By using, modifying, and/or distributing FrameGUI and/or FFLoader, you agree to the terms and conditions presented in the license. |
| 31 | +Note: The Qt designer .ui file for FrameGUI is not included in this source code. |
170 | 32 |
|
171 | | -### Dependencies |
172 | | -FrameGUI depends on multiple other third party applications in order for it to function. A list of each application is below along with a copy of their license, the author, and the source code. By using FrameGUI, you also agree to the terms and conditions of the licenses of those applications. |
| 33 | +# License |
| 34 | +FrameGUI's source code is licensed under the AGPL v3.0. See LICENSE for more details. Early released versions of FrameGUI are licensed under a custom license. Read it at https://encodegui.com/privacy-terms.html. |
173 | 35 |
|
174 | | -- FFMpeg v4.4 GPL Build - "The FFMpeg Developers" - [GPL v3.0](https://www.gnu.org/licenses/gpl-3.0.en.html) - [Source code](https://github.com/FFmpeg/FFmpeg) |
175 | | -- AviSynth+ v3.7.0 (including installer) - From Jeeb's "AviSynth" - [GPL v2.0](https://www.gnu.org/licenses/old-licenses/gpl-2.0.en.html) - [Source code](https://github.com/AviSynth/AviSynthPlus) |
176 | | -- SVPFlow AviSynth Plugins - "The SVP Team" - SVPFlow2: Closed Cource. SVPFlow1: [GPL v2.0](https://www.gnu.org/licenses/old-licenses/gpl-2.0.en.html) - [SVPFlow1 source code](http://www.svp-team.com/files/gpl/svpflow1-src.zip) |
177 | | -- FFms2 AviSynth Plugin - Thomas Goyne, Alex Smith, & Derek Buitenhuis - [MIT License](https://opensource.org/licenses/MIT) - [Source code](https://github.com/FFMS/ffms2) |
| 36 | +The setup file for FrameGUI is closed source and is NOT a part of this repository or the AGPL license. Read the privacy and terms at EncodeGUI.com linked above for more details. |
0 commit comments