* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
*/
+#include <libsigrokdecode/libsigrokdecode.h>
+
#include "sigsession.h"
-#include "logicdata.h"
-#include "logicdatasnapshot.h"
-#include "view/logicsignal.h"
+#include "devicemanager.h"
-#include <QDebug>
+#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 <assert.h>
+#include <stdexcept>
+
+#include <boost/foreach.hpp>
+
+#include <sys/stat.h>
+
+#include <QDebug>
+
using namespace boost;
using namespace std;
// TODO: This should not be necessary
SigSession* SigSession::_session = NULL;
-SigSession::SigSession() :
+SigSession::SigSession(DeviceManager &device_manager) :
+ _device_manager(device_manager),
+ _sdi(NULL),
_capture_state(Stopped)
{
// TODO: This should not be necessary
{
stop_capture();
- if(_sampling_thread.get())
- _sampling_thread->join();
- _sampling_thread.reset();
+ _sampling_thread.join();
+
+ if (_sdi)
+ _device_manager.release_device(_sdi);
+ _sdi = NULL;
// TODO: This should not be necessary
_session = NULL;
}
-void SigSession::load_file(const std::string &name)
+struct sr_dev_inst* SigSession::get_device() const
{
+ return _sdi;
+}
+
+void SigSession::set_device(struct sr_dev_inst *sdi)
+{
+ if (_sdi)
+ _device_manager.release_device(_sdi);
+ if (sdi)
+ _device_manager.use_device(sdi, this);
+ _sdi = sdi;
+ update_signals(sdi);
+}
+
+void SigSession::release_device(struct sr_dev_inst *sdi)
+{
+ (void)sdi;
+
+ assert(_capture_state == Stopped);
+ _sdi = NULL;
+ update_signals(NULL);
+}
+
+void SigSession::load_file(const string &name,
+ function<void (const QString)> 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;
+ }
+
+ sr_dev_inst *const sdi = (sr_dev_inst*)devlist->data;
+ g_slist_free(devlist);
+
+ update_signals(sdi);
+ read_sample_rate(sdi);
+
+ _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;
+
+ update_signals(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<mutex> lock(_state_mutex);
+ lock_guard<mutex> lock(_sampling_mutex);
return _capture_state;
}
-void SigSession::start_capture(struct sr_dev_inst *sdi,
- uint64_t record_length, uint64_t sample_rate)
+void SigSession::start_capture(uint64_t record_length,
+ function<void (const QString)> error_handler)
{
stop_capture();
+ // Check that a device instance has been selected.
+ if (!_sdi) {
+ 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;
+ }
+
+ if (!l) {
+ error_handler(tr("No probes enabled."));
+ return;
+ }
- _sampling_thread.reset(new boost::thread(
- &SigSession::sample_thread_proc, this, sdi,
- record_length, sample_rate));
+ // Begin the session
+ _sampling_thread = boost::thread(
+ &SigSession::sample_thread_proc, this, _sdi,
+ record_length, error_handler);
}
void SigSession::stop_capture()
{
- if(get_capture_state() == Stopped)
+ if (get_capture_state() == Stopped)
return;
sr_session_stop();
// Check that sampling stopped
- if(_sampling_thread.get())
- _sampling_thread->join();
- _sampling_thread.reset();
+ _sampling_thread.join();
}
-vector< shared_ptr<view::Signal> > SigSession::get_signals()
+vector< shared_ptr<view::Signal> > SigSession::get_signals() const
{
lock_guard<mutex> lock(_signals_mutex);
return _signals;
}
-boost::shared_ptr<LogicData> SigSession::get_data()
+boost::shared_ptr<data::Logic> SigSession::get_data()
{
return _logic_data;
}
+bool SigSession::add_decoder(srd_decoder *const dec)
+{
+ map<const srd_probe*, shared_ptr<view::LogicSignal> > probes;
+ shared_ptr<data::DecoderStack> decoder_stack;
+
+ try
+ {
+ lock_guard<mutex> lock(_signals_mutex);
+
+ // Create the decoder
+ decoder_stack = shared_ptr<data::DecoderStack>(
+ new data::DecoderStack(dec));
+
+ // Auto select the initial probes
+ for(const GSList *i = dec->probes; i; i = i->next)
+ {
+ const srd_probe *const probe = (const srd_probe*)i->data;
+ BOOST_FOREACH(shared_ptr<view::Signal> s, _signals)
+ {
+ shared_ptr<view::LogicSignal> l =
+ dynamic_pointer_cast<view::LogicSignal>(s);
+ if (l && QString(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<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> > SigSession::get_decode_signals() const
+{
+ lock_guard<mutex> lock(_signals_mutex);
+ return _decode_traces;
+}
+
+void SigSession::remove_decode_signal(view::DecodeTrace *signal)
+{
+ for (vector< shared_ptr<view::DecodeTrace> >::iterator i =
+ _decode_traces.begin();
+ i != _decode_traces.end();
+ i++)
+ if ((*i).get() == signal)
+ {
+ _decode_traces.erase(i);
+ signals_changed();
+ return;
+ }
+}
+
void SigSession::set_capture_state(capture_state state)
{
- lock_guard<mutex> lock(_state_mutex);
+ lock_guard<mutex> lock(_sampling_mutex);
+ const bool changed = _capture_state != state;
_capture_state = state;
- capture_state_changed(state);
+ if(changed)
+ capture_state_changed(state);
}
-void SigSession::sample_thread_proc(struct sr_dev_inst *sdi,
- uint64_t record_length, uint64_t sample_rate)
+/**
+ * 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<void (const QString)> 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;
+ }
+
+ return in;
+}
+
+void SigSession::update_signals(const sr_dev_inst *const sdi)
+{
+ assert(_capture_state == Stopped);
+
+ shared_ptr<view::Signal> signal;
+ unsigned int logic_probe_count = 0;
+ unsigned int analog_probe_count = 0;
+
+ // Clear the decode traces
+ _decode_traces.clear();
+
+ // Detect what data types we will receive
+ if(sdi) {
+ 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;
+ }
+ }
+ }
+
+ // Create data containers for the data snapshots
+ {
+ lock_guard<mutex> data_lock(_data_mutex);
+
+ _logic_data.reset();
+ if (logic_probe_count != 0) {
+ _logic_data.reset(new data::Logic(
+ logic_probe_count));
+ assert(_logic_data);
+ }
+
+ _analog_data.reset();
+ if (analog_probe_count != 0) {
+ _analog_data.reset(new data::Analog());
+ assert(_analog_data);
+ }
+ }
+
+ // Make the Signals list
+ {
+ lock_guard<mutex> lock(_signals_mutex);
+
+ _signals.clear();
+
+ if(sdi) {
+ for (const GSList *l = sdi->probes; l; l = l->next) {
+ sr_probe *const probe = (sr_probe *)l->data;
+ assert(probe);
+
+ switch(probe->type) {
+ case SR_PROBE_LOGIC:
+ signal = shared_ptr<view::Signal>(
+ new view::LogicSignal(*this, probe,
+ _logic_data));
+ break;
+
+ case SR_PROBE_ANALOG:
+ signal = shared_ptr<view::Signal>(
+ new view::AnalogSignal(*this, probe,
+ _analog_data));
+ break;
+ }
+
+ _signals.push_back(signal);
+ }
+ }
}
- if (sr_dev_config_set(sdi, SR_HWCAP_LIMIT_SAMPLES,
- &record_length) != SR_OK) {
- qDebug() << "Failed to configure time-based sample limit.";
+ signals_changed();
+}
+
+bool SigSession::is_trigger_enabled() const
+{
+ assert(_sdi);
+ for (const GSList *l = _sdi->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;
+ }
+
+ return false;
+}
+
+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);
+ }
+
+ if(_analog_data)
+ _analog_data->set_samplerate(sample_rate);
+ if(_logic_data)
+ _logic_data->set_samplerate(sample_rate);
+}
+
+void SigSession::load_session_thread_proc(
+ function<void (const QString)> 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_snapshot);
+}
+
+void SigSession::load_input_thread_proc(const string name,
+ sr_input *in, function<void (const QString)> 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_snapshot);
+
+ delete in;
+}
+
+void SigSession::sample_thread_proc(struct sr_dev_inst *sdi,
+ uint64_t record_length,
+ function<void (const QString)> error_handler)
+{
+ 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;
}
- if (sr_dev_config_set(sdi, SR_HWCAP_SAMPLERATE,
- &sample_rate) != SR_OK) {
- qDebug() << "Failed to configure samplerate.";
+ // Set the sample limit
+ if (sr_config_set(sdi, NULL, 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) {
- qDebug() << "Failed to start session.";
+ error_handler(tr("Failed to start session."));
return;
}
- set_capture_state(Running);
+ 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
+ assert(!_cur_logic_snapshot);
+ assert(!_cur_analog_snapshot);
}
-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<mutex> lock(_data_mutex);
+
+ if (!_logic_data)
{
- lock_guard<mutex> 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;
+ set_capture_state(Running);
+ // Create a new data snapshot
+ _cur_logic_snapshot = shared_ptr<data::LogicSnapshot>(
+ new data::LogicSnapshot(logic));
+ _logic_data->push_snapshot(_cur_logic_snapshot);
+ }
+ else
{
- lock_guard<mutex> 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<mutex> lock(_data_mutex);
+
+ if(!_analog_data)
{
- lock_guard<mutex> lock(_signals_mutex);
+ qDebug() << "Unexpected analog packet";
+ return; // This analog packet was not expected.
+ }
- // Add the signals
- for (int i = 0; i < meta_logic.num_probes; i++)
- {
- const sr_probe *const probe =
- (const sr_probe*)g_slist_nth_data(
- sdi->probes, i);
- if(probe->enabled)
- {
- shared_ptr<LogicSignal> signal(
- new LogicSignal(probe->name,
- _logic_data,
- probe->index));
- _signals.push_back(signal);
- }
- }
+ if (!_cur_analog_snapshot)
+ {
+ set_capture_state(Running);
- signals_changed();
- break;
+ // Create a new data snapshot
+ _cur_analog_snapshot = shared_ptr<data::AnalogSnapshot>(
+ new data::AnalogSnapshot(analog));
+ _analog_data->push_snapshot(_cur_analog_snapshot);
}
+ else
+ {
+ // Append to the existing data snapshot
+ _cur_analog_snapshot->append_payload(analog);
}
+ 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<mutex> lock(_data_mutex);
assert(packet->payload);
- if(!_cur_logic_snapshot)
- {
- // Create a new data snapshot
- _cur_logic_snapshot = shared_ptr<LogicDataSnapshot>(
- 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;
- data_updated();
+ case SR_DF_ANALOG:
+ assert(packet->payload);
+ feed_in_analog(*(const sr_datafeed_analog*)packet->payload);
break;
- }
case SR_DF_END:
{
{
lock_guard<mutex> lock(_data_mutex);
_cur_logic_snapshot.reset();
+ _cur_analog_snapshot.reset();
}
data_updated();
break;
}
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);
}