X-Git-Url: https://sigrok.org/gitweb/?p=pulseview.git;a=blobdiff_plain;f=pv%2Fsigsession.cpp;h=5a794417f2112754f6cf0cc566202b452b49c5d8;hp=3e0801bf1f6ffa295829f64bb35d5d337cca14cf;hb=1f4caa772cd691da7578816bf3744496c9cde1cf;hpb=728e5ef71a1a87e764f78bfbdd3cc4cc1da1163c diff --git a/pv/sigsession.cpp b/pv/sigsession.cpp index 3e0801bf..5a794417 100644 --- a/pv/sigsession.cpp +++ b/pv/sigsession.cpp @@ -1,7 +1,7 @@ /* * This file is part of the PulseView project. * - * Copyright (C) 2012 Joel Holdsworth + * Copyright (C) 2012-14 Joel Holdsworth * * 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 @@ -18,80 +18,161 @@ * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA */ +#ifdef ENABLE_DECODE +#include +#endif + #include "sigsession.h" #include "devicemanager.h" + #include "data/analog.h" #include "data/analogsnapshot.h" +#include "data/decoderstack.h" #include "data/logic.h" #include "data/logicsnapshot.h" +#include "data/decode/decoder.h" + #include "view/analogsignal.h" +#include "view/decodetrace.h" #include "view/logicsignal.h" -#include +#include +#include +#include #include #include -using namespace boost; -using namespace std; +#include + +using std::dynamic_pointer_cast; +using std::function; +using std::lock_guard; +using std::mutex; +using std::list; +using std::map; +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 { - -// TODO: This should not be necessary -SigSession* SigSession::_session = NULL; - SigSession::SigSession(DeviceManager &device_manager) : _device_manager(device_manager), - _sdi(NULL), + _session(device_manager.context()->create_session()), _capture_state(Stopped) { - // TODO: This should not be necessary - _session = this; + set_default_device(); } SigSession::~SigSession() { + // Stop and join to the thread stop_capture(); - - if (_sampling_thread.get()) - _sampling_thread->join(); - _sampling_thread.reset(); - - // TODO: This should not be necessary - _session = NULL; } -struct sr_dev_inst* SigSession::get_device() const +const shared_ptr& SigSession::session() const { - return _sdi; + return _session; } -void SigSession::set_device(struct sr_dev_inst *sdi) +shared_ptr SigSession::device() const { - if (_sdi) - _device_manager.release_device(_sdi); - if (sdi) - _device_manager.use_device(sdi, this); - _sdi = sdi; + return _device; } -void SigSession::release_device(struct sr_dev_inst *sdi) +void SigSession::set_device(shared_ptr device) { - (void)sdi; + // Ensure we are not capturing before setting the device + stop_capture(); - assert(_capture_state == Stopped); - _sdi = NULL; + // Are we setting a session device? + auto session_device = dynamic_pointer_cast(device); + // Did we have a session device selected previously? + auto prev_session_device = dynamic_pointer_cast(_device); + + if (_device) { + _session->remove_datafeed_callbacks(); + if (!prev_session_device) { + _device->close(); + _session->remove_devices(); + } + } + + if (session_device) + _session = session_device->parent(); + + _device = device; + _decode_traces.clear(); + + if (device) { + if (!session_device) + { + _session = _device_manager.context()->create_session(); + device->open(); + _session->add_device(device); + } + _session->add_datafeed_callback([=] + (shared_ptr device, shared_ptr packet) { + data_feed_in(device, packet); + }); + update_signals(device); + } } -void SigSession::load_file(const string &name, - function error_handler) +void SigSession::set_file(const string &name) { - stop_capture(); - _sampling_thread.reset(new boost::thread( - &SigSession::load_thread_proc, this, name, - error_handler)); + _session = _device_manager.context()->load_session(name); + _device = _session->devices()[0]; + _decode_traces.clear(); + _session->add_datafeed_callback([=] + (shared_ptr device, shared_ptr packet) { + data_feed_in(device, packet); + }); + _device_manager.update_display_name(_device); + update_signals(_device); +} + +void SigSession::set_default_device() +{ + shared_ptr default_device; + const list< shared_ptr > &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 dev : devices) + if (dev->driver()->name().compare("demo") == 0) { + default_device = dev; + break; + } + + set_device(default_device); + } } SigSession::capture_state SigSession::get_capture_state() const @@ -100,329 +181,296 @@ SigSession::capture_state SigSession::get_capture_state() const return _capture_state; } -void SigSession::start_capture(uint64_t record_length, - function error_handler) +void SigSession::start_capture(function error_handler) { stop_capture(); // Check that a device instance has been selected. - if (!_sdi) { + if (!_device) { qDebug() << "No device selected"; return; } - // Check that at least one probe is enabled - const GSList *l; - for (l = _sdi->probes; l; l = l->next) { - sr_probe *const probe = (sr_probe*)l->data; - assert(probe); - if (probe->enabled) - break; - } + // Check that at least one channel is enabled + auto channels = _device->channels(); + bool enabled = std::any_of(channels.begin(), channels.end(), + [](shared_ptr channel) { return channel->enabled(); }); - if (!l) { - error_handler(tr("No probes enabled.")); + if (!enabled) { + error_handler(tr("No channels enabled.")); return; } // Begin the session - _sampling_thread.reset(new boost::thread( - &SigSession::sample_thread_proc, this, _sdi, - record_length, error_handler)); + _sampling_thread = std::thread( + &SigSession::sample_thread_proc, this, _device, + error_handler); } void SigSession::stop_capture() { - if (get_capture_state() == Stopped) - return; - - sr_session_stop(); + if (get_capture_state() != Stopped) + _session->stop(); // Check that sampling stopped - if (_sampling_thread.get()) - _sampling_thread->join(); - _sampling_thread.reset(); + if (_sampling_thread.joinable()) + _sampling_thread.join(); } -vector< shared_ptr > SigSession::get_signals() +set< shared_ptr > SigSession::get_data() const { lock_guard lock(_signals_mutex); - return _signals; -} + set< shared_ptr > data; + for (const shared_ptr sig : _signals) { + assert(sig); + data.insert(sig->data()); + } -boost::shared_ptr SigSession::get_data() -{ - return _logic_data; + return data; } -void SigSession::set_capture_state(capture_state state) +vector< shared_ptr > SigSession::get_signals() const { - lock_guard lock(_sampling_mutex); - _capture_state = state; - capture_state_changed(state); + lock_guard lock(_signals_mutex); + return _signals; } -/** - * Attempts to autodetect the format. Failing that - * @param filename The filename of the input file. - * @return A pointer to the 'struct sr_input_format' that should be used, - * or NULL if no input format was selected or auto-detected. - */ -sr_input_format* SigSession::determine_input_file_format( - const string &filename) +#ifdef ENABLE_DECODE +bool SigSession::add_decoder(srd_decoder *const dec) { - int i; - - /* If there are no input formats, return NULL right away. */ - sr_input_format *const *const inputs = sr_input_list(); - if (!inputs) { - g_critical("No supported input formats available."); - return NULL; - } - - /* Otherwise, try to find an input module that can handle this file. */ - for (i = 0; inputs[i]; i++) { - if (inputs[i]->format_match(filename.c_str())) - break; - } - - /* Return NULL if no input module wanted to touch this. */ - if (!inputs[i]) { - g_critical("Error: no matching input module found."); - return NULL; - } + map > channels; + shared_ptr decoder_stack; - return inputs[i]; -} - -sr_input* SigSession::load_input_file_format(const string &filename, - function error_handler, - sr_input_format *format) -{ - struct stat st; - sr_input *in; + try + { + lock_guard lock(_signals_mutex); - if (!format && !(format = - determine_input_file_format(filename.c_str()))) { - /* The exact cause was already logged. */ - return NULL; - } + // Create the decoder + decoder_stack = shared_ptr( + new data::DecoderStack(*this, dec)); + + // Make a list of all the channels + std::vector 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 s : _signals) + { + shared_ptr l = + dynamic_pointer_cast(s); + if (l && QString::fromUtf8(pdch->name). + toLower().contains( + l->get_name().toLower())) + channels[pdch] = l; + } - if (stat(filename.c_str(), &st) == -1) { - error_handler(tr("Failed to load file")); - return NULL; - } + assert(decoder_stack); + assert(!decoder_stack->stack().empty()); + assert(decoder_stack->stack().front()); + decoder_stack->stack().front()->set_channels(channels); - /* Initialize the input module. */ - if (!(in = new sr_input)) { - qDebug("Failed to allocate input module.\n"); - return NULL; + // Create the decode signal + shared_ptr d( + new view::DecodeTrace(*this, decoder_stack, + _decode_traces.size())); + _decode_traces.push_back(d); } - - in->format = format; - in->param = NULL; - if (in->format->init && - in->format->init(in, filename.c_str()) != SR_OK) { - qDebug("Input format init failed.\n"); - return NULL; + catch(std::runtime_error e) + { + return false; } - sr_session_new(); + signals_changed(); - if (sr_session_dev_add(in->sdi) != SR_OK) { - qDebug("Failed to use device.\n"); - sr_session_destroy(); - return NULL; - } + // Do an initial decode + decoder_stack->begin_decode(); - return in; + return true; } -void SigSession::load_thread_proc(const string name, - function error_handler) +vector< shared_ptr > SigSession::get_decode_signals() const { - sr_input *in = NULL; + lock_guard lock(_signals_mutex); + return _decode_traces; +} - if (sr_session_load(name.c_str()) == SR_OK) { - if (sr_session_start() != SR_OK) { - error_handler(tr("Failed to start session.")); +void SigSession::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; } - } - else if(!(in = load_input_file_format(name.c_str(), error_handler))) - return; - - sr_session_datafeed_callback_add(data_feed_in_proc, NULL); - - set_capture_state(Running); - - if(in) { - assert(in->format); - in->format->loadfile(in, name.c_str()); - } else - sr_session_run(); - - sr_session_destroy(); - set_capture_state(Stopped); - - // Confirm that SR_DF_END was received - assert(!_cur_logic_snapshot); - assert(!_cur_analog_snapshot); - - delete in; } +#endif -void SigSession::sample_thread_proc(struct sr_dev_inst *sdi, - uint64_t record_length, - function error_handler) +void SigSession::set_capture_state(capture_state state) { - assert(sdi); - assert(error_handler); - - sr_session_new(); - sr_session_datafeed_callback_add(data_feed_in_proc, NULL); - - if (sr_session_dev_add(sdi) != SR_OK) { - error_handler(tr("Failed to use device.")); - sr_session_destroy(); - return; - } - - // Set the sample limit - if (sr_config_set(sdi, SR_CONF_LIMIT_SAMPLES, - g_variant_new_uint64(record_length)) != SR_OK) { - error_handler(tr("Failed to configure " - "time-based sample limit.")); - sr_session_destroy(); - return; - } - - if (sr_session_start() != SR_OK) { - error_handler(tr("Failed to start session.")); - return; - } - - set_capture_state(Running); - - sr_session_run(); - sr_session_destroy(); - - set_capture_state(Stopped); - - // Confirm that SR_DF_END was received - assert(!_cur_logic_snapshot); - assert(!_cur_analog_snapshot); + lock_guard lock(_sampling_mutex); + const bool changed = _capture_state != state; + _capture_state = state; + if(changed) + capture_state_changed(state); } -void SigSession::feed_in_header(const sr_dev_inst *sdi) +void SigSession::update_signals(shared_ptr device) { - shared_ptr signal; - GVariant *gvar; - uint64_t sample_rate = 0; - unsigned int logic_probe_count = 0; - unsigned int analog_probe_count = 0; - - // Detect what data types we will receive - for (const GSList *l = sdi->probes; l; l = l->next) { - const sr_probe *const probe = (const sr_probe *)l->data; - if (!probe->enabled) - continue; - - switch(probe->type) { - case SR_PROBE_LOGIC: - logic_probe_count++; - break; - - case SR_PROBE_ANALOG: - analog_probe_count++; - break; - } - } + assert(device); + assert(_capture_state == Stopped); - // Read out the sample rate - if(sdi->driver) - { - const int ret = sr_config_get(sdi->driver, - SR_CONF_SAMPLERATE, &gvar, sdi); - if (ret != SR_OK) { - qDebug("Failed to get samplerate\n"); - return; - } + // Clear the decode traces + _decode_traces.clear(); - sample_rate = g_variant_get_uint64(gvar); - g_variant_unref(gvar); - } + // 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) { + return channel->type() == ChannelType::LOGIC; }); - // Create data containers for the coming data snapshots + // Create data containers for the logic data snapshots { lock_guard data_lock(_data_mutex); - if (logic_probe_count != 0) { + _logic_data.reset(); + if (logic_channel_count != 0) { _logic_data.reset(new data::Logic( - logic_probe_count, sample_rate)); + logic_channel_count)); assert(_logic_data); } - - if (analog_probe_count != 0) { - _analog_data.reset(new data::Analog(sample_rate)); - assert(_analog_data); - } } - // Make the logic probe list + // Make the Signals list { lock_guard lock(_signals_mutex); _signals.clear(); - for (const GSList *l = sdi->probes; l; l = l->next) { - const sr_probe *const probe = - (const sr_probe *)l->data; - assert(probe); - if (!probe->enabled) - continue; + for (auto channel : device->channels()) { + shared_ptr signal; - switch(probe->type) { - case SR_PROBE_LOGIC: + switch(channel->type()->id()) { + case SR_CHANNEL_LOGIC: signal = shared_ptr( - new view::LogicSignal(probe->name, - _logic_data, probe->index)); + new view::LogicSignal(*this, device, + channel, _logic_data)); break; - case SR_PROBE_ANALOG: + case SR_CHANNEL_ANALOG: + { + shared_ptr data( + new data::Analog()); signal = shared_ptr( - new view::AnalogSignal(probe->name, - _analog_data, probe->index)); + new view::AnalogSignal( + *this, channel, data)); + break; + } + + default: + assert(0); break; } + assert(signal); _signals.push_back(signal); } - signals_changed(); + } + + signals_changed(); +} + +shared_ptr SigSession::signal_from_channel( + shared_ptr channel) const +{ + lock_guard lock(_signals_mutex); + for (shared_ptr sig : _signals) { + assert(sig); + if (sig->channel() == channel) + return sig; + } + return shared_ptr(); +} + +void SigSession::read_sample_rate(shared_ptr device) +{ + uint64_t sample_rate = VariantBase::cast_dynamic>( + device->config_get(ConfigKey::SAMPLERATE)).get(); + + // Set the sample rate of all data + const set< shared_ptr > data_set = get_data(); + for (shared_ptr data : data_set) { + assert(data); + data->set_samplerate(sample_rate); + } +} + +void SigSession::sample_thread_proc(shared_ptr device, + function 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 SigSession::feed_in_meta(const sr_dev_inst *sdi, - const sr_datafeed_meta &meta) +void SigSession::feed_in_header(shared_ptr device) { - (void)sdi; + read_sample_rate(device); +} + +void SigSession::feed_in_meta(shared_ptr device, + shared_ptr meta) +{ + (void)device; - for (const GSList *l = meta.config; l; l = l->next) { - const sr_config *const src = (const sr_config*)l->data; - switch (src->key) { + for (auto entry : meta->config()) { + switch (entry.first->id()) { case SR_CONF_SAMPLERATE: /// @todo handle samplerate changes - /// samplerate = (uint64_t *)src->value; break; default: // Unknown metadata is not an error. break; } } + + signals_changed(); } -void SigSession::feed_in_logic(const sr_datafeed_logic &logic) +void SigSession::feed_in_frame_begin() +{ + if (_cur_logic_snapshot || !_cur_analog_snapshots.empty()) + frame_began(); +} + +void SigSession::feed_in_logic(shared_ptr logic) { lock_guard lock(_data_mutex); @@ -434,10 +482,28 @@ void SigSession::feed_in_logic(const sr_datafeed_logic &logic) if (!_cur_logic_snapshot) { + // This could be the first packet after a trigger + set_capture_state(Running); + + // Get sample limit. + uint64_t sample_limit; + try { + sample_limit = VariantBase::cast_dynamic>( + _device->config_get(ConfigKey::LIMIT_SAMPLES)).get(); + } catch (Error) { + sample_limit = 0; + } + // Create a new data snapshot _cur_logic_snapshot = shared_ptr( - new data::LogicSnapshot(logic)); + 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 { @@ -445,60 +511,101 @@ void SigSession::feed_in_logic(const sr_datafeed_logic &logic) _cur_logic_snapshot->append_payload(logic); } - data_updated(); + data_received(); } -void SigSession::feed_in_analog(const sr_datafeed_analog &analog) +void SigSession::feed_in_analog(shared_ptr analog) { lock_guard lock(_data_mutex); - if(!_analog_data) - { - qDebug() << "Unexpected analog packet"; - return; // This analog packet was not expected. - } + const vector> 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; - if (!_cur_analog_snapshot) + for (auto channel : channels) { - // Create a new data snapshot - _cur_analog_snapshot = shared_ptr( - new data::AnalogSnapshot(analog)); - _analog_data->push_snapshot(_cur_analog_snapshot); + shared_ptr snapshot; + + // Try to get the snapshot of the channel + const map< shared_ptr, shared_ptr >:: + 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>( + _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( + new data::AnalogSnapshot(sample_limit)); + _cur_analog_snapshots[channel] = snapshot; + + // Find the annalog data associated with the channel + shared_ptr sig = + dynamic_pointer_cast( + signal_from_channel(channel)); + assert(sig); + + shared_ptr 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); } - else - { - // Append to the existing data snapshot - _cur_analog_snapshot->append_payload(analog); + + if (sweep_beginning) { + // This could be the first packet after a trigger + set_capture_state(Running); } - data_updated(); + data_received(); } -void SigSession::data_feed_in(const struct sr_dev_inst *sdi, - const struct sr_datafeed_packet *packet) +void SigSession::data_feed_in(shared_ptr device, shared_ptr packet) { - assert(sdi); + assert(device); assert(packet); - switch (packet->type) { + switch (packet->type()->id()) { case SR_DF_HEADER: - feed_in_header(sdi); + feed_in_header(device); break; case SR_DF_META: - assert(packet->payload); - feed_in_meta(sdi, - *(const sr_datafeed_meta*)packet->payload); + feed_in_meta(device, dynamic_pointer_cast(packet->payload())); + break; + + case SR_DF_FRAME_BEGIN: + feed_in_frame_begin(); break; case SR_DF_LOGIC: - assert(packet->payload); - feed_in_logic(*(const sr_datafeed_logic*)packet->payload); + feed_in_logic(dynamic_pointer_cast(packet->payload())); break; case SR_DF_ANALOG: - assert(packet->payload); - feed_in_analog(*(const sr_datafeed_analog*)packet->payload); + feed_in_analog(dynamic_pointer_cast(packet->payload())); break; case SR_DF_END: @@ -506,20 +613,14 @@ void SigSession::data_feed_in(const struct sr_dev_inst *sdi, { lock_guard lock(_data_mutex); _cur_logic_snapshot.reset(); - _cur_analog_snapshot.reset(); + _cur_analog_snapshots.clear(); } - data_updated(); + frame_ended(); break; } + default: + break; } } -void SigSession::data_feed_in_proc(const struct sr_dev_inst *sdi, - const struct sr_datafeed_packet *packet, void *cb_data) -{ - (void) cb_data; - assert(_session); - _session->data_feed_in(sdi, packet); -} - } // namespace pv