bindings/cxx/include/libsigrok/libsigrok.hpp

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