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 InputFileDevice;
 112 class SR_API Output;
 113 class SR_API DataType;
 114
 115 /** Exception thrown when an error code is returned by any libsigrok call. */
 116 class SR_API Error: public exception
 117 {
 118 public:
 119         Error(int result);
 120         ~Error() throw();
 121         const int result;
 122         const char *what() const throw();
 123 };
 124
 125 /* Base template for most classes which wrap a struct type from libsigrok. */
 126 template <class Parent, typename Struct> class SR_API StructureWrapper :
 127         public enable_shared_from_this<StructureWrapper<Parent, Struct> >
 128 {
 129 protected:
 130         /*  Parent object which owns this child object's underlying structure.
 131
 132                 This shared pointer will be null when this child is unused, but
 133                 will be assigned to point to the parent before any shared pointer
 134                 to this child is handed out to the user.
 135
 136                 When the reference count of this child falls to zero, this shared
 137                 pointer to its parent is reset by a custom deleter on the child's
 138                 shared pointer.
 139
 140                 This strategy ensures that the destructors for both the child and
 141                 the parent are called at the correct time, i.e. only when all
 142                 references to both the parent and all its children are gone. */
 143         shared_ptr<Parent> parent;
 144
 145 public:
 146         shared_ptr<StructureWrapper<Parent, Struct> >
 147         get_shared_pointer(Parent *parent)
 148         {
 149                 this->parent = static_pointer_cast<Parent>(parent->shared_from_this());
 150                 return shared_ptr<StructureWrapper<Parent, Struct> >(
 151                         this, reset_parent);
 152         }
 153         shared_ptr<StructureWrapper<Parent, Struct> >
 154         get_shared_pointer(shared_ptr<Parent> parent)
 155         {
 156                 this->parent = parent;
 157                 return shared_ptr<StructureWrapper<Parent, Struct> >(
 158                         this, reset_parent);
 159         }
 160 protected:
 161         static void reset_parent(StructureWrapper<Parent, Struct> *object)
 162         {
 163                 object->parent.reset();
 164         }
 165
 166         Struct *structure;
 167
 168         StructureWrapper<Parent, Struct>(Struct *structure) :
 169                 structure(structure)
 170         {
 171         }
 172 };
 173
 174 /** Type of log callback */
 175 typedef function<void(const LogLevel *, string message)> LogCallbackFunction;
 176
 177 /** The global libsigrok context */
 178 class SR_API Context : public enable_shared_from_this<Context>
 179 {
 180 public:
 181         /** Create new context */
 182         static shared_ptr<Context> create();
 183         /** libsigrok package version. */
 184         string get_package_version();
 185         /** libsigrok library version. */
 186         string get_lib_version();
 187         /** Available hardware drivers, indexed by name. */
 188         map<string, shared_ptr<Driver> > get_drivers();
 189         /** Available input formats, indexed by name. */
 190         map<string, shared_ptr<InputFormat> > get_input_formats();
 191         /** Available output formats, indexed by name. */
 192         map<string, shared_ptr<OutputFormat> > get_output_formats();
 193         /** Current log level. */
 194         const LogLevel *get_log_level();
 195         /** Set the log level. */
 196         void set_log_level(const LogLevel *level);
 197         /** Current log domain. */
 198         string get_log_domain();
 199         /** Set the log domain. */
 200         void set_log_domain(string value);
 201         /** Set the log callback. */
 202         void set_log_callback(LogCallbackFunction callback);
 203         /** Set the log callback to the default handler. */
 204         void set_log_callback_default();
 205         /** Create a new session. */
 206         shared_ptr<Session> create_session();
 207         /** Load a saved session. */
 208         shared_ptr<Session> load_session(string filename);
 209         /** Create a new trigger. */
 210         shared_ptr<Trigger> create_trigger(string name);
 211 protected:
 212         struct sr_context *structure;
 213         map<string, Driver *> drivers;
 214         map<string, InputFormat *> input_formats;
 215         map<string, OutputFormat *> output_formats;
 216         Session *session;
 217         LogCallbackFunction log_callback;
 218         Context();
 219         ~Context();
 220         /** Deleter needed to allow shared_ptr use with protected destructor. */
 221         class Deleter
 222         {
 223         public:
 224                 void operator()(Context *context) { delete context; }
 225         };
 226         friend class Deleter;
 227         friend class Session;
 228         friend class Driver;
 229 };
 230
 231 /** A hardware driver provided by the library */
 232 class SR_API Driver : public StructureWrapper<Context, struct sr_dev_driver>
 233 {
 234 public:
 235         /** Name of this driver. */
 236         string get_name();
 237         /** Long name for this driver. */
 238         string get_long_name();
 239         /** Scan for devices and return a list of devices found. */
 240         vector<shared_ptr<HardwareDevice> > scan(
 241                 map<const ConfigKey *, Glib::VariantBase> options = {});
 242 protected:
 243         bool initialized;
 244         vector<HardwareDevice *> devices;
 245         Driver(struct sr_dev_driver *structure);
 246         ~Driver();
 247         friend class Context;
 248         friend class HardwareDevice;
 249         friend class ChannelGroup;
 250 };
 251
 252 /** An object that can be configured. */
 253 class SR_API Configurable
 254 {
 255 public:
 256         /** Read configuration for the given key. */
 257         Glib::VariantBase config_get(const ConfigKey *key);
 258         /** Set configuration for the given key to a specified value. */
 259         void config_set(const ConfigKey *key, Glib::VariantBase value);
 260         /** Enumerate available values for the given configuration key. */
 261         Glib::VariantBase config_list(const ConfigKey *key);
 262 protected:
 263         Configurable(
 264                 struct sr_dev_driver *driver,
 265                 struct sr_dev_inst *sdi,
 266                 struct sr_channel_group *channel_group);
 267         virtual ~Configurable();
 268         struct sr_dev_driver *config_driver;
 269         struct sr_dev_inst *config_sdi;
 270         struct sr_channel_group *config_channel_group;
 271 };
 272
 273 /** A generic device, either hardware or virtual */
 274 class SR_API Device :
 275         public Configurable,
 276         public StructureWrapper<Context, struct sr_dev_inst>
 277 {
 278 public:
 279         /** Vendor name for this device. */
 280         string get_vendor();
 281         /** Model name for this device. */
 282         string get_model();
 283         /** Version string for this device. */
 284         string get_version();
 285         /** List of the channels available on this device. */
 286         vector<shared_ptr<Channel> > get_channels();
 287         /** Channel groups available on this device, indexed by name. */
 288         map<string, shared_ptr<ChannelGroup> > get_channel_groups();
 289         /** Open device. */
 290         void open();
 291         /** Close device. */
 292         void close();
 293 protected:
 294         Device(struct sr_dev_inst *structure);
 295         ~Device();
 296         shared_ptr<Channel> get_channel(struct sr_channel *ptr);
 297         map<struct sr_channel *, Channel *> channels;
 298         map<string, ChannelGroup *> channel_groups;
 299         /** Deleter needed to allow shared_ptr use with protected destructor. */
 300         class Deleter
 301         {
 302         public:
 303                 void operator()(Device *device) { delete device; }
 304         };
 305         friend class Deleter;
 306         friend class Session;
 307         friend class Channel;
 308         friend class ChannelGroup;
 309         friend class Output;
 310         friend class Analog;
 311 };
 312
 313 /** A real hardware device, connected via a driver */
 314 class SR_API HardwareDevice : public Device
 315 {
 316 public:
 317         /** Driver providing this device. */
 318         shared_ptr<Driver> get_driver();
 319 protected:
 320         HardwareDevice(Driver *driver, struct sr_dev_inst *structure);
 321         ~HardwareDevice();
 322         Driver *driver;
 323         friend class Driver;
 324         friend class ChannelGroup;
 325 };
 326
 327 /** A channel on a device */
 328 class SR_API Channel : public StructureWrapper<Device, struct sr_channel>
 329 {
 330 public:
 331         /** Current name of this channel. */
 332         string get_name();
 333         /** Set the name of this channel. */
 334         void set_name(string name);
 335         /** Type of this channel. */
 336         const ChannelType *get_type();
 337         /** Enabled status of this channel. */
 338         bool get_enabled();
 339         /** Set the enabled status of this channel. */
 340         void set_enabled(bool value);
 341 protected:
 342         Channel(struct sr_channel *structure);
 343         ~Channel();
 344         const ChannelType * const type;
 345         friend class Device;
 346         friend class ChannelGroup;
 347         friend class Session;
 348         friend class TriggerStage;
 349 };
 350
 351 /** A group of channels on a device, which share some configuration */
 352 class SR_API ChannelGroup :
 353         public StructureWrapper<Device, struct sr_channel_group>,
 354         public Configurable
 355 {
 356 public:
 357         /** Name of this channel group. */
 358         string get_name();
 359         /** List of the channels in this group. */
 360         vector<shared_ptr<Channel> > get_channels();
 361 protected:
 362         ChannelGroup(Device *device, struct sr_channel_group *structure);
 363         ~ChannelGroup();
 364         vector<Channel *> channels;
 365         friend class Device;
 366 };
 367
 368 /** A trigger configuration */
 369 class SR_API Trigger : public enable_shared_from_this<Trigger>
 370 {
 371 public:
 372         string get_name();
 373         vector<shared_ptr<TriggerStage> > get_stages();
 374         shared_ptr<TriggerStage> add_stage();
 375 protected:
 376         Trigger(shared_ptr<Context> context, string name);
 377         ~Trigger();
 378         struct sr_trigger *structure;
 379         shared_ptr<Context> context;
 380         vector<TriggerStage *> stages;
 381         /** Deleter needed to allow shared_ptr use with protected destructor. */
 382         class Deleter
 383         {
 384         public:
 385                 void operator()(Trigger *trigger) { delete trigger; }
 386         };
 387         friend class Context;
 388         friend class Session;
 389 };
 390
 391 /** A stage in a trigger configuration */
 392 class SR_API TriggerStage : public StructureWrapper<Trigger, struct sr_trigger_stage>
 393 {
 394 public:
 395         int get_number();
 396         vector<shared_ptr<TriggerMatch> > get_matches();
 397         void add_match(shared_ptr<Channel> channel, const TriggerMatchType *type);
 398         void add_match(shared_ptr<Channel> channel, const TriggerMatchType *type, float value);
 399 protected:
 400         vector<TriggerMatch *> matches;
 401         TriggerStage(struct sr_trigger_stage *structure);
 402         ~TriggerStage();
 403         friend class Trigger;
 404 };
 405
 406 /** A match condition in a trigger configuration  */
 407 class SR_API TriggerMatch : public StructureWrapper<TriggerStage, struct sr_trigger_match>
 408 {
 409 public:
 410         shared_ptr<Channel> get_channel();
 411         const TriggerMatchType *get_type();
 412         float get_value();
 413 protected:
 414         TriggerMatch(struct sr_trigger_match *structure, shared_ptr<Channel> channel);
 415         ~TriggerMatch();
 416         shared_ptr<Channel> channel;
 417         friend class TriggerStage;
 418 };
 419
 420 /** Type of datafeed callback */
 421 typedef function<void(shared_ptr<Device>, shared_ptr<Packet>)>
 422         DatafeedCallbackFunction;
 423
 424 /* Data required for C callback function to call a C++ datafeed callback */
 425 class SR_PRIV DatafeedCallbackData
 426 {
 427 public:
 428         void run(const struct sr_dev_inst *sdi,
 429                 const struct sr_datafeed_packet *pkt);
 430 protected:
 431         DatafeedCallbackFunction callback;
 432         DatafeedCallbackData(Session *session,
 433                 DatafeedCallbackFunction callback);
 434         Session *session;
 435         friend class Session;
 436 };
 437
 438 /** Type of source callback */
 439 typedef function<bool(Glib::IOCondition)>
 440         SourceCallbackFunction;
 441
 442 /* Data required for C callback function to call a C++ source callback */
 443 class SR_PRIV SourceCallbackData
 444 {
 445 public:
 446         bool run(int revents);
 447 protected:
 448         SourceCallbackData(shared_ptr<EventSource> source);
 449         shared_ptr<EventSource> source;
 450         friend class Session;
 451 };
 452
 453 /** An I/O event source */
 454 class SR_API EventSource
 455 {
 456 public:
 457         /** Create an event source from a file descriptor. */
 458         static shared_ptr<EventSource> create(int fd, Glib::IOCondition events,
 459                 int timeout, SourceCallbackFunction callback);
 460         /** Create an event source from a Glib::PollFD */
 461         static shared_ptr<EventSource> create(Glib::PollFD pollfd, int timeout,
 462                 SourceCallbackFunction callback);
 463         /** Create an event source from a Glib::IOChannel */
 464         static shared_ptr<EventSource> create(
 465                 Glib::RefPtr<Glib::IOChannel> channel, Glib::IOCondition events,
 466                 int timeout, SourceCallbackFunction callback);
 467 protected:
 468         EventSource(int timeout, SourceCallbackFunction callback);
 469         ~EventSource();
 470         enum source_type {
 471                 SOURCE_FD,
 472                 SOURCE_POLLFD,
 473                 SOURCE_IOCHANNEL
 474         } type;
 475         int fd;
 476         Glib::PollFD pollfd;
 477         Glib::RefPtr<Glib::IOChannel> channel;
 478         Glib::IOCondition events;
 479         int timeout;
 480         SourceCallbackFunction callback;
 481         /** Deleter needed to allow shared_ptr use with protected destructor. */
 482         class Deleter
 483         {
 484         public:
 485                 void operator()(EventSource *source) { delete source; }
 486         };
 487         friend class Deleter;
 488         friend class Session;
 489         friend class SourceCallbackData;
 490 };
 491
 492 /** A sigrok session */
 493 class SR_API Session
 494 {
 495 public:
 496         /** Add a device to this session. */
 497         void add_device(shared_ptr<Device> device);
 498         /** List devices attached to this session. */
 499         vector<shared_ptr<Device> > get_devices();
 500         /** Remove all devices from this session. */
 501         void remove_devices();
 502         /** Add a datafeed callback to this session. */
 503         void add_datafeed_callback(DatafeedCallbackFunction callback);
 504         /** Remove all datafeed callbacks from this session. */
 505         void remove_datafeed_callbacks();
 506         /** Add an event source. */
 507         void add_source(shared_ptr<EventSource> source);
 508         /** Remove an event source. */
 509         void remove_source(shared_ptr<EventSource> source);
 510         /** Start the session. */
 511         void start();
 512         /** Run the session event loop. */
 513         void run();
 514         /** Stop the session. */
 515         void stop();
 516         /** Begin saving session to a file. */
 517         void begin_save(string filename);
 518         /** Append a packet to the session file being saved. */
 519         void append(shared_ptr<Device> device, shared_ptr<Packet> packet);
 520         /** Get current trigger setting. */
 521         shared_ptr<Trigger> get_trigger();
 522         /** Set trigger setting. */
 523         void set_trigger(shared_ptr<Trigger> trigger);
 524 protected:
 525         Session(shared_ptr<Context> context);
 526         Session(shared_ptr<Context> context, string filename);
 527         ~Session();
 528         struct sr_session *structure;
 529         const shared_ptr<Context> context;
 530         map<const struct sr_dev_inst *, shared_ptr<Device> > devices;
 531         vector<DatafeedCallbackData *> datafeed_callbacks;
 532         map<shared_ptr<EventSource>, SourceCallbackData *> source_callbacks;
 533         bool saving;
 534         bool save_initialized;
 535         string save_filename;
 536         uint64_t save_samplerate;
 537         shared_ptr<Trigger> trigger;
 538         /** Deleter needed to allow shared_ptr use with protected destructor. */
 539         class Deleter
 540         {
 541         public:
 542                 void operator()(Session *session) { delete session; }
 543         };
 544         friend class Deleter;
 545         friend class Context;
 546         friend class DatafeedCallbackData;
 547 };
 548
 549 /** A packet on the session datafeed */
 550 class SR_API Packet : public enable_shared_from_this<Packet>
 551 {
 552 public:
 553         /** Type of this packet. */
 554         const PacketType *get_type();
 555         /** Payload of this packet. */
 556         shared_ptr<PacketPayload> get_payload();
 557 protected:
 558         Packet(shared_ptr<Device> device,
 559                 const struct sr_datafeed_packet *structure);
 560         ~Packet();
 561         const struct sr_datafeed_packet *structure;
 562         shared_ptr<Device> device;
 563         PacketPayload *payload;
 564         /** Deleter needed to allow shared_ptr use with protected destructor. */
 565         class Deleter
 566         {
 567         public:
 568                 void operator()(Packet *packet) { delete packet; }
 569         };
 570         friend class Deleter;
 571         friend class Session;
 572         friend class Output;
 573         friend class DatafeedCallbackData;
 574         friend class Header;
 575         friend class Meta;
 576         friend class Logic;
 577         friend class Analog;
 578 };
 579
 580 /** Abstract base class for datafeed packet payloads */
 581 class SR_API PacketPayload
 582 {
 583 protected:
 584         PacketPayload();
 585         virtual ~PacketPayload() = 0;
 586         shared_ptr<PacketPayload> get_shared_pointer(Packet *parent) {
 587                 return static_pointer_cast<PacketPayload>(get_shared_pointer(parent));
 588         }
 589         /** Deleter needed to allow shared_ptr use with protected destructor. */
 590         class Deleter
 591         {
 592         public:
 593                 void operator()(PacketPayload *payload) { delete payload; }
 594         };
 595         friend class Deleter;
 596         friend class Packet;
 597         friend class Output;
 598 };
 599
 600 /** Payload of a datafeed header packet */
 601 class SR_API Header : public PacketPayload,
 602         public StructureWrapper<Packet, const struct sr_datafeed_header>
 603 {
 604 public:
 605         int get_feed_version();
 606         Glib::TimeVal get_start_time();
 607 protected:
 608         Header(const struct sr_datafeed_header *structure);
 609         ~Header();
 610         const struct sr_datafeed_header *structure;
 611         friend class Packet;
 612 };
 613
 614 /** Payload of a datafeed metadata packet */
 615 class SR_API Meta : public PacketPayload,
 616         public StructureWrapper<Packet, const struct sr_datafeed_meta>
 617 {
 618 public:
 619         map<const ConfigKey *, Glib::VariantBase> get_config();
 620 protected:
 621         Meta(const struct sr_datafeed_meta *structure);
 622         ~Meta();
 623         const struct sr_datafeed_meta *structure;
 624         map<const ConfigKey *, Glib::VariantBase> config;
 625         friend class Packet;
 626 };
 627
 628 /** Payload of a datafeed packet with logic data */
 629 class SR_API Logic : public PacketPayload,
 630         public StructureWrapper<Packet, const struct sr_datafeed_logic>
 631 {
 632 public:
 633         /* Pointer to data. */
 634         void *get_data_pointer();
 635         /* Data length in bytes. */
 636         size_t get_data_length();
 637         /* Size of each sample in bytes. */
 638         unsigned int get_unit_size();
 639 protected:
 640         Logic(const struct sr_datafeed_logic *structure);
 641         ~Logic();
 642         const struct sr_datafeed_logic *structure;
 643         friend class Packet;
 644 };
 645
 646 /** Payload of a datafeed packet with analog data */
 647 class SR_API Analog : public PacketPayload,
 648         public StructureWrapper<Packet, const struct sr_datafeed_analog>
 649 {
 650 public:
 651         /** Pointer to data. */
 652         float *get_data_pointer();
 653         /** Number of samples in this packet. */
 654         unsigned int get_num_samples();
 655         /** Channels for which this packet contains data. */
 656         vector<shared_ptr<Channel> > get_channels();
 657         /** Measured quantity of the samples in this packet. */
 658         const Quantity *get_mq();
 659         /** Unit of the samples in this packet. */
 660         const Unit *get_unit();
 661         /** Measurement flags associated with the samples in this packet. */
 662         vector<const QuantityFlag *> get_mq_flags();
 663 protected:
 664         Analog(const struct sr_datafeed_analog *structure);
 665         ~Analog();
 666         const struct sr_datafeed_analog *structure;
 667         friend class Packet;
 668 };
 669
 670 /** An input format supported by the library */
 671 class SR_API InputFormat :
 672         public StructureWrapper<Context, struct sr_input_format>
 673 {
 674 public:
 675         /** Name of this input format. */
 676         string get_name();
 677         /** Description of this input format. */
 678         string get_description();
 679         /** Check whether a given file matches this input format. */
 680         bool format_match(string filename);
 681         /** Open a file using this input format. */
 682         shared_ptr<InputFileDevice> open_file(string filename,
 683                 map<string, string> options = {});
 684 protected:
 685         InputFormat(struct sr_input_format *structure);
 686         ~InputFormat();
 687         friend class Context;
 688         friend class InputFileDevice;
 689 };
 690
 691 /** A virtual device associated with an input file */
 692 class SR_API InputFileDevice : public Device
 693 {
 694 public:
 695         /** Load data from file. */
 696         void load();
 697 protected:
 698         InputFileDevice(shared_ptr<InputFormat> format,
 699                 struct sr_input *input, string filename);
 700         ~InputFileDevice();
 701         struct sr_input *input;
 702         shared_ptr<InputFormat> format;
 703         string filename;
 704         /** Deleter needed to allow shared_ptr use with protected destructor. */
 705         class Deleter
 706         {
 707         public:
 708                 void operator()(InputFileDevice *device) { delete device; }
 709         };
 710         friend class Deleter;
 711         friend class InputFormat;
 712 };
 713
 714 /** An output format supported by the library */
 715 class SR_API OutputFormat :
 716         public StructureWrapper<Context, struct sr_output_format>
 717 {
 718 public:
 719         /** Name of this output format. */
 720         string get_name();
 721         /** Description of this output format. */
 722         string get_description();
 723         /** Create an output using this format. */
 724         shared_ptr<Output> create_output(shared_ptr<Device> device, map<string, string> options = {});
 725 protected:
 726         OutputFormat(struct sr_output_format *structure);
 727         ~OutputFormat();
 728         friend class Context;
 729         friend class Output;
 730 };
 731
 732 /** An output instance (an output format applied to a device) */
 733 class SR_API Output
 734 {
 735 public:
 736         /** Update output with data from the given packet. */
 737         string receive(shared_ptr<Packet> packet);
 738 protected:
 739         Output(shared_ptr<OutputFormat> format, shared_ptr<Device> device);
 740         Output(shared_ptr<OutputFormat> format,
 741                 shared_ptr<Device> device, map<string, string> options);
 742         ~Output();
 743         struct sr_output *structure;
 744         const shared_ptr<OutputFormat> format;
 745         const shared_ptr<Device> device;
 746         const map<string, string> options;
 747         /** Deleter needed to allow shared_ptr use with protected destructor. */
 748         class Deleter
 749         {
 750         public:
 751                 void operator()(Output *output) { delete output; }
 752         };
 753         friend class Deleter;
 754         friend class OutputFormat;
 755 };
 756
 757 /** Base class for objects which wrap an enumeration value from libsigrok */
 758 template <typename T> class SR_API EnumValue
 759 {
 760 public:
 761         /** The enum constant associated with this value. */
 762         T get_id() const { return id; }
 763         /** The name associated with this value. */
 764         string get_name() const { return name; }
 765 protected:
 766         EnumValue(T id, const char name[]) : id(id), name(name) {}
 767         ~EnumValue() {}
 768         const T id;
 769         const string name;
 770 };
 771
 772 #include "enums.hpp"
 773
 774 }
 775
 776 #endif // LIBSIGROK_HPP