2 * This file is part of the libsigrok project.
4 * Copyright (C) 2013-2014 Martin Ling <martin-sigrok@earth.li>
6 * This program is free software: you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation, either version 3 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program. If not, see <http://www.gnu.org/licenses/>.
22 @mainpage API Reference
27 The libsigrokcxx API provides an object-oriented C++ interface to the
28 functionality in libsigrok, including automatic memory and resource management.
30 It is built on top of the public libsigrok C API, and is designed to be used as
31 a standalone alternative API. Programs should not mix usage of the C and C++
32 APIs; the C++ interface code needs to have full control of all C API calls for
33 resources to be managed correctly.
38 All runtime objects created through the C++ API are passed and accessed via
39 shared pointers, using the C++11 std::shared_ptr implementation. This means
40 that a reference count is kept for each object.
42 Shared pointers can be copied and assigned in a user's program, automatically
43 updating their reference count and deleting objects when they are no longer in
44 use. The C++ interface code also keeps track of internal dependencies between
45 libsigrok resources, and ensures that objects are not prematurely deleted when
46 their resources are in use by other objects.
48 This means that management of libsigrokcxx objects and their underlying
49 libsigrok resources can be treated as fully automatic. As long as all shared
50 pointers to objects are deleted or reassigned when no longer in use, all
51 underlying resources will be released at the right time.
56 Usage of the C++ API needs to begin with a call to sigrok::Context::create().
57 This will create the global libsigrok context and returns a shared pointer to
58 the sigrok::Context object. Methods on this object provide access to the
59 hardware drivers, input and output formats supported by the library, as well
60 as means of creating other objects such as sessions and triggers.
65 When any libsigrok C API call returns an error, a sigrok::Error exception is
66 raised, which provides access to the error code and description.
70 #ifndef LIBSIGROKCXX_HPP
71 #define LIBSIGROKCXX_HPP
73 #include <libsigrok/libsigrok.h>
87 /* Forward declarations */
92 class SR_API HardwareDevice;
94 class SR_API EventSource;
96 class SR_API ConfigKey;
97 class SR_API InputFormat;
98 class SR_API OutputFormat;
99 class SR_API OutputFlag;
100 class SR_API LogLevel;
101 class SR_API ChannelGroup;
102 class SR_API Trigger;
103 class SR_API TriggerStage;
104 class SR_API TriggerMatch;
105 class SR_API TriggerMatchType;
106 class SR_API ChannelType;
108 class SR_API PacketPayload;
109 class SR_API PacketType;
110 class SR_API Quantity;
112 class SR_API QuantityFlag;
114 class SR_API InputDevice;
116 class SR_API DataType;
118 class SR_API UserDevice;
120 /** Exception thrown when an error code is returned by any libsigrok call. */
121 class SR_API Error: public exception
127 const char *what() const throw();
130 /* Base template for classes whose resources are owned by a parent object. */
131 template <class Class, class Parent, typename Struct>
132 class SR_API ParentOwned
135 /* Parent object which owns this child object's underlying structure.
137 This shared pointer will be null when this child is unused, but
138 will be assigned to point to the parent before any shared pointer
139 to this child is handed out to the user.
141 When the reference count of this child falls to zero, this shared
142 pointer to its parent is reset by a custom deleter on the child's
145 This strategy ensures that the destructors for both the child and
146 the parent are called at the correct time, i.e. only when all
147 references to both the parent and all its children are gone. */
148 shared_ptr<Parent> _parent;
150 /* Weak pointer for shared_from_this() implementation. */
151 weak_ptr<Class> _weak_this;
154 /* Get parent object that owns this object. */
155 shared_ptr<Parent> parent()
160 /* Note, this implementation will create a new smart_ptr if none exists. */
161 shared_ptr<Class> shared_from_this()
163 shared_ptr<Class> shared;
165 if (!(shared = _weak_this.lock()))
167 shared = shared_ptr<Class>((Class *) this, reset_parent);
174 shared_ptr<Class> get_shared_pointer(shared_ptr<Parent> parent)
177 throw Error(SR_ERR_BUG);
178 this->_parent = parent;
179 return shared_from_this();
182 shared_ptr<Class> get_shared_pointer(Parent *parent)
185 throw Error(SR_ERR_BUG);
186 return get_shared_pointer(parent->shared_from_this());
189 static void reset_parent(Class *object)
191 if (!object->_parent)
192 throw Error(SR_ERR_BUG);
193 object->_parent.reset();
198 ParentOwned<Class, Parent, Struct>(Struct *structure) :
199 _structure(structure)
204 /* Base template for classes whose resources are owned by the user. */
205 template <class Class, typename Struct>
206 class SR_API UserOwned : public enable_shared_from_this<Class>
209 shared_ptr<Class> shared_from_this()
211 auto shared = enable_shared_from_this<Class>::shared_from_this();
213 throw Error(SR_ERR_BUG);
219 UserOwned<Class, Struct>(Struct *structure) :
220 _structure(structure)
224 /* Deleter needed to allow shared_ptr use with protected destructor. */
228 void operator()(Class *object) { delete object; }
232 /** Type of log callback */
233 typedef function<void(const LogLevel *, string message)> LogCallbackFunction;
235 /** Resource reader delegate. */
236 class SR_API ResourceReader
240 virtual ~ResourceReader();
242 /** Resource open hook. */
243 virtual void open(struct sr_resource *res, string name) = 0;
244 /** Resource close hook. */
245 virtual void close(struct sr_resource *res) = 0;
246 /** Resource read hook. */
247 virtual size_t read(const struct sr_resource *res, void *buf, size_t count) = 0;
249 static SR_PRIV int open_callback(struct sr_resource *res,
250 const char *name, void *cb_data);
251 static SR_PRIV int close_callback(struct sr_resource *res,
253 static SR_PRIV ssize_t read_callback(const struct sr_resource *res,
254 void *buf, size_t count, void *cb_data);
255 friend class Context;
258 /** The global libsigrok context */
259 class SR_API Context : public UserOwned<Context, struct sr_context>
262 /** Create new context */
263 static shared_ptr<Context> create();
264 /** libsigrok package version. */
265 string package_version();
266 /** libsigrok library version. */
267 string lib_version();
268 /** Available hardware drivers, indexed by name. */
269 map<string, shared_ptr<Driver> > drivers();
270 /** Available input formats, indexed by name. */
271 map<string, shared_ptr<InputFormat> > input_formats();
272 /** Available output formats, indexed by name. */
273 map<string, shared_ptr<OutputFormat> > output_formats();
274 /** Current log level. */
275 const LogLevel *log_level();
276 /** Set the log level.
277 * @param level LogLevel to use. */
278 void set_log_level(const LogLevel *level);
279 /** Set the log callback.
280 * @param callback Callback of the form callback(LogLevel, string). */
281 void set_log_callback(LogCallbackFunction callback);
282 /** Set the log callback to the default handler. */
283 void set_log_callback_default();
284 /** Install a delegate for reading resource files.
285 * @param reader The resource reader delegate, or nullptr to unset. */
286 void set_resource_reader(ResourceReader *reader);
287 /** Create a new session. */
288 shared_ptr<Session> create_session();
289 /** Create a new user device. */
290 shared_ptr<UserDevice> create_user_device(
291 string vendor, string model, string version);
292 /** Create a header packet. */
293 shared_ptr<Packet> create_header_packet(Glib::TimeVal start_time);
294 /** Create a meta packet. */
295 shared_ptr<Packet> create_meta_packet(
296 map<const ConfigKey *, Glib::VariantBase> config);
297 /** Create a logic packet. */
298 shared_ptr<Packet> create_logic_packet(
299 void *data_pointer, size_t data_length, unsigned int unit_size);
300 /** Create an analog packet. */
301 shared_ptr<Packet> create_analog_packet(
302 vector<shared_ptr<Channel> > channels,
303 float *data_pointer, unsigned int num_samples, const Quantity *mq,
304 const Unit *unit, vector<const QuantityFlag *> mqflags);
305 /** Load a saved session.
306 * @param filename File name string. */
307 shared_ptr<Session> load_session(string filename);
308 /** Create a new trigger.
309 * @param name Name string for new trigger. */
310 shared_ptr<Trigger> create_trigger(string name);
311 /** Open an input file.
312 * @param filename File name string. */
313 shared_ptr<Input> open_file(string filename);
314 /** Open an input stream based on header data.
315 * @param header Initial data from stream. */
316 shared_ptr<Input> open_stream(string header);
317 map<string, string> serials(shared_ptr<Driver> driver);
319 map<string, Driver *> _drivers;
320 map<string, InputFormat *> _input_formats;
321 map<string, OutputFormat *> _output_formats;
323 LogCallbackFunction _log_callback;
326 friend class Deleter;
327 friend class Session;
337 /** An object that can be configured. */
338 class SR_API Configurable
341 /** Read configuration for the given key.
342 * @param key ConfigKey to read. */
343 Glib::VariantBase config_get(const ConfigKey *key);
344 /** Set configuration for the given key to a specified value.
345 * @param key ConfigKey to set.
346 * @param value Value to set. */
347 void config_set(const ConfigKey *key, Glib::VariantBase value);
348 /** Enumerate available values for the given configuration key.
349 * @param key ConfigKey to enumerate values for. */
350 Glib::VariantContainerBase config_list(const ConfigKey *key);
351 /** Enumerate available keys, according to a given index key. */
352 map<const ConfigKey *, set<Capability> > config_keys(const ConfigKey *key);
353 /** Check for a key in the list from a given index key. */
354 bool config_check(const ConfigKey *key, const ConfigKey *index_key);
357 struct sr_dev_driver *driver,
358 struct sr_dev_inst *sdi,
359 struct sr_channel_group *channel_group);
360 virtual ~Configurable();
361 struct sr_dev_driver *config_driver;
362 struct sr_dev_inst *config_sdi;
363 struct sr_channel_group *config_channel_group;
366 /** A hardware driver provided by the library */
367 class SR_API Driver :
368 public ParentOwned<Driver, Context, struct sr_dev_driver>,
372 /** Name of this driver. */
374 /** Long name for this driver. */
376 /** Scan for devices and return a list of devices found.
377 * @param options Mapping of (ConfigKey, value) pairs. */
378 vector<shared_ptr<HardwareDevice> > scan(
379 map<const ConfigKey *, Glib::VariantBase> options =
380 map<const ConfigKey *, Glib::VariantBase>());
383 vector<HardwareDevice *> _devices;
384 Driver(struct sr_dev_driver *structure);
386 friend class Context;
387 friend class HardwareDevice;
388 friend class ChannelGroup;
391 /** A generic device, either hardware or virtual */
392 class SR_API Device : public Configurable
395 /** Vendor name for this device. */
397 /** Model name for this device. */
399 /** Version string for this device. */
401 /** Serial number for this device. */
402 string serial_number();
403 /** Connection ID for this device. */
404 string connection_id();
405 /** List of the channels available on this device. */
406 vector<shared_ptr<Channel> > channels();
407 /** Channel groups available on this device, indexed by name. */
408 map<string, shared_ptr<ChannelGroup> > channel_groups();
414 Device(struct sr_dev_inst *structure);
416 virtual shared_ptr<Device> get_shared_from_this() = 0;
417 shared_ptr<Channel> get_channel(struct sr_channel *ptr);
418 struct sr_dev_inst *_structure;
419 map<struct sr_channel *, Channel *> _channels;
420 map<string, ChannelGroup *> _channel_groups;
421 /** Deleter needed to allow shared_ptr use with protected destructor. */
425 void operator()(Device *device) { delete device; }
427 friend class Deleter;
428 friend class Session;
429 friend class Channel;
430 friend class ChannelGroup;
435 /** A real hardware device, connected via a driver */
436 class SR_API HardwareDevice :
437 public UserOwned<HardwareDevice, struct sr_dev_inst>,
441 /** Driver providing this device. */
442 shared_ptr<Driver> driver();
444 HardwareDevice(shared_ptr<Driver> driver, struct sr_dev_inst *structure);
446 shared_ptr<Device> get_shared_from_this();
447 shared_ptr<Driver> _driver;
448 /** Deleter needed to allow shared_ptr use with protected destructor. */
452 void operator()(HardwareDevice *device) { delete device; }
454 friend class Deleter;
456 friend class ChannelGroup;
459 /** A virtual device, created by the user */
460 class SR_API UserDevice :
461 public UserOwned<UserDevice, struct sr_dev_inst>,
465 /** Add a new channel to this device. */
466 shared_ptr<Channel> add_channel(unsigned int index, const ChannelType *type, string name);
468 UserDevice(string vendor, string model, string version);
470 shared_ptr<Device> get_shared_from_this();
471 /** Deleter needed to allow shared_ptr use with protected destructor. */
475 void operator()(UserDevice *device) { delete device; }
477 friend class Context;
478 friend class Deleter;
481 /** A channel on a device */
482 class SR_API Channel :
483 public ParentOwned<Channel, Device, struct sr_channel>
486 /** Current name of this channel. */
488 /** Set the name of this channel. *
489 * @param name Name string to set. */
490 void set_name(string name);
491 /** Type of this channel. */
492 const ChannelType *type();
493 /** Enabled status of this channel. */
495 /** Set the enabled status of this channel.
496 * @param value Boolean value to set. */
497 void set_enabled(bool value);
498 /** Get the index number of this channel. */
499 unsigned int index();
501 Channel(struct sr_channel *structure);
503 const ChannelType * const _type;
505 friend class UserDevice;
506 friend class ChannelGroup;
507 friend class Session;
508 friend class TriggerStage;
509 friend class Context;
512 /** A group of channels on a device, which share some configuration */
513 class SR_API ChannelGroup :
514 public ParentOwned<ChannelGroup, Device, struct sr_channel_group>,
518 /** Name of this channel group. */
520 /** List of the channels in this group. */
521 vector<shared_ptr<Channel> > channels();
523 ChannelGroup(Device *device, struct sr_channel_group *structure);
525 vector<Channel *> _channels;
529 /** A trigger configuration */
530 class SR_API Trigger : public UserOwned<Trigger, struct sr_trigger>
533 /** Name of this trigger configuration. */
535 /** List of the stages in this trigger. */
536 vector<shared_ptr<TriggerStage> > stages();
537 /** Add a new stage to this trigger. */
538 shared_ptr<TriggerStage> add_stage();
540 Trigger(shared_ptr<Context> context, string name);
542 shared_ptr<Context> _context;
543 vector<TriggerStage *> _stages;
544 friend class Deleter;
545 friend class Context;
546 friend class Session;
549 /** A stage in a trigger configuration */
550 class SR_API TriggerStage :
551 public ParentOwned<TriggerStage, Trigger, struct sr_trigger_stage>
554 /** Index number of this stage. */
556 /** List of match conditions on this stage. */
557 vector<shared_ptr<TriggerMatch> > matches();
558 /** Add a new match condition to this stage.
559 * @param channel Channel to match on.
560 * @param type TriggerMatchType to apply. */
561 void add_match(shared_ptr<Channel> channel, const TriggerMatchType *type);
562 /** Add a new match condition to this stage.
563 * @param channel Channel to match on.
564 * @param type TriggerMatchType to apply.
565 * @param value Threshold value. */
566 void add_match(shared_ptr<Channel> channel, const TriggerMatchType *type, float value);
568 vector<TriggerMatch *> _matches;
569 TriggerStage(struct sr_trigger_stage *structure);
571 friend class Trigger;
574 /** A match condition in a trigger configuration */
575 class SR_API TriggerMatch :
576 public ParentOwned<TriggerMatch, TriggerStage, struct sr_trigger_match>
579 /** Channel this condition matches on. */
580 shared_ptr<Channel> channel();
581 /** Type of match. */
582 const TriggerMatchType *type();
583 /** Threshold value. */
586 TriggerMatch(struct sr_trigger_match *structure, shared_ptr<Channel> channel);
588 shared_ptr<Channel> _channel;
589 friend class TriggerStage;
592 /** Type of datafeed callback */
593 typedef function<void(shared_ptr<Device>, shared_ptr<Packet>)>
594 DatafeedCallbackFunction;
596 /* Data required for C callback function to call a C++ datafeed callback */
597 class SR_PRIV DatafeedCallbackData
600 void run(const struct sr_dev_inst *sdi,
601 const struct sr_datafeed_packet *pkt);
603 DatafeedCallbackFunction _callback;
604 DatafeedCallbackData(Session *session,
605 DatafeedCallbackFunction callback);
607 friend class Session;
610 /** Type of source callback */
611 typedef function<bool(Glib::IOCondition)>
612 SourceCallbackFunction;
614 /* Data required for C callback function to call a C++ source callback */
615 class SR_PRIV SourceCallbackData
618 bool run(int revents);
620 SourceCallbackData(shared_ptr<EventSource> source);
621 shared_ptr<EventSource> _source;
622 friend class Session;
625 /** An I/O event source */
626 class SR_API EventSource
629 /** Create an event source from a file descriptor.
630 * @param fd File descriptor.
631 * @param events GLib IOCondition event mask.
632 * @param timeout Timeout in milliseconds.
633 * @param callback Callback of the form callback(events) */
634 static shared_ptr<EventSource> create(int fd, Glib::IOCondition events,
635 int timeout, SourceCallbackFunction callback);
636 /** Create an event source from a GLib PollFD
637 * @param pollfd GLib PollFD
638 * @param timeout Timeout in milliseconds.
639 * @param callback Callback of the form callback(events) */
640 static shared_ptr<EventSource> create(Glib::PollFD pollfd, int timeout,
641 SourceCallbackFunction callback);
642 /** Create an event source from a GLib IOChannel
643 * @param channel GLib IOChannel.
644 * @param events GLib IOCondition event mask.
645 * @param timeout Timeout in milliseconds.
646 * @param callback Callback of the form callback(events) */
647 static shared_ptr<EventSource> create(
648 Glib::RefPtr<Glib::IOChannel> channel, Glib::IOCondition events,
649 int timeout, SourceCallbackFunction callback);
651 EventSource(int timeout, SourceCallbackFunction callback);
659 Glib::PollFD _pollfd;
660 Glib::RefPtr<Glib::IOChannel> _channel;
661 Glib::IOCondition _events;
663 SourceCallbackFunction _callback;
664 /** Deleter needed to allow shared_ptr use with protected destructor. */
668 void operator()(EventSource *source) { delete source; }
670 friend class Deleter;
671 friend class Session;
672 friend class SourceCallbackData;
675 /** A virtual device associated with a stored session */
676 class SR_API SessionDevice :
677 public ParentOwned<SessionDevice, Session, struct sr_dev_inst>,
681 SessionDevice(struct sr_dev_inst *sdi);
683 shared_ptr<Device> get_shared_from_this();
684 /** Deleter needed to allow shared_ptr use with protected destructor. */
688 void operator()(SessionDevice *device) { delete device; }
690 friend class Deleter;
691 friend class Session;
694 /** A sigrok session */
695 class SR_API Session : public UserOwned<Session, struct sr_session>
698 /** Add a device to this session.
699 * @param device Device to add. */
700 void add_device(shared_ptr<Device> device);
701 /** List devices attached to this session. */
702 vector<shared_ptr<Device> > devices();
703 /** Remove all devices from this session. */
704 void remove_devices();
705 /** Add a datafeed callback to this session.
706 * @param callback Callback of the form callback(Device, Packet). */
707 void add_datafeed_callback(DatafeedCallbackFunction callback);
708 /** Remove all datafeed callbacks from this session. */
709 void remove_datafeed_callbacks();
710 /** Add an I/O event source.
711 * @param source EventSource to add. */
712 void add_source(shared_ptr<EventSource> source);
713 /** Remove an event source.
714 * @param source EventSource to remove. */
715 void remove_source(shared_ptr<EventSource> source);
716 /** Start the session. */
718 /** Run the session event loop. */
720 /** Stop the session. */
722 /** Get current trigger setting. */
723 shared_ptr<Trigger> trigger();
724 /** Get the context. */
725 shared_ptr<Context> context();
726 /** Set trigger setting.
727 * @param trigger Trigger object to use. */
728 void set_trigger(shared_ptr<Trigger> trigger);
729 /** Get filename this session was loaded from. */
732 Session(shared_ptr<Context> context);
733 Session(shared_ptr<Context> context, string filename);
735 shared_ptr<Device> get_device(const struct sr_dev_inst *sdi);
736 const shared_ptr<Context> _context;
737 map<const struct sr_dev_inst *, SessionDevice *> _owned_devices;
738 map<const struct sr_dev_inst *, shared_ptr<Device> > _other_devices;
739 vector<DatafeedCallbackData *> _datafeed_callbacks;
740 map<shared_ptr<EventSource>, SourceCallbackData *> _source_callbacks;
742 shared_ptr<Trigger> _trigger;
743 friend class Deleter;
744 friend class Context;
745 friend class DatafeedCallbackData;
746 friend class SessionDevice;
749 /** A packet on the session datafeed */
750 class SR_API Packet : public UserOwned<Packet, const struct sr_datafeed_packet>
753 /** Type of this packet. */
754 const PacketType *type();
755 /** Payload of this packet. */
756 shared_ptr<PacketPayload> payload();
758 Packet(shared_ptr<Device> device,
759 const struct sr_datafeed_packet *structure);
761 shared_ptr<Device> _device;
762 PacketPayload *_payload;
763 friend class Deleter;
764 friend class Session;
766 friend class DatafeedCallbackData;
771 friend class Context;
774 /** Abstract base class for datafeed packet payloads */
775 class SR_API PacketPayload
779 virtual ~PacketPayload() = 0;
780 virtual shared_ptr<PacketPayload> get_shared_pointer(Packet *parent) = 0;
781 /** Deleter needed to allow shared_ptr use with protected destructor. */
785 void operator()(PacketPayload *payload) { delete payload; }
787 friend class Deleter;
792 /** Payload of a datafeed header packet */
793 class SR_API Header :
794 public ParentOwned<Header, Packet, const struct sr_datafeed_header>,
798 /* Feed version number. */
800 /* Start time of this session. */
801 Glib::TimeVal start_time();
803 Header(const struct sr_datafeed_header *structure);
805 shared_ptr<PacketPayload> get_shared_pointer(Packet *parent);
809 /** Payload of a datafeed metadata packet */
811 public ParentOwned<Meta, Packet, const struct sr_datafeed_meta>,
815 /* Mapping of (ConfigKey, value) pairs. */
816 map<const ConfigKey *, Glib::VariantBase> config();
818 Meta(const struct sr_datafeed_meta *structure);
820 shared_ptr<PacketPayload> get_shared_pointer(Packet *parent);
821 map<const ConfigKey *, Glib::VariantBase> _config;
825 /** Payload of a datafeed packet with logic data */
827 public ParentOwned<Logic, Packet, const struct sr_datafeed_logic>,
831 /* Pointer to data. */
832 void *data_pointer();
833 /* Data length in bytes. */
834 size_t data_length();
835 /* Size of each sample in bytes. */
836 unsigned int unit_size();
838 Logic(const struct sr_datafeed_logic *structure);
840 shared_ptr<PacketPayload> get_shared_pointer(Packet *parent);
844 /** Payload of a datafeed packet with analog data */
845 class SR_API Analog :
846 public ParentOwned<Analog, Packet, const struct sr_datafeed_analog>,
850 /** Pointer to data. */
851 float *data_pointer();
852 /** Number of samples in this packet. */
853 unsigned int num_samples();
854 /** Channels for which this packet contains data. */
855 vector<shared_ptr<Channel> > channels();
856 /** Measured quantity of the samples in this packet. */
857 const Quantity *mq();
858 /** Unit of the samples in this packet. */
860 /** Measurement flags associated with the samples in this packet. */
861 vector<const QuantityFlag *> mq_flags();
863 Analog(const struct sr_datafeed_analog *structure);
865 shared_ptr<PacketPayload> get_shared_pointer(Packet *parent);
869 /** An input format supported by the library */
870 class SR_API InputFormat :
871 public ParentOwned<InputFormat, Context, const struct sr_input_module>
874 /** Name of this input format. */
876 /** Description of this input format. */
877 string description();
878 /** A list of preferred file name extensions for this file format.
879 * @note This list is a recommendation only. */
880 vector<string> extensions();
881 /** Options supported by this input format. */
882 map<string, shared_ptr<Option> > options();
883 /** Create an input using this input format.
884 * @param options Mapping of (option name, value) pairs. */
885 shared_ptr<Input> create_input(map<string, Glib::VariantBase> options =
886 map<string, Glib::VariantBase>());
888 InputFormat(const struct sr_input_module *structure);
890 friend class Context;
891 friend class InputDevice;
894 /** An input instance (an input format applied to a file or stream) */
895 class SR_API Input : public UserOwned<Input, const struct sr_input>
898 /** Virtual device associated with this input. */
899 shared_ptr<InputDevice> device();
900 /** Send next stream data.
901 * @param data Next stream data.
902 * @param length Length of data. */
903 void send(void *data, size_t length);
904 /** Signal end of input data. */
907 Input(shared_ptr<Context> context, const struct sr_input *structure);
909 shared_ptr<Context> _context;
910 InputDevice *_device;
911 friend class Deleter;
912 friend class Context;
913 friend class InputFormat;
916 /** A virtual device associated with an input */
917 class SR_API InputDevice :
918 public ParentOwned<InputDevice, Input, struct sr_dev_inst>,
922 InputDevice(shared_ptr<Input> input, struct sr_dev_inst *sdi);
924 shared_ptr<Device> get_shared_from_this();
925 shared_ptr<Input> _input;
929 /** An option used by an output format */
930 class SR_API Option : public UserOwned<Option, const struct sr_option>
933 /** Short name of this option suitable for command line usage. */
935 /** Short name of this option suitable for GUI usage. */
937 /** Description of this option in a sentence. */
938 string description();
939 /** Default value for this option. */
940 Glib::VariantBase default_value();
941 /** Possible values for this option, if a limited set. */
942 vector<Glib::VariantBase> values();
944 Option(const struct sr_option *structure,
945 shared_ptr<const struct sr_option *> structure_array);
947 shared_ptr<const struct sr_option *> _structure_array;
948 friend class Deleter;
949 friend class InputFormat;
950 friend class OutputFormat;
953 /** An output format supported by the library */
954 class SR_API OutputFormat :
955 public ParentOwned<OutputFormat, Context, const struct sr_output_module>
958 /** Name of this output format. */
960 /** Description of this output format. */
961 string description();
962 /** A list of preferred file name extensions for this file format.
963 * @note This list is a recommendation only. */
964 vector<string> extensions();
965 /** Options supported by this output format. */
966 map<string, shared_ptr<Option> > options();
967 /** Create an output using this format.
968 * @param device Device to output for.
969 * @param options Mapping of (option name, value) pairs. */
970 shared_ptr<Output> create_output(
971 shared_ptr<Device> device,
972 map<string, Glib::VariantBase> options =
973 map<string, Glib::VariantBase>());
974 /** Create an output using this format.
975 * @param filename Name of destination file.
976 * @param device Device to output for.
977 * @param options Mapping of (option name, value) pairs. */
978 shared_ptr<Output> create_output(string filename,
979 shared_ptr<Device> device,
980 map<string, Glib::VariantBase> options =
981 map<string, Glib::VariantBase>());
983 * Checks whether a given flag is set.
984 * @param flag Flag to check
985 * @return true if flag is set for this module
986 * @see sr_output_flags
988 bool test_flag(const OutputFlag *flag);
990 OutputFormat(const struct sr_output_module *structure);
992 friend class Context;
996 /** An output instance (an output format applied to a device) */
997 class SR_API Output : public UserOwned<Output, const struct sr_output>
1000 /** Update output with data from the given packet.
1001 * @param packet Packet to handle. */
1002 string receive(shared_ptr<Packet> packet);
1004 Output(shared_ptr<OutputFormat> format, shared_ptr<Device> device);
1005 Output(shared_ptr<OutputFormat> format,
1006 shared_ptr<Device> device, map<string, Glib::VariantBase> options);
1007 Output(string filename, shared_ptr<OutputFormat> format,
1008 shared_ptr<Device> device, map<string, Glib::VariantBase> options);
1010 const shared_ptr<OutputFormat> _format;
1011 const shared_ptr<Device> _device;
1012 const map<string, Glib::VariantBase> _options;
1013 friend class Deleter;
1014 friend class OutputFormat;
1017 /** Base class for objects which wrap an enumeration value from libsigrok */
1018 template <class Class, typename Enum> class SR_API EnumValue
1021 /** The integer constant associated with this value. */
1024 return static_cast<int>(_id);
1026 /** The name associated with this value. */
1031 /** Get value associated with a given integer constant. */
1032 static const Class *get(int id)
1034 auto key = static_cast<Enum>(id);
1035 if (_values.find(key) == _values.end())
1036 throw Error(SR_ERR_ARG);
1037 return _values.at(key);
1039 /** Get possible values. */
1040 static std::vector<const Class *> values()
1042 std::vector<const Class *> result;
1043 for (auto entry : _values)
1044 result.push_back(entry.second);
1048 EnumValue(Enum id, const char name[]) : _id(id), _name(name)
1054 static const std::map<const Enum, const Class * const> _values;
1059 #include <libsigrokcxx/enums.hpp>