eessppeelllloo/veejay
1
0
Fork 0
mirror of https://github.com/game-stop/veejay.git synced 2025-12-05 15:30:02 +01:00
Code Issues Packages Projects Releases Wiki Activity

Improve Doc (#76 wip) - README.alpha --> md (done)

Browse Source 
* Formating
* rename --> md
This commit is contained in:
Jerome Blanchi aka d.j.a.y
2019-02-12 17:53:40 +01:00
parent 094187cad1
commit b31ff2a05d
4 changed files with 104 additions and 118 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@@ -143,17 +143,17 @@ see also : [How to Video Codecs](./veejay-current/veejay-server/doc/HowtoVideoCo
* 161 built-in FX, many unique and original FX filters
* 60 Livido filters
* FX chain (20 slots) with Alpha Channels
* All FX parameters can be animated.
* All FX parameters can be animated
* Mix up to two layers per FX slot
* Non destructive edit decision lists (cut/copy/paste/crop video)
* Sample editor
* Sequence editor
* Live disk recorder (sampling)
* Full deck save/restore
* Live clip loading
* Live clip loading
* Live sample sequencing
see also : [README alpha](./veejay-current/veejay-server/doc/README.alpha)
see also : [README alpha](./veejay-current/veejay-server/doc/README.alpha.md)
### Trickplay
@@ -164,7 +164,7 @@ see also : [README alpha](./veejay-current/veejay-server/doc/README.alpha)
* Change in-and out points of a sample (marker)
* Slow motion audio / video
* Fast motion audio / video
* Dynamic framerate
* Dynamic framerate
* Random frame play
* Random sample play
* Access up to 4096 video samples instantly
@@ -206,6 +206,7 @@ see also : [How to video wall](./veejay-current/veejay-server/doc/video-wall.md)
* Support for Frei0r plugins
* Support for LiVIDO plugins
* Support for FreeFrame plugins (only for 32 bit systems!)
* Support for GMIC plugins
* Android server!
see also : [How to Plugins](./veejay-current/veejay-server/doc/HowtoPlugins.md), [README odroid-xu3](./veejay-current/veejay-server/doc/README.odroid-xu3) ,[README Android](./veejay-current/veejay-server/doc/README.android)
@@ -218,7 +219,7 @@ Please join our mailing list on http://groups.google.com/group/veejay-discussion
Please use the ticket system on https://github.com/c0ntrol/veejay/issues or simply write a mail to the veejay-discussion group!
ENJOY! And let us know about your performances/installations with veejay!
ENJOY! And let us know about your performances/installations with veejay!
---
```

112
veejay-current/veejay-server/doc/README.alpha
View File

@@ -1,112 +0,0 @@
______ __ ______ __ __ ______
/\ __ \ /\ \ /\ == \ /\ \_\ \ /\ __ \
\ \ __ \ \ \ \____ \ \ _-/ \ \ __ \ \ \ __ \
\ \_\ \_\ \ \_____\ \ \_\ \ \_\ \_\ \ \_\ \_\
\/_/\/_/ \/_____/ \/_/ \/_/\/_/ \/_/\/_/
______ __ __ ______ __ __ __ __ ______ __
/\ ___\ /\ \_\ \ /\ __ \ /\ "-.\ \ /\ "-.\ \ /\ ___\ /\ \
\ \ \____ \ \ __ \ \ \ __ \ \ \ \-. \ \ \ \-. \ \ \ __\ \ \ \____
\ \_____\ \ \_\ \_\ \ \_\ \_\ \ \_\\"\_\ \ \_\\"\_\ \ \_____\ \ \_____\
\/_____/ \/_/\/_/ \/_/\/_/ \/_/ \/_/ \/_/ \/_/ \/_____/ \/_____/
in veejay
Veejay has some support for alpha channel compositing
In general, you will need to add an alpha channel to your playing sample or stream by using one of the "Alpha:" filters in veejay
Then, the alpha channel will be combined used FX that can deal with Alpha. Some effects have a mode parameter "Alpha" that functions like an on/off switch but others require an alpha channel to work.
By default, the alpha channel is set to 0 (completely invisible) so such effects will always result in a black screen if you have not added an alpha channel.
In Reloaded, you can toggle the white button next to 'Alpha Clear' to switch between 0 (completely invisible) and 255 (completely visible)
Also, you can toggle the alpha-button to set the fade method to alpha blending in the (manual) chain fader
The chain fader fades the original (unchanged) image to the image that is rendered by the FX chain, either with an opacity value or by using alpha channel information
The chain fader is located next to the FX chain (the vertical slider).
Everything related to alpha compositing is in development and feedback is ofcourse welcome
List of Alpha: FX
==================
The 'Set by Color Key' operator
-----------------------------------
Use this filter to create an alpha channel from the foreground object.
The filter requires an existing alpha channel to decide which pixel from source B to composite in. Pixels with an alpha of 0 are skipped.
Using the parameters R,G,B and Angle you can select which pixels belong to the background and key them out, leaving a mask of the foreground object.
The 'Select by Chroma Key' operator
-----------------------------------
Use this filter to create an alpha channel from the foreground object.
The filter may use an existing alpha channel to decide which pixel from source B to composite in. Pixels with an alpha of 0 are skipped optionally.
Luma Key
--------
Luma Key in Mode 3 will composite-in pixels from source B using its alpha channel
Alpha Blend
------------
Image in source B will be blended on top of source A using its alpha channel
Black and White Mask by Threshold
---------------------------------
This filter creates a black/white image from a minimum and maximum threshold value. You can set a mode parameter so that the render result is written as an Alpha channel
LVD Scale0Tilt / Crop,Scale,Tilt
---------------------------------
This filter is a port of the frei0r filter "scale0tilt.so"
You can use it to crop,scale, tilt an image from source B over source A
If the Alpha paramater is set to 1, the final result will be an opaque pixel with the transparency of each pixel determined by the alpha channel values
Flatten Image
-------------
Use this to multiply the alpha channel against a black background
Alpha Fill
----------
Solid value fill of the alpha channel, 0 - 255
Set from Image / Mixing source
------------------------------
Use the luminance channel of the image as a new Alpha channel
You can use the FX switch parameter to scale the values to full range (0-255) if needed.
If you have no result in the Alpha channel, flip this parameter.
Alpha to Greyscale
-------------------
Use this FX to display the alpha channel as a greyscale image.
Transition Map
--------------
Use this FX to blend over time using a greyscale image as an opacity map

97
veejay-current/veejay-server/doc/README.alpha.md Normal file
View File

@@ -0,0 +1,97 @@
```
______ __ ______ __ __ ______
/\ __ \ /\ \ /\ == \ /\ \_\ \ /\ __ \
\ \ __ \ \ \ \____ \ \ _-/ \ \ __ \ \ \ __ \
\ \_\ \_\ \ \_____\ \ \_\ \ \_\ \_\ \ \_\ \_\
\/_/\/_/ \/_____/ \/_/ \/_/\/_/ \/_/\/_/
______ __ __ ______ __ __ __ __ ______ __
/\ ___\ /\ \_\ \ /\ __ \ /\ "-.\ \ /\ "-.\ \ /\ ___\ /\ \
\ \ \____ \ \ __ \ \ \ __ \ \ \ \-. \ \ \ \-. \ \ \ __\ \ \ \____
\ \_____\ \ \_\ \_\ \ \_\ \_\ \ \_\\"\_\ \ \_\\"\_\ \ \_____\ \ \_____\
\/_____/ \/_/\/_/ \/_/\/_/ \/_/ \/_/ \/_/ \/_/ \/_____/ \/_____/
in veejay
```
**Veejay has some support for alpha channel compositing**
In general, you will need to add an alpha channel to your playing sample or
stream by using one of the "Alpha:" filters in veejay.
Then, the alpha channel will be combined used FX that can deal with Alpha. Some
effects have a mode parameter `Alpha` that functions like an on/off switch but
others require an extra alpha channel to work.
By default, the alpha channel is set to `0` (completely invisible) so such effects
will always result in a black screen if you have not added an alpha channel.
In Reloaded, you can toggle the white button next to 'Alpha Clear' to switch
between `0` (completely invisible) and `255` (completely visible)
Also, you can toggle the alpha-button to set the fade method to alpha blending
in the (manual) chain fader
The chain fader fades the original (unchanged) image to the image that is rendered
by the FX chain, either with an opacity value or by using alpha channel information
In Reloaded, the chain fader is located next to the FX chain (the vertical slider).
_Alpha compositing is still in development and feedback is of course welcome_
List of "Alpha:" FX
-------------------
* **The 'Set by Color Key' operator**
Use this filter to create an alpha channel from the foreground object.
The filter requires an existing alpha channel to decide which pixel from source B to composite in. Pixels with an alpha of `0` are skipped.
Using the parameters `R,G,B` and `Angle` you can select which pixels belong to the background and key them out, leaving a mask of the foreground object.
* **The 'Select by Chroma Key' operator**
Use this filter to create an alpha channel from the foreground object.
The filter may use an existing alpha channel to decide which pixel from source B to composite in. Pixels with an alpha of `0` are skipped optionally.
* **Luma Key**
Luma Key in `Mode 3` will composite-in pixels from source B using its alpha channel
* **Alpha Blend**
Image in source B will be blended on top of source A using its alpha channel
* **Black and White Mask by Threshold**
This filter creates a black/white image from a minimum and maximum threshold value.
You can set a `Mode` parameter so that the render result is written as an Alpha channel
* **LVD Scale0Tilt / Crop,Scale,Tilt**
This filter is a port of the [frei0r](https://frei0r.dyne.org/) filter "scale0tilt.so"
You can use it to crop, scale, tilt an image from source B over source A
If the `Alpha` paramater is set to `1`, the final result will be an opaque pixel with the transparency of each pixel determined by the alpha channel values
* **Flatten Image**
Use this to multiply the alpha channel against a black background
* **Alpha Fill**
Solid value fill of the alpha channel into `0 - 255` range
* **Set from Image / Mixing source**
Use the luminance channel of the image as a new Alpha channel
You can use the FX switch parameter to scale the values to full range `0 - 255` if needed.
If you have no result in the Alpha channel, flip this parameter.
* **Alpha to Greyscale**
Use this FX to display the alpha channel as a greyscale image.
* **Transition Map**
Use this FX to blend over time using a greyscale image as an opacity map

2
veejay-current/veejay-server/doc/README.md
View File

@@ -8,7 +8,7 @@
* [INSTALL](./INSTALL)
* [Installation](./Installation.md)
* [NET.txt](./NET.txt)
* [README.alpha](./README.alpha)
* Support for alpha channel compositing - [README.alpha](./README.alpha.md)
* [README.android](./README.android)
* [README.audio](./README.audio)
* Memory concern with veejay - [README.memory](./README.memory.md)