output/bits: Rewrite for new output API.

[libsigrok.git] / output / output.c

diff --git a/output/output.c b/output/output.c
index 91fdf3884d52c0e134a86526cf51d962c5c82226..80552f6d29470d9f30a4d6981055690952a8cdf0 100644 (file)
--- a/output/output.c
+++ b/output/output.c
@@ -1,5 +1,5 @@
 /*
- * This file is part of the sigrok project.
+ * This file is part of the libsigrok project.
  *
  * Copyright (C) 2010-2012 Bert Vermeulen <bert@biot.com>
  *
@@ -31,11 +31,25 @@
  *
  * Output file/data format handling.
  *
+ * libsigrok supports several output (file) formats, e.g. binary, VCD,
+ * gnuplot, and so on. It provides an output API that frontends can use.
+ * New output formats can be added/implemented in libsigrok without having
+ * to change the frontends at all.
+ *
+ * All output modules are fed data in a stream. Devices that can stream data
+ * into libsigrok live, instead of storing and then transferring the whole
+ * buffer, can thus generate output live.
+ *
+ * Output modules are responsible for allocating enough memory to store
+ * their own output, and passing a pointer to that memory (and length) of
+ * the allocated memory back to the caller. The caller is then expected to
+ * free this memory when finished with it.
+ *
  * @{
  */
 
 /** @cond PRIVATE */
-extern SR_PRIV struct sr_output_format output_text_bits;
+extern SR_PRIV struct sr_output_format output_bits;
 extern SR_PRIV struct sr_output_format output_text_hex;
 extern SR_PRIV struct sr_output_format output_text_ascii;
 extern SR_PRIV struct sr_output_format output_binary;
@@ -49,7 +63,7 @@ extern SR_PRIV struct sr_output_format output_analog;
 /* @endcond */
 
 static struct sr_output_format *output_module_list[] = {
-       &output_text_bits,
+       &output_bits,
        &output_text_hex,
        &output_text_ascii,
        &output_binary,