Add Sampler classed and the vidi-player.py and vidi-sampler.py programs
[vidi-player.git] / README.md
1 vidi-timeline creates a video timeline starting from a MIDI file.
2
3 The video clips are taken from a "VideoFont" in which each sample clip
4 corresponds to a note. The samples are arranged following the time and value of
5 the notes in the MIDI file.
6
7 vidi-timeline allows to create more easily videos like these:
8
9 * Lasse Gjertsen - Hyperactive -  https://youtu.be/o9698TqtY4A
10 * Vittorio Saggiomo - Mario Bros Column Chromatography - https://youtu.be/mxi3z2vDV_0
11
12
13 Examples of use
14 ===============
15
16 vidi-timeline.py
17 ----------------
18
19 Create a synthetinc VideoFont:
20
21     $ ./create_test_videofont.py videofont
22
23
24 Play the timeline from a MIDI file using the samples from the VideoFont:
25
26     $ ./vidi-timeline.py examples/Beyer\ Op.\ 101\ -\ Exercise\ 008.midi videofont
27
28
29 Save the timeline to be edited somewhere else (e.g. in PiTiVi):
30
31     $ ./vidi-timeline.py examples/Beyer\ Op.\ 101\ -\ Exercise\ 008.midi videofont/ Beyer_008.xges
32
33
34 Render the timeline to a video file:
35
36     $ ges-launch-1.0 --load Beyer_008.xges --outputuri Beyer_008.webm --format="video/webm:video/x-vp8:audio/x-vorbis"
37
38
39 vidi-player.py
40 --------------
41
42 Play a midi file in real time (if the CPU and the disk can keep up):
43
44     $ ./vidi-player.py examples/Beyer\ Op.\ 101\ -\ Exercise\ 008.midi videofont/
45
46
47 vidi-sampler.py
48 ---------------
49
50 Play samples from the note hit on a midi controller:
51
52     $ xset -r && vkeybd && xset r on &
53     $ ./vidi-sampler.py 'Virtual Keyboard' videofont/
54     $ fg
55
56
57 Similar projects
58 ================
59
60 Of course if the idea is cool, chances are that others had it too. :)
61
62 Midi-Vidi
63 ---------
64
65 A similar concept called midi-vidi has been developed by Marcus Fischer:
66
67 * http://unrecnow.com/dust/325-midi-vidi-effect-demo/
68 * https://vimeo.com/8049917
69 * http://www.synthtopia.com/content/2009/12/09/midi-vidi-plugin-lets-you-control-video-via-midi-in-max-for-live/
70 * http://www.maxforlive.com/library/device.php?id=120
71
72 Midi-Vidi is also a very cool name, it sound like the Italian "mi dividi" which
73 means "you divide me".
74
75 VidiBox
76 -------
77
78 An interactive video mashup app:
79
80 * http://www.vidibox.net/
81 * https://twitter.com/vidibox