]>
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. */ | |
3b161085 | 145 | shared_ptr<Parent> _parent; |
7649683c | 146 | |
0d0170ae | 147 | /* Weak pointer for shared_from_this() implementation. */ |
3b161085 | 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 | 155 | |
3b161085 | 156 | if (!(shared = _weak_this.lock())) |
0d0170ae | 157 | { |
bf52cc8c | 158 | shared = shared_ptr<Class>((Class *) this, reset_parent); |
3b161085 | 159 | _weak_this = shared; |
0d0170ae ML |
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); | |
3b161085 | 169 | this->_parent = parent; |
0d0170ae | 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 | { |
3b161085 | 182 | if (!object->_parent) |
78132e2a | 183 | throw Error(SR_ERR_BUG); |
3b161085 | 184 | object->_parent.reset(); |
7649683c ML |
185 | } |
186 | ||
3b161085 | 187 | Struct *_structure; |
c23c8659 | 188 | |
541c855e | 189 | ParentOwned<Class, Parent, Struct>(Struct *structure) : |
3b161085 | 190 | _structure(structure) |
c23c8659 ML |
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: | |
3b161085 | 208 | Struct *_structure; |
90e89c2a ML |
209 | |
210 | UserOwned<Class, Struct>(Struct *structure) : | |
3b161085 | 211 | _structure(structure) |
90e89c2a ML |
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. */ | |
3b161085 | 233 | string package_version(); |
c23c8659 | 234 | /** libsigrok library version. */ |
3b161085 | 235 | string lib_version(); |
c23c8659 | 236 | /** Available hardware drivers, indexed by name. */ |
3b161085 | 237 | map<string, shared_ptr<Driver> > drivers(); |
c23c8659 | 238 | /** Available input formats, indexed by name. */ |
3b161085 | 239 | map<string, shared_ptr<InputFormat> > input_formats(); |
c23c8659 | 240 | /** Available output formats, indexed by name. */ |
3b161085 | 241 | map<string, shared_ptr<OutputFormat> > output_formats(); |
c23c8659 | 242 | /** Current log level. */ |
3b161085 | 243 | const LogLevel *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. */ | |
3b161085 | 248 | string 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: |
3b161085 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; | |
c23c8659 ML |
277 | Context(); |
278 | ~Context(); | |
c23c8659 ML |
279 | friend class Deleter; |
280 | friend class Session; | |
281 | friend class Driver; | |
282 | }; | |
283 | ||
c23c8659 ML |
284 | /** An object that can be configured. */ |
285 | class SR_API Configurable | |
286 | { | |
287 | public: | |
b6f411ac ML |
288 | /** Read configuration for the given key. |
289 | * @param key ConfigKey to read. */ | |
c23c8659 | 290 | Glib::VariantBase config_get(const ConfigKey *key); |
b6f411ac ML |
291 | /** Set configuration for the given key to a specified value. |
292 | * @param key ConfigKey to set. | |
293 | * @param value Value to set. */ | |
c23c8659 | 294 | void config_set(const ConfigKey *key, Glib::VariantBase value); |
b6f411ac ML |
295 | /** Enumerate available values for the given configuration key. |
296 | * @param key ConfigKey to enumerate values for. */ | |
e194c011 | 297 | Glib::VariantContainerBase config_list(const ConfigKey *key); |
d54190a3 ML |
298 | /** Enumerate available keys, according to a given index key. */ |
299 | vector<const ConfigKey *> config_keys(const ConfigKey *key); | |
d9eed47d ML |
300 | /** Check for a key in the list from a given index key. */ |
301 | bool config_check(const ConfigKey *key, const ConfigKey *index_key); | |
c23c8659 ML |
302 | protected: |
303 | Configurable( | |
304 | struct sr_dev_driver *driver, | |
305 | struct sr_dev_inst *sdi, | |
306 | struct sr_channel_group *channel_group); | |
307 | virtual ~Configurable(); | |
308 | struct sr_dev_driver *config_driver; | |
309 | struct sr_dev_inst *config_sdi; | |
310 | struct sr_channel_group *config_channel_group; | |
311 | }; | |
312 | ||
59b74d28 ML |
313 | /** A hardware driver provided by the library */ |
314 | class SR_API Driver : | |
315 | public ParentOwned<Driver, Context, struct sr_dev_driver>, | |
316 | public Configurable | |
317 | { | |
318 | public: | |
319 | /** Name of this driver. */ | |
3b161085 | 320 | string name(); |
59b74d28 | 321 | /** Long name for this driver. */ |
3b161085 | 322 | string long_name(); |
59b74d28 ML |
323 | /** Scan for devices and return a list of devices found. |
324 | * @param options Mapping of (ConfigKey, value) pairs. */ | |
325 | vector<shared_ptr<HardwareDevice> > scan( | |
db560903 ML |
326 | map<const ConfigKey *, Glib::VariantBase> options = |
327 | map<const ConfigKey *, Glib::VariantBase>()); | |
59b74d28 | 328 | protected: |
3b161085 ML |
329 | bool _initialized; |
330 | vector<HardwareDevice *> _devices; | |
59b74d28 ML |
331 | Driver(struct sr_dev_driver *structure); |
332 | ~Driver(); | |
333 | friend class Context; | |
334 | friend class HardwareDevice; | |
335 | friend class ChannelGroup; | |
336 | }; | |
337 | ||
07443fd2 | 338 | /** A generic device, either hardware or virtual */ |
d01d2314 | 339 | class SR_API Device : public Configurable |
c23c8659 ML |
340 | { |
341 | public: | |
f36ca889 | 342 | /** Description identifying this device. */ |
3b161085 | 343 | string description(); |
c23c8659 | 344 | /** Vendor name for this device. */ |
3b161085 | 345 | string vendor(); |
c23c8659 | 346 | /** Model name for this device. */ |
3b161085 | 347 | string model(); |
c23c8659 | 348 | /** Version string for this device. */ |
3b161085 | 349 | string version(); |
c23c8659 | 350 | /** List of the channels available on this device. */ |
3b161085 | 351 | vector<shared_ptr<Channel> > channels(); |
6be7a7f2 | 352 | /** Channel groups available on this device, indexed by name. */ |
3b161085 | 353 | map<string, shared_ptr<ChannelGroup> > channel_groups(); |
c23c8659 ML |
354 | /** Open device. */ |
355 | void open(); | |
356 | /** Close device. */ | |
357 | void close(); | |
358 | protected: | |
359 | Device(struct sr_dev_inst *structure); | |
360 | ~Device(); | |
d01d2314 | 361 | virtual shared_ptr<Device> get_shared_from_this() = 0; |
4178d971 | 362 | shared_ptr<Channel> get_channel(struct sr_channel *ptr); |
3b161085 ML |
363 | struct sr_dev_inst *_structure; |
364 | map<struct sr_channel *, Channel *> _channels; | |
365 | map<string, ChannelGroup *> _channel_groups; | |
c23c8659 ML |
366 | /** Deleter needed to allow shared_ptr use with protected destructor. */ |
367 | class Deleter | |
368 | { | |
369 | public: | |
370 | void operator()(Device *device) { delete device; } | |
371 | }; | |
372 | friend class Deleter; | |
373 | friend class Session; | |
374 | friend class Channel; | |
375 | friend class ChannelGroup; | |
376 | friend class Output; | |
2928f47d | 377 | friend class Analog; |
c23c8659 ML |
378 | }; |
379 | ||
07443fd2 | 380 | /** A real hardware device, connected via a driver */ |
6e5240f4 | 381 | class SR_API HardwareDevice : |
a4e47454 | 382 | public UserOwned<HardwareDevice, struct sr_dev_inst>, |
6e5240f4 | 383 | public Device |
c23c8659 ML |
384 | { |
385 | public: | |
386 | /** Driver providing this device. */ | |
3b161085 | 387 | shared_ptr<Driver> driver(); |
c23c8659 | 388 | protected: |
a4e47454 | 389 | HardwareDevice(shared_ptr<Driver> driver, struct sr_dev_inst *structure); |
c23c8659 | 390 | ~HardwareDevice(); |
d01d2314 | 391 | shared_ptr<Device> get_shared_from_this(); |
a4e47454 ML |
392 | shared_ptr<Driver> _driver; |
393 | /** Deleter needed to allow shared_ptr use with protected destructor. */ | |
394 | class Deleter | |
395 | { | |
396 | public: | |
397 | void operator()(HardwareDevice *device) { delete device; } | |
398 | }; | |
399 | friend class Deleter; | |
c23c8659 ML |
400 | friend class Driver; |
401 | friend class ChannelGroup; | |
402 | }; | |
403 | ||
07443fd2 | 404 | /** A channel on a device */ |
bf52cc8c | 405 | class SR_API Channel : |
541c855e | 406 | public ParentOwned<Channel, Device, struct sr_channel> |
c23c8659 ML |
407 | { |
408 | public: | |
409 | /** Current name of this channel. */ | |
3b161085 | 410 | string name(); |
b6f411ac ML |
411 | /** Set the name of this channel. * |
412 | * @param name Name string to set. */ | |
c23c8659 ML |
413 | void set_name(string name); |
414 | /** Type of this channel. */ | |
3b161085 | 415 | const ChannelType *type(); |
c23c8659 | 416 | /** Enabled status of this channel. */ |
3b161085 | 417 | bool enabled(); |
b6f411ac ML |
418 | /** Set the enabled status of this channel. |
419 | * @param value Boolean value to set. */ | |
c23c8659 | 420 | void set_enabled(bool value); |
06bd935e | 421 | /** Get the index number of this channel. */ |
3b161085 | 422 | unsigned int index(); |
c23c8659 ML |
423 | protected: |
424 | Channel(struct sr_channel *structure); | |
425 | ~Channel(); | |
3b161085 | 426 | const ChannelType * const _type; |
c23c8659 ML |
427 | friend class Device; |
428 | friend class ChannelGroup; | |
429 | friend class Session; | |
430 | friend class TriggerStage; | |
431 | }; | |
432 | ||
07443fd2 | 433 | /** A group of channels on a device, which share some configuration */ |
c23c8659 | 434 | class SR_API ChannelGroup : |
541c855e | 435 | public ParentOwned<ChannelGroup, Device, struct sr_channel_group>, |
c23c8659 ML |
436 | public Configurable |
437 | { | |
438 | public: | |
439 | /** Name of this channel group. */ | |
3b161085 | 440 | string name(); |
c23c8659 | 441 | /** List of the channels in this group. */ |
3b161085 | 442 | vector<shared_ptr<Channel> > channels(); |
c23c8659 | 443 | protected: |
6be7a7f2 | 444 | ChannelGroup(Device *device, struct sr_channel_group *structure); |
c23c8659 | 445 | ~ChannelGroup(); |
3b161085 | 446 | vector<Channel *> _channels; |
6be7a7f2 | 447 | friend class Device; |
c23c8659 ML |
448 | }; |
449 | ||
07443fd2 | 450 | /** A trigger configuration */ |
90e89c2a | 451 | class SR_API Trigger : public UserOwned<Trigger, struct sr_trigger> |
c23c8659 ML |
452 | { |
453 | public: | |
b6f411ac | 454 | /** Name of this trigger configuration. */ |
3b161085 | 455 | string name(); |
b6f411ac | 456 | /** List of the stages in this trigger. */ |
3b161085 | 457 | vector<shared_ptr<TriggerStage> > stages(); |
b6f411ac | 458 | /** Add a new stage to this trigger. */ |
c23c8659 ML |
459 | shared_ptr<TriggerStage> add_stage(); |
460 | protected: | |
461 | Trigger(shared_ptr<Context> context, string name); | |
462 | ~Trigger(); | |
3b161085 ML |
463 | shared_ptr<Context> _context; |
464 | vector<TriggerStage *> _stages; | |
b4ed33a7 | 465 | friend class Deleter; |
c23c8659 | 466 | friend class Context; |
6fa0eb86 | 467 | friend class Session; |
c23c8659 ML |
468 | }; |
469 | ||
07443fd2 | 470 | /** A stage in a trigger configuration */ |
bf52cc8c | 471 | class SR_API TriggerStage : |
541c855e | 472 | public ParentOwned<TriggerStage, Trigger, struct sr_trigger_stage> |
c23c8659 ML |
473 | { |
474 | public: | |
b6f411ac | 475 | /** Index number of this stage. */ |
3b161085 | 476 | int number(); |
b6f411ac | 477 | /** List of match conditions on this stage. */ |
3b161085 | 478 | vector<shared_ptr<TriggerMatch> > matches(); |
b6f411ac ML |
479 | /** Add a new match condition to this stage. |
480 | * @param channel Channel to match on. | |
481 | * @param type TriggerMatchType to apply. */ | |
c23c8659 | 482 | void add_match(shared_ptr<Channel> channel, const TriggerMatchType *type); |
b6f411ac ML |
483 | /** Add a new match condition to this stage. |
484 | * @param channel Channel to match on. | |
485 | * @param type TriggerMatchType to apply. | |
486 | * @param value Threshold value. */ | |
c23c8659 ML |
487 | void add_match(shared_ptr<Channel> channel, const TriggerMatchType *type, float value); |
488 | protected: | |
3b161085 | 489 | vector<TriggerMatch *> _matches; |
c23c8659 ML |
490 | TriggerStage(struct sr_trigger_stage *structure); |
491 | ~TriggerStage(); | |
492 | friend class Trigger; | |
493 | }; | |
494 | ||
07443fd2 | 495 | /** A match condition in a trigger configuration */ |
bf52cc8c | 496 | class SR_API TriggerMatch : |
541c855e | 497 | public ParentOwned<TriggerMatch, TriggerStage, struct sr_trigger_match> |
c23c8659 ML |
498 | { |
499 | public: | |
b6f411ac | 500 | /** Channel this condition matches on. */ |
3b161085 | 501 | shared_ptr<Channel> channel(); |
b6f411ac | 502 | /** Type of match. */ |
3b161085 | 503 | const TriggerMatchType *type(); |
b6f411ac | 504 | /** Threshold value. */ |
3b161085 | 505 | float value(); |
c23c8659 ML |
506 | protected: |
507 | TriggerMatch(struct sr_trigger_match *structure, shared_ptr<Channel> channel); | |
508 | ~TriggerMatch(); | |
3b161085 | 509 | shared_ptr<Channel> _channel; |
c23c8659 ML |
510 | friend class TriggerStage; |
511 | }; | |
512 | ||
513 | /** Type of datafeed callback */ | |
514 | typedef function<void(shared_ptr<Device>, shared_ptr<Packet>)> | |
515 | DatafeedCallbackFunction; | |
516 | ||
07443fd2 | 517 | /* Data required for C callback function to call a C++ datafeed callback */ |
c23c8659 ML |
518 | class SR_PRIV DatafeedCallbackData |
519 | { | |
520 | public: | |
521 | void run(const struct sr_dev_inst *sdi, | |
522 | const struct sr_datafeed_packet *pkt); | |
523 | protected: | |
3b161085 | 524 | DatafeedCallbackFunction _callback; |
c23c8659 ML |
525 | DatafeedCallbackData(Session *session, |
526 | DatafeedCallbackFunction callback); | |
3b161085 | 527 | Session *_session; |
c23c8659 ML |
528 | friend class Session; |
529 | }; | |
530 | ||
531 | /** Type of source callback */ | |
532 | typedef function<bool(Glib::IOCondition)> | |
533 | SourceCallbackFunction; | |
534 | ||
07443fd2 | 535 | /* Data required for C callback function to call a C++ source callback */ |
c23c8659 ML |
536 | class SR_PRIV SourceCallbackData |
537 | { | |
538 | public: | |
539 | bool run(int revents); | |
540 | protected: | |
541 | SourceCallbackData(shared_ptr<EventSource> source); | |
3b161085 | 542 | shared_ptr<EventSource> _source; |
c23c8659 ML |
543 | friend class Session; |
544 | }; | |
545 | ||
07443fd2 | 546 | /** An I/O event source */ |
c23c8659 ML |
547 | class SR_API EventSource |
548 | { | |
549 | public: | |
b6f411ac ML |
550 | /** Create an event source from a file descriptor. |
551 | * @param fd File descriptor. | |
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(int fd, Glib::IOCondition events, |
556 | int timeout, SourceCallbackFunction callback); | |
b6f411ac ML |
557 | /** Create an event source from a GLib PollFD |
558 | * @param pollfd GLib PollFD | |
559 | * @param timeout Timeout in milliseconds. | |
560 | * @param callback Callback of the form callback(events) */ | |
c23c8659 ML |
561 | static shared_ptr<EventSource> create(Glib::PollFD pollfd, int timeout, |
562 | SourceCallbackFunction callback); | |
b6f411ac ML |
563 | /** Create an event source from a GLib IOChannel |
564 | * @param channel GLib IOChannel. | |
565 | * @param events GLib IOCondition event mask. | |
566 | * @param timeout Timeout in milliseconds. | |
567 | * @param callback Callback of the form callback(events) */ | |
c23c8659 ML |
568 | static shared_ptr<EventSource> create( |
569 | Glib::RefPtr<Glib::IOChannel> channel, Glib::IOCondition events, | |
570 | int timeout, SourceCallbackFunction callback); | |
571 | protected: | |
572 | EventSource(int timeout, SourceCallbackFunction callback); | |
573 | ~EventSource(); | |
574 | enum source_type { | |
575 | SOURCE_FD, | |
576 | SOURCE_POLLFD, | |
577 | SOURCE_IOCHANNEL | |
3b161085 ML |
578 | } _type; |
579 | int _fd; | |
580 | Glib::PollFD _pollfd; | |
581 | Glib::RefPtr<Glib::IOChannel> _channel; | |
582 | Glib::IOCondition _events; | |
583 | int _timeout; | |
584 | SourceCallbackFunction _callback; | |
c23c8659 ML |
585 | /** Deleter needed to allow shared_ptr use with protected destructor. */ |
586 | class Deleter | |
587 | { | |
588 | public: | |
589 | void operator()(EventSource *source) { delete source; } | |
590 | }; | |
591 | friend class Deleter; | |
592 | friend class Session; | |
593 | friend class SourceCallbackData; | |
594 | }; | |
595 | ||
cac58676 ML |
596 | /** A virtual device associated with a stored session */ |
597 | class SR_API SessionDevice : | |
598 | public ParentOwned<SessionDevice, Session, struct sr_dev_inst>, | |
599 | public Device | |
600 | { | |
601 | protected: | |
602 | SessionDevice(struct sr_dev_inst *sdi); | |
603 | ~SessionDevice(); | |
604 | shared_ptr<Device> get_shared_from_this(); | |
605 | /** Deleter needed to allow shared_ptr use with protected destructor. */ | |
606 | class Deleter | |
607 | { | |
608 | public: | |
609 | void operator()(SessionDevice *device) { delete device; } | |
610 | }; | |
611 | friend class Deleter; | |
612 | friend class Session; | |
613 | }; | |
614 | ||
07443fd2 | 615 | /** A sigrok session */ |
90e89c2a | 616 | class SR_API Session : public UserOwned<Session, struct sr_session> |
c23c8659 ML |
617 | { |
618 | public: | |
b6f411ac ML |
619 | /** Add a device to this session. |
620 | * @param device Device to add. */ | |
c23c8659 ML |
621 | void add_device(shared_ptr<Device> device); |
622 | /** List devices attached to this session. */ | |
3b161085 | 623 | vector<shared_ptr<Device> > devices(); |
c23c8659 ML |
624 | /** Remove all devices from this session. */ |
625 | void remove_devices(); | |
b6f411ac ML |
626 | /** Add a datafeed callback to this session. |
627 | * @param callback Callback of the form callback(Device, Packet). */ | |
c23c8659 ML |
628 | void add_datafeed_callback(DatafeedCallbackFunction callback); |
629 | /** Remove all datafeed callbacks from this session. */ | |
630 | void remove_datafeed_callbacks(); | |
b6f411ac ML |
631 | /** Add an I/O event source. |
632 | * @param source EventSource to add. */ | |
c23c8659 | 633 | void add_source(shared_ptr<EventSource> source); |
b6f411ac ML |
634 | /** Remove an event source. |
635 | * @param source EventSource to remove. */ | |
c23c8659 ML |
636 | void remove_source(shared_ptr<EventSource> source); |
637 | /** Start the session. */ | |
638 | void start(); | |
639 | /** Run the session event loop. */ | |
640 | void run(); | |
641 | /** Stop the session. */ | |
642 | void stop(); | |
b6f411ac ML |
643 | /** Begin saving session to a file. |
644 | * @param filename File name string. */ | |
c23c8659 | 645 | void begin_save(string filename); |
b6f411ac ML |
646 | /** Append a packet to the session file being saved. |
647 | * @param packet Packet to append. */ | |
1d67cfb4 ML |
648 | void append(shared_ptr<Packet> packet); |
649 | /** Append raw logic data to the session file being saved. */ | |
650 | void append(void *data, size_t length, unsigned int unit_size); | |
6fa0eb86 | 651 | /** Get current trigger setting. */ |
3b161085 | 652 | shared_ptr<Trigger> trigger(); |
b6f411ac ML |
653 | /** Set trigger setting. |
654 | * @param trigger Trigger object to use. */ | |
6fa0eb86 | 655 | void set_trigger(shared_ptr<Trigger> trigger); |
c23c8659 ML |
656 | protected: |
657 | Session(shared_ptr<Context> context); | |
658 | Session(shared_ptr<Context> context, string filename); | |
659 | ~Session(); | |
3b161085 ML |
660 | const shared_ptr<Context> _context; |
661 | map<const struct sr_dev_inst *, shared_ptr<Device> > _devices; | |
662 | vector<DatafeedCallbackData *> _datafeed_callbacks; | |
663 | map<shared_ptr<EventSource>, SourceCallbackData *> _source_callbacks; | |
664 | bool _saving; | |
665 | bool _save_initialized; | |
666 | string _save_filename; | |
667 | uint64_t _save_samplerate; | |
668 | shared_ptr<Trigger> _trigger; | |
c23c8659 ML |
669 | friend class Deleter; |
670 | friend class Context; | |
671 | friend class DatafeedCallbackData; | |
672 | }; | |
673 | ||
07443fd2 | 674 | /** A packet on the session datafeed */ |
90e89c2a | 675 | class SR_API Packet : public UserOwned<Packet, const struct sr_datafeed_packet> |
c23c8659 ML |
676 | { |
677 | public: | |
90ba83f2 | 678 | /** Type of this packet. */ |
3b161085 | 679 | const PacketType *type(); |
c23c8659 | 680 | /** Payload of this packet. */ |
3b161085 | 681 | shared_ptr<PacketPayload> payload(); |
c23c8659 | 682 | protected: |
2928f47d ML |
683 | Packet(shared_ptr<Device> device, |
684 | const struct sr_datafeed_packet *structure); | |
c23c8659 | 685 | ~Packet(); |
3b161085 ML |
686 | shared_ptr<Device> _device; |
687 | PacketPayload *_payload; | |
c23c8659 ML |
688 | friend class Deleter; |
689 | friend class Session; | |
690 | friend class Output; | |
691 | friend class DatafeedCallbackData; | |
2928f47d ML |
692 | friend class Header; |
693 | friend class Meta; | |
694 | friend class Logic; | |
695 | friend class Analog; | |
c23c8659 ML |
696 | }; |
697 | ||
07443fd2 | 698 | /** Abstract base class for datafeed packet payloads */ |
c23c8659 ML |
699 | class SR_API PacketPayload |
700 | { | |
701 | protected: | |
702 | PacketPayload(); | |
703 | virtual ~PacketPayload() = 0; | |
4cd883a7 | 704 | virtual shared_ptr<PacketPayload> get_shared_pointer(Packet *parent) = 0; |
2928f47d ML |
705 | /** Deleter needed to allow shared_ptr use with protected destructor. */ |
706 | class Deleter | |
707 | { | |
708 | public: | |
709 | void operator()(PacketPayload *payload) { delete payload; } | |
710 | }; | |
711 | friend class Deleter; | |
c23c8659 ML |
712 | friend class Packet; |
713 | friend class Output; | |
714 | }; | |
715 | ||
2928f47d | 716 | /** Payload of a datafeed header packet */ |
4cd883a7 | 717 | class SR_API Header : |
541c855e | 718 | public ParentOwned<Header, Packet, const struct sr_datafeed_header>, |
4cd883a7 | 719 | public PacketPayload |
2928f47d ML |
720 | { |
721 | public: | |
b6f411ac | 722 | /* Feed version number. */ |
3b161085 | 723 | int feed_version(); |
b6f411ac | 724 | /* Start time of this session. */ |
3b161085 | 725 | Glib::TimeVal start_time(); |
2928f47d ML |
726 | protected: |
727 | Header(const struct sr_datafeed_header *structure); | |
728 | ~Header(); | |
4cd883a7 | 729 | shared_ptr<PacketPayload> get_shared_pointer(Packet *parent); |
2928f47d ML |
730 | friend class Packet; |
731 | }; | |
732 | ||
733 | /** Payload of a datafeed metadata packet */ | |
4cd883a7 | 734 | class SR_API Meta : |
541c855e | 735 | public ParentOwned<Meta, Packet, const struct sr_datafeed_meta>, |
4cd883a7 | 736 | public PacketPayload |
2928f47d ML |
737 | { |
738 | public: | |
b6f411ac | 739 | /* Mapping of (ConfigKey, value) pairs. */ |
3b161085 | 740 | map<const ConfigKey *, Glib::VariantBase> config(); |
2928f47d ML |
741 | protected: |
742 | Meta(const struct sr_datafeed_meta *structure); | |
743 | ~Meta(); | |
4cd883a7 | 744 | shared_ptr<PacketPayload> get_shared_pointer(Packet *parent); |
3b161085 | 745 | map<const ConfigKey *, Glib::VariantBase> _config; |
2928f47d ML |
746 | friend class Packet; |
747 | }; | |
748 | ||
07443fd2 | 749 | /** Payload of a datafeed packet with logic data */ |
4cd883a7 | 750 | class SR_API Logic : |
541c855e | 751 | public ParentOwned<Logic, Packet, const struct sr_datafeed_logic>, |
4cd883a7 | 752 | public PacketPayload |
c23c8659 | 753 | { |
2928f47d ML |
754 | public: |
755 | /* Pointer to data. */ | |
3b161085 | 756 | void *data_pointer(); |
2928f47d | 757 | /* Data length in bytes. */ |
3b161085 | 758 | size_t data_length(); |
2928f47d | 759 | /* Size of each sample in bytes. */ |
3b161085 | 760 | unsigned int unit_size(); |
c23c8659 ML |
761 | protected: |
762 | Logic(const struct sr_datafeed_logic *structure); | |
763 | ~Logic(); | |
4cd883a7 | 764 | shared_ptr<PacketPayload> get_shared_pointer(Packet *parent); |
c23c8659 ML |
765 | friend class Packet; |
766 | }; | |
767 | ||
07443fd2 | 768 | /** Payload of a datafeed packet with analog data */ |
4cd883a7 | 769 | class SR_API Analog : |
541c855e | 770 | public ParentOwned<Analog, Packet, const struct sr_datafeed_analog>, |
4cd883a7 | 771 | public PacketPayload |
c23c8659 ML |
772 | { |
773 | public: | |
2928f47d | 774 | /** Pointer to data. */ |
3b161085 | 775 | float *data_pointer(); |
c23c8659 | 776 | /** Number of samples in this packet. */ |
3b161085 | 777 | unsigned int num_samples(); |
2928f47d | 778 | /** Channels for which this packet contains data. */ |
3b161085 | 779 | vector<shared_ptr<Channel> > channels(); |
c23c8659 | 780 | /** Measured quantity of the samples in this packet. */ |
3b161085 | 781 | const Quantity *mq(); |
c23c8659 | 782 | /** Unit of the samples in this packet. */ |
3b161085 | 783 | const Unit *unit(); |
c23c8659 | 784 | /** Measurement flags associated with the samples in this packet. */ |
3b161085 | 785 | vector<const QuantityFlag *> mq_flags(); |
c23c8659 ML |
786 | protected: |
787 | Analog(const struct sr_datafeed_analog *structure); | |
788 | ~Analog(); | |
4cd883a7 | 789 | shared_ptr<PacketPayload> get_shared_pointer(Packet *parent); |
c23c8659 ML |
790 | friend class Packet; |
791 | }; | |
792 | ||
07443fd2 | 793 | /** An input format supported by the library */ |
c23c8659 | 794 | class SR_API InputFormat : |
541c855e | 795 | public ParentOwned<InputFormat, Context, const struct sr_input_module> |
c23c8659 ML |
796 | { |
797 | public: | |
798 | /** Name of this input format. */ | |
3b161085 | 799 | string name(); |
c23c8659 | 800 | /** Description of this input format. */ |
3b161085 | 801 | string description(); |
ca3291e3 | 802 | /** Options supported by this input format. */ |
3b161085 | 803 | map<string, shared_ptr<Option> > options(); |
ca3291e3 ML |
804 | /** Create an input using this input format. |
805 | * @param options Mapping of (option name, value) pairs. */ | |
db560903 ML |
806 | shared_ptr<Input> create_input(map<string, Glib::VariantBase> options = |
807 | map<string, Glib::VariantBase>()); | |
c23c8659 | 808 | protected: |
ca3291e3 | 809 | InputFormat(const struct sr_input_module *structure); |
c23c8659 ML |
810 | ~InputFormat(); |
811 | friend class Context; | |
ca3291e3 | 812 | friend class InputDevice; |
c23c8659 ML |
813 | }; |
814 | ||
ca3291e3 | 815 | /** An input instance (an input format applied to a file or stream) */ |
90e89c2a | 816 | class SR_API Input : public UserOwned<Input, const struct sr_input> |
c23c8659 ML |
817 | { |
818 | public: | |
ca3291e3 | 819 | /** Virtual device associated with this input. */ |
3b161085 | 820 | shared_ptr<InputDevice> device(); |
ca3291e3 ML |
821 | /** Send next stream data. |
822 | * @param data Next stream data. */ | |
823 | void send(string data); | |
9c51e8ec ML |
824 | /** Signal end of input data. */ |
825 | void end(); | |
c23c8659 | 826 | protected: |
ca3291e3 ML |
827 | Input(shared_ptr<Context> context, const struct sr_input *structure); |
828 | ~Input(); | |
3b161085 ML |
829 | shared_ptr<Context> _context; |
830 | InputDevice *_device; | |
c23c8659 | 831 | friend class Deleter; |
ca3291e3 | 832 | friend class Context; |
c23c8659 ML |
833 | friend class InputFormat; |
834 | }; | |
835 | ||
ca3291e3 | 836 | /** A virtual device associated with an input */ |
6e5240f4 | 837 | class SR_API InputDevice : |
541c855e | 838 | public ParentOwned<InputDevice, Input, struct sr_dev_inst>, |
6e5240f4 | 839 | public Device |
ca3291e3 ML |
840 | { |
841 | protected: | |
842 | InputDevice(shared_ptr<Input> input, struct sr_dev_inst *sdi); | |
843 | ~InputDevice(); | |
d01d2314 | 844 | shared_ptr<Device> get_shared_from_this(); |
3b161085 | 845 | shared_ptr<Input> _input; |
ca3291e3 ML |
846 | friend class Input; |
847 | }; | |
848 | ||
58aa1f83 | 849 | /** An option used by an output format */ |
90e89c2a | 850 | class SR_API Option : public UserOwned<Option, const struct sr_option> |
58aa1f83 ML |
851 | { |
852 | public: | |
853 | /** Short name of this option suitable for command line usage. */ | |
3b161085 | 854 | string id(); |
58aa1f83 | 855 | /** Short name of this option suitable for GUI usage. */ |
3b161085 | 856 | string name(); |
58aa1f83 | 857 | /** Description of this option in a sentence. */ |
3b161085 | 858 | string description(); |
58aa1f83 | 859 | /** Default value for this option. */ |
3b161085 | 860 | Glib::VariantBase default_value(); |
58aa1f83 | 861 | /** Possible values for this option, if a limited set. */ |
3b161085 | 862 | vector<Glib::VariantBase> values(); |
58aa1f83 ML |
863 | protected: |
864 | Option(const struct sr_option *structure, | |
70d3b20b | 865 | shared_ptr<const struct sr_option *> structure_array); |
58aa1f83 | 866 | ~Option(); |
3b161085 | 867 | shared_ptr<const struct sr_option *> _structure_array; |
58aa1f83 | 868 | friend class Deleter; |
43942280 | 869 | friend class InputFormat; |
58aa1f83 ML |
870 | friend class OutputFormat; |
871 | }; | |
872 | ||
07443fd2 | 873 | /** An output format supported by the library */ |
c23c8659 | 874 | class SR_API OutputFormat : |
541c855e | 875 | public ParentOwned<OutputFormat, Context, const struct sr_output_module> |
c23c8659 ML |
876 | { |
877 | public: | |
878 | /** Name of this output format. */ | |
3b161085 | 879 | string name(); |
c23c8659 | 880 | /** Description of this output format. */ |
3b161085 | 881 | string description(); |
58aa1f83 | 882 | /** Options supported by this output format. */ |
3b161085 | 883 | map<string, shared_ptr<Option> > options(); |
b6f411ac ML |
884 | /** Create an output using this format. |
885 | * @param device Device to output for. | |
886 | * @param options Mapping of (option name, value) pairs. */ | |
58aa1f83 | 887 | shared_ptr<Output> create_output(shared_ptr<Device> device, |
db560903 ML |
888 | map<string, Glib::VariantBase> options = |
889 | map<string, Glib::VariantBase>()); | |
c23c8659 | 890 | protected: |
58aa1f83 | 891 | OutputFormat(const struct sr_output_module *structure); |
c23c8659 ML |
892 | ~OutputFormat(); |
893 | friend class Context; | |
894 | friend class Output; | |
895 | }; | |
896 | ||
07443fd2 | 897 | /** An output instance (an output format applied to a device) */ |
90e89c2a | 898 | class SR_API Output : public UserOwned<Output, const struct sr_output> |
c23c8659 ML |
899 | { |
900 | public: | |
b6f411ac ML |
901 | /** Update output with data from the given packet. |
902 | * @param packet Packet to handle. */ | |
c23c8659 ML |
903 | string receive(shared_ptr<Packet> packet); |
904 | protected: | |
905 | Output(shared_ptr<OutputFormat> format, shared_ptr<Device> device); | |
906 | Output(shared_ptr<OutputFormat> format, | |
58aa1f83 | 907 | shared_ptr<Device> device, map<string, Glib::VariantBase> options); |
c23c8659 | 908 | ~Output(); |
3b161085 ML |
909 | const shared_ptr<OutputFormat> _format; |
910 | const shared_ptr<Device> _device; | |
911 | const map<string, Glib::VariantBase> _options; | |
c23c8659 ML |
912 | friend class Deleter; |
913 | friend class OutputFormat; | |
914 | }; | |
915 | ||
916 | /** Base class for objects which wrap an enumeration value from libsigrok */ | |
917 | template <typename T> class SR_API EnumValue | |
918 | { | |
919 | public: | |
920 | /** The enum constant associated with this value. */ | |
3b161085 | 921 | T id() const { return _id; } |
c23c8659 | 922 | /** The name associated with this value. */ |
3b161085 | 923 | string name() const { return _name; } |
c23c8659 | 924 | protected: |
3b161085 | 925 | EnumValue(T id, const char name[]) : _id(id), _name(name) {} |
c23c8659 | 926 | ~EnumValue() {} |
3b161085 ML |
927 | const T _id; |
928 | const string _name; | |
c23c8659 ML |
929 | }; |
930 | ||
931 | #include "enums.hpp" | |
932 | ||
933 | } | |
934 | ||
935 | #endif // LIBSIGROK_HPP |