Add Sampler classed and the vidi-player.py and vidi-sampler.py programs
[vidi-player.git] / README.md
index 7f8c3db..694a989 100644 (file)
--- a/README.md
+++ b/README.md
@@ -13,6 +13,9 @@ vidi-timeline allows to create more easily videos like these:
 Examples of use
 ===============
 
+vidi-timeline.py
+----------------
+
 Create a synthetinc VideoFont:
 
     $ ./create_test_videofont.py videofont
@@ -33,6 +36,24 @@ Render the timeline to a video file:
     $ ges-launch-1.0 --load Beyer_008.xges --outputuri Beyer_008.webm --format="video/webm:video/x-vp8:audio/x-vorbis"
 
 
+vidi-player.py
+--------------
+
+Play a midi file in real time (if the CPU and the disk can keep up):
+
+    $ ./vidi-player.py examples/Beyer\ Op.\ 101\ -\ Exercise\ 008.midi videofont/
+
+
+vidi-sampler.py
+---------------
+
+Play samples from the note hit on a midi controller:
+
+    $ xset -r && vkeybd && xset r on &
+    $ ./vidi-sampler.py 'Virtual Keyboard' videofont/
+    $ fg
+
+
 Similar projects
 ================