aboutsummaryrefslogtreecommitdiff
path: root/c/README
diff options
context:
space:
mode:
authorJavier Degirolmo2012-07-09 09:45:51 -0300
committerJavier Degirolmo2012-07-09 09:45:51 -0300
commit84ce0220dd5449587467c37d7afbd99fb1fbe69e (patch)
treee3138057c171c998d88a164f51e5dfc52d1c2dec /c/README
parent5316d8125babafb0200f84e4c3a3796b4f1374c0 (diff)
Updated README accordingly
Diffstat (limited to 'c/README')
-rw-r--r--c/README31
1 files changed, 15 insertions, 16 deletions
diff --git a/c/README b/c/README
index 5413ec0..005076e 100644
--- a/c/README
+++ b/c/README
@@ -25,25 +25,24 @@ tool and its usage is pretty simple: blob2c «input.bin» «output.c»
=============================================================================
-Echo makes use of an instrument list. There are some macros in echo.h to help
-you make the lists in your C program. Basically, do something like this:
+Echo makes use of an instrument list. In the case of the C version of Echo,
+you need to make a null-terminated pointer list, e.g. as follows:
- ECHO_LIST_START(list)
- ECHO_LIST_ENTRY(instrument1)
- ECHO_LIST_ENTRY(instrument2)
- ECHO_LIST_ENTRY(instrument3)
- ECHO_LIST_ENTRY(instrument4)
- ECHO_LIST_ENTRY(instrument5)
- ECHO_LIST_END
+const void *list[] = {
+ instrument1,
+ instrument2,
+ instrument3,
+ instrument4,
+ instrument5,
+ NULL
+};
-Where 'list' is the name the list will have (this creates a standard C
-array). This is the same name you have to pass to echo_init().
+Where 'list' is the name the list will have. This is the same name you have
+to pass to echo_init(). 'instrument1' etc. are pointers to the data of each
+instrument (EIF, EEF, EWF).
-Each ECHO_LIST_ENTRY is an instrument, and you pass a pointer to their blob
-data (EIF, EEF, EWF) as the parameter. Put as many ECHO_LIST_ENTRY as
-instruments you want in the list.
-
-Make sure to NOT put semicolons or you'll get weird compiler errors.
+If NULL isn't defined for whatever reason either include stddef.h or just use
+0 instead (which is the same value).
=============================================================================