X-Git-Url: https://sigrok.org/gitweb/?a=blobdiff_plain;f=input%2Finput.c;h=40886df98968ce5f06ffac9ad71e3c2b50d01062;hb=016e72f30e21fbec6a1097318ab36877b2c140af;hp=fd51a874ba9faf0701f4ff04d60a032aa3f413d6;hpb=393fb9cb18c5746d8567c9cf74b872804043345a;p=libsigrok.git diff --git a/input/input.c b/input/input.c index fd51a874..40886df9 100644 --- a/input/input.c +++ b/input/input.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 * @@ -31,16 +31,37 @@ * * Input file/data format handling. * + * libsigrok can process acquisition data in several different ways. + * Aside from acquiring data from a hardware device, it can also take it from + * a file in various formats (binary, CSV, VCD, and so on). + * + * Like everything in libsigrok that handles data, processing is done in a + * streaming manner -- input should be supplied to libsigrok a chunk at a time. + * This way anything that processes data can do so in real time, without the + * user having to wait for the whole thing to be finished. + * + * Every input module is "pluggable", meaning it's handled as being separate + * from the main libsigrok, but linked in to it statically. To keep things + * modular and separate like this, functions within an input module should be + * declared static, with only the respective 'struct sr_input_format' being + * exported for use into the wider libsigrok namespace. + * * @{ */ /** @cond PRIVATE */ extern SR_PRIV struct sr_input_format input_chronovu_la8; +extern SR_PRIV struct sr_input_format input_csv; extern SR_PRIV struct sr_input_format input_binary; +extern SR_PRIV struct sr_input_format input_vcd; +extern SR_PRIV struct sr_input_format input_wav; /* @endcond */ static struct sr_input_format *input_module_list[] = { + &input_vcd, &input_chronovu_la8, + &input_wav, + &input_csv, /* This one has to be last, because it will take any input. */ &input_binary, NULL,