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>
86 /* Forward declarations */
91 class SR_API HardwareDevice;
93 class SR_API EventSource;
95 class SR_API ConfigKey;
96 class SR_API InputFormat;
97 class SR_API OutputFormat;
98 class SR_API LogLevel;
99 class SR_API ChannelGroup;
100 class SR_API Trigger;
101 class SR_API TriggerStage;
102 class SR_API TriggerMatch;
103 class SR_API TriggerMatchType;
104 class SR_API ChannelType;
106 class SR_API PacketPayload;
107 class SR_API PacketType;
108 class SR_API Quantity;
110 class SR_API QuantityFlag;
111 class SR_API InputFileDevice;
113 class SR_API DataType;
115 /** Exception thrown when an error code is returned by any libsigrok call. */
116 class SR_API Error: public exception
122 const char *what() const throw();
125 /* Base template for most classes which wrap a struct type from libsigrok. */
126 template <class Parent, typename Struct> class SR_API StructureWrapper :
127 public enable_shared_from_this<StructureWrapper<Parent, Struct> >
130 /* Parent object which owns this child object's underlying structure.
132 This shared pointer will be null when this child is unused, but
133 will be assigned to point to the parent before any shared pointer
134 to this child is handed out to the user.
136 When the reference count of this child falls to zero, this shared
137 pointer to its parent is reset by a custom deleter on the child's
140 This strategy ensures that the destructors for both the child and
141 the parent are called at the correct time, i.e. only when all
142 references to both the parent and all its children are gone. */
143 shared_ptr<Parent> parent;
146 shared_ptr<StructureWrapper<Parent, Struct> >
147 get_shared_pointer(Parent *parent)
149 this->parent = static_pointer_cast<Parent>(parent->shared_from_this());
150 return shared_ptr<StructureWrapper<Parent, Struct> >(
153 shared_ptr<StructureWrapper<Parent, Struct> >
154 get_shared_pointer(shared_ptr<Parent> parent)
156 this->parent = parent;
157 return shared_ptr<StructureWrapper<Parent, Struct> >(
161 static void reset_parent(StructureWrapper<Parent, Struct> *object)
163 object->parent.reset();
168 StructureWrapper<Parent, Struct>(Struct *structure) :
174 /** Type of log callback */
175 typedef function<void(const LogLevel *, string message)> LogCallbackFunction;
177 /** The global libsigrok context */
178 class SR_API Context : public enable_shared_from_this<Context>
181 /** Create new context */
182 static shared_ptr<Context> create();
183 /** libsigrok package version. */
184 string get_package_version();
185 /** libsigrok library version. */
186 string get_lib_version();
187 /** Available hardware drivers, indexed by name. */
188 map<string, shared_ptr<Driver> > get_drivers();
189 /** Available input formats, indexed by name. */
190 map<string, shared_ptr<InputFormat> > get_input_formats();
191 /** Available output formats, indexed by name. */
192 map<string, shared_ptr<OutputFormat> > get_output_formats();
193 /** Current log level. */
194 const LogLevel *get_log_level();
195 /** Set the log level. */
196 void set_log_level(const LogLevel *level);
197 /** Current log domain. */
198 string get_log_domain();
199 /** Set the log domain. */
200 void set_log_domain(string value);
201 /** Set the log callback. */
202 void set_log_callback(LogCallbackFunction callback);
203 /** Set the log callback to the default handler. */
204 void set_log_callback_default();
205 /** Create a new session. */
206 shared_ptr<Session> create_session();
207 /** Load a saved session. */
208 shared_ptr<Session> load_session(string filename);
209 /** Create a new trigger. */
210 shared_ptr<Trigger> create_trigger(string name);
212 struct sr_context *structure;
213 map<string, Driver *> drivers;
214 map<string, InputFormat *> input_formats;
215 map<string, OutputFormat *> output_formats;
217 LogCallbackFunction log_callback;
220 /** Deleter needed to allow shared_ptr use with protected destructor. */
224 void operator()(Context *context) { delete context; }
226 friend class Deleter;
227 friend class Session;
231 /** A hardware driver provided by the library */
232 class SR_API Driver : public StructureWrapper<Context, struct sr_dev_driver>
235 /** Name of this driver. */
237 /** Long name for this driver. */
238 string get_long_name();
239 /** Scan for devices and return a list of devices found. */
240 vector<shared_ptr<HardwareDevice> > scan(
241 map<const ConfigKey *, Glib::VariantBase> options = {});
244 vector<HardwareDevice *> devices;
245 Driver(struct sr_dev_driver *structure);
247 friend class Context;
248 friend class HardwareDevice;
249 friend class ChannelGroup;
252 /** An object that can be configured. */
253 class SR_API Configurable
256 /** Read configuration for the given key. */
257 Glib::VariantBase config_get(const ConfigKey *key);
258 /** Set configuration for the given key to a specified value. */
259 void config_set(const ConfigKey *key, Glib::VariantBase value);
260 /** Enumerate available values for the given configuration key. */
261 Glib::VariantContainerBase config_list(const ConfigKey *key);
264 struct sr_dev_driver *driver,
265 struct sr_dev_inst *sdi,
266 struct sr_channel_group *channel_group);
267 virtual ~Configurable();
268 struct sr_dev_driver *config_driver;
269 struct sr_dev_inst *config_sdi;
270 struct sr_channel_group *config_channel_group;
273 /** A generic device, either hardware or virtual */
274 class SR_API Device :
276 public StructureWrapper<Context, struct sr_dev_inst>
279 /** Vendor name for this device. */
281 /** Model name for this device. */
283 /** Version string for this device. */
284 string get_version();
285 /** List of the channels available on this device. */
286 vector<shared_ptr<Channel> > get_channels();
287 /** Channel groups available on this device, indexed by name. */
288 map<string, shared_ptr<ChannelGroup> > get_channel_groups();
294 Device(struct sr_dev_inst *structure);
296 shared_ptr<Channel> get_channel(struct sr_channel *ptr);
297 map<struct sr_channel *, Channel *> channels;
298 map<string, ChannelGroup *> channel_groups;
299 /** Deleter needed to allow shared_ptr use with protected destructor. */
303 void operator()(Device *device) { delete device; }
305 friend class Deleter;
306 friend class Session;
307 friend class Channel;
308 friend class ChannelGroup;
313 /** A real hardware device, connected via a driver */
314 class SR_API HardwareDevice : public Device
317 /** Driver providing this device. */
318 shared_ptr<Driver> get_driver();
320 HardwareDevice(Driver *driver, struct sr_dev_inst *structure);
324 friend class ChannelGroup;
327 /** A channel on a device */
328 class SR_API Channel : public StructureWrapper<Device, struct sr_channel>
331 /** Current name of this channel. */
333 /** Set the name of this channel. */
334 void set_name(string name);
335 /** Type of this channel. */
336 const ChannelType *get_type();
337 /** Enabled status of this channel. */
339 /** Set the enabled status of this channel. */
340 void set_enabled(bool value);
342 Channel(struct sr_channel *structure);
344 const ChannelType * const type;
346 friend class ChannelGroup;
347 friend class Session;
348 friend class TriggerStage;
351 /** A group of channels on a device, which share some configuration */
352 class SR_API ChannelGroup :
353 public StructureWrapper<Device, struct sr_channel_group>,
357 /** Name of this channel group. */
359 /** List of the channels in this group. */
360 vector<shared_ptr<Channel> > get_channels();
362 ChannelGroup(Device *device, struct sr_channel_group *structure);
364 vector<Channel *> channels;
368 /** A trigger configuration */
369 class SR_API Trigger : public enable_shared_from_this<Trigger>
373 vector<shared_ptr<TriggerStage> > get_stages();
374 shared_ptr<TriggerStage> add_stage();
376 Trigger(shared_ptr<Context> context, string name);
378 struct sr_trigger *structure;
379 shared_ptr<Context> context;
380 vector<TriggerStage *> stages;
381 /** Deleter needed to allow shared_ptr use with protected destructor. */
385 void operator()(Trigger *trigger) { delete trigger; }
387 friend class Context;
388 friend class Session;
391 /** A stage in a trigger configuration */
392 class SR_API TriggerStage : public StructureWrapper<Trigger, struct sr_trigger_stage>
396 vector<shared_ptr<TriggerMatch> > get_matches();
397 void add_match(shared_ptr<Channel> channel, const TriggerMatchType *type);
398 void add_match(shared_ptr<Channel> channel, const TriggerMatchType *type, float value);
400 vector<TriggerMatch *> matches;
401 TriggerStage(struct sr_trigger_stage *structure);
403 friend class Trigger;
406 /** A match condition in a trigger configuration */
407 class SR_API TriggerMatch : public StructureWrapper<TriggerStage, struct sr_trigger_match>
410 shared_ptr<Channel> get_channel();
411 const TriggerMatchType *get_type();
414 TriggerMatch(struct sr_trigger_match *structure, shared_ptr<Channel> channel);
416 shared_ptr<Channel> channel;
417 friend class TriggerStage;
420 /** Type of datafeed callback */
421 typedef function<void(shared_ptr<Device>, shared_ptr<Packet>)>
422 DatafeedCallbackFunction;
424 /* Data required for C callback function to call a C++ datafeed callback */
425 class SR_PRIV DatafeedCallbackData
428 void run(const struct sr_dev_inst *sdi,
429 const struct sr_datafeed_packet *pkt);
431 DatafeedCallbackFunction callback;
432 DatafeedCallbackData(Session *session,
433 DatafeedCallbackFunction callback);
435 friend class Session;
438 /** Type of source callback */
439 typedef function<bool(Glib::IOCondition)>
440 SourceCallbackFunction;
442 /* Data required for C callback function to call a C++ source callback */
443 class SR_PRIV SourceCallbackData
446 bool run(int revents);
448 SourceCallbackData(shared_ptr<EventSource> source);
449 shared_ptr<EventSource> source;
450 friend class Session;
453 /** An I/O event source */
454 class SR_API EventSource
457 /** Create an event source from a file descriptor. */
458 static shared_ptr<EventSource> create(int fd, Glib::IOCondition events,
459 int timeout, SourceCallbackFunction callback);
460 /** Create an event source from a Glib::PollFD */
461 static shared_ptr<EventSource> create(Glib::PollFD pollfd, int timeout,
462 SourceCallbackFunction callback);
463 /** Create an event source from a Glib::IOChannel */
464 static shared_ptr<EventSource> create(
465 Glib::RefPtr<Glib::IOChannel> channel, Glib::IOCondition events,
466 int timeout, SourceCallbackFunction callback);
468 EventSource(int timeout, SourceCallbackFunction callback);
477 Glib::RefPtr<Glib::IOChannel> channel;
478 Glib::IOCondition events;
480 SourceCallbackFunction callback;
481 /** Deleter needed to allow shared_ptr use with protected destructor. */
485 void operator()(EventSource *source) { delete source; }
487 friend class Deleter;
488 friend class Session;
489 friend class SourceCallbackData;
492 /** A sigrok session */
496 /** Add a device to this session. */
497 void add_device(shared_ptr<Device> device);
498 /** List devices attached to this session. */
499 vector<shared_ptr<Device> > get_devices();
500 /** Remove all devices from this session. */
501 void remove_devices();
502 /** Add a datafeed callback to this session. */
503 void add_datafeed_callback(DatafeedCallbackFunction callback);
504 /** Remove all datafeed callbacks from this session. */
505 void remove_datafeed_callbacks();
506 /** Add an event source. */
507 void add_source(shared_ptr<EventSource> source);
508 /** Remove an event source. */
509 void remove_source(shared_ptr<EventSource> source);
510 /** Start the session. */
512 /** Run the session event loop. */
514 /** Stop the session. */
516 /** Begin saving session to a file. */
517 void begin_save(string filename);
518 /** Append a packet to the session file being saved. */
519 void append(shared_ptr<Packet> packet);
520 /** Append raw logic data to the session file being saved. */
521 void append(void *data, size_t length, unsigned int unit_size);
522 /** Get current trigger setting. */
523 shared_ptr<Trigger> get_trigger();
524 /** Set trigger setting. */
525 void set_trigger(shared_ptr<Trigger> trigger);
527 Session(shared_ptr<Context> context);
528 Session(shared_ptr<Context> context, string filename);
530 struct sr_session *structure;
531 const shared_ptr<Context> context;
532 map<const struct sr_dev_inst *, shared_ptr<Device> > devices;
533 vector<DatafeedCallbackData *> datafeed_callbacks;
534 map<shared_ptr<EventSource>, SourceCallbackData *> source_callbacks;
536 bool save_initialized;
537 string save_filename;
538 uint64_t save_samplerate;
539 shared_ptr<Trigger> trigger;
540 /** Deleter needed to allow shared_ptr use with protected destructor. */
544 void operator()(Session *session) { delete session; }
546 friend class Deleter;
547 friend class Context;
548 friend class DatafeedCallbackData;
551 /** A packet on the session datafeed */
552 class SR_API Packet : public enable_shared_from_this<Packet>
555 /** Type of this packet. */
556 const PacketType *get_type();
557 /** Payload of this packet. */
558 shared_ptr<PacketPayload> get_payload();
560 Packet(shared_ptr<Device> device,
561 const struct sr_datafeed_packet *structure);
563 const struct sr_datafeed_packet *structure;
564 shared_ptr<Device> device;
565 PacketPayload *payload;
566 /** Deleter needed to allow shared_ptr use with protected destructor. */
570 void operator()(Packet *packet) { delete packet; }
572 friend class Deleter;
573 friend class Session;
575 friend class DatafeedCallbackData;
582 /** Abstract base class for datafeed packet payloads */
583 class SR_API PacketPayload
587 virtual ~PacketPayload() = 0;
588 shared_ptr<PacketPayload> get_shared_pointer(Packet *parent) {
589 return static_pointer_cast<PacketPayload>(get_shared_pointer(parent));
591 /** Deleter needed to allow shared_ptr use with protected destructor. */
595 void operator()(PacketPayload *payload) { delete payload; }
597 friend class Deleter;
602 /** Payload of a datafeed header packet */
603 class SR_API Header : public PacketPayload,
604 public StructureWrapper<Packet, const struct sr_datafeed_header>
607 int get_feed_version();
608 Glib::TimeVal get_start_time();
610 Header(const struct sr_datafeed_header *structure);
612 const struct sr_datafeed_header *structure;
616 /** Payload of a datafeed metadata packet */
617 class SR_API Meta : public PacketPayload,
618 public StructureWrapper<Packet, const struct sr_datafeed_meta>
621 map<const ConfigKey *, Glib::VariantBase> get_config();
623 Meta(const struct sr_datafeed_meta *structure);
625 const struct sr_datafeed_meta *structure;
626 map<const ConfigKey *, Glib::VariantBase> config;
630 /** Payload of a datafeed packet with logic data */
631 class SR_API Logic : public PacketPayload,
632 public StructureWrapper<Packet, const struct sr_datafeed_logic>
635 /* Pointer to data. */
636 void *get_data_pointer();
637 /* Data length in bytes. */
638 size_t get_data_length();
639 /* Size of each sample in bytes. */
640 unsigned int get_unit_size();
642 Logic(const struct sr_datafeed_logic *structure);
644 const struct sr_datafeed_logic *structure;
648 /** Payload of a datafeed packet with analog data */
649 class SR_API Analog : public PacketPayload,
650 public StructureWrapper<Packet, const struct sr_datafeed_analog>
653 /** Pointer to data. */
654 float *get_data_pointer();
655 /** Number of samples in this packet. */
656 unsigned int get_num_samples();
657 /** Channels for which this packet contains data. */
658 vector<shared_ptr<Channel> > get_channels();
659 /** Measured quantity of the samples in this packet. */
660 const Quantity *get_mq();
661 /** Unit of the samples in this packet. */
662 const Unit *get_unit();
663 /** Measurement flags associated with the samples in this packet. */
664 vector<const QuantityFlag *> get_mq_flags();
666 Analog(const struct sr_datafeed_analog *structure);
668 const struct sr_datafeed_analog *structure;
672 /** An input format supported by the library */
673 class SR_API InputFormat :
674 public StructureWrapper<Context, struct sr_input_format>
677 /** Name of this input format. */
679 /** Description of this input format. */
680 string get_description();
681 /** Check whether a given file matches this input format. */
682 bool format_match(string filename);
683 /** Open a file using this input format. */
684 shared_ptr<InputFileDevice> open_file(string filename,
685 map<string, string> options = {});
687 InputFormat(struct sr_input_format *structure);
689 friend class Context;
690 friend class InputFileDevice;
693 /** A virtual device associated with an input file */
694 class SR_API InputFileDevice : public Device
697 /** Load data from file. */
700 InputFileDevice(shared_ptr<InputFormat> format,
701 struct sr_input *input, string filename);
703 struct sr_input *input;
704 shared_ptr<InputFormat> format;
706 /** Deleter needed to allow shared_ptr use with protected destructor. */
710 void operator()(InputFileDevice *device) { delete device; }
712 friend class Deleter;
713 friend class InputFormat;
716 /** An output format supported by the library */
717 class SR_API OutputFormat :
718 public StructureWrapper<Context, struct sr_output_format>
721 /** Name of this output format. */
723 /** Description of this output format. */
724 string get_description();
725 /** Create an output using this format. */
726 shared_ptr<Output> create_output(shared_ptr<Device> device, map<string, string> options = {});
728 OutputFormat(struct sr_output_format *structure);
730 friend class Context;
734 /** An output instance (an output format applied to a device) */
738 /** Update output with data from the given packet. */
739 string receive(shared_ptr<Packet> packet);
741 Output(shared_ptr<OutputFormat> format, shared_ptr<Device> device);
742 Output(shared_ptr<OutputFormat> format,
743 shared_ptr<Device> device, map<string, string> options);
745 struct sr_output *structure;
746 const shared_ptr<OutputFormat> format;
747 const shared_ptr<Device> device;
748 const map<string, string> options;
749 /** Deleter needed to allow shared_ptr use with protected destructor. */
753 void operator()(Output *output) { delete output; }
755 friend class Deleter;
756 friend class OutputFormat;
759 /** Base class for objects which wrap an enumeration value from libsigrok */
760 template <typename T> class SR_API EnumValue
763 /** The enum constant associated with this value. */
764 T get_id() const { return id; }
765 /** The name associated with this value. */
766 string get_name() const { return name; }
768 EnumValue(T id, const char name[]) : id(id), name(name) {}
778 #endif // LIBSIGROK_HPP