#define LIBSIGROKCXX_HPP
#include <libsigrok/libsigrok.h>
+
+/* Suppress warnings due to glibmm's use of std::auto_ptr<> in a public
+ * header file. To be removed once glibmm is fixed. */
+G_GNUC_BEGIN_IGNORE_DEPRECATIONS
#include <glibmm.h>
+G_GNUC_END_IGNORE_DEPRECATIONS
#include <stdexcept>
#include <memory>
class SR_API Channel;
class SR_API Session;
class SR_API ConfigKey;
+class SR_API Capability;
class SR_API InputFormat;
class SR_API OutputFormat;
class SR_API OutputFlag;
class SR_API Quantity;
class SR_API Unit;
class SR_API QuantityFlag;
+class SR_API Rational;
class SR_API Input;
class SR_API InputDevice;
class SR_API Output;
const char *name, void *cb_data) noexcept;
static SR_PRIV int close_callback(struct sr_resource *res,
void *cb_data) noexcept;
- static SR_PRIV ssize_t read_callback(const struct sr_resource *res,
+ static SR_PRIV gssize read_callback(const struct sr_resource *res,
void *buf, size_t count, void *cb_data) noexcept;
friend class Context;
};
map<string, shared_ptr<Driver> > drivers();
/** Available input formats, indexed by name. */
map<string, shared_ptr<InputFormat> > input_formats();
+ /** Lookup the responsible input module for an input file. */
+ shared_ptr<InputFormat> input_format_match(string filename);
/** Available output formats, indexed by name. */
map<string, shared_ptr<OutputFormat> > output_formats();
/** Current log level. */
shared_ptr<Packet> create_header_packet(Glib::TimeVal start_time);
/** Create a meta packet. */
shared_ptr<Packet> create_meta_packet(
- const map<const ConfigKey *, Glib::VariantBase> &config);
+ map<const ConfigKey *, Glib::VariantBase> config);
/** Create a logic packet. */
shared_ptr<Packet> create_logic_packet(
void *data_pointer, size_t data_length, unsigned int unit_size);
/** Create an analog packet. */
shared_ptr<Packet> create_analog_packet(
- const vector<shared_ptr<Channel> > &channels,
- float *data_pointer, unsigned int num_samples, const Quantity *mq,
- const Unit *unit, const vector<const QuantityFlag *> &mqflags);
+ vector<shared_ptr<Channel> > channels,
+ const float *data_pointer, unsigned int num_samples, const Quantity *mq,
+ const Unit *unit, vector<const QuantityFlag *> mqflags);
+ /** Create an end packet. */
+ shared_ptr<Packet> create_end_packet();
/** Load a saved session.
* @param filename File name string. */
shared_ptr<Session> load_session(string filename);
~Context();
friend class Session;
friend class Driver;
- friend class std::default_delete<Context>;
-};
-
-enum Capability {
- GET = SR_CONF_GET,
- SET = SR_CONF_SET,
- LIST = SR_CONF_LIST
+ friend struct std::default_delete<Context>;
};
/** An object that can be configured. */
class SR_API Configurable
{
public:
+ /** Supported configuration keys. */
+ set<const ConfigKey *> config_keys() const;
/** Read configuration for the given key.
* @param key ConfigKey to read. */
Glib::VariantBase config_get(const ConfigKey *key) const;
/** Enumerate available values for the given configuration key.
* @param key ConfigKey to enumerate values for. */
Glib::VariantContainerBase config_list(const ConfigKey *key) const;
- /** Enumerate available keys, according to a given index key. */
- map<const ConfigKey *, set<Capability> > config_keys(const ConfigKey *key);
- /** Check for a key in the list from a given index key. */
- bool config_check(const ConfigKey *key, const ConfigKey *index_key) const;
+ /** Enumerate configuration capabilities for the given configuration key.
+ * @param key ConfigKey to enumerate capabilities for. */
+ set<const Capability *> config_capabilities(const ConfigKey *key) const;
+ /** Check whether a configuration capability is supported for a given key.
+ * @param key ConfigKey to check.
+ * @param capability Capability to check for. */
+ bool config_check(const ConfigKey *key, const Capability *capability) const;
protected:
Configurable(
struct sr_dev_driver *driver,
};
/** A hardware driver provided by the library */
-class SR_API Driver :
- public ParentOwned<Driver, Context>,
- public Configurable
+class SR_API Driver : public ParentOwned<Driver, Context>, public Configurable
{
public:
/** Name of this driver. */
string name() const;
/** Long name for this driver. */
string long_name() const;
+ /** Scan options supported by this driver. */
+ set<const ConfigKey *> scan_options() const;
/** Scan for devices and return a list of devices found.
* @param options Mapping of (ConfigKey, value) pairs. */
- vector<shared_ptr<HardwareDevice> > scan(const map<const ConfigKey *, Glib::VariantBase>
- &options = map<const ConfigKey *, Glib::VariantBase>());
+ vector<shared_ptr<HardwareDevice> > scan(map<const ConfigKey *, Glib::VariantBase>
+ options = map<const ConfigKey *, Glib::VariantBase>());
private:
struct sr_dev_driver *_structure;
bool _initialized;
friend class Context;
friend class HardwareDevice;
friend class ChannelGroup;
- friend class std::default_delete<Driver>;
+ friend struct std::default_delete<Driver>;
};
/** A generic device, either hardware or virtual */
friend class ChannelGroup;
friend class Output;
friend class Analog;
- friend class std::default_delete<Device>;
+ friend struct std::default_delete<Device>;
};
/** A real hardware device, connected via a driver */
friend class Driver;
friend class ChannelGroup;
- friend class std::default_delete<HardwareDevice>;
+ friend struct std::default_delete<HardwareDevice>;
};
/** A virtual device, created by the user */
shared_ptr<Device> get_shared_from_this();
friend class Context;
- friend class std::default_delete<UserDevice>;
+ friend struct std::default_delete<UserDevice>;
};
/** A channel on a device */
friend class Session;
friend class TriggerStage;
friend class Context;
- friend class std::default_delete<Channel>;
+ friend struct std::default_delete<Channel>;
};
/** A group of channels on a device, which share some configuration */
~ChannelGroup();
vector<Channel *> _channels;
friend class Device;
- friend class std::default_delete<ChannelGroup>;
+ friend struct std::default_delete<ChannelGroup>;
};
/** A trigger configuration */
vector<unique_ptr<TriggerStage> > _stages;
friend class Context;
friend class Session;
- friend class std::default_delete<Trigger>;
+ friend struct std::default_delete<Trigger>;
};
/** A stage in a trigger configuration */
explicit TriggerStage(struct sr_trigger_stage *structure);
~TriggerStage();
friend class Trigger;
- friend class std::default_delete<TriggerStage>;
+ friend struct std::default_delete<TriggerStage>;
};
/** A match condition in a trigger configuration */
struct sr_trigger_match *_structure;
shared_ptr<Channel> _channel;
friend class TriggerStage;
- friend class std::default_delete<TriggerMatch>;
+ friend struct std::default_delete<TriggerMatch>;
};
/** Type of session stopped callback */
shared_ptr<Device> get_shared_from_this();
friend class Session;
- friend class std::default_delete<SessionDevice>;
+ friend struct std::default_delete<SessionDevice>;
};
/** A sigrok session */
friend class Context;
friend class DatafeedCallbackData;
friend class SessionDevice;
- friend class std::default_delete<Session>;
+ friend struct std::default_delete<Session>;
};
/** A packet on the session datafeed */
friend class Logic;
friend class Analog;
friend class Context;
- friend
class std::default_delete<Packet>;
+ friend
struct std::default_delete<Packet>;
};
/** Abstract base class for datafeed packet payloads */
friend class Packet;
friend class Output;
- friend
class std::default_delete<PacketPayload>;
+ friend
struct std::default_delete<PacketPayload>;
};
/** Payload of a datafeed header packet */
const struct sr_datafeed_logic *_structure;
friend class Packet;
+ friend class Analog;
+ friend struct std::default_delete<Logic>;
};
/** Payload of a datafeed packet with analog data */
public:
/** Pointer to data. */
void *data_pointer();
+ /**
+ * Fills dest pointer with the analog data converted to float.
+ * The pointer must have space for num_samples() floats.
+ */
+ void get_data_as_float(float *dest);
/** Number of samples in this packet. */
unsigned int num_samples() const;
/** Channels for which this packet contains data. */
vector<shared_ptr<Channel> > channels();
+ /** Size of a single sample in bytes. */
+ unsigned int unitsize() const;
+ /** Samples use a signed data type. */
+ bool is_signed() const;
+ /** Samples use float. */
+ bool is_float() const;
+ /** Samples are stored in big-endian order. */
+ bool is_bigendian() const;
+ /**
+ * Number of significant digits after the decimal point if positive,
+ * or number of non-significant digits before the decimal point if negative
+ * (refers to the value we actually read on the wire).
+ */
+ int digits() const;
+ /** TBD */
+ bool is_digits_decimal() const;
+ /** TBD */
+ shared_ptr<Rational> scale();
+ /** TBD */
+ shared_ptr<Rational> offset();
/** Measured quantity of the samples in this packet. */
const Quantity *mq() const;
/** Unit of the samples in this packet. */
const Unit *unit() const;
/** Measurement flags associated with the samples in this packet. */
vector<const QuantityFlag *> mq_flags() const;
+ /**
+ * Provides a Logic packet that contains a conversion of the analog
+ * data using a simple threshold.
+ *
+ * @param threshold Threshold to use.
+ * @param data_ptr Pointer to num_samples() bytes where the logic
+ * samples are stored. When nullptr, memory for
+ * logic->data_pointer() will be allocated and must
+ * be freed by the caller.
+ */
+ shared_ptr<Logic> get_logic_via_threshold(float threshold,
+ uint8_t *data_ptr=nullptr) const;
+ /**
+ * Provides a Logic packet that contains a conversion of the analog
+ * data using a Schmitt-Trigger.
+ *
+ * @param lo_thr Low threshold to use (anything below this is low).
+ * @param hi_thr High threshold to use (anything above this is high).
+ * @param state Points to a byte that contains the current state of the
+ * converter. For best results, set to value of logic
+ * sample n-1.
+ * @param data_ptr Pointer to num_samples() bytes where the logic
+ * samples are stored. When nullptr, memory for
+ * logic->data_pointer() will be allocated and must be
+ * freed by the caller.
+ */
+ shared_ptr<Logic> get_logic_via_schmitt_trigger(float lo_thr,
+ float hi_thr, uint8_t *state, uint8_t *data_ptr=nullptr) const;
private:
explicit Analog(const struct sr_datafeed_analog *structure);
~Analog();
friend class Packet;
};
+/** Number represented by a numerator/denominator integer pair */
+class SR_API Rational :
+ public ParentOwned<Rational, Analog>
+{
+public:
+ /** Numerator, i.e. the dividend. */
+ int64_t numerator() const;
+ /** Denominator, i.e. the divider. */
+ uint64_t denominator() const;
+ /** Actual (lossy) value. */
+ float value() const;
+private:
+ explicit Rational(const struct sr_rational *structure);
+ ~Rational();
+ shared_ptr<Rational> share_owned_by(shared_ptr<Analog> parent);
+
+ const struct sr_rational *_structure;
+
+ friend class Analog;
+ friend struct std::default_delete<Rational>;
+};
+
/** An input format supported by the library */
class SR_API InputFormat :
public ParentOwned<InputFormat, Context>
/** Description of this input format. */
string description() const;
/** A list of preferred file name extensions for this file format.
- * @note This list is a recommendation only. */
+ * @note This list is a recommendation only. */
vector<string> extensions() const;
/** Options supported by this input format. */
map<string, shared_ptr<Option> > options();
/** Create an input using this input format.
* @param options Mapping of (option name, value) pairs. */
- shared_ptr<Input> create_input(const map<string, Glib::VariantBase>
- &options = map<string, Glib::VariantBase>());
+ shared_ptr<Input> create_input(map<string, Glib::VariantBase>
+ options = map<string, Glib::VariantBase>());
private:
explicit InputFormat(const struct sr_input_module *structure);
~InputFormat();
friend class Context;
friend class InputDevice;
- friend class std::default_delete<InputFormat>;
+ friend struct std::default_delete<InputFormat>;
};
/** An input instance (an input format applied to a file or stream) */
void send(void *data, size_t length);
/** Signal end of input data. */
void end();
+ void reset();
private:
Input(shared_ptr<Context> context, const struct sr_input *structure);
~Input();
friend class Context;
friend class InputFormat;
- friend class std::default_delete<Input>;
+ friend struct std::default_delete<Input>;
};
/** A virtual device associated with an input */
shared_ptr<Device> get_shared_from_this();
shared_ptr<Input> _input;
friend class Input;
- friend class std::default_delete<InputDevice>;
+ friend struct std::default_delete<InputDevice>;
};
/** An option used by an output format */
Glib::VariantBase default_value() const;
/** Possible values for this option, if a limited set. */
vector<Glib::VariantBase> values() const;
+ /** Parse a string argument into the appropriate type for this option. */
+ Glib::VariantBase parse_string(string value);
private:
Option(const struct sr_option *structure,
shared_ptr<const struct sr_option *> structure_array);
friend class InputFormat;
friend class OutputFormat;
- friend class std::default_delete<Option>;
+ friend struct std::default_delete<Option>;
};
/** An output format supported by the library */
/** Description of this output format. */
string description() const;
/** A list of preferred file name extensions for this file format.
- * @note This list is a recommendation only. */
+ * @note This list is a recommendation only. */
vector<string> extensions() const;
/** Options supported by this output format. */
map<string, shared_ptr<Option> > options();
* @param device Device to output for.
* @param options Mapping of (option name, value) pairs. */
shared_ptr<Output> create_output(shared_ptr<Device> device,
- const map<string, Glib::VariantBase> &options = map<string, Glib::VariantBase>());
+ map<string, Glib::VariantBase> options = map<string, Glib::VariantBase>());
/** Create an output using this format.
* @param filename Name of destination file.
* @param device Device to output for.
* @param options Mapping of (option name, value) pairs. */
shared_ptr<Output> create_output(string filename,
shared_ptr<Device> device,
- const map<string, Glib::VariantBase> &options = map<string, Glib::VariantBase>());
+ map<string, Glib::VariantBase> options = map<string, Glib::VariantBase>());
/**
* Checks whether a given flag is set.
* @param flag Flag to check
friend class Context;
friend class Output;
- friend class std::default_delete<OutputFormat>;
+ friend struct std::default_delete<OutputFormat>;
};
/** An output instance (an output format applied to a device) */
/** Update output with data from the given packet.
* @param packet Packet to handle. */
string receive(shared_ptr<Packet> packet);
+ /** Output format in use for this output */
+ shared_ptr<OutputFormat> format();
private:
Output(shared_ptr<OutputFormat> format, shared_ptr<Device> device);
Output(shared_ptr<OutputFormat> format,
- shared_ptr<Device> device, const map<string, Glib::VariantBase> &options);
+ shared_ptr<Device> device, map<string, Glib::VariantBase> options);
Output(string filename, shared_ptr<OutputFormat> format,
- shared_ptr<Device> device, const map<string, Glib::VariantBase> &options);
+ shared_ptr<Device> device, map<string, Glib::VariantBase> options);
~Output();
const struct sr_output *_structure;
const map<string, Glib::VariantBase> _options;
friend class OutputFormat;
- friend class std::default_delete<Output>;
+ friend struct std::default_delete<Output>;
};
/** Base class for objects which wrap an enumeration value from libsigrok */
const string _name;
};
-#include <libsigrokcxx/enums.hpp>
-
}
+#include <libsigrokcxx/enums.hpp>
+
#endif
projects / libsigrok.git / blobdiff