Skip to content

Commit

Permalink
added new documentation plus verison bump
Browse files Browse the repository at this point in the history
  • Loading branch information
WyattBoothe committed Feb 28, 2021
1 parent 6e1dbbc commit 8a9a000
Show file tree
Hide file tree
Showing 6 changed files with 83 additions and 7 deletions.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[![Actions Status](https://github.com/wyattblue/auto-editor/workflows/build/badge.svg)](https://github.com/wyattblue/auto-editor/actions)
<a href="https://discord.com/invite/kMHAWJJ/"><img src="https://img.shields.io/discord/711767814821773372?color=%237289DA&label=chat&logo=discord&logoColor=white"></a>
<img src="https://img.shields.io/badge/version-21w06a-blue.svg">
<img src="https://img.shields.io/badge/version-21w08a-blue.svg">
<p align="center"><img src="https://raw.githubusercontent.com/wyattblue/auto-editor/master/articles/imgs/auto-editor_banner.png" title="Auto-Editor" width="700"></p>

**Auto-Editor** is a command line application for automatically **editing video and audio** by analyzing where sections are silent and cutting them up.
Expand Down Expand Up @@ -46,6 +46,8 @@ auto-editor example.mp4 --frame_margin 8
- [How to Use Motion Detection in Auto-Editor](https://github.com/WyattBlue/auto-editor/blob/master/articles/motionDetection.md)
- [`--cut_out`, `--ignore`, and Range Syntax](https://github.com/WyattBlue/auto-editor/blob/master/articles/rangeSyntax.md)
- [Zooming](https://github.com/WyattBlue/auto-editor/blob/master/articles/zooming.md)
- [The Rectangle Effect](https://github.com/WyattBlue/auto-editor/blob/master/articles/rectangleEffect.md)
- [Subcommands](https://github.com/WyattBlue/auto-editor/blob/master/articles/subcommands.md)

## Copyright
Auto-Editor is under the [Public Domain](https://github.com/WyattBlue/auto-editor/blob/master/LICENSE) but contains non-free elements. See [this page](https://github.com/WyattBlue/auto-editor/blob/master/articles/legalinfo.md) for more info.
Expand Down
32 changes: 32 additions & 0 deletions articles/rectangleEffect.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# Rectangle Effect
last modified February 28, 2021. 21w08a.

## Introduction
The rectangle effect option will overlay a rectangle on a video.

The arguments are:

```
--rectangle {start},{end},{x1},{y1},{x2},{y2},{color},{thickness}
```

or using real values:

```
--rectangle 0,30,0,100,200,300,#5ADAE8,15
```

Which means: overlay a rectangle from frame 0 to frame 30, fill at point (0, 100) and point (200, 300), color it with hex #5ADAE8, and set the thickness to 15 pixels.

The rectangle completely solid if the thickness value is left out.
The color will default to black if not specified.

The rectangle option needs at least 6 comma arguments.

### Note

Boolean Expressions are supported for this option just like with zooming.

---

Support for zooming and other effects for Premiere Pro coming soon!
27 changes: 27 additions & 0 deletions articles/subcommands.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# Subcommands
last modified February 28, 2021. 21w08a.

Subcommands are keywords that have their own options, seperate from the main auto-editor program. They typically serve an auxillary function.

Syntax:

```
auto-editor {subcommand} {*options}
```

Examples:

```
auto-editor info example.mp4
```

```
auto-editor generate_test --fps 25
```


List of subcommands currently avaiable:

1. info
1. test
1. generate_test
23 changes: 19 additions & 4 deletions articles/zooming.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Zooming
last modified February 14, 2021. 21w06a.
last modified February 28, 2021. 21w08a.

## Introduction
The `--zoom` option allows auto-editor to zoom in or out in any place. In order for the `--zoom` option to work, it needs at least 3 values:
Expand All @@ -11,7 +11,7 @@ The `--zoom` option allows auto-editor to zoom in or out in any place. In order
This is entered in as:

```
--zoom {start},{end},{start_level}
--zoom {start},{end},{start_zoom}
```

or using real numbers,
Expand Down Expand Up @@ -53,13 +53,28 @@ auto-editor example.mp4 --zoom 0,20,0.5,1.5
The zoom option can take more comma arguments, such as:

```
--zoom {start},{end},{start_level},{end_level},{x_pos},{y_pos},{interpolate_method}
--zoom {start},{end},{start_zoom},{end_zoom},{x_pos},{y_pos},{interpolate_method}
```

`x_pos` and `y_pos` can be variables like `centerX`, `centerY`, `width`, and `height`, or just regular numbers.

`interpolate_method` is `linear` by default but can be changed `sine`, `start_sine` and `end_sine`.

## Boolean Expressions

Zooming can start and end whenever an event happens. One event can be when the average audio loudness of a frame is higher than a certain point.

Examples:

```
auto-editor example.mp4 --zoom audio>0.05,audio<0.03,1,1.2,centerX,centerY,sine
```

```
auto-editor example.mp4 --zoom audio>0.05,120,1,1.2,centerX,centerY,sine
```


## Additional Examples Commands

```
Expand Down Expand Up @@ -103,4 +118,4 @@ auto-editor generate_test -o 'testsrc.mp4'

---

Zooming is not implemented in the av render method, and will not be used when exporting to other editors until 21w07a or greater.
Support for zooming and other effects for Premiere Pro coming soon!
2 changes: 1 addition & 1 deletion auto_editor/__init__.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
'''__init__.py'''

__version__ = '21.7.1'
__version__ = '21.8.1'
2 changes: 1 addition & 1 deletion auto_editor/__main__.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
import tempfile
from shutil import rmtree

version = '21w08a dev'
version = '21w08a'

def file_type(file: str) -> str:
if(not os.path.isfile(file)):
Expand Down

0 comments on commit 8a9a000

Please sign in to comment.