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