-/*
- * This file is part of the PulseView project.
- *
- * Copyright (C) 2012-14 Joel Holdsworth <joel@airwebreathe.org.uk>
- *
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation; either version 2 of the License, or
- * (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
- */
-
-#ifdef ENABLE_DECODE
-#include <libsigrokdecode/libsigrokdecode.h>
-#endif
-
-#include "sigsession.hpp"
-
-#include "devicemanager.hpp"
-
-#include "data/analog.hpp"
-#include "data/analogsnapshot.hpp"
-#include "data/decoderstack.hpp"
-#include "data/logic.hpp"
-#include "data/logicsnapshot.hpp"
-#include "data/decode/decoder.hpp"
-
-#include "view/analogsignal.hpp"
-#include "view/decodetrace.hpp"
-#include "view/logicsignal.hpp"
-
-#include <cassert>
-#include <mutex>
-#include <stdexcept>
-
-#include <sys/stat.h>
-
-#include <QDebug>
-
-#include <libsigrok/libsigrok.hpp>
-
-using boost::shared_lock;
-using boost::shared_mutex;
-using boost::unique_lock;
-
-using std::dynamic_pointer_cast;
-using std::function;
-using std::lock_guard;
-using std::list;
-using std::map;
-using std::mutex;
-using std::set;
-using std::shared_ptr;
-using std::string;
-using std::vector;
-
-using sigrok::Analog;
-using sigrok::Channel;
-using sigrok::ChannelType;
-using sigrok::ConfigKey;
-using sigrok::DatafeedCallbackFunction;
-using sigrok::Device;
-using sigrok::Error;
-using sigrok::HardwareDevice;
-using sigrok::Header;
-using sigrok::Logic;
-using sigrok::Meta;
-using sigrok::Packet;
-using sigrok::PacketPayload;
-using sigrok::Session;
-using sigrok::SessionDevice;
-
-using Glib::VariantBase;
-using Glib::Variant;
-
-namespace pv {
-Session::Session(DeviceManager &device_manager) :
- device_manager_(device_manager),
- session_(device_manager.context()->create_session()),
- capture_state_(Stopped)
-{
- set_default_device();
-}
-
-Session::~Session()
-{
- // Stop and join to the thread
- stop_capture();
-}
-
-DeviceManager& Session::device_manager()
-{
- return device_manager_;
-}
-
-const DeviceManager& Session::device_manager() const
-{
- return device_manager_;
-}
-
-const shared_ptr<sigrok::Session>& Session::session() const
-{
- return session_;
-}
-
-shared_ptr<Device> Session::device() const
-{
- return device_;
-}
-
-void Session::set_device(shared_ptr<Device> device)
-{
- // Ensure we are not capturing before setting the device
- stop_capture();
-
- // Are we setting a session device?
- auto session_device = dynamic_pointer_cast<SessionDevice>(device);
- // Did we have a session device selected previously?
- auto prev_session_device = dynamic_pointer_cast<SessionDevice>(device_);
-
- if (device_) {
- session_->remove_datafeed_callbacks();
- if (!prev_session_device) {
- device_->close();
- session_->remove_devices();
- }
- }
-
- if (session_device)
- session_ = session_device->parent();
-
- decode_traces_.clear();
-
- if (device) {
- if (!session_device)
- {
- session_ = device_manager_.context()->create_session();
-
- try {
- device->open();
- } catch(const sigrok::Error &e) {
- throw QString(e.what());
- }
-
- session_->add_device(device);
- }
-
- device_ = device;
- session_->add_datafeed_callback([=]
- (shared_ptr<Device> device, shared_ptr<Packet> packet) {
- data_feed_in(device, packet);
- });
- update_signals(device);
- } else
- device_ = nullptr;
-
- device_selected();
-}
-
-void Session::set_file(const string &name)
-{
- session_ = device_manager_.context()->load_session(name);
- device_ = session_->devices()[0];
- decode_traces_.clear();
- session_->add_datafeed_callback([=]
- (shared_ptr<Device> device, shared_ptr<Packet> packet) {
- data_feed_in(device, packet);
- });
- device_manager_.update_display_name(device_);
- update_signals(device_);
- device_selected();
-}
-
-void Session::set_default_device()
-{
- shared_ptr<HardwareDevice> default_device;
- const list< shared_ptr<HardwareDevice> > &devices =
- device_manager_.devices();
-
- if (!devices.empty()) {
- // Fall back to the first device in the list.
- default_device = devices.front();
-
- // Try and find the demo device and select that by default
- for (shared_ptr<HardwareDevice> dev : devices)
- if (dev->driver()->name().compare("demo") == 0) {
- default_device = dev;
- break;
- }
-
- set_device(default_device);
- }
-}
-
-Session::capture_state Session::get_capture_state() const
-{
- lock_guard<mutex> lock(sampling_mutex_);
- return capture_state_;
-}
-
-void Session::start_capture(function<void (const QString)> error_handler)
-{
- stop_capture();
-
- // Check that a device instance has been selected.
- if (!device_) {
- qDebug() << "No device selected";
- return;
- }
-
- // Check that at least one channel is enabled
- auto channels = device_->channels();
- bool enabled = std::any_of(channels.begin(), channels.end(),
- [](shared_ptr<Channel> channel) { return channel->enabled(); });
-
- if (!enabled) {
- error_handler(tr("No channels enabled."));
- return;
- }
-
- // Begin the session
- sampling_thread_ = std::thread(
- &Session::sample_thread_proc, this, device_,
- error_handler);
-}
-
-void Session::stop_capture()
-{
- if (get_capture_state() != Stopped)
- session_->stop();
-
- // Check that sampling stopped
- if (sampling_thread_.joinable())
- sampling_thread_.join();
-}
-
-set< shared_ptr<data::SignalData> > Session::get_data() const
-{
- shared_lock<shared_mutex> lock(signals_mutex_);
- set< shared_ptr<data::SignalData> > data;
- for (const shared_ptr<view::Signal> sig : signals_) {
- assert(sig);
- data.insert(sig->data());
- }
-
- return data;
-}
-
-boost::shared_mutex& Session::signals_mutex() const
-{
- return signals_mutex_;
-}
-
-const vector< shared_ptr<view::Signal> >& Session::signals() const
-{
- return signals_;
-}
-
-#ifdef ENABLE_DECODE
-bool Session::add_decoder(srd_decoder *const dec)
-{
- map<const srd_channel*, shared_ptr<view::LogicSignal> > channels;
- shared_ptr<data::DecoderStack> decoder_stack;
-
- try
- {
- lock_guard<boost::shared_mutex> lock(signals_mutex_);
-
- // Create the decoder
- decoder_stack = shared_ptr<data::DecoderStack>(
- new data::DecoderStack(*this, dec));
-
- // Make a list of all the channels
- std::vector<const srd_channel*> all_channels;
- for(const GSList *i = dec->channels; i; i = i->next)
- all_channels.push_back((const srd_channel*)i->data);
- for(const GSList *i = dec->opt_channels; i; i = i->next)
- all_channels.push_back((const srd_channel*)i->data);
-
- // Auto select the initial channels
- for (const srd_channel *pdch : all_channels)
- for (shared_ptr<view::Signal> s : signals_)
- {
- shared_ptr<view::LogicSignal> l =
- dynamic_pointer_cast<view::LogicSignal>(s);
- if (l && QString::fromUtf8(pdch->name).
- toLower().contains(
- l->name().toLower()))
- channels[pdch] = l;
- }
-
- assert(decoder_stack);
- assert(!decoder_stack->stack().empty());
- assert(decoder_stack->stack().front());
- decoder_stack->stack().front()->set_channels(channels);
-
- // Create the decode signal
- shared_ptr<view::DecodeTrace> d(
- new view::DecodeTrace(*this, decoder_stack,
- decode_traces_.size()));
- decode_traces_.push_back(d);
- }
- catch(std::runtime_error e)
- {
- return false;
- }
-
- signals_changed();
-
- // Do an initial decode
- decoder_stack->begin_decode();
-
- return true;
-}
-
-vector< shared_ptr<view::DecodeTrace> > Session::get_decode_signals() const
-{
- shared_lock<shared_mutex> lock(signals_mutex_);
- return decode_traces_;
-}
-
-void Session::remove_decode_signal(view::DecodeTrace *signal)
-{
- for (auto i = decode_traces_.begin(); i != decode_traces_.end(); i++)
- if ((*i).get() == signal)
- {
- decode_traces_.erase(i);
- signals_changed();
- return;
- }
-}
-#endif
-
-void Session::set_capture_state(capture_state state)
-{
- lock_guard<mutex> lock(sampling_mutex_);
- const bool changed = capture_state_ != state;
- capture_state_ = state;
- if(changed)
- capture_state_changed(state);
-}
-
-void Session::update_signals(shared_ptr<Device> device)
-{
- assert(device);
- assert(capture_state_ == Stopped);
-
- // Clear the decode traces
- decode_traces_.clear();
-
- // Detect what data types we will receive
- auto channels = device->channels();
- unsigned int logic_channel_count = std::count_if(
- channels.begin(), channels.end(),
- [] (shared_ptr<Channel> channel) {
- return channel->type() == ChannelType::LOGIC; });
-
- // Create data containers for the logic data snapshots
- {
- lock_guard<mutex> data_lock(data_mutex_);
-
- logic_data_.reset();
- if (logic_channel_count != 0) {
- logic_data_.reset(new data::Logic(
- logic_channel_count));
- assert(logic_data_);
- }
- }
-
- // Make the Signals list
- {
- unique_lock<shared_mutex> lock(signals_mutex_);
-
- signals_.clear();
-
- for (auto channel : device->channels()) {
- shared_ptr<view::Signal> signal;
-
- switch(channel->type()->id()) {
- case SR_CHANNEL_LOGIC:
- signal = shared_ptr<view::Signal>(
- new view::LogicSignal(*this, device,
- channel, logic_data_));
- break;
-
- case SR_CHANNEL_ANALOG:
- {
- shared_ptr<data::Analog> data(
- new data::Analog());
- signal = shared_ptr<view::Signal>(
- new view::AnalogSignal(
- *this, channel, data));
- break;
- }
-
- default:
- assert(0);
- break;
- }
-
- assert(signal);
- signals_.push_back(signal);
- }
-
- }
-
- signals_changed();
-}
-
-shared_ptr<view::Signal> Session::signal_from_channel(
- shared_ptr<Channel> channel) const
-{
- lock_guard<boost::shared_mutex> lock(signals_mutex_);
- for (shared_ptr<view::Signal> sig : signals_) {
- assert(sig);
- if (sig->channel() == channel)
- return sig;
- }
- return shared_ptr<view::Signal>();
-}
-
-void Session::read_sample_rate(shared_ptr<Device> device)
-{
- const auto keys = device_->config_keys(ConfigKey::DEVICE_OPTIONS);
- const auto iter = keys.find(ConfigKey::SAMPLERATE);
- const uint64_t sample_rate = (iter != keys.end() &&
- (*iter).second.find(sigrok::GET) != (*iter).second.end()) ?
- VariantBase::cast_dynamic<Variant<guint64>>(
- device->config_get(ConfigKey::SAMPLERATE)).get() : 0;
-
- // Set the sample rate of all data
- const set< shared_ptr<data::SignalData> > data_set = get_data();
- for (shared_ptr<data::SignalData> data : data_set) {
- assert(data);
- data->set_samplerate(sample_rate);
- }
-}
-
-void Session::sample_thread_proc(shared_ptr<Device> device,
- function<void (const QString)> error_handler)
-{
- assert(device);
- assert(error_handler);
-
- read_sample_rate(device);
-
- try {
- session_->start();
- } catch(Error e) {
- error_handler(e.what());
- return;
- }
-
- set_capture_state(session_->trigger() ?
- AwaitingTrigger : Running);
-
- session_->run();
- set_capture_state(Stopped);
-
- // Confirm that SR_DF_END was received
- if (cur_logic_snapshot_)
- {
- qDebug("SR_DF_END was not received.");
- assert(0);
- }
-}
-
-void Session::feed_in_header(shared_ptr<Device> device)
-{
- read_sample_rate(device);
-}
-
-void Session::feed_in_meta(shared_ptr<Device> device,
- shared_ptr<Meta> meta)
-{
- (void)device;
-
- for (auto entry : meta->config()) {
- switch (entry.first->id()) {
- case SR_CONF_SAMPLERATE:
- /// @todo handle samplerate changes
- break;
- default:
- // Unknown metadata is not an error.
- break;
- }
- }
-
- signals_changed();
-}
-
-void Session::feed_in_frame_begin()
-{
- if (cur_logic_snapshot_ || !cur_analog_snapshots_.empty())
- frame_began();
-}
-
-void Session::feed_in_logic(shared_ptr<Logic> logic)
-{
- lock_guard<mutex> lock(data_mutex_);
-
- if (!logic_data_)
- {
- qDebug() << "Unexpected logic packet";
- return;
- }
-
- if (!cur_logic_snapshot_)
- {
- // This could be the first packet after a trigger
- set_capture_state(Running);
-
- // Get sample limit.
- const auto keys = device_->config_keys(
- ConfigKey::DEVICE_OPTIONS);
- const auto iter = keys.find(ConfigKey::LIMIT_SAMPLES);
- const uint64_t sample_limit = (iter != keys.end() &&
- (*iter).second.find(sigrok::GET) !=
- (*iter).second.end()) ?
- VariantBase::cast_dynamic<Variant<guint64>>(
- device_->config_get(ConfigKey::LIMIT_SAMPLES)).get() : 0;
-
- // Create a new data snapshot
- cur_logic_snapshot_ = shared_ptr<data::LogicSnapshot>(
- new data::LogicSnapshot(logic, sample_limit));
- logic_data_->push_snapshot(cur_logic_snapshot_);
-
- // @todo Putting this here means that only listeners querying
- // for logic will be notified. Currently the only user of
- // frame_began is DecoderStack, but in future we need to signal
- // this after both analog and logic sweeps have begun.
- frame_began();
- }
- else
- {
- // Append to the existing data snapshot
- cur_logic_snapshot_->append_payload(logic);
- }
-
- data_received();
-}
-
-void Session::feed_in_analog(shared_ptr<Analog> analog)
-{
- lock_guard<mutex> lock(data_mutex_);
-
- const vector<shared_ptr<Channel>> channels = analog->channels();
- const unsigned int channel_count = channels.size();
- const size_t sample_count = analog->num_samples() / channel_count;
- const float *data = analog->data_pointer();
- bool sweep_beginning = false;
-
- for (auto channel : channels)
- {
- shared_ptr<data::AnalogSnapshot> snapshot;
-
- // Try to get the snapshot of the channel
- const map< shared_ptr<Channel>, shared_ptr<data::AnalogSnapshot> >::
- iterator iter = cur_analog_snapshots_.find(channel);
- if (iter != cur_analog_snapshots_.end())
- snapshot = (*iter).second;
- else
- {
- // If no snapshot was found, this means we havn't
- // created one yet. i.e. this is the first packet
- // in the sweep containing this snapshot.
- sweep_beginning = true;
-
- // Get sample limit.
- uint64_t sample_limit;
- try {
- sample_limit = VariantBase::cast_dynamic<Variant<guint64>>(
- device_->config_get(ConfigKey::LIMIT_SAMPLES)).get();
- } catch (Error) {
- sample_limit = 0;
- }
-
- // Create a snapshot, keep it in the maps of channels
- snapshot = shared_ptr<data::AnalogSnapshot>(
- new data::AnalogSnapshot(sample_limit));
- cur_analog_snapshots_[channel] = snapshot;
-
- // Find the annalog data associated with the channel
- shared_ptr<view::AnalogSignal> sig =
- dynamic_pointer_cast<view::AnalogSignal>(
- signal_from_channel(channel));
- assert(sig);
-
- shared_ptr<data::Analog> data(sig->analog_data());
- assert(data);
-
- // Push the snapshot into the analog data.
- data->push_snapshot(snapshot);
- }
-
- assert(snapshot);
-
- // Append the samples in the snapshot
- snapshot->append_interleaved_samples(data++, sample_count,
- channel_count);
- }
-
- if (sweep_beginning) {
- // This could be the first packet after a trigger
- set_capture_state(Running);
- }
-
- data_received();
-}
-
-void Session::data_feed_in(shared_ptr<Device> device, shared_ptr<Packet> packet)
-{
- assert(device);
- assert(packet);
-
- switch (packet->type()->id()) {
- case SR_DF_HEADER:
- feed_in_header(device);
- break;
-
- case SR_DF_META:
- feed_in_meta(device, dynamic_pointer_cast<Meta>(packet->payload()));
- break;
-
- case SR_DF_FRAME_BEGIN:
- feed_in_frame_begin();
- break;
-
- case SR_DF_LOGIC:
- feed_in_logic(dynamic_pointer_cast<Logic>(packet->payload()));
- break;
-
- case SR_DF_ANALOG:
- feed_in_analog(dynamic_pointer_cast<Analog>(packet->payload()));
- break;
-
- case SR_DF_END:
- {
- {
- lock_guard<mutex> lock(data_mutex_);
- cur_logic_snapshot_.reset();
- cur_analog_snapshots_.clear();
- }
- frame_ended();
- break;
- }
- default:
- break;
- }
-}
-
-} // namespace pv
projects / pulseview.git / commitdiff