Don't reference SR_PACKAGE_VERSION_STRING directly in output modules.

[libsigrok.git] / src / output / vcd.c

diff --git a/src/output/vcd.c b/src/output/vcd.c
index 87f8049603d6ff3733c91643e5d67188e72110ae..561b3ba059fc914583b85c0b01901a5490f62e7f 100644 (file)
--- a/src/output/vcd.c
+++ b/src/output/vcd.c
@@ -15,22 +15,20 @@
  * GNU General Public License for more details.
  *
  * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
+ * along with this program; if not, see <http://www.gnu.org/licenses/>.
  */
 
+#include <config.h>
 #include <stdlib.h>
 #include <string.h>
 #include <glib.h>
-#include "config.h" /* Needed for PACKAGE and others. */
-#include "libsigrok.h"
+#include <libsigrok/libsigrok.h>
 #include "libsigrok-internal.h"
 
 #define LOG_PREFIX "output/vcd"
 
 struct context {
        int num_enabled_channels;
-       GArray *channelindices;
        uint8_t *prevsample;
        gboolean header_done;
        int period;
@@ -39,16 +37,15 @@ struct context {
        uint64_t samplecount;
 };
 
-static const char *const vcd_header_comment =
-       "$comment\n  Acquisition with %d/%d channels at %s\n$end\n";
-
-static int init(struct sr_output *o)
+static int init(struct sr_output *o, GHashTable *options)
 {
        struct context *ctx;
        struct sr_channel *ch;
        GSList *l;
        int num_enabled_channels, i;
 
+       (void)options;
+
        num_enabled_channels = 0;
        for (l = o->sdi->channels; l; l = l->next) {
                ch = l->data;
@@ -64,7 +61,7 @@ static int init(struct sr_output *o)
        }
 
        ctx = g_malloc0(sizeof(struct context));
-       o->internal = ctx;
+       o->priv = ctx;
        ctx->num_enabled_channels = num_enabled_channels;
        ctx->channel_index = g_malloc(sizeof(int) * ctx->num_enabled_channels);
 
@@ -81,7 +78,7 @@ static int init(struct sr_output *o)
        return SR_OK;
 }
 
-static GString *gen_header(struct sr_output *o)
+static GString *gen_header(const struct sr_output *o)
 {
        struct context *ctx;
        struct sr_channel *ch;
@@ -92,20 +89,20 @@ static GString *gen_header(struct sr_output *o)
        int num_channels, i;
        char *samplerate_s, *frequency_s, *timestamp;
 
-       ctx = o->internal;
+       ctx = o->priv;
        header = g_string_sized_new(512);
        num_channels = g_slist_length(o->sdi->channels);
 
        /* timestamp */
        t = time(NULL);
        timestamp = g_strdup(ctime(&t));
-       timestamp[strlen(timestamp)-1] = 0;
+       timestamp[strlen(timestamp) - 1] = 0;
        g_string_printf(header, "$date %s $end\n", timestamp);
        g_free(timestamp);
 
        /* generator */
        g_string_append_printf(header, "$version %s %s $end\n",
-                       PACKAGE, PACKAGE_VERSION);
+                       PACKAGE_NAME, sr_package_version_string_get());
        g_string_append_printf(header, "$comment\n  Acquisition with "
                        "%d/%d channels", ctx->num_enabled_channels, num_channels);
 
@@ -131,15 +128,15 @@ static GString *gen_header(struct sr_output *o)
                ctx->period = SR_MHZ(1);
        else
                ctx->period = SR_KHZ(1);
-       frequency_s = sr_period_string(ctx->period);
+       frequency_s = sr_period_string(1, ctx->period);
        g_string_append_printf(header, "$timescale %s $end\n", frequency_s);
        g_free(frequency_s);
 
        /* scope */
-       g_string_append_printf(header, "$scope module %s $end\n", PACKAGE);
+       g_string_append_printf(header, "$scope module %s $end\n", PACKAGE_NAME);
 
        /* Wires / channels */
-       for (i = 0, l = o->sdi->channels; l; l = l->next, i++) {
+       for (i = 0, l = o->sdi->channels; l; l = l->next) {
                ch = l->data;
                if (ch->type != SR_CHANNEL_LOGIC)
                        continue;
@@ -147,6 +144,7 @@ static GString *gen_header(struct sr_output *o)
                        continue;
                g_string_append_printf(header, "$var wire 1 %c %s $end\n",
                                (char)('!' + i), ch->name);
+               i++;
        }
 
        g_string_append(header, "$upscope $end\n$enddefinitions $end\n");
@@ -154,7 +152,7 @@ static GString *gen_header(struct sr_output *o)
        return header;
 }
 
-static int receive(struct sr_output *o, const struct sr_datafeed_packet *packet,
+static int receive(const struct sr_output *o, const struct sr_datafeed_packet *packet,
                GString **out)
 {
        const struct sr_datafeed_meta *meta;
@@ -168,9 +166,9 @@ static int receive(struct sr_output *o, const struct sr_datafeed_packet *packet,
        gboolean timestamp_written;
 
        *out = NULL;
-       if (!o || !o->internal)
+       if (!o || !o->priv)
                return SR_ERR_BUG;
-       ctx = o->internal;
+       ctx = o->priv;
 
        switch (packet->type) {
        case SR_DF_META:
@@ -202,7 +200,16 @@ static int receive(struct sr_output *o, const struct sr_datafeed_packet *packet,
                        timestamp_written = FALSE;
 
                        for (p = 0; p < ctx->num_enabled_channels; p++) {
-                               index = ctx->channel_index[p];
+                               /*
+                                * TODO Check whether the mapping from
+                                * data image positions to channel numbers
+                                * is required. Experiments suggest that
+                                * the data image "is dense", and packs
+                                * bits of enabled channels, and leaves no
+                                * room for positions of disabled channels.
+                                */
+                               /* index = ctx->channel_index[p]; */
+                               index = p;
 
                                curbit = ((unsigned)sample[index / 8]
                                                >> (index % 8)) & 1;
@@ -249,10 +256,10 @@ static int cleanup(struct sr_output *o)
 {
        struct context *ctx;
 
-       if (!o || !o->internal)
+       if (!o || !o->priv)
                return SR_ERR_ARG;
 
-       ctx = o->internal;
+       ctx = o->priv;
        g_free(ctx->prevsample);
        g_free(ctx->channel_index);
        g_free(ctx);
@@ -260,9 +267,13 @@ static int cleanup(struct sr_output *o)
        return SR_OK;
 }
 
-struct sr_output_format output_vcd = {
+struct sr_output_module output_vcd = {
        .id = "vcd",
-       .description = "Value Change Dump (VCD)",
+       .name = "VCD",
+       .desc = "Value Change Dump data",
+       .exts = (const char*[]){"vcd", NULL},
+       .flags = 0,
+       .options = NULL,
        .init = init,
        .receive = receive,
        .cleanup = cleanup,