Add filename field to sr_output and make it accessible

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

diff --git a/include/libsigrok/proto.h b/include/libsigrok/proto.h
index edcd4c978582146e6cd43cf936f604518f99142c..788f80de1087601f751457cbdddb545fa2c6bdb2 100644 (file)
--- a/include/libsigrok/proto.h
+++ b/include/libsigrok/proto.h
@@ -26,6 +26,15 @@
  * Header file containing API function prototypes.
  */
 
+/*--- analog.c --------------------------------------------------------------*/
+
+SR_API int sr_analog_to_float(const struct sr_datafeed_analog2 *analog,
+               float *buf);
+SR_API int sr_analog_float_to_string(float value, int digits, char **result);
+SR_API int sr_analog_unit_to_string(const struct sr_datafeed_analog2 *analog,
+               char **result);
+SR_API void sr_rational_set(struct sr_rational *r, uint64_t p, uint64_t q);
+
 /*--- backend.c -------------------------------------------------------------*/
 
 SR_API int sr_init(struct sr_context **ctx);
@@ -45,9 +54,9 @@ SR_API char *sr_log_logdomain_get(void);
 
 /*--- device.c --------------------------------------------------------------*/
 
-SR_API int sr_dev_channel_name_set(const struct sr_dev_inst *sdi,
-               int channelnum, const char *name);
-SR_API int sr_dev_channel_enable(const struct sr_dev_inst *sdi, int channelnum,
+SR_API int sr_dev_channel_name_set(struct sr_channel *channel,
+               const char *name);
+SR_API int sr_dev_channel_enable(struct sr_channel *channel,
                gboolean state);
 SR_API gboolean sr_dev_has_option(const struct sr_dev_inst *sdi, int key);
 SR_API GSList *sr_dev_list(const struct sr_dev_driver *driver);
@@ -55,25 +64,38 @@ SR_API int sr_dev_clear(const struct sr_dev_driver *driver);
 SR_API int sr_dev_open(struct sr_dev_inst *sdi);
 SR_API int sr_dev_close(struct sr_dev_inst *sdi);
 
+SR_API struct sr_dev_driver *sr_dev_inst_driver_get(const struct sr_dev_inst *sdi);
+SR_API const char *sr_dev_inst_vendor_get(const struct sr_dev_inst *sdi);
+SR_API const char *sr_dev_inst_model_get(const struct sr_dev_inst *sdi);
+SR_API const char *sr_dev_inst_version_get(const struct sr_dev_inst *sdi);
+SR_API const char *sr_dev_inst_sernum_get(const struct sr_dev_inst *sdi);
+SR_API const char *sr_dev_inst_connid_get(const struct sr_dev_inst *sdi);
+SR_API GSList *sr_dev_inst_channels_get(const struct sr_dev_inst *sdi);
+SR_API GSList *sr_dev_inst_channel_groups_get(const struct sr_dev_inst *sdi);
+
+SR_API struct sr_dev_inst *sr_dev_inst_user_new(const char *vendor,
+               const char *model, const char *version);
+SR_API int sr_dev_inst_channel_add(struct sr_dev_inst *sdi, int index, int type, const char *name);
+
 /*--- hwdriver.c ------------------------------------------------------------*/
 
-SR_API struct sr_dev_driver **sr_driver_list(void);
+SR_API struct sr_dev_driver **sr_driver_list(const struct sr_context *ctx);
 SR_API int sr_driver_init(struct sr_context *ctx,
                struct sr_dev_driver *driver);
 SR_API GSList *sr_driver_scan(struct sr_dev_driver *driver, GSList *options);
 SR_API int sr_config_get(const struct sr_dev_driver *driver,
                const struct sr_dev_inst *sdi,
                const struct sr_channel_group *cg,
-               int key, GVariant **data);
+               uint32_t key, GVariant **data);
 SR_API int sr_config_set(const struct sr_dev_inst *sdi,
                const struct sr_channel_group *cg,
-               int key, GVariant *data);
+               uint32_t key, GVariant *data);
 SR_API int sr_config_commit(const struct sr_dev_inst *sdi);
 SR_API int sr_config_list(const struct sr_dev_driver *driver,
                const struct sr_dev_inst *sdi,
                const struct sr_channel_group *cg,
-               int key, GVariant **data);
-SR_API const struct sr_config_info *sr_config_info_get(int key);
+               uint32_t key, GVariant **data);
+SR_API const struct sr_config_info *sr_config_info_get(uint32_t key);
 SR_API const struct sr_config_info *sr_config_info_name_get(const char *optname);
 
 /*--- session.c -------------------------------------------------------------*/
@@ -83,8 +105,9 @@ typedef void (*sr_datafeed_callback)(const struct sr_dev_inst *sdi,
 SR_API struct sr_trigger *sr_session_trigger_get(struct sr_session *session);
 
 /* Session setup */
-SR_API int sr_session_load(const char *filename, struct sr_session **session);
-SR_API int sr_session_new(struct sr_session **session);
+SR_API int sr_session_load(struct sr_context *ctx, const char *filename,
+       struct sr_session **session);
+SR_API int sr_session_new(struct sr_context *ctx, struct sr_session **session);
 SR_API int sr_session_destroy(struct sr_session *session);
 SR_API int sr_session_dev_remove_all(struct sr_session *session);
 SR_API int sr_session_dev_add(struct sr_session *session,
@@ -124,23 +147,55 @@ SR_API int sr_session_source_remove_channel(struct sr_session *session,
 
 /*--- input/input.c ---------------------------------------------------------*/
 
-SR_API struct sr_input_format **sr_input_list(void);
+SR_API const struct sr_input_module **sr_input_list(void);
+SR_API const char *sr_input_id_get(const struct sr_input_module *imod);
+SR_API const char *sr_input_name_get(const struct sr_input_module *imod);
+SR_API const char *sr_input_description_get(const struct sr_input_module *imod);
+SR_API const char *const *sr_input_extensions_get(
+               const struct sr_input_module *imod);
+SR_API const struct sr_input_module *sr_input_find(char *id);
+SR_API const struct sr_option **sr_input_options_get(const struct sr_input_module *imod);
+SR_API void sr_input_options_free(const struct sr_option **options);
+SR_API struct sr_input *sr_input_new(const struct sr_input_module *imod,
+               GHashTable *options);
+SR_API int sr_input_scan_buffer(GString *buf, const struct sr_input **in);
+SR_API int sr_input_scan_file(const char *filename, const struct sr_input **in);
+SR_API struct sr_dev_inst *sr_input_dev_inst_get(const struct sr_input *in);
+SR_API int sr_input_send(const struct sr_input *in, GString *buf);
+SR_API int sr_input_end(const struct sr_input *in);
+SR_API void sr_input_free(const struct sr_input *in);
 
 /*--- output/output.c -------------------------------------------------------*/
 
 SR_API const struct sr_output_module **sr_output_list(void);
-SR_API const char *sr_output_id_get(const struct sr_output_module *o);
-SR_API const char *sr_output_name_get(const struct sr_output_module *o);
-SR_API const char *sr_output_description_get(const struct sr_output_module *o);
+SR_API const char *sr_output_id_get(const struct sr_output_module *omod);
+SR_API const char *sr_output_name_get(const struct sr_output_module *omod);
+SR_API const char *sr_output_description_get(const struct sr_output_module *omod);
+SR_API const char *const *sr_output_extensions_get(
+               const struct sr_output_module *omod);
 SR_API const struct sr_output_module *sr_output_find(char *id);
-SR_API const struct sr_option *sr_output_options_get(const struct sr_output_module *o);
-SR_API void sr_output_options_free(const struct sr_output_module *o);
-SR_API const struct sr_output *sr_output_new(const struct sr_output_module *o,
-               GHashTable *params, const struct sr_dev_inst *sdi);
+SR_API const struct sr_option **sr_output_options_get(const struct sr_output_module *omod);
+SR_API void sr_output_options_free(const struct sr_option **opts);
+SR_API const struct sr_output *sr_output_new(const struct sr_output_module *omod,
+               GHashTable *params, const struct sr_dev_inst *sdi,
+               const char *filename);
 SR_API int sr_output_send(const struct sr_output *o,
                const struct sr_datafeed_packet *packet, GString **out);
 SR_API int sr_output_free(const struct sr_output *o);
 
+/*--- transform/transform.c -------------------------------------------------*/
+
+SR_API const struct sr_transform_module **sr_transform_list(void);
+SR_API const char *sr_transform_id_get(const struct sr_transform_module *tmod);
+SR_API const char *sr_transform_name_get(const struct sr_transform_module *tmod);
+SR_API const char *sr_transform_description_get(const struct sr_transform_module *tmod);
+SR_API const struct sr_transform_module *sr_transform_find(const char *id);
+SR_API const struct sr_option **sr_transform_options_get(const struct sr_transform_module *tmod);
+SR_API void sr_transform_options_free(const struct sr_option **opts);
+SR_API const struct sr_transform *sr_transform_new(const struct sr_transform_module *tmod,
+               GHashTable *params, const struct sr_dev_inst *sdi);
+SR_API int sr_transform_free(const struct sr_transform *t);
+
 /*--- trigger.c -------------------------------------------------------------*/
 
 SR_API struct sr_trigger *sr_trigger_new(const char *name);
@@ -149,6 +204,11 @@ SR_API struct sr_trigger_stage *sr_trigger_stage_add(struct sr_trigger *trig);
 SR_API int sr_trigger_match_add(struct sr_trigger_stage *stage,
                struct sr_channel *ch, int trigger_match, float value);
 
+/*--- serial.c --------------------------------------------------------------*/
+
+SR_API GSList *sr_serial_list(const struct sr_dev_driver *driver);
+SR_API void sr_serial_free(struct sr_serial_port *serial);
+
 /*--- strutil.c -------------------------------------------------------------*/
 
 SR_API char *sr_si_string_u64(uint64_t x, const char *unit);