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

HelpUpdate : VIMS.md fix + sayVIMS documentation

Browse Source 
* port fix to howto
This commit is contained in:
Jerome Blanchi aka d.j.a.y
2019-06-21 16:56:45 +02:00
parent 1082e75c5a
commit 46e03c1608
2 changed files with 104 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

88
veejay-current/veejay-server/doc/VIMS.md
View File

@@ -188,7 +188,93 @@ the second describes the duration (in frames) for the fade in.
stream, the second for the chain entry and the last for the effect number.
Idem for 182, but here starting from the 4th argument it takes preset values
2 OSC - Open Sound Control
2 sayVIMS, an utility to talk to veejay
=========================================
[//]: # ( comment : BEGIN sayVIMS section DUPLICATE in /veejay-current/veejay-server/doc/HOWTO)
[//]: # ( WARNING : section numbering have to be adapted )
***sayVIMS*** is a commandline utility distributed with the veejay package. It allows you to send short commands in interactive mode, single VIMS message or files containing VIMS messages to batch-process to veejay.
```
Usage: sayVIMS [options] [messages]
where options are:
-p Veejay port (3490)
-g Veejay groupname (224.0.0.31)
-h Veejay hostname (localhost)
-m Send single message
-i Interactive mode
-f file Read from (special) file
-d Dump status to stdout
-b Base64 encode binary data
-v Verbose
-? Print this help
```
In the following examples, lets say a veejay instance is running on host
`localhost` using port `3490` (veejay default values).
**Interactive Mode**
```
$ sayVIMS -i -h localhost -p 3490
```
In interactive mode, after a connection is establish with a veejay server,
a prompt wait you to enter VIMS commands (see previous chapter about the VIMS message format). Simply press `[ENTER]` to send it.
```
$ sayVIMS -i
veejay sayVIMS 1.1.8
type 'quit' or press CTRL-c to exit
see 'veejay -u' for a list of commands
017:;
```
Here, the `017` tells veejay to go to sample starting position.
The connection remain open until you exit by typing `quit` or hit `[Ctrl]-[c]`.
**Single VIMS message**
Also, you can send single VIMS format message.
For example, add the Pixelate effect on the Effect Chain of the current
playing stream or clip :
```
$ sayVIMS -h localhost -p 3490 -m "361:0 0 100 3;"
```
**Using files**
Last but not least, sayVIMS can parse files containing VIMS messages.
See the `veejay-server/test/examples` directory of the package for a list of perl
scripts that output a VIMS script.
```
$ sayVIMS -f advocate.vims -h localhost -p 3490
```
**Others examples**
Alternatively, you can start a secundary veejay and stream from peer to
peer (TCP) in uncompressed video:
```
$ veejay -d -p 5000
$ sayVIMS -h localhost -p 5000 -m "245:localhost 3490;"
(press 'F7' in veejay to display the stream, prob. stream 7)
```
Or for multicast (UDP):
```
$ veejay -V 224.0.0.50 -p 5000 -n -L movie1.avi
$ veejay -d
$ sayVIMS -h localhost -p 3490 -m "246:224.0.0.50 5000;"
$ veejay -d -p 4000
$ sayVIMS -h localhost -p 4000 -m "246:224.0.0.50 5000;"
```
Have a look on [4.5.3 network](./veejay-HOWTO.md#4.5.3) for more UDP multicasting.
[//]: # ( comment : END sayVIMS section DUPLICATE in /veejay-current/veejay-server/doc/HOWTO)
[//]: # ( WARNING : url have to be adapted )
3 OSC - Open Sound Control
===================
The OpenSound Control WWW page is http://opensoundcontrol.org/

32
veejay-current/veejay-server/doc/veejay-HOWTO.md
View File

@@ -506,7 +506,7 @@ defines more or less a different functionality.
**VIMS is Veejay's IMS (Internal Message System)**
[//]: # ( comment : BEGIN VIMS section DUPLICATE in /veejay-current/veejay-server/doc/HOWTO)
[//]: # ( WARNING : section numbering has to updated )
[//]: # ( WARNING : section numbering have to be adapted )
Veejay is server/client model and all control data is distributed via VIMS. Each (atomical) message consists of an _Action Identifier_ ( aka __selector__ )
and a list of zero or more _Arguments_ which can be used to control Video Clips, Video Streams, the Effect Chain and many other things.
@@ -517,24 +517,20 @@ VIMS allows events to be triggered through:
* OSC - Synthesizers, computers, and other multimedia devices network protocol ([Open Sound Control](https://en.wikipedia.org/wiki/Open_Sound_Control))
* IMP - Veejay Internal Message Protocol
Along this documention we will review what messages you can send to veejay through using VIMS, Keyboard Event an OSC.
After [installing](./Installation.md) all veejay's packages, you will have a commandline utility `sayVIMS`
This document describes what messages you can send to veejay through using VIMS
Inside of veejay's source package you will find a `test/` directory containing various examples demonstrating
how to load an ActionFile, how to use Perl for batch like video processing and how to attach message bundles to
keyboard events.
Use the command
To quickly see documentation generated by veejay on VIMS, using Effects and OSC, use the command :
$ veejay -u -n |less
to see documentation generated by veejay on VIMS, using Effects and OSC.
If there is an error in the documentation, you have found a bug in veejay and should [report it](https://github.com/c0ntrol/veejay/issues) :)
After [installing](./Installation.md) `veejay-utils` package, you will have a commandline utility `sayVIMS` that we will discuss in this documentation.
Inside of veejay's source package you will find a `test/` directory containing various examples demonstrating how to load an ActionFile, how to use Perl for batch like video processing and how to attach message bundles to keyboard events.
Enough presentation, let's go deep in veejay messaging.
If there is an error in the documentation, you have found a bug in veejay
and should report it :)
Message Format
==================
@@ -656,13 +652,16 @@ Some reserved numbers:
div3, dvvideo, dvsd, mjpeg, i420 and yv12 (yuv 4:2:0 raw)
loop type : 0 = play once, 1 = normal loop, 2 = pingpong (bounce) loop, 3 = random frame, 4 = Play once (no pause)
```
[//]: # ( comment : END VIMS section DUPLICATE in /veejay-current/veejay-server/doc/HOWTO)
[//]: # ( comment : END VIMS section DUPLICATE in /veejay-current/veejay-server/doc/VIMS)
[//]: # ( WARNING : section numbering have to be adapted )
For deeper information about VIMS have a look to [VIMS.md](./VIMS.md).
### <span id="4.2.2">4.2.2 sayVIMS utility</span>
[//]: # ( comment : BEGIN sayVIMS section DUPLICATE in /veejay-current/veejay-server/doc/VIMS)
[//]: # ( WARNING : url have to be adapted )
***sayVIMS*** is a commandline utility distributed with the veejay package. It allows you to send short commands in interactive mode, single VIMS message or files containing VIMS messages to batch-process to veejay.
```
Usage: sayVIMS [options] [messages]
@@ -740,6 +739,9 @@ $ sayVIMS -h localhost -p 4000 -m "246:224.0.0.50 5000;"
```
Have a look on [4.5.3 network](veejay-HOWTO.md#4.5.3) for more UDP multicasting.
[//]: # ( comment : END sayVIMS section DUPLICATE in /veejay-current/veejay-server/doc/VIMS)
[//]: # ( WARNING : url have to be adapted )
<span id="4.3">4.3 The keyboard interface</span>
------------------------------------------------