analog: improve output readability by using SI prefix

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

diff --git a/include/libsigrok/proto.h b/include/libsigrok/proto.h
index 0892b99e096877569e940b62f30d10040c77eab6..c799919e267a710dfed69de94db5a303dec8edd9 100644 (file)
--- a/include/libsigrok/proto.h
+++ b/include/libsigrok/proto.h
@@ -28,12 +28,17 @@
 
 /*--- analog.c --------------------------------------------------------------*/
 
-SR_API int sr_analog_to_float(const struct sr_datafeed_analog2 *analog,
+SR_API int sr_analog_to_float(const struct sr_datafeed_analog *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,
+SR_API const char *sr_analog_si_prefix(float *value, int *digits);
+SR_API int sr_analog_unit_to_string(const struct sr_datafeed_analog *analog,
                char **result);
 SR_API void sr_rational_set(struct sr_rational *r, int64_t p, uint64_t q);
+SR_API int sr_rational_eq(const struct sr_rational *a, const struct sr_rational *b);
+SR_API int sr_rational_mult(struct sr_rational *res, const struct sr_rational *a,
+               const struct sr_rational *b);
+SR_API int sr_rational_div(struct sr_rational *res, const struct sr_rational *num,
+               const struct sr_rational *div);
 
 /*--- backend.c -------------------------------------------------------------*/
 
@@ -57,6 +62,10 @@ SR_API int sr_dev_channel_name_set(struct sr_channel *channel,
 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 int sr_dev_config_capabilities_list(const struct sr_dev_inst *sdi,
+               const struct sr_channel_group *cg, int key);
+SR_API GArray *sr_dev_options(const struct sr_dev_driver *driver,
+               const struct sr_dev_inst *sdi, const struct sr_channel_group *cg);
 SR_API GSList *sr_dev_list(const struct sr_dev_driver *driver);
 SR_API int sr_dev_clear(const struct sr_dev_driver *driver);
 SR_API int sr_dev_open(struct sr_dev_inst *sdi);
@@ -80,6 +89,7 @@ SR_API int sr_dev_inst_channel_add(struct sr_dev_inst *sdi, int index, int type,
 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 GArray *sr_driver_scan_options_list(const 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,
@@ -98,8 +108,10 @@ SR_API const struct sr_key_info *sr_key_info_name_get(int keytype, const char *k
 
 /*--- session.c -------------------------------------------------------------*/
 
+typedef void (*sr_session_stopped_callback)(void *data);
 typedef void (*sr_datafeed_callback)(const struct sr_dev_inst *sdi,
                const struct sr_datafeed_packet *packet, void *cb_data);
+
 SR_API struct sr_trigger *sr_session_trigger_get(struct sr_session *session);
 
 /* Session setup */
@@ -110,6 +122,8 @@ 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,
                struct sr_dev_inst *sdi);
+SR_API int sr_session_dev_remove(struct sr_session *session,
+               struct sr_dev_inst *sdi);
 SR_API int sr_session_dev_list(struct sr_session *session, GSList **devlist);
 SR_API int sr_session_trigger_set(struct sr_session *session, struct sr_trigger *trig);
 
@@ -122,26 +136,9 @@ SR_API int sr_session_datafeed_callback_add(struct sr_session *session,
 SR_API int sr_session_start(struct sr_session *session);
 SR_API int sr_session_run(struct sr_session *session);
 SR_API int sr_session_stop(struct sr_session *session);
-SR_API int sr_session_save(struct sr_session *session, const char *filename,
-               const struct sr_dev_inst *sdi, unsigned char *buf, int unitsize,
-               int units);
-SR_API int sr_session_save_init(struct sr_session *session,
-               const char *filename, uint64_t samplerate, char **channels);
-SR_API int sr_session_append(struct sr_session *session,
-               const char *filename, unsigned char *buf, int unitsize, int units);
-SR_API int sr_session_source_add(struct sr_session *session, int fd,
-               int events, int timeout, sr_receive_data_callback cb, void *cb_data);
-SR_API int sr_session_source_add_pollfd(struct sr_session *session,
-               GPollFD *pollfd, int timeout, sr_receive_data_callback cb,
-               void *cb_data);
-SR_API int sr_session_source_add_channel(struct sr_session *session,
-               GIOChannel *channel, int events, int timeout,
-               sr_receive_data_callback cb, void *cb_data);
-SR_API int sr_session_source_remove(struct sr_session *session, int fd);
-SR_API int sr_session_source_remove_pollfd(struct sr_session *session,
-               GPollFD *pollfd);
-SR_API int sr_session_source_remove_channel(struct sr_session *session,
-               GIOChannel *channel);
+SR_API int sr_session_is_running(struct sr_session *session);
+SR_API int sr_session_stopped_callback_set(struct sr_session *session,
+               sr_session_stopped_callback cb, void *cb_data);
 
 /*--- input/input.c ---------------------------------------------------------*/
 
@@ -163,6 +160,7 @@ 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 int sr_input_reset(const struct sr_input *in);
 SR_API void sr_input_free(const struct sr_input *in);
 
 /*--- output/output.c -------------------------------------------------------*/
@@ -209,6 +207,20 @@ SR_API int sr_trigger_match_add(struct sr_trigger_stage *stage,
 SR_API GSList *sr_serial_list(const struct sr_dev_driver *driver);
 SR_API void sr_serial_free(struct sr_serial_port *serial);
 
+/*--- resource.c ------------------------------------------------------------*/
+
+typedef int (*sr_resource_open_callback)(struct sr_resource *res,
+               const char *name, void *cb_data);
+typedef int (*sr_resource_close_callback)(struct sr_resource *res,
+               void *cb_data);
+typedef gssize (*sr_resource_read_callback)(const struct sr_resource *res,
+               void *buf, size_t count, void *cb_data);
+
+SR_API int sr_resource_set_hooks(struct sr_context *ctx,
+               sr_resource_open_callback open_cb,
+               sr_resource_close_callback close_cb,
+               sr_resource_read_callback read_cb, void *cb_data);
+
 /*--- strutil.c -------------------------------------------------------------*/
 
 SR_API char *sr_si_string_u64(uint64_t x, const char *unit);
@@ -220,6 +232,7 @@ SR_API uint64_t sr_parse_timestring(const char *timestring);
 SR_API gboolean sr_parse_boolstring(const char *boolstring);
 SR_API int sr_parse_period(const char *periodstr, uint64_t *p, uint64_t *q);
 SR_API int sr_parse_voltage(const char *voltstr, uint64_t *p, uint64_t *q);
+SR_API int sr_parse_rational(const char *str, struct sr_rational *ret);
 
 /*--- version.c -------------------------------------------------------------*/