]>
Commit | Line | Data |
---|---|---|
c23c8659 ML |
1 | /* |
2 | * This file is part of the libsigrok project. | |
3 | * | |
4 | * Copyright (C) 2013-2014 Martin Ling <martin-sigrok@earth.li> | |
5 | * | |
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. | |
10 | * | |
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. | |
15 | * | |
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/>. | |
18 | */ | |
19 | ||
07443fd2 ML |
20 | /** |
21 | ||
22 | @mainpage API Reference | |
23 | ||
24 | Introduction | |
25 | ------------ | |
26 | ||
27 | The sigrok++ API provides an object-oriented C++ interface to the functionality | |
28 | in libsigrok, including automatic memory and resource management. | |
29 | ||
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. | |
34 | ||
35 | Memory management | |
36 | ----------------- | |
37 | ||
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. | |
41 | ||
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. | |
47 | ||
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. | |
52 | ||
53 | Getting started | |
54 | --------------- | |
55 | ||
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. | |
61 | ||
62 | Error handling | |
63 | -------------- | |
64 | ||
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. | |
67 | ||
68 | */ | |
69 | ||
c23c8659 ML |
70 | #ifndef LIBSIGROK_HPP |
71 | #define LIBSIGROK_HPP | |
72 | ||
73 | #include "libsigrok/libsigrok.h" | |
74 | #include <glibmm-2.4/glibmm.h> | |
75 | ||
76 | #include <stdexcept> | |
77 | #include <memory> | |
78 | #include <vector> | |
79 | #include <map> | |
80 | ||
81 | namespace sigrok | |
82 | { | |
83 | ||
84 | using namespace std; | |
85 | ||
86 | /* Forward declarations */ | |
87 | class SR_API Error; | |
88 | class SR_API Context; | |
89 | class SR_API Driver; | |
90 | class SR_API Device; | |
91 | class SR_API HardwareDevice; | |
92 | class SR_API Channel; | |
93 | class SR_API EventSource; | |
94 | class SR_API Session; | |
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; | |
105 | class SR_API Packet; | |
106 | class SR_API PacketPayload; | |
107 | class SR_API PacketType; | |
108 | class SR_API Quantity; | |
109 | class SR_API Unit; | |
110 | class SR_API QuantityFlag; | |
ca3291e3 ML |
111 | class SR_API Input; |
112 | class SR_API InputDevice; | |
c23c8659 ML |
113 | class SR_API Output; |
114 | class SR_API DataType; | |
58aa1f83 | 115 | class SR_API Option; |
c23c8659 ML |
116 | |
117 | /** Exception thrown when an error code is returned by any libsigrok call. */ | |
118 | class SR_API Error: public exception | |
119 | { | |
120 | public: | |
121 | Error(int result); | |
122 | ~Error() throw(); | |
123 | const int result; | |
124 | const char *what() const throw(); | |
125 | }; | |
126 | ||
07443fd2 | 127 | /* Base template for most classes which wrap a struct type from libsigrok. */ |
c23c8659 ML |
128 | template <class Parent, typename Struct> class SR_API StructureWrapper : |
129 | public enable_shared_from_this<StructureWrapper<Parent, Struct> > | |
130 | { | |
7649683c | 131 | protected: |
07443fd2 | 132 | /* Parent object which owns this child object's underlying structure. |
c23c8659 ML |
133 | |
134 | This shared pointer will be null when this child is unused, but | |
135 | will be assigned to point to the parent before any shared pointer | |
136 | to this child is handed out to the user. | |
137 | ||
138 | When the reference count of this child falls to zero, this shared | |
139 | pointer to its parent is reset by a custom deleter on the child's | |
140 | shared pointer. | |
141 | ||
142 | This strategy ensures that the destructors for both the child and | |
143 | the parent are called at the correct time, i.e. only when all | |
144 | references to both the parent and all its children are gone. */ | |
145 | shared_ptr<Parent> parent; | |
7649683c ML |
146 | |
147 | public: | |
148 | shared_ptr<StructureWrapper<Parent, Struct> > | |
149 | get_shared_pointer(Parent *parent) | |
150 | { | |
151 | this->parent = static_pointer_cast<Parent>(parent->shared_from_this()); | |
152 | return shared_ptr<StructureWrapper<Parent, Struct> >( | |
153 | this, reset_parent); | |
154 | } | |
155 | shared_ptr<StructureWrapper<Parent, Struct> > | |
156 | get_shared_pointer(shared_ptr<Parent> parent) | |
157 | { | |
158 | this->parent = parent; | |
159 | return shared_ptr<StructureWrapper<Parent, Struct> >( | |
160 | this, reset_parent); | |
161 | } | |
c23c8659 | 162 | protected: |
7649683c ML |
163 | static void reset_parent(StructureWrapper<Parent, Struct> *object) |
164 | { | |
165 | object->parent.reset(); | |
166 | } | |
167 | ||
c23c8659 ML |
168 | Struct *structure; |
169 | ||
170 | StructureWrapper<Parent, Struct>(Struct *structure) : | |
171 | structure(structure) | |
172 | { | |
173 | } | |
174 | }; | |
175 | ||
176 | /** Type of log callback */ | |
177 | typedef function<void(const LogLevel *, string message)> LogCallbackFunction; | |
178 | ||
07443fd2 | 179 | /** The global libsigrok context */ |
c23c8659 ML |
180 | class SR_API Context : public enable_shared_from_this<Context> |
181 | { | |
182 | public: | |
183 | /** Create new context */ | |
184 | static shared_ptr<Context> create(); | |
185 | /** libsigrok package version. */ | |
186 | string get_package_version(); | |
187 | /** libsigrok library version. */ | |
188 | string get_lib_version(); | |
189 | /** Available hardware drivers, indexed by name. */ | |
190 | map<string, shared_ptr<Driver> > get_drivers(); | |
191 | /** Available input formats, indexed by name. */ | |
192 | map<string, shared_ptr<InputFormat> > get_input_formats(); | |
193 | /** Available output formats, indexed by name. */ | |
194 | map<string, shared_ptr<OutputFormat> > get_output_formats(); | |
195 | /** Current log level. */ | |
196 | const LogLevel *get_log_level(); | |
b6f411ac ML |
197 | /** Set the log level. |
198 | * @param level LogLevel to use. */ | |
c23c8659 ML |
199 | void set_log_level(const LogLevel *level); |
200 | /** Current log domain. */ | |
201 | string get_log_domain(); | |
b6f411ac ML |
202 | /** Set the log domain. |
203 | * @param value Log domain prefix string. */ | |
c23c8659 | 204 | void set_log_domain(string value); |
b6f411ac ML |
205 | /** Set the log callback. |
206 | * @param callback Callback of the form callback(LogLevel, string). */ | |
c23c8659 ML |
207 | void set_log_callback(LogCallbackFunction callback); |
208 | /** Set the log callback to the default handler. */ | |
209 | void set_log_callback_default(); | |
210 | /** Create a new session. */ | |
211 | shared_ptr<Session> create_session(); | |
b6f411ac ML |
212 | /** Load a saved session. |
213 | * @param filename File name string. */ | |
c23c8659 | 214 | shared_ptr<Session> load_session(string filename); |
b6f411ac ML |
215 | /** Create a new trigger. |
216 | * @param name Name string for new trigger. */ | |
c23c8659 | 217 | shared_ptr<Trigger> create_trigger(string name); |
ca3291e3 ML |
218 | /** Open an input file. |
219 | * @param filename File name string. */ | |
220 | shared_ptr<Input> open_file(string filename); | |
221 | /** Open an input stream based on header data. | |
222 | * @param header Initial data from stream. */ | |
223 | shared_ptr<Input> open_stream(string header); | |
c23c8659 ML |
224 | protected: |
225 | struct sr_context *structure; | |
226 | map<string, Driver *> drivers; | |
227 | map<string, InputFormat *> input_formats; | |
228 | map<string, OutputFormat *> output_formats; | |
229 | Session *session; | |
230 | LogCallbackFunction log_callback; | |
231 | Context(); | |
232 | ~Context(); | |
233 | /** Deleter needed to allow shared_ptr use with protected destructor. */ | |
234 | class Deleter | |
235 | { | |
236 | public: | |
237 | void operator()(Context *context) { delete context; } | |
238 | }; | |
239 | friend class Deleter; | |
240 | friend class Session; | |
241 | friend class Driver; | |
242 | }; | |
243 | ||
07443fd2 | 244 | /** A hardware driver provided by the library */ |
c23c8659 ML |
245 | class SR_API Driver : public StructureWrapper<Context, struct sr_dev_driver> |
246 | { | |
247 | public: | |
248 | /** Name of this driver. */ | |
249 | string get_name(); | |
250 | /** Long name for this driver. */ | |
251 | string get_long_name(); | |
b6f411ac ML |
252 | /** Scan for devices and return a list of devices found. |
253 | * @param options Mapping of (ConfigKey, value) pairs. */ | |
c23c8659 ML |
254 | vector<shared_ptr<HardwareDevice> > scan( |
255 | map<const ConfigKey *, Glib::VariantBase> options = {}); | |
256 | protected: | |
257 | bool initialized; | |
258 | vector<HardwareDevice *> devices; | |
259 | Driver(struct sr_dev_driver *structure); | |
260 | ~Driver(); | |
261 | friend class Context; | |
262 | friend class HardwareDevice; | |
263 | friend class ChannelGroup; | |
264 | }; | |
265 | ||
266 | /** An object that can be configured. */ | |
267 | class SR_API Configurable | |
268 | { | |
269 | public: | |
b6f411ac ML |
270 | /** Read configuration for the given key. |
271 | * @param key ConfigKey to read. */ | |
c23c8659 | 272 | Glib::VariantBase config_get(const ConfigKey *key); |
b6f411ac ML |
273 | /** Set configuration for the given key to a specified value. |
274 | * @param key ConfigKey to set. | |
275 | * @param value Value to set. */ | |
c23c8659 | 276 | void config_set(const ConfigKey *key, Glib::VariantBase value); |
b6f411ac ML |
277 | /** Enumerate available values for the given configuration key. |
278 | * @param key ConfigKey to enumerate values for. */ | |
e194c011 | 279 | Glib::VariantContainerBase config_list(const ConfigKey *key); |
c23c8659 ML |
280 | protected: |
281 | Configurable( | |
282 | struct sr_dev_driver *driver, | |
283 | struct sr_dev_inst *sdi, | |
284 | struct sr_channel_group *channel_group); | |
285 | virtual ~Configurable(); | |
286 | struct sr_dev_driver *config_driver; | |
287 | struct sr_dev_inst *config_sdi; | |
288 | struct sr_channel_group *config_channel_group; | |
289 | }; | |
290 | ||
07443fd2 | 291 | /** A generic device, either hardware or virtual */ |
d01d2314 | 292 | class SR_API Device : public Configurable |
c23c8659 ML |
293 | { |
294 | public: | |
f36ca889 ML |
295 | /** Description identifying this device. */ |
296 | string get_description(); | |
c23c8659 ML |
297 | /** Vendor name for this device. */ |
298 | string get_vendor(); | |
299 | /** Model name for this device. */ | |
300 | string get_model(); | |
301 | /** Version string for this device. */ | |
302 | string get_version(); | |
303 | /** List of the channels available on this device. */ | |
304 | vector<shared_ptr<Channel> > get_channels(); | |
6be7a7f2 ML |
305 | /** Channel groups available on this device, indexed by name. */ |
306 | map<string, shared_ptr<ChannelGroup> > get_channel_groups(); | |
c23c8659 ML |
307 | /** Open device. */ |
308 | void open(); | |
309 | /** Close device. */ | |
310 | void close(); | |
311 | protected: | |
312 | Device(struct sr_dev_inst *structure); | |
313 | ~Device(); | |
d01d2314 | 314 | virtual shared_ptr<Device> get_shared_from_this() = 0; |
4178d971 | 315 | shared_ptr<Channel> get_channel(struct sr_channel *ptr); |
6e5240f4 | 316 | struct sr_dev_inst *structure; |
4178d971 | 317 | map<struct sr_channel *, Channel *> channels; |
6be7a7f2 | 318 | map<string, ChannelGroup *> channel_groups; |
c23c8659 ML |
319 | /** Deleter needed to allow shared_ptr use with protected destructor. */ |
320 | class Deleter | |
321 | { | |
322 | public: | |
323 | void operator()(Device *device) { delete device; } | |
324 | }; | |
325 | friend class Deleter; | |
326 | friend class Session; | |
327 | friend class Channel; | |
328 | friend class ChannelGroup; | |
329 | friend class Output; | |
2928f47d | 330 | friend class Analog; |
c23c8659 ML |
331 | }; |
332 | ||
07443fd2 | 333 | /** A real hardware device, connected via a driver */ |
6e5240f4 ML |
334 | class SR_API HardwareDevice : |
335 | public StructureWrapper<Context, struct sr_dev_inst>, | |
336 | public Device | |
c23c8659 ML |
337 | { |
338 | public: | |
339 | /** Driver providing this device. */ | |
340 | shared_ptr<Driver> get_driver(); | |
c23c8659 ML |
341 | protected: |
342 | HardwareDevice(Driver *driver, struct sr_dev_inst *structure); | |
343 | ~HardwareDevice(); | |
d01d2314 | 344 | shared_ptr<Device> get_shared_from_this(); |
c23c8659 | 345 | Driver *driver; |
c23c8659 ML |
346 | friend class Driver; |
347 | friend class ChannelGroup; | |
348 | }; | |
349 | ||
07443fd2 | 350 | /** A channel on a device */ |
c23c8659 ML |
351 | class SR_API Channel : public StructureWrapper<Device, struct sr_channel> |
352 | { | |
353 | public: | |
354 | /** Current name of this channel. */ | |
355 | string get_name(); | |
b6f411ac ML |
356 | /** Set the name of this channel. * |
357 | * @param name Name string to set. */ | |
c23c8659 ML |
358 | void set_name(string name); |
359 | /** Type of this channel. */ | |
360 | const ChannelType *get_type(); | |
361 | /** Enabled status of this channel. */ | |
362 | bool get_enabled(); | |
b6f411ac ML |
363 | /** Set the enabled status of this channel. |
364 | * @param value Boolean value to set. */ | |
c23c8659 | 365 | void set_enabled(bool value); |
06bd935e ML |
366 | /** Get the index number of this channel. */ |
367 | unsigned int get_index(); | |
c23c8659 ML |
368 | protected: |
369 | Channel(struct sr_channel *structure); | |
370 | ~Channel(); | |
371 | const ChannelType * const type; | |
372 | friend class Device; | |
373 | friend class ChannelGroup; | |
374 | friend class Session; | |
375 | friend class TriggerStage; | |
376 | }; | |
377 | ||
07443fd2 | 378 | /** A group of channels on a device, which share some configuration */ |
c23c8659 | 379 | class SR_API ChannelGroup : |
6be7a7f2 | 380 | public StructureWrapper<Device, struct sr_channel_group>, |
c23c8659 ML |
381 | public Configurable |
382 | { | |
383 | public: | |
384 | /** Name of this channel group. */ | |
385 | string get_name(); | |
386 | /** List of the channels in this group. */ | |
387 | vector<shared_ptr<Channel> > get_channels(); | |
388 | protected: | |
6be7a7f2 | 389 | ChannelGroup(Device *device, struct sr_channel_group *structure); |
c23c8659 ML |
390 | ~ChannelGroup(); |
391 | vector<Channel *> channels; | |
6be7a7f2 | 392 | friend class Device; |
c23c8659 ML |
393 | }; |
394 | ||
07443fd2 | 395 | /** A trigger configuration */ |
c23c8659 ML |
396 | class SR_API Trigger : public enable_shared_from_this<Trigger> |
397 | { | |
398 | public: | |
b6f411ac | 399 | /** Name of this trigger configuration. */ |
c23c8659 | 400 | string get_name(); |
b6f411ac | 401 | /** List of the stages in this trigger. */ |
c23c8659 | 402 | vector<shared_ptr<TriggerStage> > get_stages(); |
b6f411ac | 403 | /** Add a new stage to this trigger. */ |
c23c8659 ML |
404 | shared_ptr<TriggerStage> add_stage(); |
405 | protected: | |
406 | Trigger(shared_ptr<Context> context, string name); | |
407 | ~Trigger(); | |
408 | struct sr_trigger *structure; | |
409 | shared_ptr<Context> context; | |
410 | vector<TriggerStage *> stages; | |
411 | /** Deleter needed to allow shared_ptr use with protected destructor. */ | |
412 | class Deleter | |
413 | { | |
414 | public: | |
415 | void operator()(Trigger *trigger) { delete trigger; } | |
416 | }; | |
417 | friend class Context; | |
6fa0eb86 | 418 | friend class Session; |
c23c8659 ML |
419 | }; |
420 | ||
07443fd2 | 421 | /** A stage in a trigger configuration */ |
c23c8659 ML |
422 | class SR_API TriggerStage : public StructureWrapper<Trigger, struct sr_trigger_stage> |
423 | { | |
424 | public: | |
b6f411ac | 425 | /** Index number of this stage. */ |
c23c8659 | 426 | int get_number(); |
b6f411ac | 427 | /** List of match conditions on this stage. */ |
c23c8659 | 428 | vector<shared_ptr<TriggerMatch> > get_matches(); |
b6f411ac ML |
429 | /** Add a new match condition to this stage. |
430 | * @param channel Channel to match on. | |
431 | * @param type TriggerMatchType to apply. */ | |
c23c8659 | 432 | void add_match(shared_ptr<Channel> channel, const TriggerMatchType *type); |
b6f411ac ML |
433 | /** Add a new match condition to this stage. |
434 | * @param channel Channel to match on. | |
435 | * @param type TriggerMatchType to apply. | |
436 | * @param value Threshold value. */ | |
c23c8659 ML |
437 | void add_match(shared_ptr<Channel> channel, const TriggerMatchType *type, float value); |
438 | protected: | |
439 | vector<TriggerMatch *> matches; | |
440 | TriggerStage(struct sr_trigger_stage *structure); | |
441 | ~TriggerStage(); | |
442 | friend class Trigger; | |
443 | }; | |
444 | ||
07443fd2 | 445 | /** A match condition in a trigger configuration */ |
c23c8659 ML |
446 | class SR_API TriggerMatch : public StructureWrapper<TriggerStage, struct sr_trigger_match> |
447 | { | |
448 | public: | |
b6f411ac | 449 | /** Channel this condition matches on. */ |
c23c8659 | 450 | shared_ptr<Channel> get_channel(); |
b6f411ac | 451 | /** Type of match. */ |
c23c8659 | 452 | const TriggerMatchType *get_type(); |
b6f411ac | 453 | /** Threshold value. */ |
c23c8659 ML |
454 | float get_value(); |
455 | protected: | |
456 | TriggerMatch(struct sr_trigger_match *structure, shared_ptr<Channel> channel); | |
457 | ~TriggerMatch(); | |
458 | shared_ptr<Channel> channel; | |
459 | friend class TriggerStage; | |
460 | }; | |
461 | ||
462 | /** Type of datafeed callback */ | |
463 | typedef function<void(shared_ptr<Device>, shared_ptr<Packet>)> | |
464 | DatafeedCallbackFunction; | |
465 | ||
07443fd2 | 466 | /* Data required for C callback function to call a C++ datafeed callback */ |
c23c8659 ML |
467 | class SR_PRIV DatafeedCallbackData |
468 | { | |
469 | public: | |
470 | void run(const struct sr_dev_inst *sdi, | |
471 | const struct sr_datafeed_packet *pkt); | |
472 | protected: | |
473 | DatafeedCallbackFunction callback; | |
474 | DatafeedCallbackData(Session *session, | |
475 | DatafeedCallbackFunction callback); | |
476 | Session *session; | |
477 | friend class Session; | |
478 | }; | |
479 | ||
480 | /** Type of source callback */ | |
481 | typedef function<bool(Glib::IOCondition)> | |
482 | SourceCallbackFunction; | |
483 | ||
07443fd2 | 484 | /* Data required for C callback function to call a C++ source callback */ |
c23c8659 ML |
485 | class SR_PRIV SourceCallbackData |
486 | { | |
487 | public: | |
488 | bool run(int revents); | |
489 | protected: | |
490 | SourceCallbackData(shared_ptr<EventSource> source); | |
491 | shared_ptr<EventSource> source; | |
492 | friend class Session; | |
493 | }; | |
494 | ||
07443fd2 | 495 | /** An I/O event source */ |
c23c8659 ML |
496 | class SR_API EventSource |
497 | { | |
498 | public: | |
b6f411ac ML |
499 | /** Create an event source from a file descriptor. |
500 | * @param fd File descriptor. | |
501 | * @param events GLib IOCondition event mask. | |
502 | * @param timeout Timeout in milliseconds. | |
503 | * @param callback Callback of the form callback(events) */ | |
c23c8659 ML |
504 | static shared_ptr<EventSource> create(int fd, Glib::IOCondition events, |
505 | int timeout, SourceCallbackFunction callback); | |
b6f411ac ML |
506 | /** Create an event source from a GLib PollFD |
507 | * @param pollfd GLib PollFD | |
508 | * @param timeout Timeout in milliseconds. | |
509 | * @param callback Callback of the form callback(events) */ | |
c23c8659 ML |
510 | static shared_ptr<EventSource> create(Glib::PollFD pollfd, int timeout, |
511 | SourceCallbackFunction callback); | |
b6f411ac ML |
512 | /** Create an event source from a GLib IOChannel |
513 | * @param channel GLib IOChannel. | |
514 | * @param events GLib IOCondition event mask. | |
515 | * @param timeout Timeout in milliseconds. | |
516 | * @param callback Callback of the form callback(events) */ | |
c23c8659 ML |
517 | static shared_ptr<EventSource> create( |
518 | Glib::RefPtr<Glib::IOChannel> channel, Glib::IOCondition events, | |
519 | int timeout, SourceCallbackFunction callback); | |
520 | protected: | |
521 | EventSource(int timeout, SourceCallbackFunction callback); | |
522 | ~EventSource(); | |
523 | enum source_type { | |
524 | SOURCE_FD, | |
525 | SOURCE_POLLFD, | |
526 | SOURCE_IOCHANNEL | |
527 | } type; | |
528 | int fd; | |
529 | Glib::PollFD pollfd; | |
530 | Glib::RefPtr<Glib::IOChannel> channel; | |
531 | Glib::IOCondition events; | |
532 | int timeout; | |
533 | SourceCallbackFunction callback; | |
534 | /** Deleter needed to allow shared_ptr use with protected destructor. */ | |
535 | class Deleter | |
536 | { | |
537 | public: | |
538 | void operator()(EventSource *source) { delete source; } | |
539 | }; | |
540 | friend class Deleter; | |
541 | friend class Session; | |
542 | friend class SourceCallbackData; | |
543 | }; | |
544 | ||
07443fd2 | 545 | /** A sigrok session */ |
c23c8659 ML |
546 | class SR_API Session |
547 | { | |
548 | public: | |
b6f411ac ML |
549 | /** Add a device to this session. |
550 | * @param device Device to add. */ | |
c23c8659 ML |
551 | void add_device(shared_ptr<Device> device); |
552 | /** List devices attached to this session. */ | |
553 | vector<shared_ptr<Device> > get_devices(); | |
554 | /** Remove all devices from this session. */ | |
555 | void remove_devices(); | |
b6f411ac ML |
556 | /** Add a datafeed callback to this session. |
557 | * @param callback Callback of the form callback(Device, Packet). */ | |
c23c8659 ML |
558 | void add_datafeed_callback(DatafeedCallbackFunction callback); |
559 | /** Remove all datafeed callbacks from this session. */ | |
560 | void remove_datafeed_callbacks(); | |
b6f411ac ML |
561 | /** Add an I/O event source. |
562 | * @param source EventSource to add. */ | |
c23c8659 | 563 | void add_source(shared_ptr<EventSource> source); |
b6f411ac ML |
564 | /** Remove an event source. |
565 | * @param source EventSource to remove. */ | |
c23c8659 ML |
566 | void remove_source(shared_ptr<EventSource> source); |
567 | /** Start the session. */ | |
568 | void start(); | |
569 | /** Run the session event loop. */ | |
570 | void run(); | |
571 | /** Stop the session. */ | |
572 | void stop(); | |
b6f411ac ML |
573 | /** Begin saving session to a file. |
574 | * @param filename File name string. */ | |
c23c8659 | 575 | void begin_save(string filename); |
b6f411ac ML |
576 | /** Append a packet to the session file being saved. |
577 | * @param packet Packet to append. */ | |
1d67cfb4 ML |
578 | void append(shared_ptr<Packet> packet); |
579 | /** Append raw logic data to the session file being saved. */ | |
580 | void append(void *data, size_t length, unsigned int unit_size); | |
6fa0eb86 ML |
581 | /** Get current trigger setting. */ |
582 | shared_ptr<Trigger> get_trigger(); | |
b6f411ac ML |
583 | /** Set trigger setting. |
584 | * @param trigger Trigger object to use. */ | |
6fa0eb86 | 585 | void set_trigger(shared_ptr<Trigger> trigger); |
c23c8659 ML |
586 | protected: |
587 | Session(shared_ptr<Context> context); | |
588 | Session(shared_ptr<Context> context, string filename); | |
589 | ~Session(); | |
590 | struct sr_session *structure; | |
591 | const shared_ptr<Context> context; | |
592 | map<const struct sr_dev_inst *, shared_ptr<Device> > devices; | |
593 | vector<DatafeedCallbackData *> datafeed_callbacks; | |
594 | map<shared_ptr<EventSource>, SourceCallbackData *> source_callbacks; | |
595 | bool saving; | |
596 | bool save_initialized; | |
597 | string save_filename; | |
598 | uint64_t save_samplerate; | |
6fa0eb86 | 599 | shared_ptr<Trigger> trigger; |
c23c8659 ML |
600 | /** Deleter needed to allow shared_ptr use with protected destructor. */ |
601 | class Deleter | |
602 | { | |
603 | public: | |
604 | void operator()(Session *session) { delete session; } | |
605 | }; | |
606 | friend class Deleter; | |
607 | friend class Context; | |
608 | friend class DatafeedCallbackData; | |
609 | }; | |
610 | ||
07443fd2 | 611 | /** A packet on the session datafeed */ |
2928f47d | 612 | class SR_API Packet : public enable_shared_from_this<Packet> |
c23c8659 ML |
613 | { |
614 | public: | |
90ba83f2 ML |
615 | /** Type of this packet. */ |
616 | const PacketType *get_type(); | |
c23c8659 | 617 | /** Payload of this packet. */ |
2928f47d | 618 | shared_ptr<PacketPayload> get_payload(); |
c23c8659 | 619 | protected: |
2928f47d ML |
620 | Packet(shared_ptr<Device> device, |
621 | const struct sr_datafeed_packet *structure); | |
c23c8659 ML |
622 | ~Packet(); |
623 | const struct sr_datafeed_packet *structure; | |
2928f47d | 624 | shared_ptr<Device> device; |
c23c8659 ML |
625 | PacketPayload *payload; |
626 | /** Deleter needed to allow shared_ptr use with protected destructor. */ | |
627 | class Deleter | |
628 | { | |
629 | public: | |
630 | void operator()(Packet *packet) { delete packet; } | |
631 | }; | |
632 | friend class Deleter; | |
633 | friend class Session; | |
634 | friend class Output; | |
635 | friend class DatafeedCallbackData; | |
2928f47d ML |
636 | friend class Header; |
637 | friend class Meta; | |
638 | friend class Logic; | |
639 | friend class Analog; | |
c23c8659 ML |
640 | }; |
641 | ||
07443fd2 | 642 | /** Abstract base class for datafeed packet payloads */ |
c23c8659 ML |
643 | class SR_API PacketPayload |
644 | { | |
645 | protected: | |
646 | PacketPayload(); | |
647 | virtual ~PacketPayload() = 0; | |
4cd883a7 | 648 | virtual shared_ptr<PacketPayload> get_shared_pointer(Packet *parent) = 0; |
2928f47d ML |
649 | /** Deleter needed to allow shared_ptr use with protected destructor. */ |
650 | class Deleter | |
651 | { | |
652 | public: | |
653 | void operator()(PacketPayload *payload) { delete payload; } | |
654 | }; | |
655 | friend class Deleter; | |
c23c8659 ML |
656 | friend class Packet; |
657 | friend class Output; | |
658 | }; | |
659 | ||
2928f47d | 660 | /** Payload of a datafeed header packet */ |
4cd883a7 ML |
661 | class SR_API Header : |
662 | public StructureWrapper<Packet, const struct sr_datafeed_header>, | |
663 | public PacketPayload | |
2928f47d ML |
664 | { |
665 | public: | |
b6f411ac | 666 | /* Feed version number. */ |
2928f47d | 667 | int get_feed_version(); |
b6f411ac | 668 | /* Start time of this session. */ |
2928f47d ML |
669 | Glib::TimeVal get_start_time(); |
670 | protected: | |
671 | Header(const struct sr_datafeed_header *structure); | |
672 | ~Header(); | |
4cd883a7 | 673 | shared_ptr<PacketPayload> get_shared_pointer(Packet *parent); |
2928f47d ML |
674 | friend class Packet; |
675 | }; | |
676 | ||
677 | /** Payload of a datafeed metadata packet */ | |
4cd883a7 ML |
678 | class SR_API Meta : |
679 | public StructureWrapper<Packet, const struct sr_datafeed_meta>, | |
680 | public PacketPayload | |
2928f47d ML |
681 | { |
682 | public: | |
b6f411ac | 683 | /* Mapping of (ConfigKey, value) pairs. */ |
2928f47d ML |
684 | map<const ConfigKey *, Glib::VariantBase> get_config(); |
685 | protected: | |
686 | Meta(const struct sr_datafeed_meta *structure); | |
687 | ~Meta(); | |
4cd883a7 | 688 | shared_ptr<PacketPayload> get_shared_pointer(Packet *parent); |
2928f47d ML |
689 | map<const ConfigKey *, Glib::VariantBase> config; |
690 | friend class Packet; | |
691 | }; | |
692 | ||
07443fd2 | 693 | /** Payload of a datafeed packet with logic data */ |
4cd883a7 ML |
694 | class SR_API Logic : |
695 | public StructureWrapper<Packet, const struct sr_datafeed_logic>, | |
696 | public PacketPayload | |
c23c8659 | 697 | { |
2928f47d ML |
698 | public: |
699 | /* Pointer to data. */ | |
700 | void *get_data_pointer(); | |
701 | /* Data length in bytes. */ | |
702 | size_t get_data_length(); | |
703 | /* Size of each sample in bytes. */ | |
704 | unsigned int get_unit_size(); | |
c23c8659 ML |
705 | protected: |
706 | Logic(const struct sr_datafeed_logic *structure); | |
707 | ~Logic(); | |
4cd883a7 | 708 | shared_ptr<PacketPayload> get_shared_pointer(Packet *parent); |
c23c8659 ML |
709 | friend class Packet; |
710 | }; | |
711 | ||
07443fd2 | 712 | /** Payload of a datafeed packet with analog data */ |
4cd883a7 ML |
713 | class SR_API Analog : |
714 | public StructureWrapper<Packet, const struct sr_datafeed_analog>, | |
715 | public PacketPayload | |
c23c8659 ML |
716 | { |
717 | public: | |
2928f47d ML |
718 | /** Pointer to data. */ |
719 | float *get_data_pointer(); | |
c23c8659 ML |
720 | /** Number of samples in this packet. */ |
721 | unsigned int get_num_samples(); | |
2928f47d ML |
722 | /** Channels for which this packet contains data. */ |
723 | vector<shared_ptr<Channel> > get_channels(); | |
c23c8659 ML |
724 | /** Measured quantity of the samples in this packet. */ |
725 | const Quantity *get_mq(); | |
726 | /** Unit of the samples in this packet. */ | |
727 | const Unit *get_unit(); | |
728 | /** Measurement flags associated with the samples in this packet. */ | |
729 | vector<const QuantityFlag *> get_mq_flags(); | |
730 | protected: | |
731 | Analog(const struct sr_datafeed_analog *structure); | |
732 | ~Analog(); | |
4cd883a7 | 733 | shared_ptr<PacketPayload> get_shared_pointer(Packet *parent); |
c23c8659 ML |
734 | friend class Packet; |
735 | }; | |
736 | ||
07443fd2 | 737 | /** An input format supported by the library */ |
c23c8659 | 738 | class SR_API InputFormat : |
ca3291e3 | 739 | public StructureWrapper<Context, const struct sr_input_module> |
c23c8659 ML |
740 | { |
741 | public: | |
742 | /** Name of this input format. */ | |
743 | string get_name(); | |
744 | /** Description of this input format. */ | |
745 | string get_description(); | |
ca3291e3 ML |
746 | /** Options supported by this input format. */ |
747 | map<string, shared_ptr<Option> > get_options(); | |
748 | /** Create an input using this input format. | |
749 | * @param options Mapping of (option name, value) pairs. */ | |
750 | shared_ptr<Input> create_input(map<string, Glib::VariantBase> options = {}); | |
c23c8659 | 751 | protected: |
ca3291e3 | 752 | InputFormat(const struct sr_input_module *structure); |
c23c8659 ML |
753 | ~InputFormat(); |
754 | friend class Context; | |
ca3291e3 | 755 | friend class InputDevice; |
c23c8659 ML |
756 | }; |
757 | ||
ca3291e3 ML |
758 | /** An input instance (an input format applied to a file or stream) */ |
759 | class SR_API Input : public enable_shared_from_this<Input> | |
c23c8659 ML |
760 | { |
761 | public: | |
ca3291e3 ML |
762 | /** Virtual device associated with this input. */ |
763 | shared_ptr<InputDevice> get_device(); | |
764 | /** Send next stream data. | |
765 | * @param data Next stream data. */ | |
766 | void send(string data); | |
c23c8659 | 767 | protected: |
ca3291e3 ML |
768 | Input(shared_ptr<Context> context, const struct sr_input *structure); |
769 | ~Input(); | |
d01d2314 | 770 | shared_ptr<Device> get_shared_from_this(); |
ca3291e3 ML |
771 | const struct sr_input *structure; |
772 | shared_ptr<Context> context; | |
773 | InputDevice *device; | |
c23c8659 ML |
774 | /** Deleter needed to allow shared_ptr use with protected destructor. */ |
775 | class Deleter | |
776 | { | |
777 | public: | |
ca3291e3 | 778 | void operator()(Input *input) { delete input; } |
c23c8659 ML |
779 | }; |
780 | friend class Deleter; | |
ca3291e3 | 781 | friend class Context; |
c23c8659 ML |
782 | friend class InputFormat; |
783 | }; | |
784 | ||
ca3291e3 | 785 | /** A virtual device associated with an input */ |
6e5240f4 ML |
786 | class SR_API InputDevice : |
787 | public StructureWrapper<Input, struct sr_dev_inst>, | |
788 | public Device | |
ca3291e3 ML |
789 | { |
790 | protected: | |
791 | InputDevice(shared_ptr<Input> input, struct sr_dev_inst *sdi); | |
792 | ~InputDevice(); | |
d01d2314 | 793 | shared_ptr<Device> get_shared_from_this(); |
ca3291e3 ML |
794 | shared_ptr<Input> input; |
795 | /** Deleter needed to allow shared_ptr use with protected destructor. */ | |
796 | class Deleter | |
797 | { | |
798 | public: | |
799 | void operator()(InputDevice *device) { delete device; } | |
800 | }; | |
801 | friend class Deleter; | |
802 | friend class Input; | |
803 | }; | |
804 | ||
58aa1f83 ML |
805 | /** An option used by an output format */ |
806 | class SR_API Option | |
807 | { | |
808 | public: | |
809 | /** Short name of this option suitable for command line usage. */ | |
810 | string get_id(); | |
811 | /** Short name of this option suitable for GUI usage. */ | |
812 | string get_name(); | |
813 | /** Description of this option in a sentence. */ | |
814 | string get_description(); | |
815 | /** Default value for this option. */ | |
816 | Glib::VariantBase get_default_value(); | |
817 | /** Possible values for this option, if a limited set. */ | |
818 | vector<Glib::VariantBase> get_values(); | |
819 | protected: | |
820 | Option(const struct sr_option *structure, | |
70d3b20b | 821 | shared_ptr<const struct sr_option *> structure_array); |
58aa1f83 ML |
822 | ~Option(); |
823 | const struct sr_option *structure; | |
70d3b20b | 824 | shared_ptr<const struct sr_option *> structure_array; |
58aa1f83 ML |
825 | /** Deleter needed to allow shared_ptr use with protected destructor. */ |
826 | class Deleter | |
827 | { | |
828 | public: | |
829 | void operator()(Option *option) { delete option; } | |
830 | }; | |
831 | friend class Deleter; | |
43942280 | 832 | friend class InputFormat; |
58aa1f83 ML |
833 | friend class OutputFormat; |
834 | }; | |
835 | ||
07443fd2 | 836 | /** An output format supported by the library */ |
c23c8659 | 837 | class SR_API OutputFormat : |
58aa1f83 | 838 | public StructureWrapper<Context, const struct sr_output_module> |
c23c8659 ML |
839 | { |
840 | public: | |
841 | /** Name of this output format. */ | |
842 | string get_name(); | |
843 | /** Description of this output format. */ | |
844 | string get_description(); | |
58aa1f83 ML |
845 | /** Options supported by this output format. */ |
846 | map<string, shared_ptr<Option> > get_options(); | |
b6f411ac ML |
847 | /** Create an output using this format. |
848 | * @param device Device to output for. | |
849 | * @param options Mapping of (option name, value) pairs. */ | |
58aa1f83 ML |
850 | shared_ptr<Output> create_output(shared_ptr<Device> device, |
851 | map<string, Glib::VariantBase> options = {}); | |
c23c8659 | 852 | protected: |
58aa1f83 | 853 | OutputFormat(const struct sr_output_module *structure); |
c23c8659 ML |
854 | ~OutputFormat(); |
855 | friend class Context; | |
856 | friend class Output; | |
857 | }; | |
858 | ||
07443fd2 | 859 | /** An output instance (an output format applied to a device) */ |
c23c8659 ML |
860 | class SR_API Output |
861 | { | |
862 | public: | |
b6f411ac ML |
863 | /** Update output with data from the given packet. |
864 | * @param packet Packet to handle. */ | |
c23c8659 ML |
865 | string receive(shared_ptr<Packet> packet); |
866 | protected: | |
867 | Output(shared_ptr<OutputFormat> format, shared_ptr<Device> device); | |
868 | Output(shared_ptr<OutputFormat> format, | |
58aa1f83 | 869 | shared_ptr<Device> device, map<string, Glib::VariantBase> options); |
c23c8659 | 870 | ~Output(); |
58aa1f83 | 871 | const struct sr_output *structure; |
c23c8659 ML |
872 | const shared_ptr<OutputFormat> format; |
873 | const shared_ptr<Device> device; | |
58aa1f83 | 874 | const map<string, Glib::VariantBase> options; |
c23c8659 ML |
875 | /** Deleter needed to allow shared_ptr use with protected destructor. */ |
876 | class Deleter | |
877 | { | |
878 | public: | |
879 | void operator()(Output *output) { delete output; } | |
880 | }; | |
881 | friend class Deleter; | |
882 | friend class OutputFormat; | |
883 | }; | |
884 | ||
885 | /** Base class for objects which wrap an enumeration value from libsigrok */ | |
886 | template <typename T> class SR_API EnumValue | |
887 | { | |
888 | public: | |
889 | /** The enum constant associated with this value. */ | |
890 | T get_id() const { return id; } | |
891 | /** The name associated with this value. */ | |
892 | string get_name() const { return name; } | |
893 | protected: | |
894 | EnumValue(T id, const char name[]) : id(id), name(name) {} | |
895 | ~EnumValue() {} | |
896 | const T id; | |
897 | const string name; | |
898 | }; | |
899 | ||
900 | #include "enums.hpp" | |
901 | ||
902 | } | |
903 | ||
904 | #endif // LIBSIGROK_HPP |