Merge pull request #1 from thajohns/betabeta

added documentation for mapped file structure

1 files changed, 10 insertions, 0 deletions

diff --git a/render.py b/render.py
index 0030969..aa0b75a 100644
--- a/render.py
+++ b/render.py
@@ -1,5 +1,15 @@
 # A visualizer for the Python client (or any other client) rendering to a mapped file
 
+# The map file format should look like the following C structure:
+# struct mapping {
+#   float disp_factor;  // a factor to be displayed onscreen
+#   float last_samples[MAP_SAMPLES];  // samples from the waveform being played
+#   struct {
+#     unsigned long frequency;
+#     float amplitude;
+#   } values[STREAMS];
+# }
+
 import optparse
 import mmap
 import os