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 1f20e1d66826b1b8d2bfafba6e98858cc3aff5d8..dd6307decf0df4813b54e54cd33fbff162817c64 100644 (file)
--- a/include/libsigrok/libsigrok.h
+++ b/include/libsigrok/libsigrok.h
@@ -443,6 +443,21 @@ struct sr_option {
        GSList *values;
 };
 
+/** 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;