Skip to content

Commit d74225a

Browse files
WyattBlueWyattBlue
committed
Update Edit reference
1 parent d8ac48e commit d74225a

File tree

1 file changed

+71
-0
lines changed

1 file changed

+71
-0
lines changed

‎docs/src/ref/edit.html

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,83 @@
66
{{ head_icon }}
77
<style>
88
{{ core_style }}
9+
.palet-block {
10+
padding-left: 7px;
11+
padding-bottom: 7px;
12+
padding-top: 7px;
13+
margin-top: 30px;
14+
margin-bottom: 6px;
15+
}
16+
.palet-block > p {margin-top: 0; margin-bottom: 0}
17+
.palet-var {
18+
position: relative;
19+
left: -1px;
20+
font-size: 85%;
21+
font-style: italic;
22+
font-family: SFMono-Regular, ui-monospace, SF Mono, Menlo, Consolas, Liberation Mono, monospace;
23+
}
24+
.palet-val {
25+
color: #0B65B8;
26+
font-size: 85%;
27+
font-family: SFMono-Regular, ui-monospace, SF Mono, Menlo, Consolas, Liberation Mono, monospace;
28+
}
29+
.palet-block { background-color: #F9F5F5; border-top: 3px solid #EAEAEA}
30+
@media (prefers-color-scheme: dark) {
31+
.palet-block {background-color: #323232; border-top: 3px solid #4A4A4A}
32+
.palet-val {color: #A3DEFF}
33+
}
934
</style>
35+
</head>
1036
<body>
1137
{{ nav }}
1238
<section class="section">
1339
<div class="container">
40+
<h1>Edit Reference</h1>
41+
<p>When you run:<p>
42+
<pre><code>auto-editor example.mp4 --edit audio:0.05,stream=0</code></pre>
43+
<p>You're writing the syntax-sugary equivalent of:</p>
44+
<pre><code>auto-editor example.mp4 --edit "(audio 0.05 #:stream 0)"</code></pre>
45+
<p>All the edit methods are listed below:</p>
46+
<h2>Edit Methods</h2>
47+
<div id="audio" class="palet-block">
48+
<p class="mono">(<b>audio</b>&nbsp;<span class="palet-var">[threshold]</span>&nbsp;<span class="palet-var">[stream]</span>&nbsp;<span class="palet-var">[mincut]</span>&nbsp;<span class="palet-var">[minclip]</span>)&nbsp;→&nbsp;<a href="#bool-array?">bool-array?</a>&nbsp;&nbsp;Procedure</p>
49+
<p class="mono">&nbsp;<span class="palet-var">threshold</span>:&nbsp;Threshold&nbsp;=&nbsp;0.04</p>
50+
<p class="mono">&nbsp;<span class="palet-var">stream</span>:&nbsp;(U Natural 'all)&nbsp;=&nbsp;'all</p>
51+
<p class="mono">&nbsp;<span class="palet-var">mincut</span>:&nbsp;Natural&nbsp;=&nbsp;6</p>
52+
<p class="mono">&nbsp;<span class="palet-var">minclip</span>:&nbsp;Natural&nbsp;=&nbsp;3</p>
53+
</div>
54+
<p>Do a one-pass audio filter based on loudest sample in a timebase section, divided by the max value a sample can be. Then apply minclip, then mincut since this method particular benenfits.</p>
55+
56+
<div id="motion" class="palet-block">
57+
<p class="mono">(<b>motion</b>&nbsp;<span class="palet-var">[threshold]</span>&nbsp;<span class="palet-var">[stream]</span>&nbsp;<span class="palet-var">[blur]</span>&nbsp;<span class="palet-var">[width]</span>)&nbsp;→&nbsp;<a href="#bool-array?">bool-array?</a>&nbsp;&nbsp;Procedure</p>
58+
<p class="mono">&nbsp;<span class="palet-var">threshold</span>:&nbsp;Threshold&nbsp;=&nbsp;0.02</p>
59+
<p class="mono">&nbsp;<span class="palet-var">stream</span>:&nbsp;Natural&nbsp;=&nbsp;0</p>
60+
<p class="mono">&nbsp;<span class="palet-var">blur</span>:&nbsp;Natural&nbsp;=&nbsp;9</p>
61+
<p class="mono">&nbsp;<span class="palet-var">width</span>:&nbsp;Natural&nbsp;=&nbsp;400</p>
62+
</div>
63+
<p>Scale the video to <span class="palet-var">width</span> pixels, convert to grayscale, apply a Gaussian blur of <span class="palet-var">blur</span> amount, then compare the difference with the previous frame.</p>
64+
65+
<div id="subtitle" class="palet-block">
66+
<p class="mono">(<b>subtitle</b>&nbsp;<span class="palet-var">pattern</span>&nbsp;<span class="palet-var">[stream]</span>&nbsp;<span class="palet-var">[ignore-case]</span>&nbsp;<span class="palet-var">[max-count]</span>)&nbsp;→&nbsp;<a href="#bool-array?">bool-array?</a>&nbsp;&nbsp;Procedure</p>
67+
<p class="mono">&nbsp;<span class="palet-var">pattern</span>:&nbsp;String</p>
68+
<p class="mono">&nbsp;<span class="palet-var">stream</span>:&nbsp;Natural&nbsp;=&nbsp;0</p>
69+
<p class="mono">&nbsp;<span class="palet-var">ignore-case</span>:&nbsp;Bool&nbsp;=&nbsp;<span class="palet-val">#f</span></p>
70+
<p class="mono">&nbsp;<span class="palet-var">max-count</span>:&nbsp;(U Natural Nil)&nbsp;=&nbsp;<span class="palet-val">nil</span></p>
71+
</div>
72+
<p>When <span class="palet-var">pattern</span>, a RegEx Expression, matches a subtitle line, consider that time the line occupies as loud.</p>
73+
74+
<h2>Operators</h2>
75+
<div id="or" class="palet-block">
76+
<p class="mono">(<b>or</b>&nbsp;<span class="palet-var">operand</span>&nbsp;<span class="palet-var">...</span>)&nbsp;→&nbsp;<a href="#bool-array?">bool-array?</a>&nbsp;&nbsp;Procedure</p>
77+
<p class="mono">&nbsp;<span class="palet-var">operand</span>:&nbsp;<a href="#bool-array?">bool-array?</a></p>
78+
</div>
79+
<p>"Logical Or" two or more boolean arrays. If they are different lengths, use the biggest one.</p>
1480

81+
<div id="and" class="palet-block">
82+
<p class="mono">(<b>and</b>&nbsp;<span class="palet-var">operand</span>&nbsp;<span class="palet-var">...</span>)&nbsp;→&nbsp;<a href="#bool-array?">bool-array?</a>&nbsp;&nbsp;Procedure</p>
83+
<p class="mono">&nbsp;<span class="palet-var">operand</span>:&nbsp;<a href="#bool-array?">bool-array?</a></p>
84+
</div>
85+
<p>"Logical And" two or more boolean arrays.</p>
1586
</div>
1687
</section>
1788
</body>

0 commit comments

Comments
 (0)