jumpcutter icon indicating copy to clipboard operation
jumpcutter copied to clipboard

Standardise CLI arguments to follow the UNIX/Linux formatting rules

Open James-Livesey opened this issue 6 years ago • 2 comments

Note: Compatibility may be broken with some of the changes listed below. You may want to keep the old arguments as well as the newly changed ones.

As commented on YouTube by me (link):

Why don't you allow -1 or better yet 0 for jumpcutting in the CLI arguments, could look a bit cleaner for value inputting! And I think using dashes instead of underscores in '--' arguments (for example --frame_rate should be --frame-rate or even --framerate (as framerate is quite a common word)) as that's like a standard in UNIX/Linux lol

Suggestions (correct me on anything if I'm wrong :joy:):

  • For instant jumpcutting of video parts the value 0 should be used instead of 999999, it'll save someone from having to type 999999 all of the time and looks a bit nicer.
  • Dashes/hyphens (-) instead of underscores (_) should be used in the longer command line arguments where there is more than one word, such as --frame_rate would become --frame-rate ─ AFAIK I think this is a standard as I've seen it with a few CLI commands before, and it also makes it easier to type again as you don't have to press the Shift key midway through a lowercase sentence.
  • One little thing: Personally I think the phrase 'frame rate' should be 'framerate' but that's for you to decide :wink:

Other than that, it's a brilliant piece of software Cary! Thanks for sharing it with us.

James-Livesey avatar Apr 11 '19 14:04 James-Livesey

Not just that, I think it'd also be a great quality of life improvement having fewer character arguments:

-f, --input-file           Video file you want modified.
-u, --url                  A youtube url to download and process.
-o, --output-file          Output file. (optional. if not included, it'll just modify the input file name)
-v, --silent-threshold     Volume amount that frames' audio needs to be consider "sounded". It ranges from 0 (silence) to 1 (max volume)
-t, --sounded-speed        Speed that sounded (spoken) frames should be played at. Typically 1. -t stands for "talking"
-s, --silent-speed         Speed that silent frames should be played. 0 for jumpcutting.
-m, --frame-margin         Some silent frames adjacent to sounded frames are included to provide context. How many frames on either the side of speech should be included? That's this variable.
-S, --sample-rate          Sample rate of the input and output videos
-r. --frame-rate           Frame rate of the input and output videos. optional... I try to find it out myself, but it doesn't always work.
-q, --frame-quality        Quality of frames to be extracted from input video. 1is highest, 31 is lowest, 3 is the default.

There are a couple of bad non-intuitive arguments on this list.

E.g.: The capital -S for sample rate could be mistaken for the -s for silent speed. The -q being mistaken for what most programs use as --quiet.

Space-G avatar Jun 14 '19 13:06 Space-G

That does look good! Idk maybe have --input-file as -i (like how --output-file is -o), then --frame-rate as -f and then --sample-rate as -r

James-Livesey avatar Jun 24 '19 18:06 James-Livesey