File: README.md

package info (click to toggle)
vimix 0.8.4%2Bgit20250220%2Bds-2
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 88,204 kB
  • sloc: cpp: 92,163; ansic: 34,427; makefile: 373; objc: 97; xml: 77; sh: 45
file content (144 lines) | stat: -rw-r--r-- 3,941 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
# vimix
__Live Video Mixing__

<img src=docs/vimix_screenshot.png width="800">


vimix performs graphical mixing and blending of several movie clips and
computer generated graphics, with image processing effects in real-time.

Its intuitive and hands-on user interface gives direct control on image opacity and
shape for producing live graphics during concerts and VJ-ing sessions.

The output image is typically projected full-screen on an external
monitor or a projector, and can be streamed live (SRT, Shmdata) or recorded (without audio).

vimix is the successor for GLMixer - https://sourceforge.net/projects/glmixer/

# License

GPL-3.0-or-later
See [LICENSE](https://github.com/brunoherbelin/vimix/blob/master/LICENSE)

# Install vimix

Check the [Quick Installation Guide](https://github.com/brunoherbelin/vimix/wiki/Quick-Installation-Guide)

### Linux

Download and install a released [flatpak package](https://flathub.org/apps/details/io.github.brunoherbelin.Vimix)

    flatpak install --user vimix
    
NB: Build your flatpak package to get the latest beta version; instructions are [here](https://github.com/brunoherbelin/vimix/tree/master/flatpak).
    

[![vimix](https://snapcraft.io/vimix/badge.svg)](https://snapcraft.io/vimix)

Download and install a released [snap package](https://snapcraft.io/vimix) 

    snap install vimix
    
Install the stable debian package (slower release frequency)

    sudo apt install vimix

### Mac OSX

Download and open a release package from https://github.com/brunoherbelin/vimix/releases

NB: You'll need to accept the exception in OSX security preference.

# Build vimix

## Clone

    git clone --recursive https://github.com/brunoherbelin/vimix.git

This will create the directory 'vimix', download the latest version of vimix code,
and (recursively) clone all the internal git dependencies.

## Compile

First time after git clone:

    mkdir vimix-build
    cd vimix-build
    cmake -DCMAKE_BUILD_TYPE=Release ../vimix
    cmake --build .
    
This will create the directory 'vimix-build', configure the program for build, and compile vimix.
If successful, the compilation will have produced the executable `vimix` in the `src` directory. 
You can run vimix with `./src/vimix` :
     
     ...
     [100%] Built target vimix
     ./src/vimix
    
## Update clone and re-compile 

Run these commands from the `vimix-build` directory if you did 'Clone' and 'Compile' previously and only want to get the latest update and rebuild.
    
    git -C ../vimix/ pull
    cmake --build .
    
This will pull the latest commit from git and recompile. 

## Try the Beta branch

Run this commands from the `vimix-build` directory before runing 'Update clone and re-compile above'

    git -C ../vimix/ checkout beta
    
It should say;

    branch 'beta' set up to track 'origin/beta'.
    Switched to a new branch 'beta'

## Dependencies

**Compiling tools:**

- gcc
- make
- cmake
- git

**Libraries:**

- gstreamer
- gst-plugins (libav, base, good, bad & ugly)
- libglfw3
- libicu (icu-i18n icu-uc icu-io)

Optionnal:

- glm
- stb
- TinyXML2
- AbletonLink
- Shmdata

### Install Dependencies

#### Ubuntu

    apt-get install build-essential cmake libpng-dev libglfw3-dev libgstreamer1.0-dev libgstreamer-plugins-base1.0-dev gstreamer1.0-libav libicu-dev libgtk-3-dev 

Optionnal:

    apt-get install libglm-dev libstb-dev libtinyxml2-dev ableton-link-dev 
    
  > Follow these instructions to [install Shmdata](https://github.com/nicobou/shmdata/blob/develop/doc/install-from-sources.md).
  
    git clone https://gitlab.com/sat-metalab/shmdata.git
    mkdir shmdata-build
    cd shmdata-build
    cmake -DCMAKE_INSTALL_PREFIX:PATH=/usr -DCMAKE_BUILD_TYPE=Release -DWITH_PYTHON=0 -DWITH_SDCRASH=0 -DWITH_SDFLOW=0 ../shmdata-build
    cmake --build . --target package
    sudo dpkg -i ./libshmdata_1.3*_amd64.deb

#### OSX with Brew

    brew install cmake libpng glfw gstreamer icu4c