mirror of
https://github.com/game-stop/veejay.git
synced 2025-12-05 15:30:02 +01:00
HelpUpdate : Update install procedure
* veejay-core * veejay-client * plugins * minor rewrites/typo
This commit is contained in:
Jerome Blanchi aka d.j.a.y
70
README.md
70
README.md
@@ -4,9 +4,11 @@
|
||||
|
||||
*a 'visual' instrument and realtime video sampler (for live video improvisation)*
|
||||
|
||||
It allows you to "play" the video like you would play a piano
|
||||
It allows you to "play" the video like you would play a piano.
|
||||
|
||||
While playing, you can record the resulting video directly to disk (video sampling), all effects are realtime and optimized for use on modern processors, Veejay likes the sound of your video's as much as their images: sound is kept in sync ( pitched when needed - trickplay) and delivered to JACK for possible further processing.
|
||||
While playing, you can record the resulting video directly to disk (video sampling), all effects are realtime and optimized for use on modern processors.
|
||||
|
||||
Veejay likes the sound of your video's as much as their images: sound is kept in sync ( pitched when needed - trickplay) and delivered to [JACK](http://www.jackaudio.org/) for possible further processing.
|
||||
|
||||
You can cluster to allow a number of machines to work together over the network (uncompressed streaming, veejay chaining) And much more...
|
||||
|
||||
@@ -16,13 +18,14 @@ see also : [README whatis](./veejay-current/veejay-server/doc/README.whatis.md)
|
||||
|
||||
### Veejay Applications:
|
||||
* __Reloaded__
|
||||
A GUI developed in GLADE/GTK ([veejay-client](https://github.com/c0ntrol/veejay/tree/master/veejay-current/veejay-client))
|
||||
A GUI developed in GLADE/GTK3 ([veejay-client](https://github.com/c0ntrol/veejay/tree/master/veejay-current/veejay-client))
|
||||
* __sendVIMS__
|
||||
A PureData object allowing direct communications with the server ([sendVIMS](https://github.com/c0ntrol/veejay/tree/master/veejay-current/sendVIMS))
|
||||
A PureData object allowing direct communications with the server ([sendVIMS](https://github.com/c0ntrol/veejay/tree/master/veejay-current/sendVIMS)) (_a bit outdated_)
|
||||
* __sayVIMS__
|
||||
A console based utility for quick'n'dirty scripting ([veejay-utils](https://github.com/c0ntrol/veejay/tree/master/veejay-current/veejay-utils))
|
||||
|
||||
And of course [__Veejay__](https://github.com/c0ntrol/veejay/tree/master/veejay-current/veejay-server) himself ! The video output server (Ffmpeg/libSDL). Could be remote, headless, multiples ... !
|
||||
And of course [__Veejay__](https://github.com/c0ntrol/veejay/tree/master/veejay-current/veejay-server) himself !
|
||||
The video output server (Ffmpeg/libSDL), a 'visual' instrument and realtime video sampler for live video improvisation such as live cinema, vjing, art installation ...
|
||||
|
||||
[//]: # ( comment : installation section duplicated in /veejay-server/doc/Instalation)
|
||||
[//]: # ( WARNING : some URL/PATH have to be adapted )
|
||||
@@ -30,6 +33,7 @@ And of course [__Veejay__](https://github.com/c0ntrol/veejay/tree/master/veejay-
|
||||
## Installation
|
||||
|
||||
#### Get all the dependencies
|
||||
|
||||
First, make sure you system is up-to-date, and install the dependencies with:
|
||||
```bash
|
||||
sudo apt-get install git autoconf automake libtool m4 gcc libjpeg62-dev \
|
||||
@@ -41,10 +45,11 @@ gtk-3.0-dev libxml2-dev libsdl2-dev libjack0 libjack-dev jackd1
|
||||
|
||||
Veejay is divided into multiple packages. Each must be build separately and in a specific order.
|
||||
|
||||
1. [veejay-server](https://github.com/c0ntrol/veejay/tree/master/veejay-current/veejay-server)
|
||||
2. [reloaded-gtk3](https://github.com/c0ntrol/veejay/tree/master/veejay-current/reloaded-gtk3) or [veejay-client](https://github.com/c0ntrol/veejay/tree/master/veejay-current/veejay-client) for GTK2
|
||||
3. [veejay-utils](https://github.com/c0ntrol/veejay/tree/master/veejay-current/veejay-utils)
|
||||
4. [plugin-packs](https://github.com/c0ntrol/veejay/tree/master/veejay-current/plugin-packs)
|
||||
1. [veejay-core](https://github.com/c0ntrol/veejay/tree/master/veejay-current/veejay-core) (__required__)
|
||||
2. [veejay-server](https://github.com/c0ntrol/veejay/tree/master/veejay-current/veejay-server) (__required__)
|
||||
3. [veejay_client](https://github.com/c0ntrol/veejay/tree/master/veejay-current/veejay-client) (*optional*)
|
||||
4. [veejay-utils](https://github.com/c0ntrol/veejay/tree/master/veejay-current/veejay-utils) (*optional*)
|
||||
5. [plugin-packs](https://github.com/c0ntrol/veejay/tree/master/veejay-current/plugin-packs) (*optional*)
|
||||
|
||||
For __each package__, run the triptich commands of the *GNU build system* (for a quick start you can build the first two):
|
||||
|
||||
@@ -53,15 +58,12 @@ For __each package__, run the triptich commands of the *GNU build system* (for a
|
||||
./configure
|
||||
make && sudo make install
|
||||
```
|
||||
__Nota :__ in some configuration you should have to __manually build__ the __shared libraries cache__ just after the __first__ veejay-server installation (ex `sudo ldconfig` or similar)
|
||||
__IMPORTANT :__ in some configuration you should have to __manually build__ the __shared libraries cache__ just after the __first veejay-core__ installation (ex `sudo ldconfig` or similar)
|
||||
|
||||
You do not need to pass any parameters to `./configure` for veejay to be optimized with the current cpu-type.
|
||||
If you want to build for a specific architecture or without sound support (jack) ... take a look to the
|
||||
`./configure --help` to adapt to many kinds of systems.
|
||||
__Configure :__ You do not need to pass any parameters to `./configure` for veejay to be optimized with the current cpu-type.
|
||||
If you want help to build for a specific architecture or with or without particular options (ex jack sound support) ... take a look to the `./configure --help` to adapt to many kinds of systems.
|
||||
|
||||
Before running veejay, be sure to add or link some TrueType fonts in
|
||||
|
||||
$HOME/.veejay/fonts
|
||||
Before running veejay, be sure to add or link some TrueType fonts in `$HOME/.veejay/fonts`
|
||||
|
||||
## Usage
|
||||
|
||||
@@ -85,11 +87,25 @@ veejay -p 4490 -g my-movie-B.avi
|
||||
reloaded -a
|
||||
```
|
||||
|
||||
## Building/Configuring plugins
|
||||
## Building and Configuring plugins
|
||||
|
||||
There are several plugin-packs available for veejay: https://github.com/c0ntrol/veejay/tree/master/veejay-current/plugin-packs
|
||||
Veejay contain more than 160 built-in FX, many unique and original FX filters.
|
||||
But you can have more !
|
||||
|
||||
* lvdcrop ; a couple of crop filters and a port of frei0r's scale0tilt
|
||||
### frei0r
|
||||
|
||||
Veejay looks in a few common locations to find the [frei0r plugins pack](https://frei0r.dyne.org/):
|
||||
* /usr/local/lib/frei0r-1
|
||||
* /usr/lib/frei0r-1
|
||||
* /usr/lib64/frei0r-1
|
||||
|
||||
You can list more location in the file `$HOME/.veejay/plugins.cfg`
|
||||
|
||||
### plugin-packs
|
||||
|
||||
There are several plugin-packs available for veejay: [plugin-packs](https://github.com/c0ntrol/veejay/tree/master/veejay-current/plugin-packs)
|
||||
|
||||
* lvdcrop ; a couple of crop filters and a port of frei0r's scale0tilt
|
||||
* lvdshared ; a couple of plugins that implement a producer/consumer mechanism for shared video resources
|
||||
* lvdgmic ; GMIC based filters, although slow in processing they are quite amazing
|
||||
|
||||
@@ -97,21 +113,19 @@ To compile and install a plugin-pack:
|
||||
```bash
|
||||
cd plugin-packs/lvdgmic
|
||||
./autogen.sh
|
||||
./configure && make
|
||||
./configure
|
||||
make && sudo make install
|
||||
```
|
||||
|
||||
Veejay looks in a few common locations to find plugins:
|
||||
* /usr/local/lib/frei0r-1
|
||||
* /usr/lib/frei0r-1
|
||||
* /usr/lib64/frei0r-1
|
||||
### Default parameter values
|
||||
|
||||
You can list more locations in $HOME/.veejay/plugins.cfg
|
||||
You can change the default FX parameter values by editing the files in `$HOME/.veejay/frei0r/` and `$HOME/.veejay/livido/`
|
||||
|
||||
You can change the default parameter values by editing the files in $HOME/.veejay/frei0r/ and $HOME/.veejay/livido/
|
||||
**See Also** : For more verbose information about plugins and FX check [How to Plugins](./veejay-current/veejay-server/doc/HowtoPlugins.md)
|
||||
|
||||
## Debugging
|
||||
|
||||
if you want to debug veejay-server (or if you want to submit a meaningful backtrace), build with:
|
||||
If you want to debug veejay-server (or if you want to submit a meaningful backtrace), build with:
|
||||
|
||||
./configure --enable-debug
|
||||
|
||||
@@ -244,5 +258,3 @@ ENJOY! And let us know about your performances/installations with veejay!
|
||||
|__/ |___/ |_| http://veejayhq.net
|
||||
```
|
||||
---
|
||||
|
||||
|
||||
|
||||
@@ -2,26 +2,38 @@
|
||||
[//]: # ( comment : END installation section duplicated in /README.md)
|
||||
[//]: # ( WARNING : some URL/PATH have to be adapted )
|
||||
|
||||
## Installation
|
||||
## Get all the dependencies
|
||||
|
||||
First, make sure you system is up-to-date, and install the dependencies with:
|
||||
```bash
|
||||
sudo apt-get install git autoconf automake libtool m4 gcc libjpeg62-dev \
|
||||
libswscale-dev libavutil-dev libavcodec-dev libavformat-dev libx11-dev \
|
||||
gtk-3.0-dev libxml2-dev libsdl2-dev libjack0 libjack-dev jackd1
|
||||
```
|
||||
|
||||
## Build the veejay's applications
|
||||
|
||||
Veejay is divided into multiple packages. Each must be build separately and in a specific order.
|
||||
|
||||
1. [veejay-server](https://github.com/c0ntrol/veejay/tree/master/veejay-current/veejay-server)
|
||||
2. [veejay-client](https://github.com/c0ntrol/veejay/tree/master/veejay-current/veejay-client)
|
||||
3. [veejay-utils](https://github.com/c0ntrol/veejay/tree/master/veejay-current/veejay-utils)
|
||||
4. [plugin-packs](https://github.com/c0ntrol/veejay/tree/master/veejay-current/plugin-packs)
|
||||
|
||||
For each package, run confgure and make:
|
||||
1. [veejay-core](https://github.com/c0ntrol/veejay/tree/master/veejay-current/veejay-core) (__required__)
|
||||
2. [veejay-server](https://github.com/c0ntrol/veejay/tree/master/veejay-current/veejay-server) (__required__)
|
||||
3. [veejay_client](https://github.com/c0ntrol/veejay/tree/master/veejay-current/veejay-client) (*optional*)
|
||||
4. [veejay-utils](https://github.com/c0ntrol/veejay/tree/master/veejay-current/veejay-utils) (*optional*)
|
||||
5. [plugin-packs](https://github.com/c0ntrol/veejay/tree/master/veejay-current/plugin-packs) (*optional*)
|
||||
|
||||
For __each package__, run the triptich commands of the *GNU build system* (for a quick start you can build the first two):
|
||||
|
||||
```bash
|
||||
./autogen.sh
|
||||
./configure
|
||||
make && make install
|
||||
make && sudo make install
|
||||
```
|
||||
__Nota :__ in some configuration you will have to rebuild the shared libraries cache just after veejay-server installation (ex `sudo ldconfig` or similar)
|
||||
__IMPORTANT :__ in some configuration you should have to __manually build__ the __shared libraries cache__ just after the __first veejay-core__ installation (ex `sudo ldconfig` or similar)
|
||||
|
||||
If you want veejay to be optimized for the current cpu-type, you do not need to pass any parameters. If you do not know what cpu veejay will be running on , pass `--with-arch-target=auto` to configure.
|
||||
__Configure :__ You do not need to pass any parameters to `./configure` for veejay to be optimized with the current cpu-type.
|
||||
If you want help to build for a specific architecture or with or without particular options (ex jack sound support) ... take a look to the `./configure --help` to adapt to many kinds of systems.
|
||||
|
||||
Before running veejay, be sure to add or link some TrueType fonts in `$HOME/.veejay/fonts`
|
||||
|
||||
## Usage
|
||||
|
||||
@@ -50,19 +62,40 @@ reloaded -a
|
||||
Veejay contain more than 160 built-in FX, many unique and original FX filters.
|
||||
But you can have more !
|
||||
|
||||
There are several [plugin-packs](https://github.com/c0ntrol/veejay/tree/master/veejay-current/plugin-packs) available for veejay.
|
||||
### frei0r
|
||||
|
||||
Also, Veejay looks in a few common locations to find plugins. You can even list
|
||||
more locations in `$HOME/.veejay/plugins.cfg`
|
||||
Veejay looks in a few common locations to find the [frei0r plugins pack](https://frei0r.dyne.org/):
|
||||
* /usr/local/lib/frei0r-1
|
||||
* /usr/lib/frei0r-1
|
||||
* /usr/lib64/frei0r-1
|
||||
|
||||
You can change the default FX parameter values by editing the files in
|
||||
`$HOME/.veejay/frei0r/` and `$HOME/.veejay/livido/`
|
||||
You can list more location in the file `$HOME/.veejay/plugins.cfg`
|
||||
|
||||
For more verbose information about plugins and FX check [How to Plugins](./HowtoPlugins.md)
|
||||
### plugin-packs
|
||||
|
||||
There are several plugin-packs available for veejay: [plugin-packs](https://github.com/c0ntrol/veejay/tree/master/veejay-current/plugin-packs)
|
||||
|
||||
* lvdcrop ; a couple of crop filters and a port of frei0r's scale0tilt
|
||||
* lvdshared ; a couple of plugins that implement a producer/consumer mechanism for shared video resources
|
||||
* lvdgmic ; GMIC based filters, although slow in processing they are quite amazing
|
||||
|
||||
To compile and install a plugin-pack:
|
||||
```bash
|
||||
cd plugin-packs/lvdgmic
|
||||
./autogen.sh
|
||||
./configure
|
||||
make && sudo make install
|
||||
```
|
||||
|
||||
### Default parameter values
|
||||
|
||||
You can change the default FX parameter values by editing the files in `$HOME/.veejay/frei0r/` and `$HOME/.veejay/livido/`
|
||||
|
||||
**See Also** : For more verbose information about plugins and FX check [How to Plugins](./HowtoPlugins.md)
|
||||
|
||||
## Debugging
|
||||
|
||||
if you want to debug veejay-server (or if you want to submit a meaningful backtrace), build with:
|
||||
If you want to debug veejay-server (or if you want to submit a meaningful backtrace), build with:
|
||||
|
||||
./configure --enable-debug
|
||||
|
||||
|
||||
Reference in New Issue
Block a user