bindings/cxx/include/libsigrokcxx/libsigrokcxx.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 libsigrokcxx API provides an object-oriented C++ interface to the
  28 functionality 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 libsigrokcxx objects and their underlying
  49 libsigrok resources can be treated as fully automatic. As long as all shared
  50 pointers to objects are deleted or reassigned when no longer in use, all
  51 underlying 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 LIBSIGROKCXX_HPP
  71 #define LIBSIGROKCXX_HPP
  72
  73 #include <libsigrok/libsigrok.h>
  74 #include <glibmm.h>
  75
  76 #include <stdexcept>
  77 #include <memory>
  78 #include <vector>
  79 #include <map>
  80 #include <set>
  81
  82 namespace sigrok
  83 {
  84
  85 using namespace std;
  86
  87 /* Forward declarations */
  88 class SR_API Error;
  89 class SR_API Context;
  90 class SR_API Driver;
  91 class SR_API Device;
  92 class SR_API HardwareDevice;
  93 class SR_API Channel;
  94 class SR_API EventSource;
  95 class SR_API Session;
  96 class SR_API ConfigKey;
  97 class SR_API InputFormat;
  98 class SR_API OutputFormat;
  99 class SR_API OutputFlag;
 100 class SR_API LogLevel;
 101 class SR_API ChannelGroup;
 102 class SR_API Trigger;
 103 class SR_API TriggerStage;
 104 class SR_API TriggerMatch;
 105 class SR_API TriggerMatchType;
 106 class SR_API ChannelType;
 107 class SR_API Packet;
 108 class SR_API PacketPayload;
 109 class SR_API PacketType;
 110 class SR_API Quantity;
 111 class SR_API Unit;
 112 class SR_API QuantityFlag;
 113 class SR_API Input;
 114 class SR_API InputDevice;
 115 class SR_API Output;
 116 class SR_API DataType;
 117 class SR_API Option;
 118 class SR_API UserDevice;
 119
 120 /** Exception thrown when an error code is returned by any libsigrok call. */
 121 class SR_API Error: public exception
 122 {
 123 public:
 124         Error(int result);
 125         ~Error() throw();
 126         const int result;
 127         const char *what() const throw();
 128 };
 129
 130 /* Base template for classes whose resources are owned by a parent object. */
 131 template <class Class, class Parent, typename Struct>
 132 class SR_API ParentOwned
 133 {
 134 protected:
 135         /*  Parent object which owns this child object's underlying structure.
 136
 137                 This shared pointer will be null when this child is unused, but
 138                 will be assigned to point to the parent before any shared pointer
 139                 to this child is handed out to the user.
 140
 141                 When the reference count of this child falls to zero, this shared
 142                 pointer to its parent is reset by a custom deleter on the child's
 143                 shared pointer.
 144
 145                 This strategy ensures that the destructors for both the child and
 146                 the parent are called at the correct time, i.e. only when all
 147                 references to both the parent and all its children are gone. */
 148         shared_ptr<Parent> _parent;
 149
 150         /* Weak pointer for shared_from_this() implementation. */
 151         weak_ptr<Class> _weak_this;
 152
 153 public:
 154         /* Get parent object that owns this object. */
 155         shared_ptr<Parent> parent()
 156         {
 157                 return _parent;
 158         }
 159
 160         /* Note, this implementation will create a new smart_ptr if none exists. */
 161         shared_ptr<Class> shared_from_this()
 162         {
 163                 shared_ptr<Class> shared;
 164
 165                 if (!(shared = _weak_this.lock()))
 166                 {
 167                         shared = shared_ptr<Class>((Class *) this, reset_parent);
 168                         _weak_this = shared;
 169                 }
 170
 171                 return shared;
 172         }
 173
 174         shared_ptr<Class> get_shared_pointer(shared_ptr<Parent> parent)
 175         {
 176                 if (!parent)
 177                         throw Error(SR_ERR_BUG);
 178                 this->_parent = parent;
 179                 return shared_from_this();
 180         }
 181
 182         shared_ptr<Class> get_shared_pointer(Parent *parent)
 183         {
 184                 if (!parent)
 185                         throw Error(SR_ERR_BUG);
 186                 return get_shared_pointer(parent->shared_from_this());
 187         }
 188 protected:
 189         static void reset_parent(Class *object)
 190         {
 191                 if (!object->_parent)
 192                         throw Error(SR_ERR_BUG);
 193                 object->_parent.reset();
 194         }
 195
 196         Struct *_structure;
 197
 198         ParentOwned<Class, Parent, Struct>(Struct *structure) :
 199                 _structure(structure)
 200         {
 201         }
 202 };
 203
 204 /* Base template for classes whose resources are owned by the user. */
 205 template <class Class, typename Struct>
 206 class SR_API UserOwned : public enable_shared_from_this<Class>
 207 {
 208 public:
 209         shared_ptr<Class> shared_from_this()
 210         {
 211                 auto shared = enable_shared_from_this<Class>::shared_from_this();
 212                 if (!shared)
 213                         throw Error(SR_ERR_BUG);
 214                 return shared;
 215         }
 216 protected:
 217         Struct *_structure;
 218
 219         UserOwned<Class, Struct>(Struct *structure) :
 220                 _structure(structure)
 221         {
 222         }
 223
 224         /* Deleter needed to allow shared_ptr use with protected destructor. */
 225         class Deleter
 226         {
 227         public:
 228                 void operator()(Class *object) { delete object; }
 229         };
 230 };
 231
 232 /** Type of log callback */
 233 typedef function<void(const LogLevel *, string message)> LogCallbackFunction;
 234
 235 /** Resource reader delegate. */
 236 class SR_API ResourceReader
 237 {
 238 public:
 239         ResourceReader() {}
 240         virtual ~ResourceReader();
 241 private:
 242         /** Resource open hook. */
 243         virtual void open(struct sr_resource *res, string name) = 0;
 244         /** Resource close hook. */
 245         virtual void close(struct sr_resource *res) = 0;
 246         /** Resource read hook. */
 247         virtual size_t read(const struct sr_resource *res, void *buf, size_t count) = 0;
 248
 249         static SR_PRIV int open_callback(struct sr_resource *res,
 250                         const char *name, void *cb_data);
 251         static SR_PRIV int close_callback(struct sr_resource *res,
 252                         void *cb_data);
 253         static SR_PRIV ssize_t read_callback(const struct sr_resource *res,
 254                         void *buf, size_t count, void *cb_data);
 255         friend class Context;
 256 };
 257
 258 /** The global libsigrok context */
 259 class SR_API Context : public UserOwned<Context, struct sr_context>
 260 {
 261 public:
 262         /** Create new context */
 263         static shared_ptr<Context> create();
 264         /** libsigrok package version. */
 265         string package_version();
 266         /** libsigrok library version. */
 267         string lib_version();
 268         /** Available hardware drivers, indexed by name. */
 269         map<string, shared_ptr<Driver> > drivers();
 270         /** Available input formats, indexed by name. */
 271         map<string, shared_ptr<InputFormat> > input_formats();
 272         /** Available output formats, indexed by name. */
 273         map<string, shared_ptr<OutputFormat> > output_formats();
 274         /** Current log level. */
 275         const LogLevel *log_level();
 276         /** Set the log level.
 277          * @param level LogLevel to use. */
 278         void set_log_level(const LogLevel *level);
 279         /** Set the log callback.
 280          * @param callback Callback of the form callback(LogLevel, string). */
 281         void set_log_callback(LogCallbackFunction callback);
 282         /** Set the log callback to the default handler. */
 283         void set_log_callback_default();
 284         /** Install a delegate for reading resource files.
 285          * @param reader The resource reader delegate, or nullptr to unset. */
 286         void set_resource_reader(ResourceReader *reader);
 287         /** Create a new session. */
 288         shared_ptr<Session> create_session();
 289         /** Create a new user device. */
 290         shared_ptr<UserDevice> create_user_device(
 291                 string vendor, string model, string version);
 292         /** Create a header packet. */
 293         shared_ptr<Packet> create_header_packet(Glib::TimeVal start_time);
 294         /** Create a meta packet. */
 295         shared_ptr<Packet> create_meta_packet(
 296                 map<const ConfigKey *, Glib::VariantBase> config);
 297         /** Create a logic packet. */
 298         shared_ptr<Packet> create_logic_packet(
 299                 void *data_pointer, size_t data_length, unsigned int unit_size);
 300         /** Create an analog packet. */
 301         shared_ptr<Packet> create_analog_packet(
 302                 vector<shared_ptr<Channel> > channels,
 303                 float *data_pointer, unsigned int num_samples, const Quantity *mq,
 304                 const Unit *unit, vector<const QuantityFlag *> mqflags);
 305         /** Load a saved session.
 306          * @param filename File name string. */
 307         shared_ptr<Session> load_session(string filename);
 308         /** Create a new trigger.
 309          * @param name Name string for new trigger. */
 310         shared_ptr<Trigger> create_trigger(string name);
 311         /** Open an input file.
 312          * @param filename File name string. */
 313         shared_ptr<Input> open_file(string filename);
 314         /** Open an input stream based on header data.
 315          * @param header Initial data from stream. */
 316         shared_ptr<Input> open_stream(string header);
 317         map<string, string> serials(shared_ptr<Driver> driver);
 318 protected:
 319         map<string, Driver *> _drivers;
 320         map<string, InputFormat *> _input_formats;
 321         map<string, OutputFormat *> _output_formats;
 322         Session *_session;
 323         LogCallbackFunction _log_callback;
 324         Context();
 325         ~Context();
 326         friend class Deleter;
 327         friend class Session;
 328         friend class Driver;
 329 };
 330
 331 enum Capability {
 332         GET = SR_CONF_GET,
 333         SET = SR_CONF_SET,
 334         LIST = SR_CONF_LIST
 335 };
 336
 337 /** An object that can be configured. */
 338 class SR_API Configurable
 339 {
 340 public:
 341         /** Read configuration for the given key.
 342          * @param key ConfigKey to read. */
 343         Glib::VariantBase config_get(const ConfigKey *key);
 344         /** Set configuration for the given key to a specified value.
 345          * @param key ConfigKey to set.
 346          * @param value Value to set. */
 347         void config_set(const ConfigKey *key, Glib::VariantBase value);
 348         /** Enumerate available values for the given configuration key.
 349          * @param key ConfigKey to enumerate values for. */
 350         Glib::VariantContainerBase config_list(const ConfigKey *key);
 351         /** Enumerate available keys, according to a given index key. */
 352         map<const ConfigKey *, set<Capability> > config_keys(const ConfigKey *key);
 353         /** Check for a key in the list from a given index key. */
 354         bool config_check(const ConfigKey *key, const ConfigKey *index_key);
 355 protected:
 356         Configurable(
 357                 struct sr_dev_driver *driver,
 358                 struct sr_dev_inst *sdi,
 359                 struct sr_channel_group *channel_group);
 360         virtual ~Configurable();
 361         struct sr_dev_driver *config_driver;
 362         struct sr_dev_inst *config_sdi;
 363         struct sr_channel_group *config_channel_group;
 364 };
 365
 366 /** A hardware driver provided by the library */
 367 class SR_API Driver :
 368         public ParentOwned<Driver, Context, struct sr_dev_driver>,
 369         public Configurable
 370 {
 371 public:
 372         /** Name of this driver. */
 373         string name();
 374         /** Long name for this driver. */
 375         string long_name();
 376         /** Scan for devices and return a list of devices found.
 377          * @param options Mapping of (ConfigKey, value) pairs. */
 378         vector<shared_ptr<HardwareDevice> > scan(
 379                 map<const ConfigKey *, Glib::VariantBase> options =
 380                         map<const ConfigKey *, Glib::VariantBase>());
 381 protected:
 382         bool _initialized;
 383         vector<HardwareDevice *> _devices;
 384         Driver(struct sr_dev_driver *structure);
 385         ~Driver();
 386         friend class Context;
 387         friend class HardwareDevice;
 388         friend class ChannelGroup;
 389 };
 390
 391 /** A generic device, either hardware or virtual */
 392 class SR_API Device : public Configurable
 393 {
 394 public:
 395         /** Vendor name for this device. */
 396         string vendor();
 397         /** Model name for this device. */
 398         string model();
 399         /** Version string for this device. */
 400         string version();
 401         /** Serial number for this device. */
 402         string serial_number();
 403         /** Connection ID for this device. */
 404         string connection_id();
 405         /** List of the channels available on this device. */
 406         vector<shared_ptr<Channel> > channels();
 407         /** Channel groups available on this device, indexed by name. */
 408         map<string, shared_ptr<ChannelGroup> > channel_groups();
 409         /** Open device. */
 410         void open();
 411         /** Close device. */
 412         void close();
 413 protected:
 414         Device(struct sr_dev_inst *structure);
 415         ~Device();
 416         virtual shared_ptr<Device> get_shared_from_this() = 0;
 417         shared_ptr<Channel> get_channel(struct sr_channel *ptr);
 418         struct sr_dev_inst *_structure;
 419         map<struct sr_channel *, Channel *> _channels;
 420         map<string, ChannelGroup *> _channel_groups;
 421         /** Deleter needed to allow shared_ptr use with protected destructor. */
 422         class Deleter
 423         {
 424         public:
 425                 void operator()(Device *device) { delete device; }
 426         };
 427         friend class Deleter;
 428         friend class Session;
 429         friend class Channel;
 430         friend class ChannelGroup;
 431         friend class Output;
 432         friend class Analog;
 433 };
 434
 435 /** A real hardware device, connected via a driver */
 436 class SR_API HardwareDevice :
 437         public UserOwned<HardwareDevice, struct sr_dev_inst>,
 438         public Device
 439 {
 440 public:
 441         /** Driver providing this device. */
 442         shared_ptr<Driver> driver();
 443 protected:
 444         HardwareDevice(shared_ptr<Driver> driver, struct sr_dev_inst *structure);
 445         ~HardwareDevice();
 446         shared_ptr<Device> get_shared_from_this();
 447         shared_ptr<Driver> _driver;
 448         /** Deleter needed to allow shared_ptr use with protected destructor. */
 449         class Deleter
 450         {
 451         public:
 452                 void operator()(HardwareDevice *device) { delete device; }
 453         };
 454         friend class Deleter;
 455         friend class Driver;
 456         friend class ChannelGroup;
 457 };
 458
 459 /** A virtual device, created by the user */
 460 class SR_API UserDevice :
 461         public UserOwned<UserDevice, struct sr_dev_inst>,
 462         public Device
 463 {
 464 public:
 465         /** Add a new channel to this device. */
 466         shared_ptr<Channel> add_channel(unsigned int index, const ChannelType *type, string name);
 467 protected:
 468         UserDevice(string vendor, string model, string version);
 469         ~UserDevice();
 470         shared_ptr<Device> get_shared_from_this();
 471         /** Deleter needed to allow shared_ptr use with protected destructor. */
 472         class Deleter
 473         {
 474         public:
 475                 void operator()(UserDevice *device) { delete device; }
 476         };
 477         friend class Context;
 478         friend class Deleter;
 479 };
 480
 481 /** A channel on a device */
 482 class SR_API Channel :
 483         public ParentOwned<Channel, Device, struct sr_channel>
 484 {
 485 public:
 486         /** Current name of this channel. */
 487         string name();
 488         /** Set the name of this channel. *
 489          * @param name Name string to set. */
 490         void set_name(string name);
 491         /** Type of this channel. */
 492         const ChannelType *type();
 493         /** Enabled status of this channel. */
 494         bool enabled();
 495         /** Set the enabled status of this channel.
 496          * @param value Boolean value to set. */
 497         void set_enabled(bool value);
 498         /** Get the index number of this channel. */
 499         unsigned int index();
 500 protected:
 501         Channel(struct sr_channel *structure);
 502         ~Channel();
 503         const ChannelType * const _type;
 504         friend class Device;
 505         friend class UserDevice;
 506         friend class ChannelGroup;
 507         friend class Session;
 508         friend class TriggerStage;
 509         friend class Context;
 510 };
 511
 512 /** A group of channels on a device, which share some configuration */
 513 class SR_API ChannelGroup :
 514         public ParentOwned<ChannelGroup, Device, struct sr_channel_group>,
 515         public Configurable
 516 {
 517 public:
 518         /** Name of this channel group. */
 519         string name();
 520         /** List of the channels in this group. */
 521         vector<shared_ptr<Channel> > channels();
 522 protected:
 523         ChannelGroup(Device *device, struct sr_channel_group *structure);
 524         ~ChannelGroup();
 525         vector<Channel *> _channels;
 526         friend class Device;
 527 };
 528
 529 /** A trigger configuration */
 530 class SR_API Trigger : public UserOwned<Trigger, struct sr_trigger>
 531 {
 532 public:
 533         /** Name of this trigger configuration. */
 534         string name();
 535         /** List of the stages in this trigger. */
 536         vector<shared_ptr<TriggerStage> > stages();
 537         /** Add a new stage to this trigger. */
 538         shared_ptr<TriggerStage> add_stage();
 539 protected:
 540         Trigger(shared_ptr<Context> context, string name);
 541         ~Trigger();
 542         shared_ptr<Context> _context;
 543         vector<TriggerStage *> _stages;
 544         friend class Deleter;
 545         friend class Context;
 546         friend class Session;
 547 };
 548
 549 /** A stage in a trigger configuration */
 550 class SR_API TriggerStage :
 551         public ParentOwned<TriggerStage, Trigger, struct sr_trigger_stage>
 552 {
 553 public:
 554         /** Index number of this stage. */
 555         int number();
 556         /** List of match conditions on this stage. */
 557         vector<shared_ptr<TriggerMatch> > matches();
 558         /** Add a new match condition to this stage.
 559          * @param channel Channel to match on.
 560          * @param type TriggerMatchType to apply. */
 561         void add_match(shared_ptr<Channel> channel, const TriggerMatchType *type);
 562         /** Add a new match condition to this stage.
 563          * @param channel Channel to match on.
 564          * @param type TriggerMatchType to apply.
 565          * @param value Threshold value. */
 566         void add_match(shared_ptr<Channel> channel, const TriggerMatchType *type, float value);
 567 protected:
 568         vector<TriggerMatch *> _matches;
 569         TriggerStage(struct sr_trigger_stage *structure);
 570         ~TriggerStage();
 571         friend class Trigger;
 572 };
 573
 574 /** A match condition in a trigger configuration  */
 575 class SR_API TriggerMatch :
 576         public ParentOwned<TriggerMatch, TriggerStage, struct sr_trigger_match>
 577 {
 578 public:
 579         /** Channel this condition matches on. */
 580         shared_ptr<Channel> channel();
 581         /** Type of match. */
 582         const TriggerMatchType *type();
 583         /** Threshold value. */
 584         float value();
 585 protected:
 586         TriggerMatch(struct sr_trigger_match *structure, shared_ptr<Channel> channel);
 587         ~TriggerMatch();
 588         shared_ptr<Channel> _channel;
 589         friend class TriggerStage;
 590 };
 591
 592 /** Type of session stopped callback */
 593 typedef function<void()> SessionStoppedCallback;
 594
 595 /** Type of datafeed callback */
 596 typedef function<void(shared_ptr<Device>, shared_ptr<Packet>)>
 597         DatafeedCallbackFunction;
 598
 599 /* Data required for C callback function to call a C++ datafeed callback */
 600 class SR_PRIV DatafeedCallbackData
 601 {
 602 public:
 603         void run(const struct sr_dev_inst *sdi,
 604                 const struct sr_datafeed_packet *pkt);
 605 protected:
 606         DatafeedCallbackFunction _callback;
 607         DatafeedCallbackData(Session *session,
 608                 DatafeedCallbackFunction callback);
 609         Session *_session;
 610         friend class Session;
 611 };
 612
 613 /** Type of source callback */
 614 typedef function<bool(Glib::IOCondition)>
 615         SourceCallbackFunction;
 616
 617 /* Data required for C callback function to call a C++ source callback */
 618 class SR_PRIV SourceCallbackData
 619 {
 620 public:
 621         bool run(int revents);
 622 protected:
 623         SourceCallbackData(shared_ptr<EventSource> source);
 624         shared_ptr<EventSource> _source;
 625         friend class Session;
 626 };
 627
 628 /** An I/O event source */
 629 class SR_API EventSource
 630 {
 631 public:
 632         /** Create an event source from a file descriptor.
 633          * @param fd File descriptor.
 634          * @param events GLib IOCondition event mask.
 635          * @param timeout Timeout in milliseconds.
 636          * @param callback Callback of the form callback(events) */
 637         static shared_ptr<EventSource> create(int fd, Glib::IOCondition events,
 638                 int timeout, SourceCallbackFunction callback);
 639         /** Create an event source from a GLib PollFD
 640          * @param pollfd GLib PollFD
 641          * @param timeout Timeout in milliseconds.
 642          * @param callback Callback of the form callback(events) */
 643         static shared_ptr<EventSource> create(Glib::PollFD pollfd, int timeout,
 644                 SourceCallbackFunction callback);
 645         /** Create an event source from a GLib IOChannel
 646          * @param channel GLib IOChannel.
 647          * @param events GLib IOCondition event mask.
 648          * @param timeout Timeout in milliseconds.
 649          * @param callback Callback of the form callback(events) */
 650         static shared_ptr<EventSource> create(
 651                 Glib::RefPtr<Glib::IOChannel> channel, Glib::IOCondition events,
 652                 int timeout, SourceCallbackFunction callback);
 653 protected:
 654         EventSource(int timeout, SourceCallbackFunction callback);
 655         ~EventSource();
 656         enum source_type {
 657                 SOURCE_FD,
 658                 SOURCE_POLLFD,
 659                 SOURCE_IOCHANNEL
 660         } _type;
 661         int _fd;
 662         Glib::PollFD _pollfd;
 663         Glib::RefPtr<Glib::IOChannel> _channel;
 664         Glib::IOCondition _events;
 665         int _timeout;
 666         SourceCallbackFunction _callback;
 667         /** Deleter needed to allow shared_ptr use with protected destructor. */
 668         class Deleter
 669         {
 670         public:
 671                 void operator()(EventSource *source) { delete source; }
 672         };
 673         friend class Deleter;
 674         friend class Session;
 675         friend class SourceCallbackData;
 676 };
 677
 678 /** A virtual device associated with a stored session */
 679 class SR_API SessionDevice :
 680         public ParentOwned<SessionDevice, Session, struct sr_dev_inst>,
 681         public Device
 682 {
 683 protected:
 684         SessionDevice(struct sr_dev_inst *sdi);
 685         ~SessionDevice();
 686         shared_ptr<Device> get_shared_from_this();
 687         /** Deleter needed to allow shared_ptr use with protected destructor. */
 688         class Deleter
 689         {
 690         public:
 691                 void operator()(SessionDevice *device) { delete device; }
 692         };
 693         friend class Deleter;
 694         friend class Session;
 695 };
 696
 697 /** A sigrok session */
 698 class SR_API Session : public UserOwned<Session, struct sr_session>
 699 {
 700 public:
 701         /** Add a device to this session.
 702          * @param device Device to add. */
 703         void add_device(shared_ptr<Device> device);
 704         /** List devices attached to this session. */
 705         vector<shared_ptr<Device> > devices();
 706         /** Remove all devices from this session. */
 707         void remove_devices();
 708         /** Add a datafeed callback to this session.
 709          * @param callback Callback of the form callback(Device, Packet). */
 710         void add_datafeed_callback(DatafeedCallbackFunction callback);
 711         /** Remove all datafeed callbacks from this session. */
 712         void remove_datafeed_callbacks();
 713         /** Add an I/O event source.
 714          * @param source EventSource to add. */
 715         void add_source(shared_ptr<EventSource> source);
 716         /** Remove an event source.
 717          * @param source EventSource to remove. */
 718         void remove_source(shared_ptr<EventSource> source);
 719         /** Start the session. */
 720         void start();
 721         /** Run the session event loop. */
 722         void run();
 723         /** Stop the session. */
 724         void stop();
 725         /** Return whether the session is running. */
 726         bool is_running() const;
 727         /** Set callback to be invoked on session stop. */
 728         void set_stopped_callback(SessionStoppedCallback callback);
 729         /** Get current trigger setting. */
 730         shared_ptr<Trigger> trigger();
 731         /** Get the context. */
 732         shared_ptr<Context> context();
 733         /** Set trigger setting.
 734          * @param trigger Trigger object to use. */
 735         void set_trigger(shared_ptr<Trigger> trigger);
 736         /** Get filename this session was loaded from. */
 737         string filename();
 738 protected:
 739         Session(shared_ptr<Context> context);
 740         Session(shared_ptr<Context> context, string filename);
 741         ~Session();
 742         shared_ptr<Device> get_device(const struct sr_dev_inst *sdi);
 743         const shared_ptr<Context> _context;
 744         map<const struct sr_dev_inst *, SessionDevice *> _owned_devices;
 745         map<const struct sr_dev_inst *, shared_ptr<Device> > _other_devices;
 746         vector<DatafeedCallbackData *> _datafeed_callbacks;
 747         SessionStoppedCallback _stopped_callback;
 748         map<shared_ptr<EventSource>, SourceCallbackData *> _source_callbacks;
 749         string _filename;
 750         shared_ptr<Trigger> _trigger;
 751         friend class Deleter;
 752         friend class Context;
 753         friend class DatafeedCallbackData;
 754         friend class SessionDevice;
 755 };
 756
 757 /** A packet on the session datafeed */
 758 class SR_API Packet : public UserOwned<Packet, const struct sr_datafeed_packet>
 759 {
 760 public:
 761         /** Type of this packet. */
 762         const PacketType *type();
 763         /** Payload of this packet. */
 764         shared_ptr<PacketPayload> payload();
 765 protected:
 766         Packet(shared_ptr<Device> device,
 767                 const struct sr_datafeed_packet *structure);
 768         ~Packet();
 769         shared_ptr<Device> _device;
 770         PacketPayload *_payload;
 771         friend class Deleter;
 772         friend class Session;
 773         friend class Output;
 774         friend class DatafeedCallbackData;
 775         friend class Header;
 776         friend class Meta;
 777         friend class Logic;
 778         friend class Analog;
 779         friend class Context;
 780 };
 781
 782 /** Abstract base class for datafeed packet payloads */
 783 class SR_API PacketPayload
 784 {
 785 protected:
 786         PacketPayload();
 787         virtual ~PacketPayload() = 0;
 788         virtual shared_ptr<PacketPayload> get_shared_pointer(Packet *parent) = 0;
 789         /** Deleter needed to allow shared_ptr use with protected destructor. */
 790         class Deleter
 791         {
 792         public:
 793                 void operator()(PacketPayload *payload) { delete payload; }
 794         };
 795         friend class Deleter;
 796         friend class Packet;
 797         friend class Output;
 798 };
 799
 800 /** Payload of a datafeed header packet */
 801 class SR_API Header :
 802         public ParentOwned<Header, Packet, const struct sr_datafeed_header>,
 803         public PacketPayload
 804 {
 805 public:
 806         /* Feed version number. */
 807         int feed_version();
 808         /* Start time of this session. */
 809         Glib::TimeVal start_time();
 810 protected:
 811         Header(const struct sr_datafeed_header *structure);
 812         ~Header();
 813         shared_ptr<PacketPayload> get_shared_pointer(Packet *parent);
 814         friend class Packet;
 815 };
 816
 817 /** Payload of a datafeed metadata packet */
 818 class SR_API Meta :
 819         public ParentOwned<Meta, Packet, const struct sr_datafeed_meta>,
 820         public PacketPayload
 821 {
 822 public:
 823         /* Mapping of (ConfigKey, value) pairs. */
 824         map<const ConfigKey *, Glib::VariantBase> config();
 825 protected:
 826         Meta(const struct sr_datafeed_meta *structure);
 827         ~Meta();
 828         shared_ptr<PacketPayload> get_shared_pointer(Packet *parent);
 829         map<const ConfigKey *, Glib::VariantBase> _config;
 830         friend class Packet;
 831 };
 832
 833 /** Payload of a datafeed packet with logic data */
 834 class SR_API Logic :
 835         public ParentOwned<Logic, Packet, const struct sr_datafeed_logic>,
 836         public PacketPayload
 837 {
 838 public:
 839         /* Pointer to data. */
 840         void *data_pointer();
 841         /* Data length in bytes. */
 842         size_t data_length();
 843         /* Size of each sample in bytes. */
 844         unsigned int unit_size();
 845 protected:
 846         Logic(const struct sr_datafeed_logic *structure);
 847         ~Logic();
 848         shared_ptr<PacketPayload> get_shared_pointer(Packet *parent);
 849         friend class Packet;
 850 };
 851
 852 /** Payload of a datafeed packet with analog data */
 853 class SR_API Analog :
 854         public ParentOwned<Analog, Packet, const struct sr_datafeed_analog>,
 855         public PacketPayload
 856 {
 857 public:
 858         /** Pointer to data. */
 859         float *data_pointer();
 860         /** Number of samples in this packet. */
 861         unsigned int num_samples();
 862         /** Channels for which this packet contains data. */
 863         vector<shared_ptr<Channel> > channels();
 864         /** Measured quantity of the samples in this packet. */
 865         const Quantity *mq();
 866         /** Unit of the samples in this packet. */
 867         const Unit *unit();
 868         /** Measurement flags associated with the samples in this packet. */
 869         vector<const QuantityFlag *> mq_flags();
 870 protected:
 871         Analog(const struct sr_datafeed_analog *structure);
 872         ~Analog();
 873         shared_ptr<PacketPayload> get_shared_pointer(Packet *parent);
 874         friend class Packet;
 875 };
 876
 877 /** An input format supported by the library */
 878 class SR_API InputFormat :
 879         public ParentOwned<InputFormat, Context, const struct sr_input_module>
 880 {
 881 public:
 882         /** Name of this input format. */
 883         string name();
 884         /** Description of this input format. */
 885         string description();
 886         /** A list of preferred file name extensions for this file format.
 887          * @note This list is a recommendation only. */
 888         vector<string> extensions();
 889         /** Options supported by this input format. */
 890         map<string, shared_ptr<Option> > options();
 891         /** Create an input using this input format.
 892          * @param options Mapping of (option name, value) pairs. */
 893         shared_ptr<Input> create_input(map<string, Glib::VariantBase> options =
 894                 map<string, Glib::VariantBase>());
 895 protected:
 896         InputFormat(const struct sr_input_module *structure);
 897         ~InputFormat();
 898         friend class Context;
 899         friend class InputDevice;
 900 };
 901
 902 /** An input instance (an input format applied to a file or stream) */
 903 class SR_API Input : public UserOwned<Input, const struct sr_input>
 904 {
 905 public:
 906         /** Virtual device associated with this input. */
 907         shared_ptr<InputDevice> device();
 908         /** Send next stream data.
 909          * @param data Next stream data.
 910          * @param length Length of data. */
 911         void send(void *data, size_t length);
 912         /** Signal end of input data. */
 913         void end();
 914 protected:
 915         Input(shared_ptr<Context> context, const struct sr_input *structure);
 916         ~Input();
 917         shared_ptr<Context> _context;
 918         InputDevice *_device;
 919         friend class Deleter;
 920         friend class Context;
 921         friend class InputFormat;
 922 };
 923
 924 /** A virtual device associated with an input */
 925 class SR_API InputDevice :
 926         public ParentOwned<InputDevice, Input, struct sr_dev_inst>,
 927         public Device
 928 {
 929 protected:
 930         InputDevice(shared_ptr<Input> input, struct sr_dev_inst *sdi);
 931         ~InputDevice();
 932         shared_ptr<Device> get_shared_from_this();
 933         shared_ptr<Input> _input;
 934         friend class Input;
 935 };
 936
 937 /** An option used by an output format */
 938 class SR_API Option : public UserOwned<Option, const struct sr_option>
 939 {
 940 public:
 941         /** Short name of this option suitable for command line usage. */
 942         string id();
 943         /** Short name of this option suitable for GUI usage. */
 944         string name();
 945         /** Description of this option in a sentence. */
 946         string description();
 947         /** Default value for this option. */
 948         Glib::VariantBase default_value();
 949         /** Possible values for this option, if a limited set. */
 950         vector<Glib::VariantBase> values();
 951 protected:
 952         Option(const struct sr_option *structure,
 953                 shared_ptr<const struct sr_option *> structure_array);
 954         ~Option();
 955         shared_ptr<const struct sr_option *> _structure_array;
 956         friend class Deleter;
 957         friend class InputFormat;
 958         friend class OutputFormat;
 959 };
 960
 961 /** An output format supported by the library */
 962 class SR_API OutputFormat :
 963         public ParentOwned<OutputFormat, Context, const struct sr_output_module>
 964 {
 965 public:
 966         /** Name of this output format. */
 967         string name();
 968         /** Description of this output format. */
 969         string description();
 970         /** A list of preferred file name extensions for this file format.
 971          * @note This list is a recommendation only. */
 972         vector<string> extensions();
 973         /** Options supported by this output format. */
 974         map<string, shared_ptr<Option> > options();
 975         /** Create an output using this format.
 976          * @param device Device to output for.
 977          * @param options Mapping of (option name, value) pairs. */
 978         shared_ptr<Output> create_output(
 979                 shared_ptr<Device> device,
 980                 map<string, Glib::VariantBase> options =
 981                         map<string, Glib::VariantBase>());
 982         /** Create an output using this format.
 983          * @param filename Name of destination file.
 984          * @param device Device to output for.
 985          * @param options Mapping of (option name, value) pairs. */
 986         shared_ptr<Output> create_output(string filename,
 987                 shared_ptr<Device> device,
 988                 map<string, Glib::VariantBase> options =
 989                         map<string, Glib::VariantBase>());
 990         /**
 991          * Checks whether a given flag is set.
 992          * @param flag Flag to check
 993          * @return true if flag is set for this module
 994          * @see sr_output_flags
 995          */
 996         bool test_flag(const OutputFlag *flag);
 997 protected:
 998         OutputFormat(const struct sr_output_module *structure);
 999         ~OutputFormat();
1000         friend class Context;
1001         friend class Output;
1002 };
1003
1004 /** An output instance (an output format applied to a device) */
1005 class SR_API Output : public UserOwned<Output, const struct sr_output>
1006 {
1007 public:
1008         /** Update output with data from the given packet.
1009          * @param packet Packet to handle. */
1010         string receive(shared_ptr<Packet> packet);
1011 protected:
1012         Output(shared_ptr<OutputFormat> format, shared_ptr<Device> device);
1013         Output(shared_ptr<OutputFormat> format,
1014                 shared_ptr<Device> device, map<string, Glib::VariantBase> options);
1015         Output(string filename, shared_ptr<OutputFormat> format,
1016                 shared_ptr<Device> device, map<string, Glib::VariantBase> options);
1017         ~Output();
1018         const shared_ptr<OutputFormat> _format;
1019         const shared_ptr<Device> _device;
1020         const map<string, Glib::VariantBase> _options;
1021         friend class Deleter;
1022         friend class OutputFormat;
1023 };
1024
1025 /** Base class for objects which wrap an enumeration value from libsigrok */
1026 template <class Class, typename Enum> class SR_API EnumValue
1027 {
1028 public:
1029         /** The integer constant associated with this value. */
1030         int id() const
1031         {
1032                 return static_cast<int>(_id);
1033         }
1034         /** The name associated with this value. */
1035         string name() const
1036         {
1037                 return _name;
1038         }
1039         /** Get value associated with a given integer constant. */
1040         static const Class *get(int id)
1041         {
1042                 auto key = static_cast<Enum>(id);
1043                 if (_values.find(key) == _values.end())
1044                         throw Error(SR_ERR_ARG);
1045                 return _values.at(key);
1046         }
1047         /** Get possible values. */
1048         static std::vector<const Class *> values()
1049         {
1050                 std::vector<const Class *> result;
1051                 for (auto entry : _values)
1052                         result.push_back(entry.second);
1053                 return result;
1054         }
1055 protected:
1056         EnumValue(Enum id, const char name[]) : _id(id), _name(name)
1057         {
1058         }
1059         ~EnumValue()
1060         {
1061         }
1062         static const std::map<const Enum, const Class * const> _values;
1063         const Enum _id;
1064         const string _name;
1065 };
1066
1067 #include <libsigrokcxx/enums.hpp>
1068
1069 }
1070
1071 #endif