📚 Modified some variable names and information about preload-replay mode.

Author: userElaina

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Elaina
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -28,14 +28,14 @@ Automatically enter preload-replay mode when the input file extension is `.badap
 usage: badapple [options] ... 
 options:
   -i, --input                   video file (string [=./badapple.mp4])
-  -o, --output                  [preloaded mode] output file (string [=])
+  -o, --output                  [preload] output file (string [=])
   -a, --audio                   audio file (string [=])
   -m, --map                     font data file (string [=])
   -s, --scale                   width:height (string [=76:54])
   -r, --rate                    frame rate (double [=10])
       --not-clear               don't clear screen (using ANSI) before print a frame
       --contrast-enhancement    contrast Enhancement
-      --preload                 [preload mode]
+      --preload                 [preload]
       --play-audio              play audio with ffplay
   -?, --help                    print this message
 ```
@@ -46,6 +46,14 @@ options:
 git clone --recurse-submodules --remote-submodule [email protected]:userElaina/Bad-Apple.git
 ```
 
+### To do
+
+How to build OpenCV with MinGW-W64
+
+### License
+
+The code is available under the [MIT license](./LICENSE).
+
 ### How to use
 
 **[Fonts Pre-processing](#fonts-pre-processing)**
@@ -56,10 +64,6 @@ git clone --recurse-submodules --remote-submodule [email protected]:userElaina/Bad-
 **[Linux-FFmpeg](#linux-ffmpeg)**
 **[Linux-OpenCV](#linux-opencv)**
 
-### To do
-
-How to build OpenCV with MinGW-W64
-
 #### Fonts Pre-processing
 
 ##### Dependencies

badapple.cpp

@@ -9,14 +9,14 @@ int main(int argc, char** argv) {
     cmdline::parser a;
     a.set_program_name("badapple");
     a.add<std::string>("input", 'i', "video file", false, "./badapple.mp4");
-    a.add<std::string>("output", 'o', "[preloaded mode] output file", false, "");
+    a.add<std::string>("output", 'o', "[preload] output file", false, "");
     a.add<std::string>("audio", 'a', "audio file", false, "");
     a.add<std::string>("map", 'm', "font data file", false, "");
     a.add<std::string>("scale", 's', "width:height", false, "76:54");
     a.add<double>("rate", 'r', "frame rate", false, 10.0);
     a.add("not-clear", '\0', "don't clear screen (using ANSI) before print a frame");
     a.add("contrast-enhancement", '\0', "contrast Enhancement");
-    a.add("preload", '\0', "[preload mode]");
+    a.add("preload", '\0', "[preload]");
     a.add("play-audio", '\0', "play audio with ffplay");
     a.parse_check(argc, argv);
 

badapple.hpp

@@ -1,6 +1,6 @@
 #pragma once
 
-#include "decode_preload.hpp"
+#include "decode_replay.hpp"
 
 #ifdef DECODE_FFMPEG
 #include "decode_ffmpeg.hpp"
@@ -51,7 +51,7 @@ inline int play(
     }
 
     if(endswith(video,".badapple")){
-        return play_preload(video,audio,not_clear,play_audio);
+        return replay(video,audio,not_clear,play_audio);
     }
 
     Font *map = new Font(font);

decode_preload.hpp decode_replay.hppdecode_preload.hpp renamed to decode_replay.hpp

@@ -2,7 +2,7 @@
 
 #include "base.hpp"
 
-namespace decode_preload {
+namespace decode_replay {
 FILE* fp;
 inline void pt(int c) {
     fputc(c, fp);
@@ -26,10 +26,10 @@ inline int r() {
     }
     return ans;
 }
-}  // namespace decode_preload
+}  // namespace decode_replay
 
 inline void compress(int x, int y, int clk, FILE* _fp) {
-    using namespace decode_preload;
+    using namespace decode_replay;
     fp = _fp;
     w(x);
     pt(32);
@@ -41,12 +41,12 @@ inline void compress(int x, int y, int clk, FILE* _fp) {
     pt(10);
 }
 
-inline int play_preload(
+inline int replay(
     std::string video,
-    std::string audio,  // default use video
+    std::string audio,
     int not_clear = 0,
     int play_audio = 0) {
-    using namespace decode_preload;
+    using namespace decode_replay;
 
     fp = fopen(video.c_str(), "r");