videobeaux/EXAMPLES.md at 9e1c7c296c762d6b8566c9839255261d4e4919fb

mirror of https://github.com/vondas-network/videobeaux.git synced 2025-12-05 15:30:02 +01:00

Files

cskonopka 9e1c7c296c working on splitting readme into two files, one for readme/installation and the other for examples

2025-11-28 20:52:23 -05:00

19 KiB

Raw Blame History

The friendly multilateral video toolkit built for artists by artists. It's your best friend.

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.

/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/schwwaaa/videobeaux/refs/heads/main/install.sh)"

Windows

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.

source env/bin/activate

Check the installation

Get help and find out more about videobeaux

videobeaux --help

... outputs the following ...

       _     _            _
__   _(_) __| | ___  ___ | |__   ___  __ _ _   ___  __
\ \ / / |/ _` |/ _ \/ _ \| '_ \ / _ \/ _` | | | \ \/ /
 \ V /| | (_| |  __/ (_) | |_) |  __/ (_| | |_| |>  <
  \_/ |_|\__,_|\___|\___/|_.__/ \___|\__,_|\__,_/_/\_\


📺 The friendly multilateral video toolkit built for artists by artists.
🫂  It's your best friend!

🌐 https://schwwaaa.net

usage: videobeaux --program PROGRAM --input INPUT_FILE --output OUTPUT_FILE [program options]

options:
  -P, --program PROGRAM
                        Name of the effect program to run (e.g. convert, glitch)
  -i, --input INPUT     Input video file - mp4 only
  -o, --output OUTPUT   Output file name, no extension. Output will be saved as mp4.
  -F, --force           Force overwrite output file
  -h, --help            Show help message and exit

Available Program Modes:

bad_animation        extract_sound        pickle_juice         splitting
bad_contrast         fever                rb_blur              stack_2x
bad_predator         frame_delay_pro1     recalled_sensor      steel_wash
ball_point_pen       frame_delay_pro2     repainting           stutter_pro
blur_pix             ghostee              resize               t1000
broken_scroll        light_snow           reverse              transcraibe
chain_builder        looper_pro           scrolling_pro        twociz
chain_builder_pro    lsd_feedback         septic               wbflare
convert              mirror_delay         silence_xtraction    xrgb
digital_boss         nostalgic_stutter    slight_smear         zapruder
double_cup           num_edits            smudge
download_yt          overexposed_stutter  soapblind
extract_frames       overlay_img_pro      speed

Good to go!

Examples

Running a program that does not have additional arguments

Check if the program needs additional arguments

       _     _            _
__   _(_) __| | ___  ___ | |__   ___  __ _ _   ___  __
\ \ / / |/ _` |/ _ \/ _ \| '_ \ / _ \/ _` | | | \ \/ /
 \ V /| | (_| |  __/ (_) | |_) |  __/ (_| | |_| |>  <
  \_/ |_|\__,_|\___|\___/|_.__/ \___|\__,_|\__,_/_/\_\


Your friendly multilateral video toolkit built for artists by artists.
https://schwwaaa.net
--------------------------------------------------
Selected program mode: bad_predator
✅ This program mode does not require additional arguments
usage: python3 -m videobeaux.cli --program PROGRAM [global options] [program options]

📺 Your friendly multilateral video toolkit built for artists by artists.
 It's your best friend!
https://schwwaaa.net

options:
  -P PROGRAM, --program PROGRAM
                        Name of the effect program to run (e.g. convert, glitch)
  -i INPUT, --input INPUT
                        Input video file - mp4 only
  -o OUTPUT, --output OUTPUT
                        Output file name, no extension. Output will be saved as mp4.
  -F, --force           Force overwrite output file
  -h, --help            Show help message and exit

 👁️ 👇 Additional help for program mode 👇 👁️
usage: videobeaux --program bad_predator [-h]

Apply bad Predator heat vision effect

options:
  -h, --help  show this help message and exit

Run the program

videobeaux --program PROGRAM --input INPUT_FILE --output OUTPUT_FILE

... translates to ...

videobeaux --program bad_predator --input example.mp4 --output example_bp.mp4

Output of the program

       _     _            _
__   _(_) __| | ___  ___ | |__   ___  __ _ _   ___  __
\ \ / / |/ _` |/ _ \/ _ \| '_ \ / _ \/ _` | | | \ \/ /
 \ V /| | (_| |  __/ (_) | |_) |  __/ (_| | |_| |>  <
  \_/ |_|\__,_|\___|\___/|_.__/ \___|\__,_|\__,_/_/\_\


Your friendly multilateral video toolkit built for artists by artists.
https://schwwaaa.net
--------------------------------------------------
Selected program mode: bad_predator
✅ This program mode does not require additional arguments
Input duration: 10.01 seconds
🔨 Processing example.mp4: 100%|██████████████████████████████████████████████████████ | 10.01/10.01s [00:04<00:00]

📺 Process Complete: example_bp.mp4

https://github.com/user-attachments/assets/fe45aa80-9878-4d15-bc64-87dd25071855

Running a program that does have additional arguments

Check if the program needs additional arguments

       _     _            _
__   _(_) __| | ___  ___ | |__   ___  __ _ _   ___  __
\ \ / / |/ _` |/ _ \/ _ \| '_ \ / _ \/ _` | | | \ \/ /
 \ V /| | (_| |  __/ (_) | |_) |  __/ (_| | |_| |>  <
  \_/ |_|\__,_|\___|\___/|_.__/ \___|\__,_|\__,_/_/\_\


Your friendly multilateral video toolkit built for artists by artists.
https://schwwaaa.net
--------------------------------------------------
Selected program mode: stutter_pro
usage: python3 -m videobeaux.cli --program PROGRAM [global options] [program options]

📺 Your friendly multilateral video toolkit built for artists by artists.
 It's your best friend!
https://schwwaaa.net

options:
  -P PROGRAM, --program PROGRAM
                        Name of the effect program to run (e.g. convert, glitch)
  -i INPUT, --input INPUT
                        Input video file - mp4 only
  -o OUTPUT, --output OUTPUT
                        Output file name, no extension. Output will be saved as mp4.
  -F, --force           Force overwrite output file
  -h, --help            Show help message and exit

 👁️ 👇 Additional help for program mode 👇 👁️
usage: videobeaux --program stutter_pro [-h] --stutter STUTTER

Imagine watching a video where random frames are played instead of a smooth progression.

options:
  -h, --help         show this help message and exit
  --stutter STUTTER  Replaces the current video frame with a randomly selected one from the most recent N frames.The larger the value, the larger the variation.

Run the program

videobeaux --program PROGRAM --input INPUT_FILE --output OUTPUT_FILE --args ARGUMENTS

... translates to ...

videobeaux --program stutter_pro -i example.mp4 -o stutter_example.mp4 --stutter 2

Output of the program

       _     _            _
__   _(_) __| | ___  ___ | |__   ___  __ _ _   ___  __
\ \ / / |/ _` |/ _ \/ _ \| '_ \ / _ \/ _` | | | \ \/ /
 \ V /| | (_| |  __/ (_) | |_) |  __/ (_| | |_| |>  <
  \_/ |_|\__,_|\___|\___/|_.__/ \___|\__,_|\__,_/_/\_\


Your friendly multilateral video toolkit built for artists by artists.
https://schwwaaa.net
--------------------------------------------------
Selected program mode: stutter_pro
Input duration: 10.01 seconds
🔨 Processing example.mp4: 100%|██████████████████████████████████████████████████████████ | 10.01/10.01s [00:00<00:00]

📺 Process Complete: stutter_example.mp4

https://github.com/user-attachments/assets/fec22179-8e40-49e5-b591-c9d5fb07e31b

Running a program to chain process a video

Find out more information about the program

       _     _            _
__   _(_) __| | ___  ___ | |__   ___  __ _ _   ___  __
\ \ / / |/ _` |/ _ \/ _ \| '_ \ / _ \/ _` | | | \ \/ /
 \ V /| | (_| |  __/ (_) | |_) |  __/ (_| | |_| |>  <
  \_/ |_|\__,_|\___|\___/|_.__/ \___|\__,_|\__,_/_/\_\


Your friendly multilateral video toolkit built for artists by artists.
https://schwwaaa.net
--------------------------------------------------
Selected program mode: chain_builder
usage: python3 -m videobeaux.cli --program PROGRAM [global options] [program options]

📺 Your friendly multilateral video toolkit built for artists by artists.
 It's your best friend!
https://schwwaaa.net

options:
  -P PROGRAM, --program PROGRAM
                        Name of the effect program to run (e.g. convert, glitch)
  -i INPUT, --input INPUT
                        Input video file - mp4 only
  -o OUTPUT, --output OUTPUT
                        Output file name, no extension. Output will be saved as mp4.
  -F, --force           Force overwrite output file
  -h, --help            Show help message and exit

 👁️ 👇 Additional help for program mode 👇 👁️
usage: videobeaux --program chain_builder [-h] --chain CHAIN

The output of the first will be used as the input for the next, and so on.
Only supports program modes that do not require their own specific arguments.

options:
  -h, --help     show this help message and exit
  --chain CHAIN  A comma separated list of programs to run.

Run the program

videobeaux --program PROGRAM --input INPUT_FILE --output OUTPUT_FILE --chain CHAIN

... translates to ...

videobeaux --program chain_builder --input example.mp4 --output chainedoutput.mp4 --chain rb_blur,soapblind,lsd_feedback --force

Output of the program

       _     _            _
__   _(_) __| | ___  ___ | |__   ___  __ _ _   ___  __
\ \ / / |/ _` |/ _ \/ _ \| '_ \ / _ \/ _` | | | \ \/ /
 \ V /| | (_| |  __/ (_) | |_) |  __/ (_| | |_| |>  <
  \_/ |_|\__,_|\___|\___/|_.__/ \___|\__,_|\__,_/_/\_\


Your friendly multilateral video toolkit built for artists by artists.
https://schwwaaa.net
--------------------------------------------------
Selected program mode: chain_builder
🔁 Running step 1/3: rb_blur
Input duration: 10.01 seconds
🔨 Processing example.mp4: 100%|██████████████████████████████████████████████████████ | 10.01/10.01s [00:00<00:00]

📺 Process Complete: /var/folders/jv/lp20pdtn4jsgjpxw710m0vkm0000gn/T/videobeaux_chain_z7ixo5cs/step_0_rb_blur.mp4

🔁 Running step 2/3: soapblind
Input duration: 10.03 seconds
🔨 Processing step_0_rb_blur.mp4: 100%|███████████████████████████████████████████████ | 10.03/10.03s [00:46<00:00]

📺 Process Complete: /var/folders/jv/lp20pdtn4jsgjpxw710m0vkm0000gn/T/videobeaux_chain_z7ixo5cs/step_1_soapblind.mp4

🔁 Running step 3/3: lsd_feedback
Input duration: 10.03 seconds
🔨 Processing step_1_soapblind.mp4: 100%|█████████████████████████████████████████████ | 10.03/10.03s [00:03<00:00]

📺 Process Complete: /var/folders/jv/lp20pdtn4jsgjpxw710m0vkm0000gn/T/videobeaux_chain_z7ixo5cs/step_2_lsd_feedback.mp4

✅ Final output written to chainedoutput.mp4

https://github.com/user-attachments/assets/ac321c77-4757-4846-b838-6847472e7e09

Available Programs

An overview of each program can be find in this YouTube playlist.

Effects

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	-
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	-
looper_pro	Apply video looper effect base on frame size & start frame	-
lsd_feedback	Apply LSD-like frame delay effect	-
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
stack_2x	Stack 2 videos on top of each other keeping the original-	orientation
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	-

Utilities

Program	Description	Arguments
convert	Simple video file convert	-
convert_dims	Video file dimensions converter based on industry standards	-
download_yt	Video ripper	-
extract_frames	Extract individuals frames from a video file as PNGs	-
extract_sound	Extract audio from video file	-
silence_extraction	Extracting the silence out of a video file	min_d, max_d, adjuster
transraibe	AI-based transcription tool	stt_model