From f36f6b0792427e8c03c80c485efa82b24fe44a85 Mon Sep 17 00:00:00 2001 From: cskonopka Date: Sun, 30 Nov 2025 22:12:06 -0500 Subject: [PATCH] updating docs with individual fils --- docs/getting-started.md | 27 ---------- docs/programs/effects.md | 49 ------------------- docs/programs/effects/bad_animation.md | 25 ++++++++++ docs/programs/effects/bad_contrast.md | 25 ++++++++++ docs/programs/effects/bad_predator.md | 25 ++++++++++ docs/programs/effects/ball_point_pen.md | 25 ++++++++++ docs/programs/effects/blur_pix.md | 25 ++++++++++ docs/programs/effects/crossmosh.md | 34 +++++++++++++ docs/programs/effects/digital_boss.md | 25 ++++++++++ docs/programs/effects/double_cup.md | 25 ++++++++++ docs/programs/effects/frame_delay_pro1.md | 26 ++++++++++ docs/programs/effects/frame_delay_pro2.md | 26 ++++++++++ docs/programs/effects/ghostee.md | 25 ++++++++++ docs/programs/effects/lagkage.md | 28 +++++++++++ docs/programs/effects/looper_pro.md | 25 ++++++++++ docs/programs/effects/lsd_feedback.md | 25 ++++++++++ docs/programs/effects/mince.md | 45 +++++++++++++++++ docs/programs/effects/mirror_delay.md | 25 ++++++++++ docs/programs/effects/nostalgic_stutter.md | 25 ++++++++++ docs/programs/effects/overexposed_stutter.md | 25 ++++++++++ docs/programs/effects/overlay_img_pro.md | 29 +++++++++++ docs/programs/effects/pickle_juice.md | 25 ++++++++++ docs/programs/effects/recalled_sensor.md | 25 ++++++++++ docs/programs/effects/repainting.md | 25 ++++++++++ docs/programs/effects/resize.md | 26 ++++++++++ docs/programs/effects/reverse.md | 25 ++++++++++ docs/programs/effects/scrolling.md | 25 ++++++++++ docs/programs/effects/scrolling_pro.md | 26 ++++++++++ docs/programs/effects/septic.md | 25 ++++++++++ docs/programs/effects/slight_smear.md | 25 ++++++++++ docs/programs/effects/smudge.md | 25 ++++++++++ docs/programs/effects/soapblind.md | 25 ++++++++++ docs/programs/effects/speed.md | 25 ++++++++++ docs/programs/effects/splitting.md | 25 ++++++++++ docs/programs/effects/splitting_pro.md | 26 ++++++++++ docs/programs/effects/stack_2x.md | 25 ++++++++++ docs/programs/effects/steel_wash.md | 25 ++++++++++ docs/programs/effects/stutter_pro.md | 25 ++++++++++ docs/programs/effects/t1000.md | 25 ++++++++++ docs/programs/effects/twociz.md | 25 ++++++++++ docs/programs/effects/wbflare.md | 25 ++++++++++ docs/programs/effects/xrgb.md | 25 ++++++++++ docs/programs/effects/zapruder.md | 25 ++++++++++ docs/programs/utilities.md | 49 ------------------- docs/programs/utilities/captburn.md | 49 +++++++++++++++++++ docs/programs/utilities/chain_builder.md | 21 ++++++++ docs/programs/utilities/convert.md | 21 ++++++++ docs/programs/utilities/convert_dims.md | 21 ++++++++ docs/programs/utilities/convert_mux.md | 40 +++++++++++++++ docs/programs/utilities/download_yt.md | 21 ++++++++ docs/programs/utilities/extract_frames.md | 21 ++++++++ docs/programs/utilities/extract_sound.md | 21 ++++++++ docs/programs/utilities/frame_interpolate.md | 34 +++++++++++++ docs/programs/utilities/gamma_fix.md | 31 ++++++++++++ docs/programs/utilities/hash_fingerprint.md | 30 ++++++++++++ docs/programs/utilities/lut_apply.md | 33 +++++++++++++ docs/programs/utilities/meta_extraction.md | 28 +++++++++++ docs/programs/utilities/num_edits.md | 21 ++++++++ docs/programs/utilities/qwikchop.md | 30 ++++++++++++ docs/programs/utilities/silence_extraction.md | 23 +++++++++ docs/programs/utilities/subs_convert.md | 30 ++++++++++++ docs/programs/utilities/thumbs.md | 35 +++++++++++++ docs/programs/utilities/tonemap_hdr_sdr.md | 29 +++++++++++ docs/programs/utilities/transraibe.md | 21 ++++++++ docs/programs/utilities/watermark.md | 32 ++++++++++++ docs/programs/utilities/wipe_transitions.md | 26 ++++++++++ 66 files changed, 1684 insertions(+), 125 deletions(-) delete mode 100644 docs/programs/effects.md create mode 100644 docs/programs/effects/bad_animation.md create mode 100644 docs/programs/effects/bad_contrast.md create mode 100644 docs/programs/effects/bad_predator.md create mode 100644 docs/programs/effects/ball_point_pen.md create mode 100644 docs/programs/effects/blur_pix.md create mode 100644 docs/programs/effects/crossmosh.md create mode 100644 docs/programs/effects/digital_boss.md create mode 100644 docs/programs/effects/double_cup.md create mode 100644 docs/programs/effects/frame_delay_pro1.md create mode 100644 docs/programs/effects/frame_delay_pro2.md create mode 100644 docs/programs/effects/ghostee.md create mode 100644 docs/programs/effects/lagkage.md create mode 100644 docs/programs/effects/looper_pro.md create mode 100644 docs/programs/effects/lsd_feedback.md create mode 100644 docs/programs/effects/mince.md create mode 100644 docs/programs/effects/mirror_delay.md create mode 100644 docs/programs/effects/nostalgic_stutter.md create mode 100644 docs/programs/effects/overexposed_stutter.md create mode 100644 docs/programs/effects/overlay_img_pro.md create mode 100644 docs/programs/effects/pickle_juice.md create mode 100644 docs/programs/effects/recalled_sensor.md create mode 100644 docs/programs/effects/repainting.md create mode 100644 docs/programs/effects/resize.md create mode 100644 docs/programs/effects/reverse.md create mode 100644 docs/programs/effects/scrolling.md create mode 100644 docs/programs/effects/scrolling_pro.md create mode 100644 docs/programs/effects/septic.md create mode 100644 docs/programs/effects/slight_smear.md create mode 100644 docs/programs/effects/smudge.md create mode 100644 docs/programs/effects/soapblind.md create mode 100644 docs/programs/effects/speed.md create mode 100644 docs/programs/effects/splitting.md create mode 100644 docs/programs/effects/splitting_pro.md create mode 100644 docs/programs/effects/stack_2x.md create mode 100644 docs/programs/effects/steel_wash.md create mode 100644 docs/programs/effects/stutter_pro.md create mode 100644 docs/programs/effects/t1000.md create mode 100644 docs/programs/effects/twociz.md create mode 100644 docs/programs/effects/wbflare.md create mode 100644 docs/programs/effects/xrgb.md create mode 100644 docs/programs/effects/zapruder.md delete mode 100644 docs/programs/utilities.md create mode 100644 docs/programs/utilities/captburn.md create mode 100644 docs/programs/utilities/chain_builder.md create mode 100644 docs/programs/utilities/convert.md create mode 100644 docs/programs/utilities/convert_dims.md create mode 100644 docs/programs/utilities/convert_mux.md create mode 100644 docs/programs/utilities/download_yt.md create mode 100644 docs/programs/utilities/extract_frames.md create mode 100644 docs/programs/utilities/extract_sound.md create mode 100644 docs/programs/utilities/frame_interpolate.md create mode 100644 docs/programs/utilities/gamma_fix.md create mode 100644 docs/programs/utilities/hash_fingerprint.md create mode 100644 docs/programs/utilities/lut_apply.md create mode 100644 docs/programs/utilities/meta_extraction.md create mode 100644 docs/programs/utilities/num_edits.md create mode 100644 docs/programs/utilities/qwikchop.md create mode 100644 docs/programs/utilities/silence_extraction.md create mode 100644 docs/programs/utilities/subs_convert.md create mode 100644 docs/programs/utilities/thumbs.md create mode 100644 docs/programs/utilities/tonemap_hdr_sdr.md create mode 100644 docs/programs/utilities/transraibe.md create mode 100644 docs/programs/utilities/watermark.md create mode 100644 docs/programs/utilities/wipe_transitions.md diff --git a/docs/getting-started.md b/docs/getting-started.md index 8c202d5..7fa9777 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -4,33 +4,6 @@ title: Getting Started nav_order: 2 --- -## Project dependencies -### macOS/Linux - -In the shell prompt, go to the place where you want the project to live. Paste that in a macOS Terminal or Linux shell prompt & run it. - -``` bash -/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/schwwaaa/videobeaux/refs/heads/main/install.sh)" -``` - -### Windows - -``` powershell -choco install ffmpeg -setx VIDEOBEAUX_PATH "C:\videobeaux" -``` - -## Usage - -### Activate virtual environment -This will activate your virtual environment. Immediately, you will notice that your terminal path includes env, signifying an activated virtual environment. -``` bash -source env/bin/activate -``` - -### Check the installation - -### Get help and find out more about videobeaux ``` bash videobeaux --help ``` diff --git a/docs/programs/effects.md b/docs/programs/effects.md deleted file mode 100644 index 0b7d891..0000000 --- a/docs/programs/effects.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -layout: default -title: Effects -nav_order: 5 ---- - -| Program | Description | Arguments | -| -------- | ------- | ------- | -| bad_animation | Apply a bad animation effect | - | -| bad_contrast | Apply a bad constrast effect | - | -| ball_point_pen | Apply a ball point pen style effect | - | -| blur_pix | Extracting the silence out of a video file | - | -| bad_predator | Apply bad Predator heat vision effect | - | -| crossmosh | A controlled datamoshing engine that manipulates motion vectors and frame order to create stylized glitch-drift distortions | b_input, outfile, codec, qscale, gop, keep_temp, mode, frames, decay, blend | -| digital_boss | Apply busted gameboy style digital boss effect | - | -| double_cup | Apply the effect of purple drank | - | -| frame_delay_pro1 | Apply frame delay effect with parameter input | frame_quantity, frame_weights | -| frame_delay_pro2 | Apply frame delay effect with parameter input | decay, plane | -| ghostee | Apply a slight ghost effect | - | -| lagkage | A JSON-driven multilayer video compositor that stacks, positions, resizes, and mixes multiple media sources into one unified output | layout_json, sequence_direction, audio_mode, audio_src | -| looper_pro | Apply video looper effect base on frame size & start frame | - | -| lsd_feedback | Apply LSD-like frame delay effect | - | -| mince | A fast, lossless segment-extractor and concatenator that slices videos into parts and recombines them with precision | mode, seed, engine, normalize, size, fit, fps, pixfmt, ar, ac, norm_vcodec, norm_crf, norm_preset, vcodec, acodec, crf, preset, faststart, fallback_reencode, decode_tolerant, hard_trim | -| mirror_delay | Apply a frame delay plus a mirrored effect | - | -| nostalgic_stutter | Apply frame stutter akin to a corrupted file | - | -| overexposed_stutter | Apply a frame stutter and exposing the video like the- | file is corrupted | - | -| overlay_img_pro | Overlay an image with location & dimension control | overlay_img, x_pos, y_pos, img_height, img_width | -| pickle_juice | Apply filter like the video was dipped in pickle juice | - | -| recalled_sensor | Apply filter like a sensor was broken and to-be recalled |- | -| repainting | Apply filter like repainting the same image while smudged with- | alcohol |- | -| resize | Resizing the dimensions of a video file | new_height, new_width | -| reverse | Reverse video file | - | -| scrolling_pro | Apply video scrolling effect with definable parameters | horiz_speed, vert_speed | -| scrolling | Apply static video scrolling effect | - | -| septic | Apply filter like a person in septic shock | - | -| slight_smear | Slightly smearing RGB color space | - | -| smudge | Smudging image slightly | - | -| soapblind | Apply filter like soap blinded eyes | - | -| speed | Change the video and audio speed of a file | speed_factor | -| splitting | A simple segmentation utility that divides a video into evenly timed chunks or scene-based fragments for modular editing | - | -| splitting_pro | Precise segmentation tool that slices a source video into reusable chunks based on time, count, or scene-style rules for downstream editing and recombination. | width, position | -| stack_2x | Stack 2 videos on top of each other keeping the original- | orientation | input2 | -| steel_wash | Apply steel blue filter to video | - | -| stutter_pro | Apply frame stutter effect with definable parameters | stutter | -| t1000 | Apply filter from the perspective of liquid T-1000 | - | -| twociz | Apply filter from the perspective of a zombie on TC-1 hallucinogens | - | -| wbflare | Apply filter with a blown out white-balance flare | - | -| zapruder | Apply zapruder-film like effect | - | -| xrgb | Extreme RGB adjustment | - | \ No newline at end of file diff --git a/docs/programs/effects/bad_animation.md b/docs/programs/effects/bad_animation.md new file mode 100644 index 0000000..bdb2995 --- /dev/null +++ b/docs/programs/effects/bad_animation.md @@ -0,0 +1,25 @@ +# bad_animation + +## Description + +Apply a bad animation effect + +## Arguments + +- *(No additional program-specific arguments; uses global videobeaux options only.)* + +## Program Template + +```bash +videobeaux -P bad_animation -i input.mp4 -o output.mp4 +``` + +## Real World Example + +```bash +videobeaux -P bad_animation -i myvideo.mp4 -o bad_animation_styled.mp4 +``` + +## Program Output + +[Program output video](https://github.com/schwwaaa/videobeaux/assets/7625379/65403294-3e34-4ff8-816a-5de7c80c811d) diff --git a/docs/programs/effects/bad_contrast.md b/docs/programs/effects/bad_contrast.md new file mode 100644 index 0000000..69295ce --- /dev/null +++ b/docs/programs/effects/bad_contrast.md @@ -0,0 +1,25 @@ +# bad_contrast + +## Description + +Apply a bad constrast effect + +## Arguments + +- *(No additional program-specific arguments; uses global videobeaux options only.)* + +## Program Template + +```bash +videobeaux -P bad_contrast -i input.mp4 -o output.mp4 +``` + +## Real World Example + +```bash +videobeaux -P bad_contrast -i myvideo.mp4 -o bad_contrast_styled.mp4 +``` + +## Program Output + +[Program output video](https://github.com/schwwaaa/videobeaux/assets/7625379/65403294-3e34-4ff8-816a-5de7c80c811d) diff --git a/docs/programs/effects/bad_predator.md b/docs/programs/effects/bad_predator.md new file mode 100644 index 0000000..11f18af --- /dev/null +++ b/docs/programs/effects/bad_predator.md @@ -0,0 +1,25 @@ +# bad_predator + +## Description + +Apply bad Predator heat vision effect + +## Arguments + +- *(No additional program-specific arguments; uses global videobeaux options only.)* + +## Program Template + +```bash +videobeaux -P bad_predator -i input.mp4 -o output.mp4 +``` + +## Real World Example + +```bash +videobeaux -P bad_predator -i myvideo.mp4 -o bad_predator_styled.mp4 +``` + +## Program Output + +[Program output video](https://github.com/schwwaaa/videobeaux/assets/7625379/65403294-3e34-4ff8-816a-5de7c80c811d) diff --git a/docs/programs/effects/ball_point_pen.md b/docs/programs/effects/ball_point_pen.md new file mode 100644 index 0000000..b071388 --- /dev/null +++ b/docs/programs/effects/ball_point_pen.md @@ -0,0 +1,25 @@ +# ball_point_pen + +## Description + +Apply a ball point pen style effect + +## Arguments + +- *(No additional program-specific arguments; uses global videobeaux options only.)* + +## Program Template + +```bash +videobeaux -P ball_point_pen -i input.mp4 -o output.mp4 +``` + +## Real World Example + +```bash +videobeaux -P ball_point_pen -i myvideo.mp4 -o ball_point_pen_styled.mp4 +``` + +## Program Output + +[Program output video](https://github.com/schwwaaa/videobeaux/assets/7625379/65403294-3e34-4ff8-816a-5de7c80c811d) diff --git a/docs/programs/effects/blur_pix.md b/docs/programs/effects/blur_pix.md new file mode 100644 index 0000000..40a2467 --- /dev/null +++ b/docs/programs/effects/blur_pix.md @@ -0,0 +1,25 @@ +# blur_pix + +## Description + +Extracting the silence out of a video file + +## Arguments + +- *(No additional program-specific arguments; uses global videobeaux options only.)* + +## Program Template + +```bash +videobeaux -P blur_pix -i input.mp4 -o output.mp4 +``` + +## Real World Example + +```bash +videobeaux -P blur_pix -i myvideo.mp4 -o blur_pix_styled.mp4 +``` + +## Program Output + +[Program output video](https://github.com/schwwaaa/videobeaux/assets/7625379/65403294-3e34-4ff8-816a-5de7c80c811d) diff --git a/docs/programs/effects/crossmosh.md b/docs/programs/effects/crossmosh.md new file mode 100644 index 0000000..f48a5c9 --- /dev/null +++ b/docs/programs/effects/crossmosh.md @@ -0,0 +1,34 @@ +# crossmosh + +## Description + +A controlled datamoshing engine that manipulates motion vectors and frame order to create stylized glitch-drift distortions + +## Arguments + +- `b_input` +- `outfile` +- `codec` +- `qscale` +- `gop` +- `keep_temp` +- `mode` +- `frames` +- `decay` +- `blend` + +## Program Template + +```bash +videobeaux -P crossmosh -i input.mp4 -o output.mp4 --b_input VALUE --outfile VALUE --codec VALUE --qscale VALUE --gop VALUE --keep_temp VALUE --mode VALUE --frames VALUE --decay VALUE --blend VALUE +``` + +## Real World Example + +```bash +videobeaux -P crossmosh -i myvideo.mp4 -o crossmosh_styled.mp4 --b_input EXAMPLE --outfile EXAMPLE --codec EXAMPLE --qscale EXAMPLE --gop EXAMPLE --keep_temp EXAMPLE --mode EXAMPLE --frames EXAMPLE --decay EXAMPLE --blend EXAMPLE +``` + +## Program Output + +[Program output video](https://github.com/schwwaaa/videobeaux/assets/7625379/65403294-3e34-4ff8-816a-5de7c80c811d) diff --git a/docs/programs/effects/digital_boss.md b/docs/programs/effects/digital_boss.md new file mode 100644 index 0000000..52e21ea --- /dev/null +++ b/docs/programs/effects/digital_boss.md @@ -0,0 +1,25 @@ +# digital_boss + +## Description + +Apply busted gameboy style digital boss effect + +## Arguments + +- *(No additional program-specific arguments; uses global videobeaux options only.)* + +## Program Template + +```bash +videobeaux -P digital_boss -i input.mp4 -o output.mp4 +``` + +## Real World Example + +```bash +videobeaux -P digital_boss -i myvideo.mp4 -o digital_boss_styled.mp4 +``` + +## Program Output + +[Program output video](https://github.com/schwwaaa/videobeaux/assets/7625379/65403294-3e34-4ff8-816a-5de7c80c811d) diff --git a/docs/programs/effects/double_cup.md b/docs/programs/effects/double_cup.md new file mode 100644 index 0000000..f37d3e8 --- /dev/null +++ b/docs/programs/effects/double_cup.md @@ -0,0 +1,25 @@ +# double_cup + +## Description + +Apply the effect of purple drank + +## Arguments + +- *(No additional program-specific arguments; uses global videobeaux options only.)* + +## Program Template + +```bash +videobeaux -P double_cup -i input.mp4 -o output.mp4 +``` + +## Real World Example + +```bash +videobeaux -P double_cup -i myvideo.mp4 -o double_cup_styled.mp4 +``` + +## Program Output + +[Program output video](https://github.com/schwwaaa/videobeaux/assets/7625379/65403294-3e34-4ff8-816a-5de7c80c811d) diff --git a/docs/programs/effects/frame_delay_pro1.md b/docs/programs/effects/frame_delay_pro1.md new file mode 100644 index 0000000..126c775 --- /dev/null +++ b/docs/programs/effects/frame_delay_pro1.md @@ -0,0 +1,26 @@ +# frame_delay_pro1 + +## Description + +Apply frame delay effect with parameter input + +## Arguments + +- `frame_quantity` +- `frame_weights` + +## Program Template + +```bash +videobeaux -P frame_delay_pro1 -i input.mp4 -o output.mp4 --frame_quantity VALUE --frame_weights VALUE +``` + +## Real World Example + +```bash +videobeaux -P frame_delay_pro1 -i myvideo.mp4 -o frame_delay_pro1_styled.mp4 --frame_quantity EXAMPLE --frame_weights EXAMPLE +``` + +## Program Output + +[Program output video](https://github.com/schwwaaa/videobeaux/assets/7625379/65403294-3e34-4ff8-816a-5de7c80c811d) diff --git a/docs/programs/effects/frame_delay_pro2.md b/docs/programs/effects/frame_delay_pro2.md new file mode 100644 index 0000000..6cb7d47 --- /dev/null +++ b/docs/programs/effects/frame_delay_pro2.md @@ -0,0 +1,26 @@ +# frame_delay_pro2 + +## Description + +Apply frame delay effect with parameter input + +## Arguments + +- `decay` +- `plane` + +## Program Template + +```bash +videobeaux -P frame_delay_pro2 -i input.mp4 -o output.mp4 --decay VALUE --plane VALUE +``` + +## Real World Example + +```bash +videobeaux -P frame_delay_pro2 -i myvideo.mp4 -o frame_delay_pro2_styled.mp4 --decay EXAMPLE --plane EXAMPLE +``` + +## Program Output + +[Program output video](https://github.com/schwwaaa/videobeaux/assets/7625379/65403294-3e34-4ff8-816a-5de7c80c811d) diff --git a/docs/programs/effects/ghostee.md b/docs/programs/effects/ghostee.md new file mode 100644 index 0000000..8441b22 --- /dev/null +++ b/docs/programs/effects/ghostee.md @@ -0,0 +1,25 @@ +# ghostee + +## Description + +Apply a slight ghost effect + +## Arguments + +- *(No additional program-specific arguments; uses global videobeaux options only.)* + +## Program Template + +```bash +videobeaux -P ghostee -i input.mp4 -o output.mp4 +``` + +## Real World Example + +```bash +videobeaux -P ghostee -i myvideo.mp4 -o ghostee_styled.mp4 +``` + +## Program Output + +[Program output video](https://github.com/schwwaaa/videobeaux/assets/7625379/65403294-3e34-4ff8-816a-5de7c80c811d) diff --git a/docs/programs/effects/lagkage.md b/docs/programs/effects/lagkage.md new file mode 100644 index 0000000..f487235 --- /dev/null +++ b/docs/programs/effects/lagkage.md @@ -0,0 +1,28 @@ +# lagkage + +## Description + +A JSON-driven multilayer video compositor that stacks, positions, resizes, and mixes multiple media sources into one unified output + +## Arguments + +- `layout_json` +- `sequence_direction` +- `audio_mode` +- `audio_src` + +## Program Template + +```bash +videobeaux -P lagkage -i input.mp4 -o output.mp4 --layout_json VALUE --sequence_direction VALUE --audio_mode VALUE --audio_src VALUE +``` + +## Real World Example + +```bash +videobeaux -P lagkage -i myvideo.mp4 -o lagkage_styled.mp4 --layout_json EXAMPLE --sequence_direction EXAMPLE --audio_mode EXAMPLE --audio_src EXAMPLE +``` + +## Program Output + +[Program output video](https://github.com/schwwaaa/videobeaux/assets/7625379/65403294-3e34-4ff8-816a-5de7c80c811d) diff --git a/docs/programs/effects/looper_pro.md b/docs/programs/effects/looper_pro.md new file mode 100644 index 0000000..3bcede1 --- /dev/null +++ b/docs/programs/effects/looper_pro.md @@ -0,0 +1,25 @@ +# looper_pro + +## Description + +Apply video looper effect base on frame size & start frame + +## Arguments + +- *(No additional program-specific arguments; uses global videobeaux options only.)* + +## Program Template + +```bash +videobeaux -P looper_pro -i input.mp4 -o output.mp4 +``` + +## Real World Example + +```bash +videobeaux -P looper_pro -i myvideo.mp4 -o looper_pro_styled.mp4 +``` + +## Program Output + +[Program output video](https://github.com/schwwaaa/videobeaux/assets/7625379/65403294-3e34-4ff8-816a-5de7c80c811d) diff --git a/docs/programs/effects/lsd_feedback.md b/docs/programs/effects/lsd_feedback.md new file mode 100644 index 0000000..7ebb525 --- /dev/null +++ b/docs/programs/effects/lsd_feedback.md @@ -0,0 +1,25 @@ +# lsd_feedback + +## Description + +Apply LSD-like frame delay effect + +## Arguments + +- *(No additional program-specific arguments; uses global videobeaux options only.)* + +## Program Template + +```bash +videobeaux -P lsd_feedback -i input.mp4 -o output.mp4 +``` + +## Real World Example + +```bash +videobeaux -P lsd_feedback -i myvideo.mp4 -o lsd_feedback_styled.mp4 +``` + +## Program Output + +[Program output video](https://github.com/schwwaaa/videobeaux/assets/7625379/65403294-3e34-4ff8-816a-5de7c80c811d) diff --git a/docs/programs/effects/mince.md b/docs/programs/effects/mince.md new file mode 100644 index 0000000..e16b1c9 --- /dev/null +++ b/docs/programs/effects/mince.md @@ -0,0 +1,45 @@ +# mince + +## Description + +A fast, lossless segment-extractor and concatenator that slices videos into parts and recombines them with precision + +## Arguments + +- `mode` +- `seed` +- `engine` +- `normalize` +- `size` +- `fit` +- `fps` +- `pixfmt` +- `ar` +- `ac` +- `norm_vcodec` +- `norm_crf` +- `norm_preset` +- `vcodec` +- `acodec` +- `crf` +- `preset` +- `faststart` +- `fallback_reencode` +- `decode_tolerant` +- `hard_trim` + +## Program Template + +```bash +videobeaux -P mince -i input.mp4 -o output.mp4 --mode VALUE --seed VALUE --engine VALUE --normalize VALUE --size VALUE --fit VALUE --fps VALUE --pixfmt VALUE --ar VALUE --ac VALUE --norm_vcodec VALUE --norm_crf VALUE --norm_preset VALUE --vcodec VALUE --acodec VALUE --crf VALUE --preset VALUE --faststart VALUE --fallback_reencode VALUE --decode_tolerant VALUE --hard_trim VALUE +``` + +## Real World Example + +```bash +videobeaux -P mince -i myvideo.mp4 -o mince_styled.mp4 --mode EXAMPLE --seed EXAMPLE --engine EXAMPLE --normalize EXAMPLE --size EXAMPLE --fit EXAMPLE --fps EXAMPLE --pixfmt EXAMPLE --ar EXAMPLE --ac EXAMPLE --norm_vcodec EXAMPLE --norm_crf EXAMPLE --norm_preset EXAMPLE --vcodec EXAMPLE --acodec EXAMPLE --crf EXAMPLE --preset EXAMPLE --faststart EXAMPLE --fallback_reencode EXAMPLE --decode_tolerant EXAMPLE --hard_trim EXAMPLE +``` + +## Program Output + +[Program output video](https://github.com/schwwaaa/videobeaux/assets/7625379/65403294-3e34-4ff8-816a-5de7c80c811d) diff --git a/docs/programs/effects/mirror_delay.md b/docs/programs/effects/mirror_delay.md new file mode 100644 index 0000000..06707da --- /dev/null +++ b/docs/programs/effects/mirror_delay.md @@ -0,0 +1,25 @@ +# mirror_delay + +## Description + +Apply a frame delay plus a mirrored effect + +## Arguments + +- *(No additional program-specific arguments; uses global videobeaux options only.)* + +## Program Template + +```bash +videobeaux -P mirror_delay -i input.mp4 -o output.mp4 +``` + +## Real World Example + +```bash +videobeaux -P mirror_delay -i myvideo.mp4 -o mirror_delay_styled.mp4 +``` + +## Program Output + +[Program output video](https://github.com/schwwaaa/videobeaux/assets/7625379/65403294-3e34-4ff8-816a-5de7c80c811d) diff --git a/docs/programs/effects/nostalgic_stutter.md b/docs/programs/effects/nostalgic_stutter.md new file mode 100644 index 0000000..4595294 --- /dev/null +++ b/docs/programs/effects/nostalgic_stutter.md @@ -0,0 +1,25 @@ +# nostalgic_stutter + +## Description + +Apply frame stutter akin to a corrupted file + +## Arguments + +- *(No additional program-specific arguments; uses global videobeaux options only.)* + +## Program Template + +```bash +videobeaux -P nostalgic_stutter -i input.mp4 -o output.mp4 +``` + +## Real World Example + +```bash +videobeaux -P nostalgic_stutter -i myvideo.mp4 -o nostalgic_stutter_styled.mp4 +``` + +## Program Output + +[Program output video](https://github.com/schwwaaa/videobeaux/assets/7625379/65403294-3e34-4ff8-816a-5de7c80c811d) diff --git a/docs/programs/effects/overexposed_stutter.md b/docs/programs/effects/overexposed_stutter.md new file mode 100644 index 0000000..c97f140 --- /dev/null +++ b/docs/programs/effects/overexposed_stutter.md @@ -0,0 +1,25 @@ +# overexposed_stutter + +## Description + +Apply a frame stutter and exposing the video like the file is corrupted + +## Arguments + +- *(No additional program-specific arguments; uses global videobeaux options only.)* + +## Program Template + +```bash +videobeaux -P overexposed_stutter -i input.mp4 -o output.mp4 +``` + +## Real World Example + +```bash +videobeaux -P overexposed_stutter -i myvideo.mp4 -o overexposed_stutter_styled.mp4 +``` + +## Program Output + +[Program output video](https://github.com/schwwaaa/videobeaux/assets/7625379/65403294-3e34-4ff8-816a-5de7c80c811d) diff --git a/docs/programs/effects/overlay_img_pro.md b/docs/programs/effects/overlay_img_pro.md new file mode 100644 index 0000000..fa9a7a6 --- /dev/null +++ b/docs/programs/effects/overlay_img_pro.md @@ -0,0 +1,29 @@ +# overlay_img_pro + +## Description + +Overlay an image with location & dimension control + +## Arguments + +- `overlay_img` +- `x_pos` +- `y_pos` +- `img_height` +- `img_width` + +## Program Template + +```bash +videobeaux -P overlay_img_pro -i input.mp4 -o output.mp4 --overlay_img VALUE --x_pos VALUE --y_pos VALUE --img_height VALUE --img_width VALUE +``` + +## Real World Example + +```bash +videobeaux -P overlay_img_pro -i myvideo.mp4 -o overlay_img_pro_styled.mp4 --overlay_img EXAMPLE --x_pos EXAMPLE --y_pos EXAMPLE --img_height EXAMPLE --img_width EXAMPLE +``` + +## Program Output + +[Program output video](https://github.com/schwwaaa/videobeaux/assets/7625379/65403294-3e34-4ff8-816a-5de7c80c811d) diff --git a/docs/programs/effects/pickle_juice.md b/docs/programs/effects/pickle_juice.md new file mode 100644 index 0000000..750f4c1 --- /dev/null +++ b/docs/programs/effects/pickle_juice.md @@ -0,0 +1,25 @@ +# pickle_juice + +## Description + +Apply filter like the video was dipped in pickle juice + +## Arguments + +- *(No additional program-specific arguments; uses global videobeaux options only.)* + +## Program Template + +```bash +videobeaux -P pickle_juice -i input.mp4 -o output.mp4 +``` + +## Real World Example + +```bash +videobeaux -P pickle_juice -i myvideo.mp4 -o pickle_juice_styled.mp4 +``` + +## Program Output + +[Program output video](https://github.com/schwwaaa/videobeaux/assets/7625379/65403294-3e34-4ff8-816a-5de7c80c811d) diff --git a/docs/programs/effects/recalled_sensor.md b/docs/programs/effects/recalled_sensor.md new file mode 100644 index 0000000..c1148d9 --- /dev/null +++ b/docs/programs/effects/recalled_sensor.md @@ -0,0 +1,25 @@ +# recalled_sensor + +## Description + +Apply filter like a sensor was broken and to-be recalled + +## Arguments + +- *(No additional program-specific arguments; uses global videobeaux options only.)* + +## Program Template + +```bash +videobeaux -P recalled_sensor -i input.mp4 -o output.mp4 +``` + +## Real World Example + +```bash +videobeaux -P recalled_sensor -i myvideo.mp4 -o recalled_sensor_styled.mp4 +``` + +## Program Output + +[Program output video](https://github.com/schwwaaa/videobeaux/assets/7625379/65403294-3e34-4ff8-816a-5de7c80c811d) diff --git a/docs/programs/effects/repainting.md b/docs/programs/effects/repainting.md new file mode 100644 index 0000000..e9cf458 --- /dev/null +++ b/docs/programs/effects/repainting.md @@ -0,0 +1,25 @@ +# repainting + +## Description + +Apply filter like repainting the same image while smudged with alcohol + +## Arguments + +- *(No additional program-specific arguments; uses global videobeaux options only.)* + +## Program Template + +```bash +videobeaux -P repainting -i input.mp4 -o output.mp4 +``` + +## Real World Example + +```bash +videobeaux -P repainting -i myvideo.mp4 -o repainting_styled.mp4 +``` + +## Program Output + +[Program output video](https://github.com/schwwaaa/videobeaux/assets/7625379/65403294-3e34-4ff8-816a-5de7c80c811d) diff --git a/docs/programs/effects/resize.md b/docs/programs/effects/resize.md new file mode 100644 index 0000000..fb4fc36 --- /dev/null +++ b/docs/programs/effects/resize.md @@ -0,0 +1,26 @@ +# resize + +## Description + +Resizing the dimensions of a video file + +## Arguments + +- `new_height` +- `new_width` + +## Program Template + +```bash +videobeaux -P resize -i input.mp4 -o output.mp4 --new_height VALUE --new_width VALUE +``` + +## Real World Example + +```bash +videobeaux -P resize -i myvideo.mp4 -o resize_styled.mp4 --new_height EXAMPLE --new_width EXAMPLE +``` + +## Program Output + +[Program output video](https://github.com/schwwaaa/videobeaux/assets/7625379/65403294-3e34-4ff8-816a-5de7c80c811d) diff --git a/docs/programs/effects/reverse.md b/docs/programs/effects/reverse.md new file mode 100644 index 0000000..802b97a --- /dev/null +++ b/docs/programs/effects/reverse.md @@ -0,0 +1,25 @@ +# reverse + +## Description + +Reverse video file + +## Arguments + +- *(No additional program-specific arguments; uses global videobeaux options only.)* + +## Program Template + +```bash +videobeaux -P reverse -i input.mp4 -o output.mp4 +``` + +## Real World Example + +```bash +videobeaux -P reverse -i myvideo.mp4 -o reverse_styled.mp4 +``` + +## Program Output + +[Program output video](https://github.com/schwwaaa/videobeaux/assets/7625379/65403294-3e34-4ff8-816a-5de7c80c811d) diff --git a/docs/programs/effects/scrolling.md b/docs/programs/effects/scrolling.md new file mode 100644 index 0000000..4fe3c9b --- /dev/null +++ b/docs/programs/effects/scrolling.md @@ -0,0 +1,25 @@ +# scrolling + +## Description + +Apply static video scrolling effect + +## Arguments + +- *(No additional program-specific arguments; uses global videobeaux options only.)* + +## Program Template + +```bash +videobeaux -P scrolling -i input.mp4 -o output.mp4 +``` + +## Real World Example + +```bash +videobeaux -P scrolling -i myvideo.mp4 -o scrolling_styled.mp4 +``` + +## Program Output + +[Program output video](https://github.com/schwwaaa/videobeaux/assets/7625379/65403294-3e34-4ff8-816a-5de7c80c811d) diff --git a/docs/programs/effects/scrolling_pro.md b/docs/programs/effects/scrolling_pro.md new file mode 100644 index 0000000..49d6c8e --- /dev/null +++ b/docs/programs/effects/scrolling_pro.md @@ -0,0 +1,26 @@ +# scrolling_pro + +## Description + +Apply video scrolling effect with definable parameters + +## Arguments + +- `horiz_speed` +- `vert_speed` + +## Program Template + +```bash +videobeaux -P scrolling_pro -i input.mp4 -o output.mp4 --horiz_speed VALUE --vert_speed VALUE +``` + +## Real World Example + +```bash +videobeaux -P scrolling_pro -i myvideo.mp4 -o scrolling_pro_styled.mp4 --horiz_speed EXAMPLE --vert_speed EXAMPLE +``` + +## Program Output + +[Program output video](https://github.com/schwwaaa/videobeaux/assets/7625379/65403294-3e34-4ff8-816a-5de7c80c811d) diff --git a/docs/programs/effects/septic.md b/docs/programs/effects/septic.md new file mode 100644 index 0000000..8b1d136 --- /dev/null +++ b/docs/programs/effects/septic.md @@ -0,0 +1,25 @@ +# septic + +## Description + +Apply filter like a person in septic shock + +## Arguments + +- *(No additional program-specific arguments; uses global videobeaux options only.)* + +## Program Template + +```bash +videobeaux -P septic -i input.mp4 -o output.mp4 +``` + +## Real World Example + +```bash +videobeaux -P septic -i myvideo.mp4 -o septic_styled.mp4 +``` + +## Program Output + +[Program output video](https://github.com/schwwaaa/videobeaux/assets/7625379/65403294-3e34-4ff8-816a-5de7c80c811d) diff --git a/docs/programs/effects/slight_smear.md b/docs/programs/effects/slight_smear.md new file mode 100644 index 0000000..1018e05 --- /dev/null +++ b/docs/programs/effects/slight_smear.md @@ -0,0 +1,25 @@ +# slight_smear + +## Description + +Slightly smearing RGB color space + +## Arguments + +- *(No additional program-specific arguments; uses global videobeaux options only.)* + +## Program Template + +```bash +videobeaux -P slight_smear -i input.mp4 -o output.mp4 +``` + +## Real World Example + +```bash +videobeaux -P slight_smear -i myvideo.mp4 -o slight_smear_styled.mp4 +``` + +## Program Output + +[Program output video](https://github.com/schwwaaa/videobeaux/assets/7625379/65403294-3e34-4ff8-816a-5de7c80c811d) diff --git a/docs/programs/effects/smudge.md b/docs/programs/effects/smudge.md new file mode 100644 index 0000000..f2d528d --- /dev/null +++ b/docs/programs/effects/smudge.md @@ -0,0 +1,25 @@ +# smudge + +## Description + +Smudging image slightly + +## Arguments + +- *(No additional program-specific arguments; uses global videobeaux options only.)* + +## Program Template + +```bash +videobeaux -P smudge -i input.mp4 -o output.mp4 +``` + +## Real World Example + +```bash +videobeaux -P smudge -i myvideo.mp4 -o smudge_styled.mp4 +``` + +## Program Output + +[Program output video](https://github.com/schwwaaa/videobeaux/assets/7625379/65403294-3e34-4ff8-816a-5de7c80c811d) diff --git a/docs/programs/effects/soapblind.md b/docs/programs/effects/soapblind.md new file mode 100644 index 0000000..bd1942d --- /dev/null +++ b/docs/programs/effects/soapblind.md @@ -0,0 +1,25 @@ +# soapblind + +## Description + +Apply filter like soap blinded eyes + +## Arguments + +- *(No additional program-specific arguments; uses global videobeaux options only.)* + +## Program Template + +```bash +videobeaux -P soapblind -i input.mp4 -o output.mp4 +``` + +## Real World Example + +```bash +videobeaux -P soapblind -i myvideo.mp4 -o soapblind_styled.mp4 +``` + +## Program Output + +[Program output video](https://github.com/schwwaaa/videobeaux/assets/7625379/65403294-3e34-4ff8-816a-5de7c80c811d) diff --git a/docs/programs/effects/speed.md b/docs/programs/effects/speed.md new file mode 100644 index 0000000..4491967 --- /dev/null +++ b/docs/programs/effects/speed.md @@ -0,0 +1,25 @@ +# speed + +## Description + +Change the video and audio speed of a file + +## Arguments + +- `speed_factor` + +## Program Template + +```bash +videobeaux -P speed -i input.mp4 -o output.mp4 --speed_factor VALUE +``` + +## Real World Example + +```bash +videobeaux -P speed -i myvideo.mp4 -o speed_styled.mp4 --speed_factor EXAMPLE +``` + +## Program Output + +[Program output video](https://github.com/schwwaaa/videobeaux/assets/7625379/65403294-3e34-4ff8-816a-5de7c80c811d) diff --git a/docs/programs/effects/splitting.md b/docs/programs/effects/splitting.md new file mode 100644 index 0000000..482633a --- /dev/null +++ b/docs/programs/effects/splitting.md @@ -0,0 +1,25 @@ +# splitting + +## Description + +A simple segmentation utility that divides a video into evenly timed chunks or scene-based fragments for modular editing + +## Arguments + +- *(No additional program-specific arguments; uses global videobeaux options only.)* + +## Program Template + +```bash +videobeaux -P splitting -i input.mp4 -o output.mp4 +``` + +## Real World Example + +```bash +videobeaux -P splitting -i myvideo.mp4 -o splitting_styled.mp4 +``` + +## Program Output + +[Program output video](https://github.com/schwwaaa/videobeaux/assets/7625379/65403294-3e34-4ff8-816a-5de7c80c811d) diff --git a/docs/programs/effects/splitting_pro.md b/docs/programs/effects/splitting_pro.md new file mode 100644 index 0000000..749b947 --- /dev/null +++ b/docs/programs/effects/splitting_pro.md @@ -0,0 +1,26 @@ +# splitting_pro + +## Description + +Precise segmentation tool that slices a source video into reusable chunks based on time, count, or scene-style rules for downstream editing and recombination. + +## Arguments + +- `width` +- `position` + +## Program Template + +```bash +videobeaux -P splitting_pro -i input.mp4 -o output.mp4 --width VALUE --position VALUE +``` + +## Real World Example + +```bash +videobeaux -P splitting_pro -i myvideo.mp4 -o splitting_pro_styled.mp4 --width EXAMPLE --position EXAMPLE +``` + +## Program Output + +[Program output video](https://github.com/schwwaaa/videobeaux/assets/7625379/65403294-3e34-4ff8-816a-5de7c80c811d) diff --git a/docs/programs/effects/stack_2x.md b/docs/programs/effects/stack_2x.md new file mode 100644 index 0000000..99cadd3 --- /dev/null +++ b/docs/programs/effects/stack_2x.md @@ -0,0 +1,25 @@ +# stack_2x + +## Description + +Stack 2 videos on top of each other keeping the original orientation + +## Arguments + +- `input2` + +## Program Template + +```bash +videobeaux -P stack_2x -i input.mp4 -o output.mp4 --input2 VALUE +``` + +## Real World Example + +```bash +videobeaux -P stack_2x -i myvideo.mp4 -o stack_2x_styled.mp4 --input2 EXAMPLE +``` + +## Program Output + +[Program output video](https://github.com/schwwaaa/videobeaux/assets/7625379/65403294-3e34-4ff8-816a-5de7c80c811d) diff --git a/docs/programs/effects/steel_wash.md b/docs/programs/effects/steel_wash.md new file mode 100644 index 0000000..728411c --- /dev/null +++ b/docs/programs/effects/steel_wash.md @@ -0,0 +1,25 @@ +# steel_wash + +## Description + +Apply steel blue filter to video + +## Arguments + +- *(No additional program-specific arguments; uses global videobeaux options only.)* + +## Program Template + +```bash +videobeaux -P steel_wash -i input.mp4 -o output.mp4 +``` + +## Real World Example + +```bash +videobeaux -P steel_wash -i myvideo.mp4 -o steel_wash_styled.mp4 +``` + +## Program Output + +[Program output video](https://github.com/schwwaaa/videobeaux/assets/7625379/65403294-3e34-4ff8-816a-5de7c80c811d) diff --git a/docs/programs/effects/stutter_pro.md b/docs/programs/effects/stutter_pro.md new file mode 100644 index 0000000..c61ebe6 --- /dev/null +++ b/docs/programs/effects/stutter_pro.md @@ -0,0 +1,25 @@ +# stutter_pro + +## Description + +Apply frame stutter effect with definable parameters + +## Arguments + +- `stutter` + +## Program Template + +```bash +videobeaux -P stutter_pro -i input.mp4 -o output.mp4 --stutter VALUE +``` + +## Real World Example + +```bash +videobeaux -P stutter_pro -i myvideo.mp4 -o stutter_pro_styled.mp4 --stutter EXAMPLE +``` + +## Program Output + +[Program output video](https://github.com/schwwaaa/videobeaux/assets/7625379/65403294-3e34-4ff8-816a-5de7c80c811d) diff --git a/docs/programs/effects/t1000.md b/docs/programs/effects/t1000.md new file mode 100644 index 0000000..e709d48 --- /dev/null +++ b/docs/programs/effects/t1000.md @@ -0,0 +1,25 @@ +# t1000 + +## Description + +Apply filter from the perspective of liquid T-1000 + +## Arguments + +- *(No additional program-specific arguments; uses global videobeaux options only.)* + +## Program Template + +```bash +videobeaux -P t1000 -i input.mp4 -o output.mp4 +``` + +## Real World Example + +```bash +videobeaux -P t1000 -i myvideo.mp4 -o t1000_styled.mp4 +``` + +## Program Output + +[Program output video](https://github.com/schwwaaa/videobeaux/assets/7625379/65403294-3e34-4ff8-816a-5de7c80c811d) diff --git a/docs/programs/effects/twociz.md b/docs/programs/effects/twociz.md new file mode 100644 index 0000000..09a1b4f --- /dev/null +++ b/docs/programs/effects/twociz.md @@ -0,0 +1,25 @@ +# twociz + +## Description + +Apply filter from the perspective of a zombie on TC-1 hallucinogens + +## Arguments + +- *(No additional program-specific arguments; uses global videobeaux options only.)* + +## Program Template + +```bash +videobeaux -P twociz -i input.mp4 -o output.mp4 +``` + +## Real World Example + +```bash +videobeaux -P twociz -i myvideo.mp4 -o twociz_styled.mp4 +``` + +## Program Output + +[Program output video](https://github.com/schwwaaa/videobeaux/assets/7625379/65403294-3e34-4ff8-816a-5de7c80c811d) diff --git a/docs/programs/effects/wbflare.md b/docs/programs/effects/wbflare.md new file mode 100644 index 0000000..05b49fc --- /dev/null +++ b/docs/programs/effects/wbflare.md @@ -0,0 +1,25 @@ +# wbflare + +## Description + +Apply filter with a blown out white-balance flare + +## Arguments + +- *(No additional program-specific arguments; uses global videobeaux options only.)* + +## Program Template + +```bash +videobeaux -P wbflare -i input.mp4 -o output.mp4 +``` + +## Real World Example + +```bash +videobeaux -P wbflare -i myvideo.mp4 -o wbflare_styled.mp4 +``` + +## Program Output + +[Program output video](https://github.com/schwwaaa/videobeaux/assets/7625379/65403294-3e34-4ff8-816a-5de7c80c811d) diff --git a/docs/programs/effects/xrgb.md b/docs/programs/effects/xrgb.md new file mode 100644 index 0000000..58a9498 --- /dev/null +++ b/docs/programs/effects/xrgb.md @@ -0,0 +1,25 @@ +# xrgb + +## Description + +Extreme RGB adjustment + +## Arguments + +- *(No additional program-specific arguments; uses global videobeaux options only.)* + +## Program Template + +```bash +videobeaux -P xrgb -i input.mp4 -o output.mp4 +``` + +## Real World Example + +```bash +videobeaux -P xrgb -i myvideo.mp4 -o xrgb_styled.mp4 +``` + +## Program Output + +[Program output video](https://github.com/schwwaaa/videobeaux/assets/7625379/65403294-3e34-4ff8-816a-5de7c80c811d) diff --git a/docs/programs/effects/zapruder.md b/docs/programs/effects/zapruder.md new file mode 100644 index 0000000..3a1c8da --- /dev/null +++ b/docs/programs/effects/zapruder.md @@ -0,0 +1,25 @@ +# zapruder + +## Description + +Apply zapruder-film like effect + +## Arguments + +- *(No additional program-specific arguments; uses global videobeaux options only.)* + +## Program Template + +```bash +videobeaux -P zapruder -i input.mp4 -o output.mp4 +``` + +## Real World Example + +```bash +videobeaux -P zapruder -i myvideo.mp4 -o zapruder_styled.mp4 +``` + +## Program Output + +[Program output video](https://github.com/schwwaaa/videobeaux/assets/7625379/65403294-3e34-4ff8-816a-5de7c80c811d) diff --git a/docs/programs/utilities.md b/docs/programs/utilities.md deleted file mode 100644 index 10a9e21..0000000 --- a/docs/programs/utilities.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -layout: default -title: Utilities -nav_order: 6 ---- - -| Program | Description | Arguments | -| -------- | ------- | ------- | -| bad_animation | Apply a bad animation effect | - | -| bad_contrast | Apply a bad constrast effect | - | -| ball_point_pen | Apply a ball point pen style effect | - | -| blur_pix | Extracting the silence out of a video file | - | -| bad_predator | Apply bad Predator heat vision effect | - | -| crossmosh | A controlled datamoshing engine that manipulates motion vectors and frame order to create stylized glitch-drift distortions | b_input, outfile, codec, qscale, gop, keep_temp, mode, frames, decay, blend | -| digital_boss | Apply busted gameboy style digital boss effect | - | -| double_cup | Apply the effect of purple drank | - | -| frame_delay_pro1 | Apply frame delay effect with parameter input | frame_quantity, frame_weights | -| frame_delay_pro2 | Apply frame delay effect with parameter input | decay, plane | -| ghostee | Apply a slight ghost effect | - | -| lagkage | A JSON-driven multilayer video compositor that stacks, positions, resizes, and mixes multiple media sources into one unified output | layout_json, sequence_direction, audio_mode, audio_src | -| looper_pro | Apply video looper effect base on frame size & start frame | - | -| lsd_feedback | Apply LSD-like frame delay effect | - | -| mince | A fast, lossless segment-extractor and concatenator that slices videos into parts and recombines them with precision | mode, seed, engine, normalize, size, fit, fps, pixfmt, ar, ac, norm_vcodec, norm_crf, norm_preset, vcodec, acodec, crf, preset, faststart, fallback_reencode, decode_tolerant, hard_trim | -| mirror_delay | Apply a frame delay plus a mirrored effect | - | -| nostalgic_stutter | Apply frame stutter akin to a corrupted file | - | -| overexposed_stutter | Apply a frame stutter and exposing the video like the- | file is corrupted | - | -| overlay_img_pro | Overlay an image with location & dimension control | overlay_img, x_pos, y_pos, img_height, img_width | -| pickle_juice | Apply filter like the video was dipped in pickle juice | - | -| recalled_sensor | Apply filter like a sensor was broken and to-be recalled |- | -| repainting | Apply filter like repainting the same image while smudged with- | alcohol |- | -| resize | Resizing the dimensions of a video file | new_height, new_width | -| reverse | Reverse video file | - | -| scrolling_pro | Apply video scrolling effect with definable parameters | horiz_speed, vert_speed | -| scrolling | Apply static video scrolling effect | - | -| septic | Apply filter like a person in septic shock | - | -| slight_smear | Slightly smearing RGB color space | - | -| smudge | Smudging image slightly | - | -| soapblind | Apply filter like soap blinded eyes | - | -| speed | Change the video and audio speed of a file | speed_factor | -| splitting | A simple segmentation utility that divides a video into evenly timed chunks or scene-based fragments for modular editing | - | -| splitting_pro | Precise segmentation tool that slices a source video into reusable chunks based on time, count, or scene-style rules for downstream editing and recombination. | width, position | -| stack_2x | Stack 2 videos on top of each other keeping the original- | orientation | input2 | -| steel_wash | Apply steel blue filter to video | - | -| stutter_pro | Apply frame stutter effect with definable parameters | stutter | -| t1000 | Apply filter from the perspective of liquid T-1000 | - | -| twociz | Apply filter from the perspective of a zombie on TC-1 hallucinogens | - | -| wbflare | Apply filter with a blown out white-balance flare | - | -| zapruder | Apply zapruder-film like effect | - | -| xrgb | Extreme RGB adjustment | - | diff --git a/docs/programs/utilities/captburn.md b/docs/programs/utilities/captburn.md new file mode 100644 index 0000000..a701743 --- /dev/null +++ b/docs/programs/utilities/captburn.md @@ -0,0 +1,49 @@ +# captburn + +## Description + +Burns subtitles, captions, or transcript text directly into the video with precise styling, timing, and layout control + +## Arguments + +- `caption` +- `style` +- `rollup_lines` +- `words_per_line` +- `font` +- `font_size` +- `bold` +- `italic` +- `primary` +- `outline` +- `outline_width` +- `shadow` +- `back` +- `back_opacity` +- `scale_x` +- `scale_y` +- `spacing` +- `rotate` +- `margin_l` +- `margin_r` +- `margin_v` +- `align` +- `border_style` +- `x` +- `y` +- `move` +- `vcodec` +- `crf` +- `preset` + +## Program Template + +```bash +videobeaux -P captburn -i input.mp4 -o output.mp4 --caption VALUE --style VALUE --rollup_lines VALUE --words_per_line VALUE --font VALUE --font_size VALUE --bold VALUE --italic VALUE --primary VALUE --outline VALUE --outline_width VALUE --shadow VALUE --back VALUE --back_opacity VALUE --scale_x VALUE --scale_y VALUE --spacing VALUE --rotate VALUE --margin_l VALUE --margin_r VALUE --margin_v VALUE --align VALUE --border_style VALUE --x VALUE --y VALUE --move VALUE --vcodec VALUE --crf VALUE --preset VALUE +``` + +## Real World Example + +```bash +videobeaux -P captburn -i myvideo.mp4 -o captburn_styled.mp4 --caption EXAMPLE --style EXAMPLE --rollup_lines EXAMPLE --words_per_line EXAMPLE --font EXAMPLE --font_size EXAMPLE --bold EXAMPLE --italic EXAMPLE --primary EXAMPLE --outline EXAMPLE --outline_width EXAMPLE --shadow EXAMPLE --back EXAMPLE --back_opacity EXAMPLE --scale_x EXAMPLE --scale_y EXAMPLE --spacing EXAMPLE --rotate EXAMPLE --margin_l EXAMPLE --margin_r EXAMPLE --margin_v EXAMPLE --align EXAMPLE --border_style EXAMPLE --x EXAMPLE --y EXAMPLE --move EXAMPLE --vcodec EXAMPLE --crf EXAMPLE --preset EXAMPLE +``` diff --git a/docs/programs/utilities/chain_builder.md b/docs/programs/utilities/chain_builder.md new file mode 100644 index 0000000..505814f --- /dev/null +++ b/docs/programs/utilities/chain_builder.md @@ -0,0 +1,21 @@ +# chain_builder + +## Description + +Assembles a sequence of videobeaux program steps into a single automated workflow, chaining multiple transformations into one output + +## Arguments + +- `chain` + +## Program Template + +```bash +videobeaux -P chain_builder -i input.mp4 -o output.mp4 --chain VALUE +``` + +## Real World Example + +```bash +videobeaux -P chain_builder -i myvideo.mp4 -o chain_builder_styled.mp4 --chain EXAMPLE +``` diff --git a/docs/programs/utilities/convert.md b/docs/programs/utilities/convert.md new file mode 100644 index 0000000..7e3c1dd --- /dev/null +++ b/docs/programs/utilities/convert.md @@ -0,0 +1,21 @@ +# convert + +## Description + +Simple video file convert + +## Arguments + +- *(No additional program-specific arguments; uses global videobeaux options only.)* + +## Program Template + +```bash +videobeaux -P convert -i input.mp4 -o output.mp4 +``` + +## Real World Example + +```bash +videobeaux -P convert -i myvideo.mp4 -o convert_styled.mp4 +``` diff --git a/docs/programs/utilities/convert_dims.md b/docs/programs/utilities/convert_dims.md new file mode 100644 index 0000000..28c794b --- /dev/null +++ b/docs/programs/utilities/convert_dims.md @@ -0,0 +1,21 @@ +# convert_dims + +## Description + +Video file dimensions converter based on industry standards + +## Arguments + +- *(No additional program-specific arguments; uses global videobeaux options only.)* + +## Program Template + +```bash +videobeaux -P convert_dims -i input.mp4 -o output.mp4 +``` + +## Real World Example + +```bash +videobeaux -P convert_dims -i myvideo.mp4 -o convert_dims_styled.mp4 +``` diff --git a/docs/programs/utilities/convert_mux.md b/docs/programs/utilities/convert_mux.md new file mode 100644 index 0000000..fd32f1f --- /dev/null +++ b/docs/programs/utilities/convert_mux.md @@ -0,0 +1,40 @@ +# convert_mux + +## Description + +Rewraps or converts media streams while copying or re-encoding video/audio, ideal for fixing containers, codecs, or sync issues. + +## Arguments + +- `format` +- `profile` +- `vcodec` +- `acodec` +- `crf` +- `bitrate` +- `maxrate` +- `bufsize` +- `preset` +- `profile_v` +- `level` +- `pix_fmt` +- `gop` +- `r` +- `vf` +- `tagv` +- `abitrate` +- `ac` +- `ar` +- `copy` + +## Program Template + +```bash +videobeaux -P convert_mux -i input.mp4 -o output.mp4 --format VALUE --profile VALUE --vcodec VALUE --acodec VALUE --crf VALUE --bitrate VALUE --maxrate VALUE --bufsize VALUE --preset VALUE --profile_v VALUE --level VALUE --pix_fmt VALUE --gop VALUE --r VALUE --vf VALUE --tagv VALUE --abitrate VALUE --ac VALUE --ar VALUE --copy VALUE +``` + +## Real World Example + +```bash +videobeaux -P convert_mux -i myvideo.mp4 -o convert_mux_styled.mp4 --format EXAMPLE --profile EXAMPLE --vcodec EXAMPLE --acodec EXAMPLE --crf EXAMPLE --bitrate EXAMPLE --maxrate EXAMPLE --bufsize EXAMPLE --preset EXAMPLE --profile_v EXAMPLE --level EXAMPLE --pix_fmt EXAMPLE --gop EXAMPLE --r EXAMPLE --vf EXAMPLE --tagv EXAMPLE --abitrate EXAMPLE --ac EXAMPLE --ar EXAMPLE --copy EXAMPLE +``` diff --git a/docs/programs/utilities/download_yt.md b/docs/programs/utilities/download_yt.md new file mode 100644 index 0000000..d5e07fc --- /dev/null +++ b/docs/programs/utilities/download_yt.md @@ -0,0 +1,21 @@ +# download_yt + +## Description + +Video ripper + +## Arguments + +- *(No additional program-specific arguments; uses global videobeaux options only.)* + +## Program Template + +```bash +videobeaux -P download_yt -i input.mp4 -o output.mp4 +``` + +## Real World Example + +```bash +videobeaux -P download_yt -i myvideo.mp4 -o download_yt_styled.mp4 +``` diff --git a/docs/programs/utilities/extract_frames.md b/docs/programs/utilities/extract_frames.md new file mode 100644 index 0000000..470960e --- /dev/null +++ b/docs/programs/utilities/extract_frames.md @@ -0,0 +1,21 @@ +# extract_frames + +## Description + +Extract individual frames from a video file as PNGs + +## Arguments + +- *(No additional program-specific arguments; uses global videobeaux options only.)* + +## Program Template + +```bash +videobeaux -P extract_frames -i input.mp4 -o output.mp4 +``` + +## Real World Example + +```bash +videobeaux -P extract_frames -i myvideo.mp4 -o extract_frames_styled.mp4 +``` diff --git a/docs/programs/utilities/extract_sound.md b/docs/programs/utilities/extract_sound.md new file mode 100644 index 0000000..ee61138 --- /dev/null +++ b/docs/programs/utilities/extract_sound.md @@ -0,0 +1,21 @@ +# extract_sound + +## Description + +Extract audio from video file + +## Arguments + +- *(No additional program-specific arguments; uses global videobeaux options only.)* + +## Program Template + +```bash +videobeaux -P extract_sound -i input.mp4 -o output.mp4 +``` + +## Real World Example + +```bash +videobeaux -P extract_sound -i myvideo.mp4 -o extract_sound_styled.mp4 +``` diff --git a/docs/programs/utilities/frame_interpolate.md b/docs/programs/utilities/frame_interpolate.md new file mode 100644 index 0000000..965d05c --- /dev/null +++ b/docs/programs/utilities/frame_interpolate.md @@ -0,0 +1,34 @@ +# frame_interpolate + +## Description + +Generates smooth slow-motion or higher-FPS video by creating intermediate frames using motion-compensated interpolation + +## Arguments + +- `outfile` +- `engine` +- `fps` +- `multiplier` +- `mi_mode` +- `me_mode` +- `mc_mode` +- `vsbmc` +- `scd` +- `x264_preset` +- `crf` +- `copy_audio` +- `rife_bin` +- `dain_bin` + +## Program Template + +```bash +videobeaux -P frame_interpolate -i input.mp4 -o output.mp4 --outfile VALUE --engine VALUE --fps VALUE --multiplier VALUE --mi_mode VALUE --me_mode VALUE --mc_mode VALUE --vsbmc VALUE --scd VALUE --x264_preset VALUE --crf VALUE --copy_audio VALUE --rife_bin VALUE --dain_bin VALUE +``` + +## Real World Example + +```bash +videobeaux -P frame_interpolate -i myvideo.mp4 -o frame_interpolate_styled.mp4 --outfile EXAMPLE --engine EXAMPLE --fps EXAMPLE --multiplier EXAMPLE --mi_mode EXAMPLE --me_mode EXAMPLE --mc_mode EXAMPLE --vsbmc EXAMPLE --scd EXAMPLE --x264_preset EXAMPLE --crf EXAMPLE --copy_audio EXAMPLE --rife_bin EXAMPLE --dain_bin EXAMPLE +``` diff --git a/docs/programs/utilities/gamma_fix.md b/docs/programs/utilities/gamma_fix.md new file mode 100644 index 0000000..808bf7b --- /dev/null +++ b/docs/programs/utilities/gamma_fix.md @@ -0,0 +1,31 @@ +# gamma_fix + +## Description + +Normalizes gamma, brightness, and exposure levels for broadcast-safe or web-safe consistency across diverse footage + +## Arguments + +- `target_yavg` +- `min_contrast` +- `max_contrast` +- `gamma` +- `sat` +- `legalize` +- `vcodec` +- `crf` +- `preset` +- `acodec` +- `ab` + +## Program Template + +```bash +videobeaux -P gamma_fix -i input.mp4 -o output.mp4 --target_yavg VALUE --min_contrast VALUE --max_contrast VALUE --gamma VALUE --sat VALUE --legalize VALUE --vcodec VALUE --crf VALUE --preset VALUE --acodec VALUE --ab VALUE +``` + +## Real World Example + +```bash +videobeaux -P gamma_fix -i myvideo.mp4 -o gamma_fix_styled.mp4 --target_yavg EXAMPLE --min_contrast EXAMPLE --max_contrast EXAMPLE --gamma EXAMPLE --sat EXAMPLE --legalize EXAMPLE --vcodec EXAMPLE --crf EXAMPLE --preset EXAMPLE --acodec EXAMPLE --ab EXAMPLE +``` diff --git a/docs/programs/utilities/hash_fingerprint.md b/docs/programs/utilities/hash_fingerprint.md new file mode 100644 index 0000000..dc48722 --- /dev/null +++ b/docs/programs/utilities/hash_fingerprint.md @@ -0,0 +1,30 @@ +# hash_fingerprint + +## Description + +Creates unique perceptual or checksum-style fingerprints of a video for identification, comparison, or deduplication + +## Arguments + +- `recursive` +- `exts` +- `file_hashes` +- `stream_hash` +- `framemd5` +- `phash` +- `phash_fps` +- `phash_size` +- `catalog` +- `stream_kind` + +## Program Template + +```bash +videobeaux -P hash_fingerprint -i input.mp4 -o output.mp4 --recursive VALUE --exts VALUE --file_hashes VALUE --stream_hash VALUE --framemd5 VALUE --phash VALUE --phash_fps VALUE --phash_size VALUE --catalog VALUE --stream_kind VALUE +``` + +## Real World Example + +```bash +videobeaux -P hash_fingerprint -i myvideo.mp4 -o hash_fingerprint_styled.mp4 --recursive EXAMPLE --exts EXAMPLE --file_hashes EXAMPLE --stream_hash EXAMPLE --framemd5 EXAMPLE --phash EXAMPLE --phash_fps EXAMPLE --phash_size EXAMPLE --catalog EXAMPLE --stream_kind EXAMPLE +``` diff --git a/docs/programs/utilities/lut_apply.md b/docs/programs/utilities/lut_apply.md new file mode 100644 index 0000000..10a30ea --- /dev/null +++ b/docs/programs/utilities/lut_apply.md @@ -0,0 +1,33 @@ +# lut_apply + +## Description + +Applies a 3D or 1D LUT file to recolor a video, enabling film-style grading, color transforms, or creative look development + +## Arguments + +- `outfile` +- `vcodec` +- `lut` +- `interp` +- `intensity` +- `brightness` +- `contrast` +- `saturation` +- `gamma` +- `pix_fmt` +- `x264_preset` +- `crf` +- `copy_audio` + +## Program Template + +```bash +videobeaux -P lut_apply -i input.mp4 -o output.mp4 --outfile VALUE --vcodec VALUE --lut VALUE --interp VALUE --intensity VALUE --brightness VALUE --contrast VALUE --saturation VALUE --gamma VALUE --pix_fmt VALUE --x264_preset VALUE --crf VALUE --copy_audio VALUE +``` + +## Real World Example + +```bash +videobeaux -P lut_apply -i myvideo.mp4 -o lut_apply_styled.mp4 --outfile EXAMPLE --vcodec EXAMPLE --lut EXAMPLE --interp EXAMPLE --intensity EXAMPLE --brightness EXAMPLE --contrast EXAMPLE --saturation EXAMPLE --gamma EXAMPLE --pix_fmt EXAMPLE --x264_preset EXAMPLE --crf EXAMPLE --copy_audio EXAMPLE +``` diff --git a/docs/programs/utilities/meta_extraction.md b/docs/programs/utilities/meta_extraction.md new file mode 100644 index 0000000..16433c6 --- /dev/null +++ b/docs/programs/utilities/meta_extraction.md @@ -0,0 +1,28 @@ +# meta_extraction + +## Description + +Extracts detailed metadata—including codecs, bitrates, dimensions, color info, and stream structure—from any media file + +## Arguments + +- `outputfile` +- `sample_frames` +- `sample_stride` +- `sample_limit` +- `blackdetect` +- `black_pic_th` +- `black_dur_min` +- `loudness` + +## Program Template + +```bash +videobeaux -P meta_extraction -i input.mp4 -o output.mp4 --outputfile VALUE --sample_frames VALUE --sample_stride VALUE --sample_limit VALUE --blackdetect VALUE --black_pic_th VALUE --black_dur_min VALUE --loudness VALUE +``` + +## Real World Example + +```bash +videobeaux -P meta_extraction -i myvideo.mp4 -o meta_extraction_styled.mp4 --outputfile EXAMPLE --sample_frames EXAMPLE --sample_stride EXAMPLE --sample_limit EXAMPLE --blackdetect EXAMPLE --black_pic_th EXAMPLE --black_dur_min EXAMPLE --loudness EXAMPLE +``` diff --git a/docs/programs/utilities/num_edits.md b/docs/programs/utilities/num_edits.md new file mode 100644 index 0000000..ac64ca9 --- /dev/null +++ b/docs/programs/utilities/num_edits.md @@ -0,0 +1,21 @@ +# num_edits + +## Description + +Analyzes a timeline or cut structure to count edits, transitions, or shot boundaries for editorial statistics or QC + +## Arguments + +- `count` + +## Program Template + +```bash +videobeaux -P num_edits -i input.mp4 -o output.mp4 --count VALUE +``` + +## Real World Example + +```bash +videobeaux -P num_edits -i myvideo.mp4 -o num_edits_styled.mp4 --count EXAMPLE +``` diff --git a/docs/programs/utilities/qwikchop.md b/docs/programs/utilities/qwikchop.md new file mode 100644 index 0000000..87ae584 --- /dev/null +++ b/docs/programs/utilities/qwikchop.md @@ -0,0 +1,30 @@ +# qwikchop + +## Description + +Rapidly slices videos into precise segments based on timecodes or cut lists, optimized for speed and batch operations + +## Arguments + +- `pieces` +- `recurse` +- `keep_temp` +- `trim_black_front` +- `black_scan` +- `black_thresh` +- `black_pict` +- `edge_pad_pre` +- `edge_pad_post` +- `min_edit` + +## Program Template + +```bash +videobeaux -P qwikchop -i input.mp4 -o output.mp4 --pieces VALUE --recurse VALUE --keep_temp VALUE --trim_black_front VALUE --black_scan VALUE --black_thresh VALUE --black_pict VALUE --edge_pad_pre VALUE --edge_pad_post VALUE --min_edit VALUE +``` + +## Real World Example + +```bash +videobeaux -P qwikchop -i myvideo.mp4 -o qwikchop_styled.mp4 --pieces EXAMPLE --recurse EXAMPLE --keep_temp EXAMPLE --trim_black_front EXAMPLE --black_scan EXAMPLE --black_thresh EXAMPLE --black_pict EXAMPLE --edge_pad_pre EXAMPLE --edge_pad_post EXAMPLE --min_edit EXAMPLE +``` diff --git a/docs/programs/utilities/silence_extraction.md b/docs/programs/utilities/silence_extraction.md new file mode 100644 index 0000000..3194943 --- /dev/null +++ b/docs/programs/utilities/silence_extraction.md @@ -0,0 +1,23 @@ +# silence_extraction + +## Description + +Extracting the silence out of a video file + +## Arguments + +- `min_d` +- `max_d` +- `adjuster` + +## Program Template + +```bash +videobeaux -P silence_extraction -i input.mp4 -o output.mp4 --min_d VALUE --max_d VALUE --adjuster VALUE +``` + +## Real World Example + +```bash +videobeaux -P silence_extraction -i myvideo.mp4 -o silence_extraction_styled.mp4 --min_d EXAMPLE --max_d EXAMPLE --adjuster EXAMPLE +``` diff --git a/docs/programs/utilities/subs_convert.md b/docs/programs/utilities/subs_convert.md new file mode 100644 index 0000000..3a9d69d --- /dev/null +++ b/docs/programs/utilities/subs_convert.md @@ -0,0 +1,30 @@ +# subs_convert + +## Description + +Converts subtitle files between formats (e.g., SRT, VTT, ASS), preserving timing, text, and style metadata + +## Arguments + +- `list` +- `indexes` +- `langs` +- `all` +- `forced_only` +- `exclude_hi` +- `format` +- `outdir` +- `outputfile` +- `time_shift` + +## Program Template + +```bash +videobeaux -P subs_convert -i input.mp4 -o output.mp4 --list VALUE --indexes VALUE --langs VALUE --all VALUE --forced_only VALUE --exclude_hi VALUE --format VALUE --outdir VALUE --outputfile VALUE --time_shift VALUE +``` + +## Real World Example + +```bash +videobeaux -P subs_convert -i myvideo.mp4 -o subs_convert_styled.mp4 --list EXAMPLE --indexes EXAMPLE --langs EXAMPLE --all EXAMPLE --forced_only EXAMPLE --exclude_hi EXAMPLE --format EXAMPLE --outdir EXAMPLE --outputfile EXAMPLE --time_shift EXAMPLE +``` diff --git a/docs/programs/utilities/thumbs.md b/docs/programs/utilities/thumbs.md new file mode 100644 index 0000000..cf5a5cf --- /dev/null +++ b/docs/programs/utilities/thumbs.md @@ -0,0 +1,35 @@ +# thumbs + +## Description + +Generates thumbnails or contact sheets by sampling frames at chosen intervals for previews, galleries, or QC review + +## Arguments + +- `fps` +- `scene` +- `scene_threshold` +- `tile` +- `scale` +- `timestamps` +- `label` +- `fontfile` +- `bg` +- `margin` +- `padding` +- `outdir` +- `outputfile` +- `image_format` +- `jpeg_quality` + +## Program Template + +```bash +videobeaux -P thumbs -i input.mp4 -o output.mp4 --fps VALUE --scene VALUE --scene_threshold VALUE --tile VALUE --scale VALUE --timestamps VALUE --label VALUE --fontfile VALUE --bg VALUE --margin VALUE --padding VALUE --outdir VALUE --outputfile VALUE --image_format VALUE --jpeg_quality VALUE +``` + +## Real World Example + +```bash +videobeaux -P thumbs -i myvideo.mp4 -o thumbs_styled.mp4 --fps EXAMPLE --scene EXAMPLE --scene_threshold EXAMPLE --tile EXAMPLE --scale EXAMPLE --timestamps EXAMPLE --label EXAMPLE --fontfile EXAMPLE --bg EXAMPLE --margin EXAMPLE --padding EXAMPLE --outdir EXAMPLE --outputfile EXAMPLE --image_format EXAMPLE --jpeg_quality EXAMPLE +``` diff --git a/docs/programs/utilities/tonemap_hdr_sdr.md b/docs/programs/utilities/tonemap_hdr_sdr.md new file mode 100644 index 0000000..409bc7e --- /dev/null +++ b/docs/programs/utilities/tonemap_hdr_sdr.md @@ -0,0 +1,29 @@ +# tonemap_hdr_sdr + +## Description + +Converts HDR footage (PQ/HLG) to SDR using tunable tonemapping curves, preserving highlight detail and color accuracy + +## Arguments + +- `outfile` +- `algo` +- `desat` +- `peak` +- `dither` +- `pix_fmt` +- `x264_preset` +- `crf` +- `copy_audio` + +## Program Template + +```bash +videobeaux -P tonemap_hdr_sdr -i input.mp4 -o output.mp4 --outfile VALUE --algo VALUE --desat VALUE --peak VALUE --dither VALUE --pix_fmt VALUE --x264_preset VALUE --crf VALUE --copy_audio VALUE +``` + +## Real World Example + +```bash +videobeaux -P tonemap_hdr_sdr -i myvideo.mp4 -o tonemap_hdr_sdr_styled.mp4 --outfile EXAMPLE --algo EXAMPLE --desat EXAMPLE --peak EXAMPLE --dither EXAMPLE --pix_fmt EXAMPLE --x264_preset EXAMPLE --crf EXAMPLE --copy_audio EXAMPLE +``` diff --git a/docs/programs/utilities/transraibe.md b/docs/programs/utilities/transraibe.md new file mode 100644 index 0000000..e96e49e --- /dev/null +++ b/docs/programs/utilities/transraibe.md @@ -0,0 +1,21 @@ +# transraibe + +## Description + +AI-based transcription tool + +## Arguments + +- `stt_model` + +## Program Template + +```bash +videobeaux -P transraibe -i input.mp4 -o output.mp4 --stt_model VALUE +``` + +## Real World Example + +```bash +videobeaux -P transraibe -i myvideo.mp4 -o transraibe_styled.mp4 --stt_model EXAMPLE +``` diff --git a/docs/programs/utilities/watermark.md b/docs/programs/utilities/watermark.md new file mode 100644 index 0000000..79ee24d --- /dev/null +++ b/docs/programs/utilities/watermark.md @@ -0,0 +1,32 @@ +# watermark + +## Description + +Applies image or text watermarks onto video with configurable positioning, scaling, opacity, and blend style + +## Arguments + +- `watermark` +- `placement` +- `margin` +- `scale` +- `opacity` +- `spin` +- `start` +- `end` +- `wm_loop` +- `ignore_loop` +- `video_crf` +- `video_preset` + +## Program Template + +```bash +videobeaux -P watermark -i input.mp4 -o output.mp4 --watermark VALUE --placement VALUE --margin VALUE --scale VALUE --opacity VALUE --spin VALUE --start VALUE --end VALUE --wm_loop VALUE --ignore_loop VALUE --video_crf VALUE --video_preset VALUE +``` + +## Real World Example + +```bash +videobeaux -P watermark -i myvideo.mp4 -o watermark_styled.mp4 --watermark EXAMPLE --placement EXAMPLE --margin EXAMPLE --scale EXAMPLE --opacity EXAMPLE --spin EXAMPLE --start EXAMPLE --end EXAMPLE --wm_loop EXAMPLE --ignore_loop EXAMPLE --video_crf EXAMPLE --video_preset EXAMPLE +``` diff --git a/docs/programs/utilities/wipe_transitions.md b/docs/programs/utilities/wipe_transitions.md new file mode 100644 index 0000000..9ea40ca --- /dev/null +++ b/docs/programs/utilities/wipe_transitions.md @@ -0,0 +1,26 @@ +# wipe_transitions + +## Description + +Creates directional wipe transitions between clips using customizable timing, edge softness, and motion orientation + +## Arguments + +- `input1` +- `input2` +- `output_format` +- `preset` +- `duration` +- `offset` + +## Program Template + +```bash +videobeaux -P wipe_transitions -i input.mp4 -o output.mp4 --input1 VALUE --input2 VALUE --output_format VALUE --preset VALUE --duration VALUE --offset VALUE +``` + +## Real World Example + +```bash +videobeaux -P wipe_transitions -i myvideo.mp4 -o wipe_transitions_styled.mp4 --input1 EXAMPLE --input2 EXAMPLE --output_format EXAMPLE --preset EXAMPLE --duration EXAMPLE --offset EXAMPLE +```