input: Introduce new input module API.

[libsigrok.git] / include / libsigrok / libsigrok.h

diff --git a/include/libsigrok/libsigrok.h b/include/libsigrok/libsigrok.h
index 1a076d6aad46cd5aa516e29e297fa50b5c9cd242..dd6307decf0df4813b54e54cd33fbff162817c64 100644 (file)
--- a/include/libsigrok/libsigrok.h
+++ b/include/libsigrok/libsigrok.h
@@ -443,78 +443,23 @@ struct sr_option {
        GSList *values;
 };
 
-/** Input (file) module struct. */
-struct sr_input {
-       /**
-        * A pointer to this input module's 'struct sr_input_module'.
-        * The frontend can use this to call the module's callbacks.
-        */
-       struct sr_input_module *module;
-
-       GHashTable *param;
-
-       struct sr_dev_inst *sdi;
-
-       void *internal;
-};
-
-/** Input (file) module driver. */
-struct sr_input_module {
-       /** The unique ID for this input module. Must not be NULL. */
-       char *id;
-
-       /**
-        * A short description of the input module, which can (for example)
-        * be displayed to the user by frontends. Must not be NULL.
-        */
-       char *description;
-
-       /**
-        * Check if this input module can load and parse the specified file.
-        *
-        * @param[in] filename The name (and path) of the file to check.
-        *
-        * @retval TRUE This module knows the format.
-        * @retval FALSE This module does not know the format.
-        */
-       int (*format_match) (const char *filename);
-
-       /**
-        * Initialize the input module.
-        *
-        * @param in A pointer to a valid 'struct sr_input' that the caller
-        *           has to allocate and provide to this function. It is also
-        *           the responsibility of the caller to free it later.
-        * @param[in] filename The name (and path) of the file to use.
-        *
-        * @retval SR_OK Success
-        * @retval other Negative error code.
-        */
-       int (*init) (struct sr_input *in, const char *filename);
-
-       /**
-        * Load a file, parsing the input according to the file's format.
-        *
-        * This function will send datafeed packets to the session bus, so
-        * the calling frontend must have registered its session callbacks
-        * beforehand.
-        *
-        * The packet types sent across the session bus by this function must
-        * include at least SR_DF_HEADER, SR_DF_END, and an appropriate data
-        * type such as SR_DF_LOGIC. It may also send a SR_DF_TRIGGER packet
-        * if appropriate.
-        *
-        * @param in A pointer to a valid 'struct sr_input' that the caller
-        *           has to allocate and provide to this function. It is also
-        *           the responsibility of the caller to free it later.
-        * @param filename The name (and path) of the file to use.
-        *
-        * @retval SR_OK Success
-        * @retval other Negative error code.
-        */
-       int (*loadfile) (struct sr_input *in, const char *filename);
+/** Input module metadata keys. */
+enum sr_input_meta_keys {
+       /** The input filename, if there is one. */
+       SR_INPUT_META_FILENAME = 0x01,
+       /** The input file's size in bytes. */
+       SR_INPUT_META_FILESIZE = 0x02,
+       /** The first 128 bytes of the file, provided as a GString. */
+       SR_INPUT_META_HEADER = 0x04,
+       /** The file's MIME type. */
+       SR_INPUT_META_MIMETYPE = 0x08,
+
+       /** The module cannot identify a file without this metadata. */
+       SR_INPUT_META_REQUIRED = 0x80,
 };
 
+struct sr_input;
+struct sr_input_module;
 struct sr_output;
 struct sr_output_module;