2 * This file is part of the PulseView project.
4 * Copyright (C) 2012 Joel Holdsworth <joel@airwebreathe.org.uk>
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 2 of the License, or
9 * (at your option) any later version.
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.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
21 #include "sigsession.h"
23 #include "devicemanager.h"
25 #include "data/analog.h"
26 #include "data/analogsnapshot.h"
27 #include "data/decoder.h"
28 #include "data/logic.h"
29 #include "data/logicsnapshot.h"
31 #include "view/analogsignal.h"
32 #include "view/decodesignal.h"
33 #include "view/logicsignal.h"
41 using namespace boost;
46 // TODO: This should not be necessary
47 SigSession* SigSession::_session = NULL;
49 SigSession::SigSession(DeviceManager &device_manager) :
50 _device_manager(device_manager),
52 _capture_state(Stopped)
54 // TODO: This should not be necessary
58 SigSession::~SigSession()
62 _sampling_thread.join();
65 _device_manager.release_device(_sdi);
68 // TODO: This should not be necessary
72 struct sr_dev_inst* SigSession::get_device() const
77 void SigSession::set_device(struct sr_dev_inst *sdi)
80 _device_manager.release_device(_sdi);
82 _device_manager.use_device(sdi, this);
87 void SigSession::release_device(struct sr_dev_inst *sdi)
91 assert(_capture_state == Stopped);
96 void SigSession::load_file(const string &name,
97 function<void (const QString)> error_handler)
101 if (sr_session_load(name.c_str()) == SR_OK) {
102 GSList *devlist = NULL;
103 sr_session_dev_list(&devlist);
105 if (!devlist || !devlist->data ||
106 sr_session_start() != SR_OK) {
107 error_handler(tr("Failed to start session."));
111 sr_dev_inst *const sdi = (sr_dev_inst*)devlist->data;
112 g_slist_free(devlist);
115 read_sample_rate(sdi);
117 _sampling_thread = boost::thread(
118 &SigSession::load_session_thread_proc, this,
124 if (!(in = load_input_file_format(name.c_str(),
128 update_signals(in->sdi);
129 read_sample_rate(in->sdi);
131 _sampling_thread = boost::thread(
132 &SigSession::load_input_thread_proc, this,
133 name, in, error_handler);
137 SigSession::capture_state SigSession::get_capture_state() const
139 lock_guard<mutex> lock(_sampling_mutex);
140 return _capture_state;
143 void SigSession::start_capture(uint64_t record_length,
144 function<void (const QString)> error_handler)
148 // Check that a device instance has been selected.
150 qDebug() << "No device selected";
154 // Check that at least one probe is enabled
156 for (l = _sdi->probes; l; l = l->next) {
157 sr_probe *const probe = (sr_probe*)l->data;
164 error_handler(tr("No probes enabled."));
169 _sampling_thread = boost::thread(
170 &SigSession::sample_thread_proc, this, _sdi,
171 record_length, error_handler);
174 void SigSession::stop_capture()
176 if (get_capture_state() == Stopped)
181 // Check that sampling stopped
182 _sampling_thread.join();
185 vector< shared_ptr<view::Signal> > SigSession::get_signals() const
187 lock_guard<mutex> lock(_signals_mutex);
191 boost::shared_ptr<data::Logic> SigSession::get_data()
196 void SigSession::add_decoder(srd_decoder *const dec,
197 std::map<const srd_probe*,
198 boost::shared_ptr<view::Signal> > probes,
202 lock_guard<mutex> lock(_signals_mutex);
204 if (!_decode_traces.empty()) {
205 qDebug("Currently only one decode trace can be added "
207 _decode_traces.clear();
210 shared_ptr<data::Decoder> decoder(
211 new data::Decoder(dec, probes, options));
212 shared_ptr<view::DecodeSignal> d(
213 new view::DecodeSignal(*this, decoder,
214 _decode_traces.size()));
215 _decode_traces.push_back(d);
220 vector< shared_ptr<view::DecodeSignal> > SigSession::get_decode_signals() const
222 lock_guard<mutex> lock(_signals_mutex);
223 return _decode_traces;
226 void SigSession::set_capture_state(capture_state state)
228 lock_guard<mutex> lock(_sampling_mutex);
229 const bool changed = _capture_state != state;
230 _capture_state = state;
232 capture_state_changed(state);
236 * Attempts to autodetect the format. Failing that
237 * @param filename The filename of the input file.
238 * @return A pointer to the 'struct sr_input_format' that should be used,
239 * or NULL if no input format was selected or auto-detected.
241 sr_input_format* SigSession::determine_input_file_format(
242 const string &filename)
246 /* If there are no input formats, return NULL right away. */
247 sr_input_format *const *const inputs = sr_input_list();
249 g_critical("No supported input formats available.");
253 /* Otherwise, try to find an input module that can handle this file. */
254 for (i = 0; inputs[i]; i++) {
255 if (inputs[i]->format_match(filename.c_str()))
259 /* Return NULL if no input module wanted to touch this. */
261 g_critical("Error: no matching input module found.");
268 sr_input* SigSession::load_input_file_format(const string &filename,
269 function<void (const QString)> error_handler,
270 sr_input_format *format)
275 if (!format && !(format =
276 determine_input_file_format(filename.c_str()))) {
277 /* The exact cause was already logged. */
281 if (stat(filename.c_str(), &st) == -1) {
282 error_handler(tr("Failed to load file"));
286 /* Initialize the input module. */
287 if (!(in = new sr_input)) {
288 qDebug("Failed to allocate input module.\n");
294 if (in->format->init &&
295 in->format->init(in, filename.c_str()) != SR_OK) {
296 qDebug("Input format init failed.\n");
302 if (sr_session_dev_add(in->sdi) != SR_OK) {
303 qDebug("Failed to use device.\n");
304 sr_session_destroy();
311 void SigSession::update_signals(const sr_dev_inst *const sdi)
313 assert(_capture_state == Stopped);
315 shared_ptr<view::Signal> signal;
316 unsigned int logic_probe_count = 0;
317 unsigned int analog_probe_count = 0;
319 // Clear the decode traces
320 _decode_traces.clear();
322 // Detect what data types we will receive
324 for (const GSList *l = sdi->probes; l; l = l->next) {
325 const sr_probe *const probe = (const sr_probe *)l->data;
329 switch(probe->type) {
334 case SR_PROBE_ANALOG:
335 analog_probe_count++;
341 // Create data containers for the data snapshots
343 lock_guard<mutex> data_lock(_data_mutex);
346 if (logic_probe_count != 0) {
347 _logic_data.reset(new data::Logic(
352 _analog_data.reset();
353 if (analog_probe_count != 0) {
354 _analog_data.reset(new data::Analog());
355 assert(_analog_data);
359 // Make the Signals list
361 lock_guard<mutex> lock(_signals_mutex);
366 for (const GSList *l = sdi->probes; l; l = l->next) {
367 const sr_probe *const probe =
368 (const sr_probe *)l->data;
371 switch(probe->type) {
373 signal = shared_ptr<view::Signal>(
374 new view::LogicSignal(*this, probe,
378 case SR_PROBE_ANALOG:
379 signal = shared_ptr<view::Signal>(
380 new view::AnalogSignal(*this, probe,
385 _signals.push_back(signal);
393 bool SigSession::is_trigger_enabled() const
396 for (const GSList *l = _sdi->probes; l; l = l->next) {
397 const sr_probe *const p = (const sr_probe *)l->data;
399 if (p->trigger && p->trigger[0] != '\0')
406 void SigSession::read_sample_rate(const sr_dev_inst *const sdi)
409 uint64_t sample_rate = 0;
411 // Read out the sample rate
414 const int ret = sr_config_get(sdi->driver,
415 SR_CONF_SAMPLERATE, &gvar, sdi);
417 qDebug("Failed to get samplerate\n");
421 sample_rate = g_variant_get_uint64(gvar);
422 g_variant_unref(gvar);
426 _analog_data->set_samplerate(sample_rate);
428 _logic_data->set_samplerate(sample_rate);
431 void SigSession::load_session_thread_proc(
432 function<void (const QString)> error_handler)
436 sr_session_datafeed_callback_add(data_feed_in_proc, NULL);
438 set_capture_state(Running);
442 sr_session_destroy();
443 set_capture_state(Stopped);
445 // Confirm that SR_DF_END was received
446 assert(!_cur_logic_snapshot);
447 assert(!_cur_analog_snapshot);
450 void SigSession::load_input_thread_proc(const string name,
451 sr_input *in, function<void (const QString)> error_handler)
458 sr_session_datafeed_callback_add(data_feed_in_proc, NULL);
460 set_capture_state(Running);
462 in->format->loadfile(in, name.c_str());
464 sr_session_destroy();
465 set_capture_state(Stopped);
467 // Confirm that SR_DF_END was received
468 assert(!_cur_logic_snapshot);
469 assert(!_cur_analog_snapshot);
474 void SigSession::sample_thread_proc(struct sr_dev_inst *sdi,
475 uint64_t record_length,
476 function<void (const QString)> error_handler)
479 assert(error_handler);
482 sr_session_datafeed_callback_add(data_feed_in_proc, NULL);
484 if (sr_session_dev_add(sdi) != SR_OK) {
485 error_handler(tr("Failed to use device."));
486 sr_session_destroy();
490 // Set the sample limit
491 if (sr_config_set(sdi, SR_CONF_LIMIT_SAMPLES,
492 g_variant_new_uint64(record_length)) != SR_OK) {
493 error_handler(tr("Failed to configure "
494 "time-based sample limit."));
495 sr_session_destroy();
499 if (sr_session_start() != SR_OK) {
500 error_handler(tr("Failed to start session."));
504 set_capture_state(is_trigger_enabled() ? AwaitingTrigger : Running);
507 sr_session_destroy();
509 set_capture_state(Stopped);
511 // Confirm that SR_DF_END was received
512 assert(!_cur_logic_snapshot);
513 assert(!_cur_analog_snapshot);
516 void SigSession::feed_in_header(const sr_dev_inst *sdi)
518 read_sample_rate(sdi);
521 void SigSession::feed_in_meta(const sr_dev_inst *sdi,
522 const sr_datafeed_meta &meta)
526 for (const GSList *l = meta.config; l; l = l->next) {
527 const sr_config *const src = (const sr_config*)l->data;
529 case SR_CONF_SAMPLERATE:
530 /// @todo handle samplerate changes
531 /// samplerate = (uint64_t *)src->value;
534 // Unknown metadata is not an error.
542 void SigSession::feed_in_logic(const sr_datafeed_logic &logic)
544 lock_guard<mutex> lock(_data_mutex);
548 qDebug() << "Unexpected logic packet";
552 if (!_cur_logic_snapshot)
554 set_capture_state(Running);
556 // Create a new data snapshot
557 _cur_logic_snapshot = shared_ptr<data::LogicSnapshot>(
558 new data::LogicSnapshot(logic));
559 _logic_data->push_snapshot(_cur_logic_snapshot);
563 // Append to the existing data snapshot
564 _cur_logic_snapshot->append_payload(logic);
570 void SigSession::feed_in_analog(const sr_datafeed_analog &analog)
572 lock_guard<mutex> lock(_data_mutex);
576 qDebug() << "Unexpected analog packet";
577 return; // This analog packet was not expected.
580 if (!_cur_analog_snapshot)
582 set_capture_state(Running);
584 // Create a new data snapshot
585 _cur_analog_snapshot = shared_ptr<data::AnalogSnapshot>(
586 new data::AnalogSnapshot(analog));
587 _analog_data->push_snapshot(_cur_analog_snapshot);
591 // Append to the existing data snapshot
592 _cur_analog_snapshot->append_payload(analog);
598 void SigSession::data_feed_in(const struct sr_dev_inst *sdi,
599 const struct sr_datafeed_packet *packet)
604 switch (packet->type) {
610 assert(packet->payload);
612 *(const sr_datafeed_meta*)packet->payload);
616 assert(packet->payload);
617 feed_in_logic(*(const sr_datafeed_logic*)packet->payload);
621 assert(packet->payload);
622 feed_in_analog(*(const sr_datafeed_analog*)packet->payload);
628 lock_guard<mutex> lock(_data_mutex);
629 _cur_logic_snapshot.reset();
630 _cur_analog_snapshot.reset();
638 void SigSession::data_feed_in_proc(const struct sr_dev_inst *sdi,
639 const struct sr_datafeed_packet *packet, void *cb_data)
643 _session->data_feed_in(sdi, packet);