bindings/cxx/classes.cpp

   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 /* Needed for isascii(), as used in the GNU libstdc++ headers */
  21 #ifndef _XOPEN_SOURCE
  22 #define _XOPEN_SOURCE 600
  23 #endif
  24
  25 #include <config.h>
  26 #include <libsigrokcxx/libsigrokcxx.hpp>
  27
  28 #include <sstream>
  29 #include <cmath>
  30
  31 namespace sigrok
  32 {
  33
  34 /** Helper function to translate C errors to C++ exceptions. */
  35 static void check(int result)
  36 {
  37         if (result != SR_OK)
  38                 throw Error(result);
  39 }
  40
  41 /** Helper function to obtain valid strings from possibly null input. */
  42 static inline const char *valid_string(const char *input)
  43 {
  44         return (input) ? input : "";
  45 }
  46
  47 /** Helper function to convert between map<string, VariantBase> and GHashTable */
  48 static GHashTable *map_to_hash_variant(const map<string, Glib::VariantBase> &input)
  49 {
  50         auto *const output = g_hash_table_new_full(g_str_hash, g_str_equal, g_free,
  51                         reinterpret_cast<GDestroyNotify>(&g_variant_unref));
  52         for (const auto &entry : input)
  53                 g_hash_table_insert(output,
  54                         g_strdup(entry.first.c_str()),
  55                         entry.second.gobj_copy());
  56         return output;
  57 }
  58
  59 Error::Error(int result) : result(result)
  60 {
  61 }
  62
  63 const char *Error::what() const noexcept
  64 {
  65         return sr_strerror(result);
  66 }
  67
  68 Error::~Error() noexcept
  69 {
  70 }
  71
  72 ResourceReader::~ResourceReader()
  73 {
  74 }
  75
  76 SR_PRIV int ResourceReader::open_callback(struct sr_resource *res,
  77                 const char *name, void *cb_data) noexcept
  78 {
  79         try {
  80                 auto *const reader = static_cast<ResourceReader*>(cb_data);
  81                 reader->open(res, name);
  82         } catch (const Error &err) {
  83                 return err.result;
  84         } catch (...) {
  85                 return SR_ERR;
  86         }
  87         return SR_OK;
  88 }
  89
  90 SR_PRIV int ResourceReader::close_callback(struct sr_resource *res,
  91                 void *cb_data) noexcept
  92 {
  93         try {
  94                 auto *const reader = static_cast<ResourceReader*>(cb_data);
  95                 reader->close(res);
  96         } catch (const Error &err) {
  97                 return err.result;
  98         } catch (...) {
  99                 return SR_ERR;
 100         }
 101         return SR_OK;
 102 }
 103
 104 SR_PRIV ssize_t ResourceReader::read_callback(const struct sr_resource *res,
 105                 void *buf, size_t count, void *cb_data) noexcept
 106 {
 107         try {
 108                 auto *const reader = static_cast<ResourceReader*>(cb_data);
 109                 return reader->read(res, buf, count);
 110         } catch (const Error &err) {
 111                 return err.result;
 112         } catch (...) {
 113                 return SR_ERR;
 114         }
 115 }
 116
 117 shared_ptr<Context> Context::create()
 118 {
 119         return shared_ptr<Context>(new Context(), Context::Deleter());
 120 }
 121
 122 Context::Context() :
 123         _structure(nullptr),
 124         _session(nullptr)
 125 {
 126         check(sr_init(&_structure));
 127
 128         if (struct sr_dev_driver **driver_list = sr_driver_list(_structure))
 129                 for (int i = 0; driver_list[i]; i++) {
 130                         unique_ptr<Driver> driver {new Driver{driver_list[i]}};
 131                         _drivers.emplace(driver->name(), move(driver));
 132                 }
 133
 134         if (const struct sr_input_module **input_list = sr_input_list())
 135                 for (int i = 0; input_list[i]; i++) {
 136                         unique_ptr<InputFormat> input {new InputFormat{input_list[i]}};
 137                         _input_formats.emplace(input->name(), move(input));
 138                 }
 139
 140         if (const struct sr_output_module **output_list = sr_output_list())
 141                 for (int i = 0; output_list[i]; i++) {
 142                         unique_ptr<OutputFormat> output {new OutputFormat{output_list[i]}};
 143                         _output_formats.emplace(output->name(), move(output));
 144                 }
 145 }
 146
 147 string Context::package_version()
 148 {
 149         return sr_package_version_string_get();
 150 }
 151
 152 string Context::lib_version()
 153 {
 154         return sr_lib_version_string_get();
 155 }
 156
 157 map<string, shared_ptr<Driver>> Context::drivers()
 158 {
 159         map<string, shared_ptr<Driver>> result;
 160         for (const auto &entry: _drivers)
 161         {
 162                 const auto &name = entry.first;
 163                 const auto &driver = entry.second;
 164                 result.emplace(name, driver->share_owned_by(shared_from_this()));
 165         }
 166         return result;
 167 }
 168
 169 map<string, shared_ptr<InputFormat>> Context::input_formats()
 170 {
 171         map<string, shared_ptr<InputFormat>> result;
 172         for (const auto &entry: _input_formats)
 173         {
 174                 const auto &name = entry.first;
 175                 const auto &input_format = entry.second;
 176                 result.emplace(name, input_format->share_owned_by(shared_from_this()));
 177         }
 178         return result;
 179 }
 180
 181 map<string, shared_ptr<OutputFormat>> Context::output_formats()
 182 {
 183         map<string, shared_ptr<OutputFormat>> result;
 184         for (const auto &entry: _output_formats)
 185         {
 186                 const auto &name = entry.first;
 187                 const auto &output_format = entry.second;
 188                 result.emplace(name, output_format->share_owned_by(shared_from_this()));
 189         }
 190         return result;
 191 }
 192
 193 Context::~Context()
 194 {
 195         check(sr_exit(_structure));
 196 }
 197
 198 const LogLevel *Context::log_level() const
 199 {
 200         return LogLevel::get(sr_log_loglevel_get());
 201 }
 202
 203 void Context::set_log_level(const LogLevel *level)
 204 {
 205         check(sr_log_loglevel_set(level->id()));
 206 }
 207
 208 static int call_log_callback(void *cb_data, int loglevel,
 209                 const char *format, va_list args) noexcept
 210 {
 211         const unique_ptr<char, decltype(&g_free)>
 212                 message {g_strdup_vprintf(format, args), &g_free};
 213
 214         auto *const callback = static_cast<LogCallbackFunction *>(cb_data);
 215
 216         try
 217         {
 218                 (*callback)(LogLevel::get(loglevel), message.get());
 219         }
 220         catch (Error e)
 221         {
 222                 return e.result;
 223         }
 224
 225         return SR_OK;
 226 }
 227
 228 void Context::set_log_callback(LogCallbackFunction callback)
 229 {
 230         _log_callback = move(callback);
 231         check(sr_log_callback_set(call_log_callback, &_log_callback));
 232 }
 233
 234 void Context::set_log_callback_default()
 235 {
 236         check(sr_log_callback_set_default());
 237         _log_callback = nullptr;
 238 }
 239
 240 void Context::set_resource_reader(ResourceReader *reader)
 241 {
 242         if (reader) {
 243                 check(sr_resource_set_hooks(_structure,
 244                                 &ResourceReader::open_callback,
 245                                 &ResourceReader::close_callback,
 246                                 &ResourceReader::read_callback, reader));
 247         } else {
 248                 check(sr_resource_set_hooks(_structure,
 249                                 nullptr, nullptr, nullptr, nullptr));
 250         }
 251 }
 252
 253 shared_ptr<Session> Context::create_session()
 254 {
 255         return shared_ptr<Session>(
 256                 new Session(shared_from_this()), Session::Deleter());
 257 }
 258
 259 shared_ptr<UserDevice> Context::create_user_device(
 260                 string vendor, string model, string version)
 261 {
 262         return shared_ptr<UserDevice>(
 263                 new UserDevice(vendor, model, version), UserDevice::Deleter());
 264 }
 265
 266 shared_ptr<Packet> Context::create_header_packet(Glib::TimeVal start_time)
 267 {
 268         auto header = g_new(struct sr_datafeed_header, 1);
 269         header->feed_version = 1;
 270         header->starttime.tv_sec = start_time.tv_sec;
 271         header->starttime.tv_usec = start_time.tv_usec;
 272         auto packet = g_new(struct sr_datafeed_packet, 1);
 273         packet->type = SR_DF_HEADER;
 274         packet->payload = header;
 275         return shared_ptr<Packet>(new Packet(nullptr, packet), Packet::Deleter());
 276 }
 277
 278 shared_ptr<Packet> Context::create_meta_packet(
 279         const map<const ConfigKey *, Glib::VariantBase> &config)
 280 {
 281         auto meta = g_new0(struct sr_datafeed_meta, 1);
 282         for (const auto &input : config)
 283         {
 284                 const auto &key = input.first;
 285                 const auto &value = input.second;
 286                 auto *const output = g_new(struct sr_config, 1);
 287                 output->key = key->id();
 288                 output->data = value.gobj_copy();
 289                 meta->config = g_slist_append(meta->config, output);
 290         }
 291         auto packet = g_new(struct sr_datafeed_packet, 1);
 292         packet->type = SR_DF_META;
 293         packet->payload = meta;
 294         return shared_ptr<Packet>(new Packet(nullptr, packet), Packet::Deleter());
 295 }
 296
 297 shared_ptr<Packet> Context::create_logic_packet(
 298         void *data_pointer, size_t data_length, unsigned int unit_size)
 299 {
 300         auto logic = g_new(struct sr_datafeed_logic, 1);
 301         logic->length = data_length;
 302         logic->unitsize = unit_size;
 303         logic->data = data_pointer;
 304         auto packet = g_new(struct sr_datafeed_packet, 1);
 305         packet->type = SR_DF_LOGIC;
 306         packet->payload = logic;
 307         return shared_ptr<Packet>(new Packet(nullptr, packet), Packet::Deleter());
 308 }
 309
 310 shared_ptr<Packet> Context::create_analog_packet(
 311         const vector<shared_ptr<Channel> > &channels,
 312         float *data_pointer, unsigned int num_samples, const Quantity *mq,
 313         const Unit *unit, const vector<const QuantityFlag *> &mqflags)
 314 {
 315         auto analog = g_new0(struct sr_datafeed_analog, 1);
 316         auto meaning = g_new0(struct sr_analog_meaning, 1);
 317
 318         analog->meaning = meaning;
 319
 320         for (const auto &channel : channels)
 321                 meaning->channels = g_slist_append(meaning->channels, channel->_structure);
 322         analog->num_samples = num_samples;
 323         meaning->mq = static_cast<sr_mq>(mq->id());
 324         meaning->unit = static_cast<sr_unit>(unit->id());
 325         meaning->mqflags = static_cast<sr_mqflag>(QuantityFlag::mask_from_flags(mqflags));
 326         analog->data = data_pointer;
 327         auto packet = g_new(struct sr_datafeed_packet, 1);
 328         packet->type = SR_DF_ANALOG;
 329         packet->payload = analog;
 330         return shared_ptr<Packet>(new Packet(nullptr, packet), Packet::Deleter());
 331 }
 332
 333 shared_ptr<Session> Context::load_session(string filename)
 334 {
 335         return shared_ptr<Session>(
 336                 new Session(shared_from_this(), move(filename)), Session::Deleter());
 337 }
 338
 339 shared_ptr<Trigger> Context::create_trigger(string name)
 340 {
 341         return shared_ptr<Trigger>(
 342                 new Trigger(shared_from_this(), move(name)), Trigger::Deleter());
 343 }
 344
 345 shared_ptr<Input> Context::open_file(string filename)
 346 {
 347         const struct sr_input *input;
 348
 349         check(sr_input_scan_file(filename.c_str(), &input));
 350         return shared_ptr<Input>(
 351                 new Input(shared_from_this(), input), Input::Deleter());
 352 }
 353
 354 shared_ptr<Input> Context::open_stream(string header)
 355 {
 356         const struct sr_input *input;
 357
 358         auto gstr = g_string_new(header.c_str());
 359         auto ret = sr_input_scan_buffer(gstr, &input);
 360         g_string_free(gstr, true);
 361         check(ret);
 362         return shared_ptr<Input>(
 363                 new Input(shared_from_this(), input), Input::Deleter());
 364 }
 365
 366 map<string, string> Context::serials(shared_ptr<Driver> driver) const
 367 {
 368         GSList *serial_list = sr_serial_list(driver ? driver->_structure : nullptr);
 369         map<string, string> serials;
 370
 371         for (GSList *serial = serial_list; serial; serial = serial->next) {
 372                 auto *const port = static_cast<sr_serial_port *>(serial->data);
 373                 serials[string(port->name)] = string(port->description);
 374         }
 375
 376         g_slist_free_full(serial_list,
 377                 reinterpret_cast<GDestroyNotify>(&sr_serial_free));
 378         return serials;
 379 }
 380
 381 Driver::Driver(struct sr_dev_driver *structure) :
 382         Configurable(structure, nullptr, nullptr),
 383         _structure(structure),
 384         _initialized(false)
 385 {
 386 }
 387
 388 Driver::~Driver()
 389 {
 390 }
 391
 392 string Driver::name() const
 393 {
 394         return valid_string(_structure->name);
 395 }
 396
 397 string Driver::long_name() const
 398 {
 399         return valid_string(_structure->longname);
 400 }
 401
 402 vector<shared_ptr<HardwareDevice>> Driver::scan(
 403         const map<const ConfigKey *, Glib::VariantBase> &options)
 404 {
 405         /* Initialise the driver if not yet done. */
 406         if (!_initialized)
 407         {
 408                 check(sr_driver_init(_parent->_structure, _structure));
 409                 _initialized = true;
 410         }
 411
 412         /* Translate scan options to GSList of struct sr_config pointers. */
 413         GSList *option_list = nullptr;
 414         for (const auto &entry : options)
 415         {
 416                 const auto &key = entry.first;
 417                 const auto &value = entry.second;
 418                 auto *const config = g_new(struct sr_config, 1);
 419                 config->key = key->id();
 420                 config->data = const_cast<GVariant*>(value.gobj());
 421                 option_list = g_slist_append(option_list, config);
 422         }
 423
 424         /* Run scan. */
 425         GSList *device_list = sr_driver_scan(_structure, option_list);
 426
 427         /* Free option list. */
 428         g_slist_free_full(option_list, g_free);
 429
 430
 431         /* Create device objects. */
 432         vector<shared_ptr<HardwareDevice>> result;
 433         for (GSList *device = device_list; device; device = device->next)
 434         {
 435                 auto *const sdi = static_cast<struct sr_dev_inst *>(device->data);
 436                 result.push_back(shared_ptr<HardwareDevice>(
 437                         new HardwareDevice(shared_from_this(), sdi),
 438                         HardwareDevice::Deleter()));
 439         }
 440
 441         /* Free GSList returned from scan. */
 442         g_slist_free(device_list);
 443
 444         return result;
 445 }
 446
 447 Configurable::Configurable(
 448                 struct sr_dev_driver *driver,
 449                 struct sr_dev_inst *sdi,
 450                 struct sr_channel_group *cg) :
 451         config_driver(driver),
 452         config_sdi(sdi),
 453         config_channel_group(cg)
 454 {
 455 }
 456
 457 Configurable::~Configurable()
 458 {
 459 }
 460
 461 Glib::VariantBase Configurable::config_get(const ConfigKey *key) const
 462 {
 463         GVariant *data;
 464         check(sr_config_get(
 465                 config_driver, config_sdi, config_channel_group,
 466                 key->id(), &data));
 467         return Glib::VariantBase(data);
 468 }
 469
 470 void Configurable::config_set(const ConfigKey *key, const Glib::VariantBase &value)
 471 {
 472         check(sr_config_set(
 473                 config_sdi, config_channel_group,
 474                 key->id(), const_cast<GVariant*>(value.gobj())));
 475 }
 476
 477 Glib::VariantContainerBase Configurable::config_list(const ConfigKey *key) const
 478 {
 479         GVariant *data;
 480         check(sr_config_list(
 481                 config_driver, config_sdi, config_channel_group,
 482                 key->id(), &data));
 483         return Glib::VariantContainerBase(data);
 484 }
 485
 486 map<const ConfigKey *, set<Capability>> Configurable::config_keys(const ConfigKey *key)
 487 {
 488         GVariant *gvar_opts;
 489         gsize num_opts;
 490         const uint32_t *opts;
 491         map<const ConfigKey *, set<Capability>> result;
 492
 493         check(sr_config_list(
 494                 config_driver, config_sdi, config_channel_group,
 495                 key->id(), &gvar_opts));
 496
 497         opts = static_cast<const uint32_t *>(g_variant_get_fixed_array(
 498                 gvar_opts, &num_opts, sizeof(uint32_t)));
 499
 500         for (gsize i = 0; i < num_opts; i++)
 501         {
 502                 auto key = ConfigKey::get(opts[i] & SR_CONF_MASK);
 503                 set<Capability> capabilities;
 504                 if (opts[i] & SR_CONF_GET)
 505                         capabilities.insert(GET);
 506                 if (opts[i] & SR_CONF_SET)
 507                         capabilities.insert(SET);
 508                 if (opts[i] & SR_CONF_LIST)
 509                         capabilities.insert(LIST);
 510                 result[key] = capabilities;
 511         }
 512
 513         g_variant_unref(gvar_opts);
 514
 515         return result;
 516 }
 517
 518 bool Configurable::config_check(const ConfigKey *key,
 519         const ConfigKey *index_key) const
 520 {
 521         GVariant *gvar_opts;
 522         gsize num_opts;
 523         const uint32_t *opts;
 524
 525         if (sr_config_list(config_driver, config_sdi, config_channel_group,
 526                         index_key->id(), &gvar_opts) != SR_OK)
 527                 return false;
 528
 529         opts = static_cast<const uint32_t *>(g_variant_get_fixed_array(
 530                 gvar_opts, &num_opts, sizeof(uint32_t)));
 531
 532         for (gsize i = 0; i < num_opts; i++)
 533         {
 534                 if ((opts[i] & SR_CONF_MASK) == unsigned(key->id()))
 535                 {
 536                         g_variant_unref(gvar_opts);
 537                         return true;
 538                 }
 539         }
 540
 541         g_variant_unref(gvar_opts);
 542
 543         return false;
 544 }
 545
 546 Device::Device(struct sr_dev_inst *structure) :
 547         Configurable(sr_dev_inst_driver_get(structure), structure, nullptr),
 548         _structure(structure)
 549 {
 550         for (GSList *entry = sr_dev_inst_channels_get(structure); entry; entry = entry->next)
 551         {
 552                 auto *const ch = static_cast<struct sr_channel *>(entry->data);
 553                 unique_ptr<Channel> channel {new Channel{ch}};
 554                 _channels.emplace(ch, move(channel));
 555         }
 556
 557         for (GSList *entry = sr_dev_inst_channel_groups_get(structure); entry; entry = entry->next)
 558         {
 559                 auto *const cg = static_cast<struct sr_channel_group *>(entry->data);
 560                 unique_ptr<ChannelGroup> group {new ChannelGroup{this, cg}};
 561                 _channel_groups.emplace(group->name(), move(group));
 562         }
 563 }
 564
 565 Device::~Device()
 566 {}
 567
 568 string Device::vendor() const
 569 {
 570         return valid_string(sr_dev_inst_vendor_get(_structure));
 571 }
 572
 573 string Device::model() const
 574 {
 575         return valid_string(sr_dev_inst_model_get(_structure));
 576 }
 577
 578 string Device::version() const
 579 {
 580         return valid_string(sr_dev_inst_version_get(_structure));
 581 }
 582
 583 string Device::serial_number() const
 584 {
 585         return valid_string(sr_dev_inst_sernum_get(_structure));
 586 }
 587
 588 string Device::connection_id() const
 589 {
 590         return valid_string(sr_dev_inst_connid_get(_structure));
 591 }
 592
 593 vector<shared_ptr<Channel>> Device::channels()
 594 {
 595         vector<shared_ptr<Channel>> result;
 596         for (auto channel = sr_dev_inst_channels_get(_structure); channel; channel = channel->next) {
 597                 auto *const ch = static_cast<struct sr_channel *>(channel->data);
 598                 result.push_back(_channels[ch]->share_owned_by(get_shared_from_this()));
 599         }
 600         return result;
 601 }
 602
 603 shared_ptr<Channel> Device::get_channel(struct sr_channel *ptr)
 604 {
 605         return _channels[ptr]->share_owned_by(get_shared_from_this());
 606 }
 607
 608 map<string, shared_ptr<ChannelGroup>>
 609 Device::channel_groups()
 610 {
 611         map<string, shared_ptr<ChannelGroup>> result;
 612         for (const auto &entry: _channel_groups)
 613         {
 614                 const auto &name = entry.first;
 615                 const auto &channel_group = entry.second;
 616                 result.emplace(name, channel_group->share_owned_by(get_shared_from_this()));
 617         }
 618         return result;
 619 }
 620
 621 void Device::open()
 622 {
 623         check(sr_dev_open(_structure));
 624 }
 625
 626 void Device::close()
 627 {
 628         check(sr_dev_close(_structure));
 629 }
 630
 631 HardwareDevice::HardwareDevice(shared_ptr<Driver> driver,
 632                 struct sr_dev_inst *structure) :
 633         Device(structure),
 634         _driver(move(driver))
 635 {
 636 }
 637
 638 HardwareDevice::~HardwareDevice()
 639 {
 640 }
 641
 642 shared_ptr<Device> HardwareDevice::get_shared_from_this()
 643 {
 644         return static_pointer_cast<Device>(shared_from_this());
 645 }
 646
 647 shared_ptr<Driver> HardwareDevice::driver()
 648 {
 649         return _driver;
 650 }
 651
 652 UserDevice::UserDevice(string vendor, string model, string version) :
 653         Device(sr_dev_inst_user_new(
 654                 vendor.c_str(), model.c_str(), version.c_str()))
 655 {
 656 }
 657
 658 UserDevice::~UserDevice()
 659 {
 660 }
 661
 662 shared_ptr<Device> UserDevice::get_shared_from_this()
 663 {
 664         return static_pointer_cast<Device>(shared_from_this());
 665 }
 666
 667 shared_ptr<Channel> UserDevice::add_channel(unsigned int index,
 668         const ChannelType *type, string name)
 669 {
 670         check(sr_dev_inst_channel_add(Device::_structure,
 671                 index, type->id(), name.c_str()));
 672         GSList *const last = g_slist_last(sr_dev_inst_channels_get(Device::_structure));
 673         auto *const ch = static_cast<struct sr_channel *>(last->data);
 674         unique_ptr<Channel> channel {new Channel{ch}};
 675         _channels.emplace(ch, move(channel));
 676         return get_channel(ch);
 677 }
 678
 679 Channel::Channel(struct sr_channel *structure) :
 680         _structure(structure),
 681         _type(ChannelType::get(_structure->type))
 682 {
 683 }
 684
 685 Channel::~Channel()
 686 {
 687 }
 688
 689 string Channel::name() const
 690 {
 691         return valid_string(_structure->name);
 692 }
 693
 694 void Channel::set_name(string name)
 695 {
 696         check(sr_dev_channel_name_set(_structure, name.c_str()));
 697 }
 698
 699 const ChannelType *Channel::type() const
 700 {
 701         return ChannelType::get(_structure->type);
 702 }
 703
 704 bool Channel::enabled() const
 705 {
 706         return _structure->enabled;
 707 }
 708
 709 void Channel::set_enabled(bool value)
 710 {
 711         check(sr_dev_channel_enable(_structure, value));
 712 }
 713
 714 unsigned int Channel::index() const
 715 {
 716         return _structure->index;
 717 }
 718
 719 ChannelGroup::ChannelGroup(const Device *device,
 720                 struct sr_channel_group *structure) :
 721         Configurable(sr_dev_inst_driver_get(device->_structure), device->_structure, structure)
 722 {
 723         for (GSList *entry = config_channel_group->channels; entry; entry = entry->next) {
 724                 auto *const ch = static_cast<struct sr_channel *>(entry->data);
 725                 /* Note: This relies on Device::_channels to keep the Channel
 726                  * objects around over the lifetime of the ChannelGroup. */
 727                 _channels.push_back(device->_channels.find(ch)->second.get());
 728         }
 729 }
 730
 731 ChannelGroup::~ChannelGroup()
 732 {
 733 }
 734
 735 string ChannelGroup::name() const
 736 {
 737         return valid_string(config_channel_group->name);
 738 }
 739
 740 vector<shared_ptr<Channel>> ChannelGroup::channels()
 741 {
 742         vector<shared_ptr<Channel>> result;
 743         for (const auto &channel : _channels)
 744                 result.push_back(channel->share_owned_by(_parent));
 745         return result;
 746 }
 747
 748 Trigger::Trigger(shared_ptr<Context> context, string name) :
 749         _structure(sr_trigger_new(name.c_str())),
 750         _context(move(context))
 751 {
 752         for (auto *stage = _structure->stages; stage; stage = stage->next) {
 753                 unique_ptr<TriggerStage> ts {new TriggerStage{
 754                                 static_cast<struct sr_trigger_stage *>(stage->data)}};
 755                 _stages.push_back(move(ts));
 756         }
 757 }
 758
 759 Trigger::~Trigger()
 760 {
 761         sr_trigger_free(_structure);
 762 }
 763
 764 string Trigger::name() const
 765 {
 766         return _structure->name;
 767 }
 768
 769 vector<shared_ptr<TriggerStage>> Trigger::stages()
 770 {
 771         vector<shared_ptr<TriggerStage>> result;
 772         for (const auto &stage : _stages)
 773                 result.push_back(stage->share_owned_by(shared_from_this()));
 774         return result;
 775 }
 776
 777 shared_ptr<TriggerStage> Trigger::add_stage()
 778 {
 779         unique_ptr<TriggerStage> stage {new TriggerStage{sr_trigger_stage_add(_structure)}};
 780         _stages.push_back(move(stage));
 781         return _stages.back()->share_owned_by(shared_from_this());
 782 }
 783
 784 TriggerStage::TriggerStage(struct sr_trigger_stage *structure) :
 785         _structure(structure)
 786 {
 787 }
 788
 789 TriggerStage::~TriggerStage()
 790 {
 791 }
 792
 793 int TriggerStage::number() const
 794 {
 795         return _structure->stage;
 796 }
 797
 798 vector<shared_ptr<TriggerMatch>> TriggerStage::matches()
 799 {
 800         vector<shared_ptr<TriggerMatch>> result;
 801         for (const auto &match : _matches)
 802                 result.push_back(match->share_owned_by(shared_from_this()));
 803         return result;
 804 }
 805
 806 void TriggerStage::add_match(shared_ptr<Channel> channel,
 807         const TriggerMatchType *type, float value)
 808 {
 809         check(sr_trigger_match_add(_structure,
 810                 channel->_structure, type->id(), value));
 811         GSList *const last = g_slist_last(_structure->matches);
 812         unique_ptr<TriggerMatch> match {new TriggerMatch{
 813                         static_cast<struct sr_trigger_match *>(last->data),
 814                         move(channel)}};
 815         _matches.push_back(move(match));
 816 }
 817
 818 void TriggerStage::add_match(shared_ptr<Channel> channel,
 819         const TriggerMatchType *type)
 820 {
 821         add_match(move(channel), type, NAN);
 822 }
 823
 824 TriggerMatch::TriggerMatch(struct sr_trigger_match *structure,
 825                 shared_ptr<Channel> channel) :
 826         _structure(structure),
 827         _channel(move(channel))
 828 {
 829 }
 830
 831 TriggerMatch::~TriggerMatch()
 832 {
 833 }
 834
 835 shared_ptr<Channel> TriggerMatch::channel()
 836 {
 837         return _channel;
 838 }
 839
 840 const TriggerMatchType *TriggerMatch::type() const
 841 {
 842         return TriggerMatchType::get(_structure->match);
 843 }
 844
 845 float TriggerMatch::value() const
 846 {
 847         return _structure->value;
 848 }
 849
 850 DatafeedCallbackData::DatafeedCallbackData(Session *session,
 851                 DatafeedCallbackFunction callback) :
 852         _callback(move(callback)),
 853         _session(session)
 854 {
 855 }
 856
 857 void DatafeedCallbackData::run(const struct sr_dev_inst *sdi,
 858         const struct sr_datafeed_packet *pkt)
 859 {
 860         auto device = _session->get_device(sdi);
 861         auto packet = shared_ptr<Packet>(new Packet(device, pkt), Packet::Deleter());
 862         _callback(move(device), move(packet));
 863 }
 864
 865 SessionDevice::SessionDevice(struct sr_dev_inst *structure) :
 866         Device(structure)
 867 {
 868 }
 869
 870 SessionDevice::~SessionDevice()
 871 {
 872 }
 873
 874 shared_ptr<Device> SessionDevice::get_shared_from_this()
 875 {
 876         return static_pointer_cast<Device>(shared_from_this());
 877 }
 878
 879 Session::Session(shared_ptr<Context> context) :
 880         _structure(nullptr),
 881         _context(move(context))
 882 {
 883         check(sr_session_new(_context->_structure, &_structure));
 884         _context->_session = this;
 885 }
 886
 887 Session::Session(shared_ptr<Context> context, string filename) :
 888         _structure(nullptr),
 889         _context(move(context)),
 890         _filename(move(filename))
 891 {
 892         check(sr_session_load(_context->_structure, _filename.c_str(), &_structure));
 893         GSList *dev_list;
 894         check(sr_session_dev_list(_structure, &dev_list));
 895         for (GSList *dev = dev_list; dev; dev = dev->next) {
 896                 auto *const sdi = static_cast<struct sr_dev_inst *>(dev->data);
 897                 unique_ptr<SessionDevice> device {new SessionDevice{sdi}};
 898                 _owned_devices.emplace(sdi, move(device));
 899         }
 900         _context->_session = this;
 901 }
 902
 903 Session::~Session()
 904 {
 905         check(sr_session_destroy(_structure));
 906 }
 907
 908 shared_ptr<Device> Session::get_device(const struct sr_dev_inst *sdi)
 909 {
 910         if (_owned_devices.count(sdi))
 911                 return static_pointer_cast<Device>(
 912                         _owned_devices[sdi]->share_owned_by(shared_from_this()));
 913         else if (_other_devices.count(sdi))
 914                 return _other_devices[sdi];
 915         else
 916                 throw Error(SR_ERR_BUG);
 917 }
 918
 919 void Session::add_device(shared_ptr<Device> device)
 920 {
 921         const auto dev_struct = device->_structure;
 922         check(sr_session_dev_add(_structure, dev_struct));
 923         _other_devices[dev_struct] = move(device);
 924 }
 925
 926 vector<shared_ptr<Device>> Session::devices()
 927 {
 928         GSList *dev_list;
 929         check(sr_session_dev_list(_structure, &dev_list));
 930         vector<shared_ptr<Device>> result;
 931         for (GSList *dev = dev_list; dev; dev = dev->next) {
 932                 auto *const sdi = static_cast<struct sr_dev_inst *>(dev->data);
 933                 result.push_back(get_device(sdi));
 934         }
 935         return result;
 936 }
 937
 938 void Session::remove_devices()
 939 {
 940         _other_devices.clear();
 941         check(sr_session_dev_remove_all(_structure));
 942 }
 943
 944 void Session::start()
 945 {
 946         check(sr_session_start(_structure));
 947 }
 948
 949 void Session::run()
 950 {
 951         check(sr_session_run(_structure));
 952 }
 953
 954 void Session::stop()
 955 {
 956         check(sr_session_stop(_structure));
 957 }
 958
 959 bool Session::is_running() const
 960 {
 961         const int ret = sr_session_is_running(_structure);
 962         if (ret < 0)
 963                 throw Error{ret};
 964         return (ret != 0);
 965 }
 966
 967 static void session_stopped_callback(void *data) noexcept
 968 {
 969         auto *const callback = static_cast<SessionStoppedCallback*>(data);
 970         (*callback)();
 971 }
 972
 973 void Session::set_stopped_callback(SessionStoppedCallback callback)
 974 {
 975         _stopped_callback = move(callback);
 976         if (_stopped_callback)
 977                 check(sr_session_stopped_callback_set(_structure,
 978                                 &session_stopped_callback, &_stopped_callback));
 979         else
 980                 check(sr_session_stopped_callback_set(_structure,
 981                                 nullptr, nullptr));
 982 }
 983
 984 static void datafeed_callback(const struct sr_dev_inst *sdi,
 985         const struct sr_datafeed_packet *pkt, void *cb_data) noexcept
 986 {
 987         auto callback = static_cast<DatafeedCallbackData *>(cb_data);
 988         callback->run(sdi, pkt);
 989 }
 990
 991 void Session::add_datafeed_callback(DatafeedCallbackFunction callback)
 992 {
 993         unique_ptr<DatafeedCallbackData> cb_data
 994                 {new DatafeedCallbackData{this, move(callback)}};
 995         check(sr_session_datafeed_callback_add(_structure,
 996                         &datafeed_callback, cb_data.get()));
 997         _datafeed_callbacks.push_back(move(cb_data));
 998 }
 999
1000 void Session::remove_datafeed_callbacks()
1001 {
1002         check(sr_session_datafeed_callback_remove_all(_structure));
1003         _datafeed_callbacks.clear();
1004 }
1005
1006 shared_ptr<Trigger> Session::trigger()
1007 {
1008         return _trigger;
1009 }
1010
1011 void Session::set_trigger(shared_ptr<Trigger> trigger)
1012 {
1013         if (!trigger)
1014                 // Set NULL trigger, i.e. remove any trigger from the session.
1015                 check(sr_session_trigger_set(_structure, nullptr));
1016         else
1017                 check(sr_session_trigger_set(_structure, trigger->_structure));
1018         _trigger = move(trigger);
1019 }
1020
1021 string Session::filename() const
1022 {
1023         return _filename;
1024 }
1025
1026 shared_ptr<Context> Session::context()
1027 {
1028         return _context;
1029 }
1030
1031 Packet::Packet(shared_ptr<Device> device,
1032         const struct sr_datafeed_packet *structure) :
1033         _structure(structure),
1034         _device(move(device))
1035 {
1036         switch (structure->type)
1037         {
1038                 case SR_DF_HEADER:
1039                         _payload.reset(new Header{
1040                                 static_cast<const struct sr_datafeed_header *>(
1041                                         structure->payload)});
1042                         break;
1043                 case SR_DF_META:
1044                         _payload.reset(new Meta{
1045                                 static_cast<const struct sr_datafeed_meta *>(
1046                                         structure->payload)});
1047                         break;
1048                 case SR_DF_LOGIC:
1049                         _payload.reset(new Logic{
1050                                 static_cast<const struct sr_datafeed_logic *>(
1051                                         structure->payload)});
1052                         break;
1053                 case SR_DF_ANALOG:
1054                         _payload.reset(new Analog{
1055                                 static_cast<const struct sr_datafeed_analog *>(
1056                                         structure->payload)});
1057                         break;
1058         }
1059 }
1060
1061 Packet::~Packet()
1062 {
1063 }
1064
1065 const PacketType *Packet::type() const
1066 {
1067         return PacketType::get(_structure->type);
1068 }
1069
1070 shared_ptr<PacketPayload> Packet::payload()
1071 {
1072         if (_payload)
1073                 return _payload->share_owned_by(shared_from_this());
1074         else
1075                 throw Error(SR_ERR_NA);
1076 }
1077
1078 PacketPayload::PacketPayload()
1079 {
1080 }
1081
1082 PacketPayload::~PacketPayload()
1083 {
1084 }
1085
1086 Header::Header(const struct sr_datafeed_header *structure) :
1087         PacketPayload(),
1088         _structure(structure)
1089 {
1090 }
1091
1092 Header::~Header()
1093 {
1094 }
1095
1096 shared_ptr<PacketPayload> Header::share_owned_by(shared_ptr<Packet> _parent)
1097 {
1098         return static_pointer_cast<PacketPayload>(
1099                 ParentOwned::share_owned_by(_parent));
1100 }
1101
1102 int Header::feed_version() const
1103 {
1104         return _structure->feed_version;
1105 }
1106
1107 Glib::TimeVal Header::start_time() const
1108 {
1109         return Glib::TimeVal(
1110                 _structure->starttime.tv_sec,
1111                 _structure->starttime.tv_usec);
1112 }
1113
1114 Meta::Meta(const struct sr_datafeed_meta *structure) :
1115         PacketPayload(),
1116         _structure(structure)
1117 {
1118 }
1119
1120 Meta::~Meta()
1121 {
1122 }
1123
1124 shared_ptr<PacketPayload> Meta::share_owned_by(shared_ptr<Packet> _parent)
1125 {
1126         return static_pointer_cast<PacketPayload>(
1127                 ParentOwned::share_owned_by(_parent));
1128 }
1129
1130 map<const ConfigKey *, Glib::VariantBase> Meta::config() const
1131 {
1132         map<const ConfigKey *, Glib::VariantBase> result;
1133         for (auto l = _structure->config; l; l = l->next) {
1134                 auto *const config = static_cast<struct sr_config *>(l->data);
1135                 result[ConfigKey::get(config->key)] = Glib::VariantBase(config->data);
1136         }
1137         return result;
1138 }
1139
1140 Logic::Logic(const struct sr_datafeed_logic *structure) :
1141         PacketPayload(),
1142         _structure(structure)
1143 {
1144 }
1145
1146 Logic::~Logic()
1147 {
1148 }
1149
1150 shared_ptr<PacketPayload> Logic::share_owned_by(shared_ptr<Packet> _parent)
1151 {
1152         return static_pointer_cast<PacketPayload>(
1153                 ParentOwned::share_owned_by(_parent));
1154 }
1155
1156 void *Logic::data_pointer()
1157 {
1158         return _structure->data;
1159 }
1160
1161 size_t Logic::data_length() const
1162 {
1163         return _structure->length;
1164 }
1165
1166 unsigned int Logic::unit_size() const
1167 {
1168         return _structure->unitsize;
1169 }
1170
1171 Analog::Analog(const struct sr_datafeed_analog *structure) :
1172         PacketPayload(),
1173         _structure(structure)
1174 {
1175 }
1176
1177 Analog::~Analog()
1178 {
1179 }
1180
1181 shared_ptr<PacketPayload> Analog::share_owned_by(shared_ptr<Packet> _parent)
1182 {
1183         return static_pointer_cast<PacketPayload>(
1184                 ParentOwned::share_owned_by(_parent));
1185 }
1186
1187 void *Analog::data_pointer()
1188 {
1189         return _structure->data;
1190 }
1191
1192 unsigned int Analog::num_samples() const
1193 {
1194         return _structure->num_samples;
1195 }
1196
1197 vector<shared_ptr<Channel>> Analog::channels()
1198 {
1199         vector<shared_ptr<Channel>> result;
1200         for (auto l = _structure->meaning->channels; l; l = l->next) {
1201                 auto *const ch = static_cast<struct sr_channel *>(l->data);
1202                 result.push_back(_parent->_device->get_channel(ch));
1203         }
1204         return result;
1205 }
1206
1207 const Quantity *Analog::mq() const
1208 {
1209         return Quantity::get(_structure->meaning->mq);
1210 }
1211
1212 const Unit *Analog::unit() const
1213 {
1214         return Unit::get(_structure->meaning->unit);
1215 }
1216
1217 vector<const QuantityFlag *> Analog::mq_flags() const
1218 {
1219         return QuantityFlag::flags_from_mask(_structure->meaning->mqflags);
1220 }
1221
1222 InputFormat::InputFormat(const struct sr_input_module *structure) :
1223         _structure(structure)
1224 {
1225 }
1226
1227 InputFormat::~InputFormat()
1228 {
1229 }
1230
1231 string InputFormat::name() const
1232 {
1233         return valid_string(sr_input_id_get(_structure));
1234 }
1235
1236 string InputFormat::description() const
1237 {
1238         return valid_string(sr_input_description_get(_structure));
1239 }
1240
1241 vector<string> InputFormat::extensions() const
1242 {
1243         vector<string> exts;
1244         for (const char *const *e = sr_input_extensions_get(_structure);
1245                 e && *e; e++)
1246                 exts.push_back(*e);
1247         return exts;
1248 }
1249
1250 map<string, shared_ptr<Option>> InputFormat::options()
1251 {
1252         const struct sr_option **options = sr_input_options_get(_structure);
1253         map<string, shared_ptr<Option>> result;
1254         if (options)
1255         {
1256                 auto option_array = shared_ptr<const struct sr_option *>(
1257                         options, sr_input_options_free);
1258                 for (int i = 0; options[i]; i++)
1259                         result[options[i]->id] = shared_ptr<Option>(
1260                                 new Option(options[i], option_array), Option::Deleter());
1261         }
1262         return result;
1263 }
1264
1265 shared_ptr<Input> InputFormat::create_input(
1266         const map<string, Glib::VariantBase> &options)
1267 {
1268         auto input = sr_input_new(_structure, map_to_hash_variant(options));
1269         if (!input)
1270                 throw Error(SR_ERR_ARG);
1271         return shared_ptr<Input>(new Input(_parent, input), Input::Deleter());
1272 }
1273
1274 Input::Input(shared_ptr<Context> context, const struct sr_input *structure) :
1275         _structure(structure),
1276         _context(move(context))
1277 {
1278 }
1279
1280 shared_ptr<InputDevice> Input::device()
1281 {
1282         if (!_device)
1283         {
1284                 auto sdi = sr_input_dev_inst_get(_structure);
1285                 if (!sdi)
1286                         throw Error(SR_ERR_NA);
1287                 _device.reset(new InputDevice{shared_from_this(), sdi});
1288         }
1289
1290         return _device->share_owned_by(shared_from_this());
1291 }
1292
1293 void Input::send(void *data, size_t length)
1294 {
1295         auto gstr = g_string_new_len(static_cast<char *>(data), length);
1296         auto ret = sr_input_send(_structure, gstr);
1297         g_string_free(gstr, false);
1298         check(ret);
1299 }
1300
1301 void Input::end()
1302 {
1303         check(sr_input_end(_structure));
1304 }
1305
1306 Input::~Input()
1307 {
1308         sr_input_free(_structure);
1309 }
1310
1311 InputDevice::InputDevice(shared_ptr<Input> input,
1312                 struct sr_dev_inst *structure) :
1313         Device(structure),
1314         _input(move(input))
1315 {
1316 }
1317
1318 InputDevice::~InputDevice()
1319 {
1320 }
1321
1322 shared_ptr<Device> InputDevice::get_shared_from_this()
1323 {
1324         return static_pointer_cast<Device>(shared_from_this());
1325 }
1326
1327 Option::Option(const struct sr_option *structure,
1328                 shared_ptr<const struct sr_option *> structure_array) :
1329         _structure(structure),
1330         _structure_array(move(structure_array))
1331 {
1332 }
1333
1334 Option::~Option()
1335 {
1336 }
1337
1338 string Option::id() const
1339 {
1340         return valid_string(_structure->id);
1341 }
1342
1343 string Option::name() const
1344 {
1345         return valid_string(_structure->name);
1346 }
1347
1348 string Option::description() const
1349 {
1350         return valid_string(_structure->desc);
1351 }
1352
1353 Glib::VariantBase Option::default_value() const
1354 {
1355         return Glib::VariantBase(_structure->def, true);
1356 }
1357
1358 vector<Glib::VariantBase> Option::values() const
1359 {
1360         vector<Glib::VariantBase> result;
1361         for (auto l = _structure->values; l; l = l->next) {
1362                 auto *const var = static_cast<GVariant *>(l->data);
1363                 result.push_back(Glib::VariantBase(var, true));
1364         }
1365         return result;
1366 }
1367
1368 OutputFormat::OutputFormat(const struct sr_output_module *structure) :
1369         _structure(structure)
1370 {
1371 }
1372
1373 OutputFormat::~OutputFormat()
1374 {
1375 }
1376
1377 string OutputFormat::name() const
1378 {
1379         return valid_string(sr_output_id_get(_structure));
1380 }
1381
1382 string OutputFormat::description() const
1383 {
1384         return valid_string(sr_output_description_get(_structure));
1385 }
1386
1387 vector<string> OutputFormat::extensions() const
1388 {
1389         vector<string> exts;
1390         for (const char *const *e = sr_output_extensions_get(_structure);
1391                 e && *e; e++)
1392                 exts.push_back(*e);
1393         return exts;
1394 }
1395
1396 map<string, shared_ptr<Option>> OutputFormat::options()
1397 {
1398         const struct sr_option **options = sr_output_options_get(_structure);
1399         map<string, shared_ptr<Option>> result;
1400         if (options)
1401         {
1402                 auto option_array = shared_ptr<const struct sr_option *>(
1403                         options, sr_output_options_free);
1404                 for (int i = 0; options[i]; i++)
1405                         result[options[i]->id] = shared_ptr<Option>(
1406                                 new Option(options[i], option_array), Option::Deleter());
1407         }
1408         return result;
1409 }
1410
1411 shared_ptr<Output> OutputFormat::create_output(
1412         shared_ptr<Device> device, const map<string, Glib::VariantBase> &options)
1413 {
1414         return shared_ptr<Output>(
1415                 new Output(shared_from_this(), move(device), options),
1416                 Output::Deleter());
1417 }
1418
1419 shared_ptr<Output> OutputFormat::create_output(string filename,
1420         shared_ptr<Device> device, const map<string, Glib::VariantBase> &options)
1421 {
1422         return shared_ptr<Output>(
1423                 new Output(move(filename), shared_from_this(), move(device), options),
1424                 Output::Deleter());
1425 }
1426
1427 bool OutputFormat::test_flag(const OutputFlag *flag) const
1428 {
1429         return sr_output_test_flag(_structure, flag->id());
1430 }
1431
1432 Output::Output(shared_ptr<OutputFormat> format,
1433                 shared_ptr<Device> device, const map<string, Glib::VariantBase> &options) :
1434         _structure(sr_output_new(format->_structure,
1435                 map_to_hash_variant(options), device->_structure, nullptr)),
1436         _format(move(format)),
1437         _device(move(device)),
1438         _options(options)
1439 {
1440 }
1441
1442 Output::Output(string filename, shared_ptr<OutputFormat> format,
1443                 shared_ptr<Device> device, const map<string, Glib::VariantBase> &options) :
1444         _structure(sr_output_new(format->_structure,
1445                 map_to_hash_variant(options), device->_structure, filename.c_str())),
1446         _format(move(format)),
1447         _device(move(device)),
1448         _options(options)
1449 {
1450 }
1451
1452 Output::~Output()
1453 {
1454         check(sr_output_free(_structure));
1455 }
1456
1457 string Output::receive(shared_ptr<Packet> packet)
1458 {
1459         GString *out;
1460         check(sr_output_send(_structure, packet->_structure, &out));
1461         if (out)
1462         {
1463                 auto result = string(out->str, out->str + out->len);
1464                 g_string_free(out, true);
1465                 return result;
1466         }
1467         else
1468         {
1469                 return string();
1470         }
1471 }
1472
1473 #include <enums.cpp>
1474
1475 }