X-Git-Url: https://sigrok.org/gitweb/?p=pulseview.git;a=blobdiff_plain;f=pv%2Fsigsession.cpp;h=b5387877dda0a73a513f7cb5f066e030f3b17539;hp=63a683df8eb7a5310907b95154891728a42481f4;hb=6d483b8b51b4efceacf2f48776af33550bf5d29e;hpb=3868e5fa3081573891ff2ae5b9dd67eb4a6afa4b diff --git a/pv/sigsession.cpp b/pv/sigsession.cpp index 63a683df..b5387877 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,25 +18,54 @@ * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA */ +#ifdef ENABLE_DECODE +#include +#endif + #include "sigsession.h" -#include "logicdata.h" -#include "logicdatasnapshot.h" -#include "view/logicsignal.h" +#include "devicemanager.h" +#include "devinst.h" -#include +#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 -using namespace boost; -using namespace std; +#include + +#include + +#include + +#include + +using boost::dynamic_pointer_cast; +using boost::function; +using boost::lock_guard; +using boost::mutex; +using boost::shared_ptr; +using std::map; +using std::set; +using std::string; +using std::vector; namespace pv { // TODO: This should not be necessary SigSession* SigSession::_session = NULL; -SigSession::SigSession() +SigSession::SigSession(DeviceManager &device_manager) : + _device_manager(device_manager), + _capture_state(Stopped) { // TODO: This should not be necessary _session = this; @@ -44,166 +73,686 @@ SigSession::SigSession() SigSession::~SigSession() { - if(_sampling_thread.get()) - _sampling_thread->join(); - _sampling_thread.reset(); + stop_capture(); + + if (_sampling_thread.joinable()) + _sampling_thread.join(); + + if (_dev_inst) + _device_manager.release_device(_dev_inst); // TODO: This should not be necessary _session = NULL; } -void SigSession::load_file(const std::string &name) +shared_ptr SigSession::get_device() const { + return _dev_inst; +} + +void SigSession::set_device(shared_ptr dev_inst) +{ + // Ensure we are not capturing before setting the device + stop_capture(); + + if (_dev_inst) + _device_manager.release_device(_dev_inst); + if (dev_inst) + _device_manager.use_device(dev_inst, this); + _dev_inst = dev_inst; + update_signals(dev_inst); +} + +void SigSession::release_device(shared_ptr dev_inst) +{ + (void)dev_inst; + + assert(_capture_state == Stopped); + _dev_inst = shared_ptr(); +} + +void SigSession::load_file(const string &name, + function error_handler) +{ + stop_capture(); + if (sr_session_load(name.c_str()) == SR_OK) { - /* sigrok session file */ - sr_session_datafeed_callback_add(data_feed_in_proc); - sr_session_start(); - sr_session_run(); - sr_session_stop(); + GSList *devlist = NULL; + sr_session_dev_list(&devlist); + + if (!devlist || !devlist->data || + sr_session_start() != SR_OK) { + error_handler(tr("Failed to start session.")); + return; + } + + shared_ptr dev_inst( + new DevInst((sr_dev_inst*)devlist->data)); + g_slist_free(devlist); + + _decode_traces.clear(); + update_signals(dev_inst); + read_sample_rate(dev_inst->dev_inst()); + + _sampling_thread = boost::thread( + &SigSession::load_session_thread_proc, this, + error_handler); + + } else { + sr_input *in = NULL; + + if (!(in = load_input_file_format(name.c_str(), + error_handler))) + return; + + _decode_traces.clear(); + update_signals(shared_ptr(new DevInst(in->sdi))); + read_sample_rate(in->sdi); + + _sampling_thread = boost::thread( + &SigSession::load_input_thread_proc, this, + name, in, error_handler); + } +} + +SigSession::capture_state SigSession::get_capture_state() const +{ + lock_guard lock(_sampling_mutex); + return _capture_state; +} + +void SigSession::start_capture(function error_handler) +{ + stop_capture(); + + // Check that a device instance has been selected. + if (!_dev_inst) { + qDebug() << "No device selected"; + return; + } + + assert(_dev_inst->dev_inst()); + + // Check that at least one probe is enabled + const GSList *l; + for (l = _dev_inst->dev_inst()->probes; l; l = l->next) { + sr_probe *const probe = (sr_probe*)l->data; + assert(probe); + if (probe->enabled) + break; + } + + if (!l) { + error_handler(tr("No probes enabled.")); + return; } + + // Begin the session + _sampling_thread = boost::thread( + &SigSession::sample_thread_proc, this, _dev_inst, + error_handler); } -void SigSession::start_capture(struct sr_dev_inst *sdi, - uint64_t record_length, uint64_t sample_rate) +void SigSession::stop_capture() { - // Check sampling isn't already active - if(_sampling_thread.get()) - _sampling_thread->join(); + if (get_capture_state() == Stopped) + return; - _sampling_thread.reset(new boost::thread( - &SigSession::sample_thread_proc, this, sdi, - record_length, sample_rate)); + sr_session_stop(); + + // Check that sampling stopped + 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); + set< shared_ptr > data; + BOOST_FOREACH(const shared_ptr sig, _signals) { + assert(sig); + data.insert(sig->data()); + } + + return data; +} + +vector< shared_ptr > SigSession::get_signals() const { lock_guard lock(_signals_mutex); return _signals; } -boost::shared_ptr SigSession::get_data() +#ifdef ENABLE_DECODE +bool SigSession::add_decoder(srd_decoder *const dec) +{ + map > probes; + shared_ptr decoder_stack; + + try + { + lock_guard lock(_signals_mutex); + + // Create the decoder + decoder_stack = shared_ptr( + new data::DecoderStack(dec)); + + // Make a list of all the probes + std::vector all_probes; + for(const GSList *i = dec->probes; i; i = i->next) + all_probes.push_back((const srd_probe*)i->data); + for(const GSList *i = dec->opt_probes; i; i = i->next) + all_probes.push_back((const srd_probe*)i->data); + + // Auto select the initial probes + BOOST_FOREACH(const srd_probe *probe, all_probes) + BOOST_FOREACH(shared_ptr s, _signals) + { + shared_ptr l = + dynamic_pointer_cast(s); + if (l && QString::fromUtf8(probe->name). + toLower().contains( + l->get_name().toLower())) + probes[probe] = l; + } + + assert(decoder_stack); + assert(!decoder_stack->stack().empty()); + assert(decoder_stack->stack().front()); + decoder_stack->stack().front()->set_probes(probes); + + // Create the decode signal + shared_ptr 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 > SigSession::get_decode_signals() const { - return _logic_data; + lock_guard lock(_signals_mutex); + return _decode_traces; } -void SigSession::sample_thread_proc(struct sr_dev_inst *sdi, - uint64_t record_length, uint64_t sample_rate) +void SigSession::remove_decode_signal(view::DecodeTrace *signal) { + for (vector< shared_ptr >::iterator i = + _decode_traces.begin(); + i != _decode_traces.end(); + i++) + if ((*i).get() == signal) + { + _decode_traces.erase(i); + signals_changed(); + return; + } +} +#endif + +void SigSession::set_capture_state(capture_state state) +{ + lock_guard lock(_sampling_mutex); + const bool changed = _capture_state != state; + _capture_state = state; + if(changed) + capture_state_changed(state); +} + +/** + * 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) +{ + 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; + } + + 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; + + if (!format && !(format = + determine_input_file_format(filename.c_str()))) { + /* The exact cause was already logged. */ + return NULL; + } + + if (stat(filename.c_str(), &st) == -1) { + error_handler(tr("Failed to load file")); + return NULL; + } + + /* Initialize the input module. */ + if (!(in = new sr_input)) { + qDebug("Failed to allocate input module.\n"); + return NULL; + } + + 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; + } + sr_session_new(); - sr_session_datafeed_callback_add(data_feed_in_proc); - if (sr_session_dev_add(sdi) != SR_OK) { - qDebug() << "Failed to use device."; + if (sr_session_dev_add(in->sdi) != SR_OK) { + qDebug("Failed to use device.\n"); sr_session_destroy(); - return; + return NULL; } - if (sr_dev_config_set(sdi, SR_HWCAP_LIMIT_SAMPLES, - &record_length) != SR_OK) { - qDebug() << "Failed to configure time-based sample limit."; - sr_session_destroy(); - return; + return in; +} + +void SigSession::update_signals(shared_ptr dev_inst) +{ + assert(dev_inst); + assert(_capture_state == Stopped); + + unsigned int logic_probe_count = 0; + + // Clear the decode traces + _decode_traces.clear(); + + // Detect what data types we will receive + if(dev_inst) { + assert(dev_inst->dev_inst()); + for (const GSList *l = dev_inst->dev_inst()->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; + } + } + } + + // Create data containers for the logic data snapshots + { + lock_guard data_lock(_data_mutex); + + _logic_data.reset(); + if (logic_probe_count != 0) { + _logic_data.reset(new data::Logic( + logic_probe_count)); + assert(_logic_data); + } + } + + // Make the Signals list + do { + lock_guard lock(_signals_mutex); + + _signals.clear(); + + if(!dev_inst) + break; + + assert(dev_inst->dev_inst()); + for (const GSList *l = dev_inst->dev_inst()->probes; + l; l = l->next) { + shared_ptr signal; + sr_probe *const probe = (sr_probe *)l->data; + assert(probe); + + switch(probe->type) { + case SR_PROBE_LOGIC: + signal = shared_ptr( + new view::LogicSignal(dev_inst, + probe, _logic_data)); + break; + + case SR_PROBE_ANALOG: + { + shared_ptr data( + new data::Analog()); + signal = shared_ptr( + new view::AnalogSignal(dev_inst, + probe, data)); + break; + } + + default: + assert(0); + break; + } + + assert(signal); + _signals.push_back(signal); + } + + } while(0); + + signals_changed(); +} + +bool SigSession::is_trigger_enabled() const +{ + assert(_dev_inst); + assert(_dev_inst->dev_inst()); + for (const GSList *l = _dev_inst->dev_inst()->probes; l; l = l->next) { + const sr_probe *const p = (const sr_probe *)l->data; + assert(p); + if (p->trigger && p->trigger[0] != '\0') + return true; } - if (sr_dev_config_set(sdi, SR_HWCAP_SAMPLERATE, - &sample_rate) != SR_OK) { - qDebug() << "Failed to configure samplerate."; + return false; +} + +shared_ptr SigSession::signal_from_probe( + const sr_probe *probe) const +{ + lock_guard lock(_signals_mutex); + BOOST_FOREACH(shared_ptr sig, _signals) { + assert(sig); + if (sig->probe() == probe) + return sig; + } + return shared_ptr(); +} + +void SigSession::read_sample_rate(const sr_dev_inst *const sdi) +{ + GVariant *gvar; + uint64_t sample_rate = 0; + + // Read out the sample rate + if(sdi->driver) + { + const int ret = sr_config_get(sdi->driver, sdi, NULL, + SR_CONF_SAMPLERATE, &gvar); + if (ret != SR_OK) { + qDebug("Failed to get samplerate\n"); + return; + } + + sample_rate = g_variant_get_uint64(gvar); + g_variant_unref(gvar); + } + + // Set the sample rate of all data + const set< shared_ptr > data_set = get_data(); + BOOST_FOREACH(shared_ptr data, data_set) { + assert(data); + data->set_samplerate(sample_rate); + } +} + +void SigSession::load_session_thread_proc( + function error_handler) +{ + (void)error_handler; + + sr_session_datafeed_callback_add(data_feed_in_proc, NULL); + + 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_snapshots.empty()); +} + +void SigSession::load_input_thread_proc(const string name, + sr_input *in, function error_handler) +{ + (void)error_handler; + + assert(in); + assert(in->format); + + sr_session_datafeed_callback_add(data_feed_in_proc, NULL); + + set_capture_state(Running); + + in->format->loadfile(in, name.c_str()); + + sr_session_destroy(); + set_capture_state(Stopped); + + // Confirm that SR_DF_END was received + assert(!_cur_logic_snapshot); + assert(_cur_analog_snapshots.empty()); + + delete in; +} + +void SigSession::sample_thread_proc(shared_ptr dev_inst, + function error_handler) +{ + assert(dev_inst); + assert(dev_inst->dev_inst()); + assert(error_handler); + + sr_session_new(); + sr_session_datafeed_callback_add(data_feed_in_proc, NULL); + + if (sr_session_dev_add(dev_inst->dev_inst()) != SR_OK) { + error_handler(tr("Failed to use device.")); sr_session_destroy(); return; } if (sr_session_start() != SR_OK) { - qDebug() << "Failed to start session."; + error_handler(tr("Failed to start session.")); return; } + set_capture_state(is_trigger_enabled() ? AwaitingTrigger : Running); + sr_session_run(); sr_session_destroy(); + + 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::data_feed_in(const struct sr_dev_inst *sdi, - struct sr_datafeed_packet *packet) +void SigSession::feed_in_header(const sr_dev_inst *sdi) { - using view::LogicSignal; + read_sample_rate(sdi); +} - assert(sdi); - assert(packet); +void SigSession::feed_in_meta(const sr_dev_inst *sdi, + const sr_datafeed_meta &meta) +{ + (void)sdi; + + for (const GSList *l = meta.config; l; l = l->next) { + const sr_config *const src = (const sr_config*)l->data; + switch (src->key) { + case SR_CONF_SAMPLERATE: + /// @todo handle samplerate changes + /// samplerate = (uint64_t *)src->value; + break; + default: + // Unknown metadata is not an error. + break; + } + } - switch (packet->type) { - case SR_DF_HEADER: + signals_changed(); +} + +void SigSession::feed_in_logic(const sr_datafeed_logic &logic) +{ + lock_guard lock(_data_mutex); + + if (!_logic_data) { - lock_guard lock(_signals_mutex); - _signals.clear(); - break; + qDebug() << "Unexpected logic packet"; + return; } - case SR_DF_META_LOGIC: + if (!_cur_logic_snapshot) { - assert(packet->payload); - const sr_datafeed_meta_logic &meta_logic = - *(sr_datafeed_meta_logic*)packet->payload; + // This could be the first packet after a trigger + set_capture_state(Running); + // Create a new data snapshot + _cur_logic_snapshot = shared_ptr( + new data::LogicSnapshot(logic, _dev_inst->get_sample_limit())); + _logic_data->push_snapshot(_cur_logic_snapshot); + } + else { - lock_guard lock(_data_mutex); - - // Create an empty LogiData for coming data snapshots - _logic_data.reset(new LogicData(meta_logic)); - assert(_logic_data); - if(!_logic_data) - break; + // Append to the existing data snapshot + _cur_logic_snapshot->append_payload(logic); } + data_updated(); +} + +void SigSession::feed_in_analog(const sr_datafeed_analog &analog) +{ + lock_guard lock(_data_mutex); + + const unsigned int probe_count = g_slist_length(analog.probes); + const size_t sample_count = analog.num_samples / probe_count; + const float *data = analog.data; + bool sweep_beginning = false; + + for (GSList *p = analog.probes; p; p = p->next) { - lock_guard lock(_signals_mutex); + shared_ptr snapshot; - // Add the signals - for (int i = 0; i < meta_logic.num_probes; i++) + sr_probe *const probe = (sr_probe*)p->data; + assert(probe); + + // Try to get the snapshot of the probe + const map< const sr_probe*, shared_ptr >:: + iterator iter = _cur_analog_snapshots.find(probe); + if (iter != _cur_analog_snapshots.end()) + snapshot = (*iter).second; + else { - const sr_probe *const probe = - (const sr_probe*)g_slist_nth_data( - sdi->probes, i); - if(probe->enabled) - { - shared_ptr signal( - new LogicSignal(probe->name, - _logic_data, - probe->index)); - _signals.push_back(signal); - } + // 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; + + // Create a snapshot, keep it in the maps of probes + snapshot = shared_ptr( + new data::AnalogSnapshot(_dev_inst->get_sample_limit())); + _cur_analog_snapshots[probe] = snapshot; + + // Find the annalog data associated with the probe + shared_ptr sig = + dynamic_pointer_cast( + signal_from_probe(probe)); + assert(sig); + + shared_ptr data(sig->analog_data()); + assert(data); + + // Push the snapshot into the analog data. + data->push_snapshot(snapshot); } - signals_changed(); - break; + assert(snapshot); + + // Append the samples in the snapshot + snapshot->append_interleaved_samples(data++, sample_count, + probe_count); } + + if (sweep_beginning) { + // This could be the first packet after a trigger + set_capture_state(Running); } + data_updated(); +} + +void SigSession::data_feed_in(const struct sr_dev_inst *sdi, + const struct sr_datafeed_packet *packet) +{ + assert(sdi); + assert(packet); + + switch (packet->type) { + case SR_DF_HEADER: + feed_in_header(sdi); + break; + + case SR_DF_META: + assert(packet->payload); + feed_in_meta(sdi, + *(const sr_datafeed_meta*)packet->payload); + break; + case SR_DF_LOGIC: - { - lock_guard lock(_data_mutex); assert(packet->payload); - if(!_cur_logic_snapshot) - { - // Create a new data snapshot - _cur_logic_snapshot = shared_ptr( - new LogicDataSnapshot( - *(sr_datafeed_logic*)packet->payload)); - _logic_data->push_snapshot(_cur_logic_snapshot); - } - else - { - // Append to the existing data snapshot - _cur_logic_snapshot->append_payload( - *(sr_datafeed_logic*)packet->payload); - } + feed_in_logic(*(const sr_datafeed_logic*)packet->payload); + break; + case SR_DF_ANALOG: + assert(packet->payload); + feed_in_analog(*(const sr_datafeed_analog*)packet->payload); break; - } case SR_DF_END: { { lock_guard lock(_data_mutex); _cur_logic_snapshot.reset(); + _cur_analog_snapshots.clear(); } data_updated(); break; @@ -212,8 +761,9 @@ void SigSession::data_feed_in(const struct sr_dev_inst *sdi, } void SigSession::data_feed_in_proc(const struct sr_dev_inst *sdi, - struct sr_datafeed_packet *packet) + const struct sr_datafeed_packet *packet, void *cb_data) { + (void) cb_data; assert(_session); _session->data_feed_in(sdi, packet); }