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 sigrok++ API provides an object-oriented C++ interface to the functionality
28 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 sigrok++ objects and their underlying libsigrok
49 resources can be treated as fully automatic. As long as all shared pointers to
50 objects are deleted or reassigned when no longer in use, all underlying
51 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.
73 #include "libsigrok/libsigrok.h"
74 #include <glibmm-2.4/glibmm.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 LogLevel;
100 class SR_API ChannelGroup;
101 class SR_API Trigger;
102 class SR_API TriggerStage;
103 class SR_API TriggerMatch;
104 class SR_API TriggerMatchType;
105 class SR_API ChannelType;
107 class SR_API PacketPayload;
108 class SR_API PacketType;
109 class SR_API Quantity;
111 class SR_API QuantityFlag;
113 class SR_API InputDevice;
115 class SR_API DataType;
118 /** Exception thrown when an error code is returned by any libsigrok call. */
119 class SR_API Error: public exception
125 const char *what() const throw();
128 /* Base template for classes whose resources are owned by a parent object. */
129 template <class Class, class Parent, typename Struct>
130 class SR_API ParentOwned
133 /* Parent object which owns this child object's underlying structure.
135 This shared pointer will be null when this child is unused, but
136 will be assigned to point to the parent before any shared pointer
137 to this child is handed out to the user.
139 When the reference count of this child falls to zero, this shared
140 pointer to its parent is reset by a custom deleter on the child's
143 This strategy ensures that the destructors for both the child and
144 the parent are called at the correct time, i.e. only when all
145 references to both the parent and all its children are gone. */
146 shared_ptr<Parent> _parent;
148 /* Weak pointer for shared_from_this() implementation. */
149 weak_ptr<Class> _weak_this;
152 /* Get parent object that owns this object. */
153 shared_ptr<Parent> parent()
158 /* Note, this implementation will create a new smart_ptr if none exists. */
159 shared_ptr<Class> shared_from_this()
161 shared_ptr<Class> shared;
163 if (!(shared = _weak_this.lock()))
165 shared = shared_ptr<Class>((Class *) this, reset_parent);
172 shared_ptr<Class> get_shared_pointer(shared_ptr<Parent> parent)
175 throw Error(SR_ERR_BUG);
176 this->_parent = parent;
177 return shared_from_this();
180 shared_ptr<Class> get_shared_pointer(Parent *parent)
183 throw Error(SR_ERR_BUG);
184 return get_shared_pointer(parent->shared_from_this());
187 static void reset_parent(Class *object)
189 if (!object->_parent)
190 throw Error(SR_ERR_BUG);
191 object->_parent.reset();
196 ParentOwned<Class, Parent, Struct>(Struct *structure) :
197 _structure(structure)
202 /* Base template for classes whose resources are owned by the user. */
203 template <class Class, typename Struct>
204 class SR_API UserOwned : public enable_shared_from_this<Class>
207 shared_ptr<Class> shared_from_this()
209 auto shared = enable_shared_from_this<Class>::shared_from_this();
211 throw Error(SR_ERR_BUG);
217 UserOwned<Class, Struct>(Struct *structure) :
218 _structure(structure)
222 /* Deleter needed to allow shared_ptr use with protected destructor. */
226 void operator()(Class *object) { delete object; }
230 /** Type of log callback */
231 typedef function<void(const LogLevel *, string message)> LogCallbackFunction;
233 /** The global libsigrok context */
234 class SR_API Context : public UserOwned<Context, struct sr_context>
237 /** Create new context */
238 static shared_ptr<Context> create();
239 /** libsigrok package version. */
240 string package_version();
241 /** libsigrok library version. */
242 string lib_version();
243 /** Available hardware drivers, indexed by name. */
244 map<string, shared_ptr<Driver> > drivers();
245 /** Available input formats, indexed by name. */
246 map<string, shared_ptr<InputFormat> > input_formats();
247 /** Available output formats, indexed by name. */
248 map<string, shared_ptr<OutputFormat> > output_formats();
249 /** Current log level. */
250 const LogLevel *log_level();
251 /** Set the log level.
252 * @param level LogLevel to use. */
253 void set_log_level(const LogLevel *level);
254 /** Current log domain. */
256 /** Set the log domain.
257 * @param value Log domain prefix string. */
258 void set_log_domain(string value);
259 /** Set the log callback.
260 * @param callback Callback of the form callback(LogLevel, string). */
261 void set_log_callback(LogCallbackFunction callback);
262 /** Set the log callback to the default handler. */
263 void set_log_callback_default();
264 /** Create a new session. */
265 shared_ptr<Session> create_session();
266 /** Load a saved session.
267 * @param filename File name string. */
268 shared_ptr<Session> load_session(string filename);
269 /** Create a new trigger.
270 * @param name Name string for new trigger. */
271 shared_ptr<Trigger> create_trigger(string name);
272 /** Open an input file.
273 * @param filename File name string. */
274 shared_ptr<Input> open_file(string filename);
275 /** Open an input stream based on header data.
276 * @param header Initial data from stream. */
277 shared_ptr<Input> open_stream(string header);
279 map<string, Driver *> _drivers;
280 map<string, InputFormat *> _input_formats;
281 map<string, OutputFormat *> _output_formats;
283 LogCallbackFunction _log_callback;
286 friend class Deleter;
287 friend class Session;
297 /** An object that can be configured. */
298 class SR_API Configurable
301 /** Read configuration for the given key.
302 * @param key ConfigKey to read. */
303 Glib::VariantBase config_get(const ConfigKey *key);
304 /** Set configuration for the given key to a specified value.
305 * @param key ConfigKey to set.
306 * @param value Value to set. */
307 void config_set(const ConfigKey *key, Glib::VariantBase value);
308 /** Enumerate available values for the given configuration key.
309 * @param key ConfigKey to enumerate values for. */
310 Glib::VariantContainerBase config_list(const ConfigKey *key);
311 /** Enumerate available keys, according to a given index key. */
312 map<const ConfigKey *, set<Capability> > config_keys(const ConfigKey *key);
313 /** Check for a key in the list from a given index key. */
314 bool config_check(const ConfigKey *key, const ConfigKey *index_key);
317 struct sr_dev_driver *driver,
318 struct sr_dev_inst *sdi,
319 struct sr_channel_group *channel_group);
320 virtual ~Configurable();
321 struct sr_dev_driver *config_driver;
322 struct sr_dev_inst *config_sdi;
323 struct sr_channel_group *config_channel_group;
326 /** A hardware driver provided by the library */
327 class SR_API Driver :
328 public ParentOwned<Driver, Context, struct sr_dev_driver>,
332 /** Name of this driver. */
334 /** Long name for this driver. */
336 /** Scan for devices and return a list of devices found.
337 * @param options Mapping of (ConfigKey, value) pairs. */
338 vector<shared_ptr<HardwareDevice> > scan(
339 map<const ConfigKey *, Glib::VariantBase> options =
340 map<const ConfigKey *, Glib::VariantBase>());
343 vector<HardwareDevice *> _devices;
344 Driver(struct sr_dev_driver *structure);
346 friend class Context;
347 friend class HardwareDevice;
348 friend class ChannelGroup;
351 /** A generic device, either hardware or virtual */
352 class SR_API Device : public Configurable
355 /** Description identifying this device. */
356 virtual string description();
357 /** Vendor name for this device. */
359 /** Model name for this device. */
361 /** Version string for this device. */
363 /** Serial number for this device. */
364 string serial_number();
365 /** Connection ID for this device. */
366 string connection_id();
367 /** List of the channels available on this device. */
368 vector<shared_ptr<Channel> > channels();
369 /** Channel groups available on this device, indexed by name. */
370 map<string, shared_ptr<ChannelGroup> > channel_groups();
376 Device(struct sr_dev_inst *structure);
378 virtual shared_ptr<Device> get_shared_from_this() = 0;
379 shared_ptr<Channel> get_channel(struct sr_channel *ptr);
380 struct sr_dev_inst *_structure;
381 map<struct sr_channel *, Channel *> _channels;
382 map<string, ChannelGroup *> _channel_groups;
383 /** Deleter needed to allow shared_ptr use with protected destructor. */
387 void operator()(Device *device) { delete device; }
389 friend class Deleter;
390 friend class Session;
391 friend class Channel;
392 friend class ChannelGroup;
397 /** A real hardware device, connected via a driver */
398 class SR_API HardwareDevice :
399 public UserOwned<HardwareDevice, struct sr_dev_inst>,
403 /** Driver providing this device. */
404 shared_ptr<Driver> driver();
406 HardwareDevice(shared_ptr<Driver> driver, struct sr_dev_inst *structure);
408 shared_ptr<Device> get_shared_from_this();
409 shared_ptr<Driver> _driver;
410 /** Deleter needed to allow shared_ptr use with protected destructor. */
414 void operator()(HardwareDevice *device) { delete device; }
416 friend class Deleter;
418 friend class ChannelGroup;
421 /** A channel on a device */
422 class SR_API Channel :
423 public ParentOwned<Channel, Device, struct sr_channel>
426 /** Current name of this channel. */
428 /** Set the name of this channel. *
429 * @param name Name string to set. */
430 void set_name(string name);
431 /** Type of this channel. */
432 const ChannelType *type();
433 /** Enabled status of this channel. */
435 /** Set the enabled status of this channel.
436 * @param value Boolean value to set. */
437 void set_enabled(bool value);
438 /** Get the index number of this channel. */
439 unsigned int index();
441 Channel(struct sr_channel *structure);
443 const ChannelType * const _type;
445 friend class ChannelGroup;
446 friend class Session;
447 friend class TriggerStage;
450 /** A group of channels on a device, which share some configuration */
451 class SR_API ChannelGroup :
452 public ParentOwned<ChannelGroup, Device, struct sr_channel_group>,
456 /** Name of this channel group. */
458 /** List of the channels in this group. */
459 vector<shared_ptr<Channel> > channels();
461 ChannelGroup(Device *device, struct sr_channel_group *structure);
463 vector<Channel *> _channels;
467 /** A trigger configuration */
468 class SR_API Trigger : public UserOwned<Trigger, struct sr_trigger>
471 /** Name of this trigger configuration. */
473 /** List of the stages in this trigger. */
474 vector<shared_ptr<TriggerStage> > stages();
475 /** Add a new stage to this trigger. */
476 shared_ptr<TriggerStage> add_stage();
478 Trigger(shared_ptr<Context> context, string name);
480 shared_ptr<Context> _context;
481 vector<TriggerStage *> _stages;
482 friend class Deleter;
483 friend class Context;
484 friend class Session;
487 /** A stage in a trigger configuration */
488 class SR_API TriggerStage :
489 public ParentOwned<TriggerStage, Trigger, struct sr_trigger_stage>
492 /** Index number of this stage. */
494 /** List of match conditions on this stage. */
495 vector<shared_ptr<TriggerMatch> > matches();
496 /** Add a new match condition to this stage.
497 * @param channel Channel to match on.
498 * @param type TriggerMatchType to apply. */
499 void add_match(shared_ptr<Channel> channel, const TriggerMatchType *type);
500 /** Add a new match condition to this stage.
501 * @param channel Channel to match on.
502 * @param type TriggerMatchType to apply.
503 * @param value Threshold value. */
504 void add_match(shared_ptr<Channel> channel, const TriggerMatchType *type, float value);
506 vector<TriggerMatch *> _matches;
507 TriggerStage(struct sr_trigger_stage *structure);
509 friend class Trigger;
512 /** A match condition in a trigger configuration */
513 class SR_API TriggerMatch :
514 public ParentOwned<TriggerMatch, TriggerStage, struct sr_trigger_match>
517 /** Channel this condition matches on. */
518 shared_ptr<Channel> channel();
519 /** Type of match. */
520 const TriggerMatchType *type();
521 /** Threshold value. */
524 TriggerMatch(struct sr_trigger_match *structure, shared_ptr<Channel> channel);
526 shared_ptr<Channel> _channel;
527 friend class TriggerStage;
530 /** Type of datafeed callback */
531 typedef function<void(shared_ptr<Device>, shared_ptr<Packet>)>
532 DatafeedCallbackFunction;
534 /* Data required for C callback function to call a C++ datafeed callback */
535 class SR_PRIV DatafeedCallbackData
538 void run(const struct sr_dev_inst *sdi,
539 const struct sr_datafeed_packet *pkt);
541 DatafeedCallbackFunction _callback;
542 DatafeedCallbackData(Session *session,
543 DatafeedCallbackFunction callback);
545 friend class Session;
548 /** Type of source callback */
549 typedef function<bool(Glib::IOCondition)>
550 SourceCallbackFunction;
552 /* Data required for C callback function to call a C++ source callback */
553 class SR_PRIV SourceCallbackData
556 bool run(int revents);
558 SourceCallbackData(shared_ptr<EventSource> source);
559 shared_ptr<EventSource> _source;
560 friend class Session;
563 /** An I/O event source */
564 class SR_API EventSource
567 /** Create an event source from a file descriptor.
568 * @param fd File descriptor.
569 * @param events GLib IOCondition event mask.
570 * @param timeout Timeout in milliseconds.
571 * @param callback Callback of the form callback(events) */
572 static shared_ptr<EventSource> create(int fd, Glib::IOCondition events,
573 int timeout, SourceCallbackFunction callback);
574 /** Create an event source from a GLib PollFD
575 * @param pollfd GLib PollFD
576 * @param timeout Timeout in milliseconds.
577 * @param callback Callback of the form callback(events) */
578 static shared_ptr<EventSource> create(Glib::PollFD pollfd, int timeout,
579 SourceCallbackFunction callback);
580 /** Create an event source from a GLib IOChannel
581 * @param channel GLib IOChannel.
582 * @param events GLib IOCondition event mask.
583 * @param timeout Timeout in milliseconds.
584 * @param callback Callback of the form callback(events) */
585 static shared_ptr<EventSource> create(
586 Glib::RefPtr<Glib::IOChannel> channel, Glib::IOCondition events,
587 int timeout, SourceCallbackFunction callback);
589 EventSource(int timeout, SourceCallbackFunction callback);
597 Glib::PollFD _pollfd;
598 Glib::RefPtr<Glib::IOChannel> _channel;
599 Glib::IOCondition _events;
601 SourceCallbackFunction _callback;
602 /** Deleter needed to allow shared_ptr use with protected destructor. */
606 void operator()(EventSource *source) { delete source; }
608 friend class Deleter;
609 friend class Session;
610 friend class SourceCallbackData;
613 /** A virtual device associated with a stored session */
614 class SR_API SessionDevice :
615 public ParentOwned<SessionDevice, Session, struct sr_dev_inst>,
618 /** Description identifying this device. */
619 string description();
621 SessionDevice(struct sr_dev_inst *sdi);
623 shared_ptr<Device> get_shared_from_this();
624 /** Deleter needed to allow shared_ptr use with protected destructor. */
628 void operator()(SessionDevice *device) { delete device; }
630 friend class Deleter;
631 friend class Session;
634 /** A sigrok session */
635 class SR_API Session : public UserOwned<Session, struct sr_session>
638 /** Add a device to this session.
639 * @param device Device to add. */
640 void add_device(shared_ptr<Device> device);
641 /** List devices attached to this session. */
642 vector<shared_ptr<Device> > devices();
643 /** Remove all devices from this session. */
644 void remove_devices();
645 /** Add a datafeed callback to this session.
646 * @param callback Callback of the form callback(Device, Packet). */
647 void add_datafeed_callback(DatafeedCallbackFunction callback);
648 /** Remove all datafeed callbacks from this session. */
649 void remove_datafeed_callbacks();
650 /** Add an I/O event source.
651 * @param source EventSource to add. */
652 void add_source(shared_ptr<EventSource> source);
653 /** Remove an event source.
654 * @param source EventSource to remove. */
655 void remove_source(shared_ptr<EventSource> source);
656 /** Start the session. */
658 /** Run the session event loop. */
660 /** Stop the session. */
662 /** Begin saving session to a file.
663 * @param filename File name string. */
664 void begin_save(string filename);
665 /** Append a packet to the session file being saved.
666 * @param packet Packet to append. */
667 void append(shared_ptr<Packet> packet);
668 /** Append raw logic data to the session file being saved. */
669 void append(void *data, size_t length, unsigned int unit_size);
670 /** Get current trigger setting. */
671 shared_ptr<Trigger> trigger();
672 /** Set trigger setting.
673 * @param trigger Trigger object to use. */
674 void set_trigger(shared_ptr<Trigger> trigger);
675 /** Get filename this session was loaded from. */
678 Session(shared_ptr<Context> context);
679 Session(shared_ptr<Context> context, string filename);
681 shared_ptr<Device> get_device(const struct sr_dev_inst *sdi);
682 const shared_ptr<Context> _context;
683 map<const struct sr_dev_inst *, SessionDevice *> _owned_devices;
684 map<const struct sr_dev_inst *, shared_ptr<Device> > _other_devices;
685 vector<DatafeedCallbackData *> _datafeed_callbacks;
686 map<shared_ptr<EventSource>, SourceCallbackData *> _source_callbacks;
689 bool _save_initialized;
690 string _save_filename;
691 uint64_t _save_samplerate;
692 shared_ptr<Trigger> _trigger;
693 friend class Deleter;
694 friend class Context;
695 friend class DatafeedCallbackData;
696 friend class SessionDevice;
699 /** A packet on the session datafeed */
700 class SR_API Packet : public UserOwned<Packet, const struct sr_datafeed_packet>
703 /** Type of this packet. */
704 const PacketType *type();
705 /** Payload of this packet. */
706 shared_ptr<PacketPayload> payload();
708 Packet(shared_ptr<Device> device,
709 const struct sr_datafeed_packet *structure);
711 shared_ptr<Device> _device;
712 PacketPayload *_payload;
713 friend class Deleter;
714 friend class Session;
716 friend class DatafeedCallbackData;
723 /** Abstract base class for datafeed packet payloads */
724 class SR_API PacketPayload
728 virtual ~PacketPayload() = 0;
729 virtual shared_ptr<PacketPayload> get_shared_pointer(Packet *parent) = 0;
730 /** Deleter needed to allow shared_ptr use with protected destructor. */
734 void operator()(PacketPayload *payload) { delete payload; }
736 friend class Deleter;
741 /** Payload of a datafeed header packet */
742 class SR_API Header :
743 public ParentOwned<Header, Packet, const struct sr_datafeed_header>,
747 /* Feed version number. */
749 /* Start time of this session. */
750 Glib::TimeVal start_time();
752 Header(const struct sr_datafeed_header *structure);
754 shared_ptr<PacketPayload> get_shared_pointer(Packet *parent);
758 /** Payload of a datafeed metadata packet */
760 public ParentOwned<Meta, Packet, const struct sr_datafeed_meta>,
764 /* Mapping of (ConfigKey, value) pairs. */
765 map<const ConfigKey *, Glib::VariantBase> config();
767 Meta(const struct sr_datafeed_meta *structure);
769 shared_ptr<PacketPayload> get_shared_pointer(Packet *parent);
770 map<const ConfigKey *, Glib::VariantBase> _config;
774 /** Payload of a datafeed packet with logic data */
776 public ParentOwned<Logic, Packet, const struct sr_datafeed_logic>,
780 /* Pointer to data. */
781 void *data_pointer();
782 /* Data length in bytes. */
783 size_t data_length();
784 /* Size of each sample in bytes. */
785 unsigned int unit_size();
787 Logic(const struct sr_datafeed_logic *structure);
789 shared_ptr<PacketPayload> get_shared_pointer(Packet *parent);
793 /** Payload of a datafeed packet with analog data */
794 class SR_API Analog :
795 public ParentOwned<Analog, Packet, const struct sr_datafeed_analog>,
799 /** Pointer to data. */
800 float *data_pointer();
801 /** Number of samples in this packet. */
802 unsigned int num_samples();
803 /** Channels for which this packet contains data. */
804 vector<shared_ptr<Channel> > channels();
805 /** Measured quantity of the samples in this packet. */
806 const Quantity *mq();
807 /** Unit of the samples in this packet. */
809 /** Measurement flags associated with the samples in this packet. */
810 vector<const QuantityFlag *> mq_flags();
812 Analog(const struct sr_datafeed_analog *structure);
814 shared_ptr<PacketPayload> get_shared_pointer(Packet *parent);
818 /** An input format supported by the library */
819 class SR_API InputFormat :
820 public ParentOwned<InputFormat, Context, const struct sr_input_module>
823 /** Name of this input format. */
825 /** Description of this input format. */
826 string description();
827 /** Options supported by this input format. */
828 map<string, shared_ptr<Option> > options();
829 /** Create an input using this input format.
830 * @param options Mapping of (option name, value) pairs. */
831 shared_ptr<Input> create_input(map<string, Glib::VariantBase> options =
832 map<string, Glib::VariantBase>());
834 InputFormat(const struct sr_input_module *structure);
836 friend class Context;
837 friend class InputDevice;
840 /** An input instance (an input format applied to a file or stream) */
841 class SR_API Input : public UserOwned<Input, const struct sr_input>
844 /** Virtual device associated with this input. */
845 shared_ptr<InputDevice> device();
846 /** Send next stream data.
847 * @param data Next stream data. */
848 void send(string data);
849 /** Signal end of input data. */
852 Input(shared_ptr<Context> context, const struct sr_input *structure);
854 shared_ptr<Context> _context;
855 InputDevice *_device;
856 friend class Deleter;
857 friend class Context;
858 friend class InputFormat;
861 /** A virtual device associated with an input */
862 class SR_API InputDevice :
863 public ParentOwned<InputDevice, Input, struct sr_dev_inst>,
867 /** Description identifying this device. */
868 string description();
870 InputDevice(shared_ptr<Input> input, struct sr_dev_inst *sdi);
872 shared_ptr<Device> get_shared_from_this();
873 shared_ptr<Input> _input;
877 /** An option used by an output format */
878 class SR_API Option : public UserOwned<Option, const struct sr_option>
881 /** Short name of this option suitable for command line usage. */
883 /** Short name of this option suitable for GUI usage. */
885 /** Description of this option in a sentence. */
886 string description();
887 /** Default value for this option. */
888 Glib::VariantBase default_value();
889 /** Possible values for this option, if a limited set. */
890 vector<Glib::VariantBase> values();
892 Option(const struct sr_option *structure,
893 shared_ptr<const struct sr_option *> structure_array);
895 shared_ptr<const struct sr_option *> _structure_array;
896 friend class Deleter;
897 friend class InputFormat;
898 friend class OutputFormat;
901 /** An output format supported by the library */
902 class SR_API OutputFormat :
903 public ParentOwned<OutputFormat, Context, const struct sr_output_module>
906 /** Name of this output format. */
908 /** Description of this output format. */
909 string description();
910 /** Options supported by this output format. */
911 map<string, shared_ptr<Option> > options();
912 /** Create an output using this format.
913 * @param device Device to output for.
914 * @param options Mapping of (option name, value) pairs. */
915 shared_ptr<Output> create_output(shared_ptr<Device> device,
916 map<string, Glib::VariantBase> options =
917 map<string, Glib::VariantBase>());
919 OutputFormat(const struct sr_output_module *structure);
921 friend class Context;
925 /** An output instance (an output format applied to a device) */
926 class SR_API Output : public UserOwned<Output, const struct sr_output>
929 /** Update output with data from the given packet.
930 * @param packet Packet to handle. */
931 string receive(shared_ptr<Packet> packet);
933 Output(shared_ptr<OutputFormat> format, shared_ptr<Device> device);
934 Output(shared_ptr<OutputFormat> format,
935 shared_ptr<Device> device, map<string, Glib::VariantBase> options);
937 const shared_ptr<OutputFormat> _format;
938 const shared_ptr<Device> _device;
939 const map<string, Glib::VariantBase> _options;
940 friend class Deleter;
941 friend class OutputFormat;
944 /** Base class for objects which wrap an enumeration value from libsigrok */
945 template <typename T> class SR_API EnumValue
948 /** The enum constant associated with this value. */
949 T id() const { return _id; }
950 /** The name associated with this value. */
951 string name() const { return _name; }
953 EnumValue(T id, const char name[]) : _id(id), _name(name) {}
963 #endif // LIBSIGROK_HPP