-
Notifications
You must be signed in to change notification settings - Fork 432
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
4 changed files
with
39 additions
and
8 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,26 @@ | ||
| {{ comp.header "Why It's Time to Remove --silent-threshold" }} | ||
| <body> | ||
| {{ comp.nav }} | ||
| <section class="section"> | ||
| <div class="container"> | ||
| <!-- Titles Are Capitalized in AP Style --> | ||
| <h1>Why It's Time To Remove <code>--silent-threshold</code></h1> | ||
| <p class="author">Author: <b>WyattBlue</b></p> | ||
| <p class="date">Date: <b>July 26, 2022</b></p> | ||
| <p>TL;DR use <code>--edit audio:threshold=NUM</code> instead.</p> | ||
| <hr> | ||
| <p><code>--silent-threshold</code> has been with us since the <a href="https://github.com/WyattBlue/auto-editor/blob/3a2211573742c0e3eb9bcc6e55e21cbcdca661e6/auto-editor.py">literal first day of auto-editor's existence</a>. However, it's continued usage has become problematic. It's finally time to put this aging option to rest.</p> | ||
| <h3>Reason 1: It's Too Ambiguous</h3> | ||
| <p>Every threshold controls what is considered silent and loud, yet <code>--silent-threshold</code> only controls audio threshold. This used to make sense when auto-editor used to only have one way of automatically editing files. But now, it's not so obvious that it still only controls audio threshold, or really, that <code>--silent-threshold</code> only controls the default value of the <code>threshold</code> attribute of <code>--edit</code>, which leads us to...</p> | ||
|
|
||
| <h3>Reason 2: <code>--edit</code>'s Syntax Is So Much Nicer</h3> | ||
| <p>With <code>--edit</code>'s syntax, you can edit multiple tracks with different thresholds, something never possible with the <code>--silent-threshold</code>.</p> | ||
| <pre><code>auto-editor multi-track.mov --edit 'audio:stream=0,threshold=0.04 or audio:stream=1,threshold=0.09'</code></pre> | ||
| <p>It's also much clearer how threshold impacts the editing process while <code>--silent-threshold</code> is much more opaque on how it exactly works and how it interacts with <code>--edit</code>. Why bother explaining how <code>--silent-threshold</code> interacts with <code>--edit</code> to every user when <code>--edit</code> is better in every way?</p> | ||
| <h3>Reason 3: It’s Used Surprisingly Little Out in the Wild</h3> | ||
| <p><code>--silent-threshold</code> and it's alias <code>-t</code> is used surprising little in scripts. I look at <a href="https://github.com/WyattBlue/auto-editor/network/dependents?package_id=UGFja2FnZS0xMzQ0MTE1MzMz">GitHub's Dependency Graph</a> and watch various YouTube videos showcasing auto-editor to gauge how options are used in the real world, and in all usages I can find, it's never mentioned at all. This might be both that <code>4%</code> is a very good default that doesn't need changing and/or how audio threshold works is unintuitive, which is why it is never explained or used. Whatever the case, this lack of usage means <code>--silent-threshold</code> can be removed without causing annoyance.</p> | ||
| <hr> | ||
| <h3>Appendix: Why Not Create a Macro?</h3> | ||
| <p>When I removed <code>--export-to-premiere</code> and <code>--export-to-final-cut-pro</code> options, I used a 'macro' that essentially silently treats <code>'--export-to-premiere'</code> like <code>'--export premiere'</code> and this allowed users to write the option in the "old style", blissfully unaware of any changes, even when the option and it's help text technically doesn't exist anymore. The reason why I didn't use a similar strategy for <code>--silent-threshold</code> is that any script makers who feel the need to change silent threshold, are the people most who would benefit from the flexibility of <code>--edit</code>. | ||
| </body> | ||
| </html> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters