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 shared_ptr<data::Decoder> decoder(
205 new data::Decoder(dec, probes, options));
206 shared_ptr<view::DecodeSignal> d(
207 new view::DecodeSignal(*this, decoder,
208 _decode_traces.size()));
209 _decode_traces.push_back(d);
214 vector< shared_ptr<view::DecodeSignal> > SigSession::get_decode_signals() const
216 lock_guard<mutex> lock(_signals_mutex);
217 return _decode_traces;
220 void SigSession::remove_decode_signal(view::DecodeSignal *signal)
222 for (vector< shared_ptr<view::DecodeSignal> >::iterator i =
223 _decode_traces.begin();
224 i != _decode_traces.end();
226 if ((*i).get() == signal)
228 _decode_traces.erase(i);
234 void SigSession::set_capture_state(capture_state state)
236 lock_guard<mutex> lock(_sampling_mutex);
237 const bool changed = _capture_state != state;
238 _capture_state = state;
240 capture_state_changed(state);
244 * Attempts to autodetect the format. Failing that
245 * @param filename The filename of the input file.
246 * @return A pointer to the 'struct sr_input_format' that should be used,
247 * or NULL if no input format was selected or auto-detected.
249 sr_input_format* SigSession::determine_input_file_format(
250 const string &filename)
254 /* If there are no input formats, return NULL right away. */
255 sr_input_format *const *const inputs = sr_input_list();
257 g_critical("No supported input formats available.");
261 /* Otherwise, try to find an input module that can handle this file. */
262 for (i = 0; inputs[i]; i++) {
263 if (inputs[i]->format_match(filename.c_str()))
267 /* Return NULL if no input module wanted to touch this. */
269 g_critical("Error: no matching input module found.");
276 sr_input* SigSession::load_input_file_format(const string &filename,
277 function<void (const QString)> error_handler,
278 sr_input_format *format)
283 if (!format && !(format =
284 determine_input_file_format(filename.c_str()))) {
285 /* The exact cause was already logged. */
289 if (stat(filename.c_str(), &st) == -1) {
290 error_handler(tr("Failed to load file"));
294 /* Initialize the input module. */
295 if (!(in = new sr_input)) {
296 qDebug("Failed to allocate input module.\n");
302 if (in->format->init &&
303 in->format->init(in, filename.c_str()) != SR_OK) {
304 qDebug("Input format init failed.\n");
310 if (sr_session_dev_add(in->sdi) != SR_OK) {
311 qDebug("Failed to use device.\n");
312 sr_session_destroy();
319 void SigSession::update_signals(const sr_dev_inst *const sdi)
321 assert(_capture_state == Stopped);
323 shared_ptr<view::Signal> signal;
324 unsigned int logic_probe_count = 0;
325 unsigned int analog_probe_count = 0;
327 // Clear the decode traces
328 _decode_traces.clear();
330 // Detect what data types we will receive
332 for (const GSList *l = sdi->probes; l; l = l->next) {
333 const sr_probe *const probe = (const sr_probe *)l->data;
337 switch(probe->type) {
342 case SR_PROBE_ANALOG:
343 analog_probe_count++;
349 // Create data containers for the data snapshots
351 lock_guard<mutex> data_lock(_data_mutex);
354 if (logic_probe_count != 0) {
355 _logic_data.reset(new data::Logic(
360 _analog_data.reset();
361 if (analog_probe_count != 0) {
362 _analog_data.reset(new data::Analog());
363 assert(_analog_data);
367 // Make the Signals list
369 lock_guard<mutex> lock(_signals_mutex);
374 for (const GSList *l = sdi->probes; l; l = l->next) {
375 sr_probe *const probe = (sr_probe *)l->data;
378 switch(probe->type) {
380 signal = shared_ptr<view::Signal>(
381 new view::LogicSignal(*this, probe,
385 case SR_PROBE_ANALOG:
386 signal = shared_ptr<view::Signal>(
387 new view::AnalogSignal(*this, probe,
392 _signals.push_back(signal);
400 bool SigSession::is_trigger_enabled() const
403 for (const GSList *l = _sdi->probes; l; l = l->next) {
404 const sr_probe *const p = (const sr_probe *)l->data;
406 if (p->trigger && p->trigger[0] != '\0')
413 void SigSession::read_sample_rate(const sr_dev_inst *const sdi)
416 uint64_t sample_rate = 0;
418 // Read out the sample rate
421 const int ret = sr_config_get(sdi->driver,
422 SR_CONF_SAMPLERATE, &gvar, sdi);
424 qDebug("Failed to get samplerate\n");
428 sample_rate = g_variant_get_uint64(gvar);
429 g_variant_unref(gvar);
433 _analog_data->set_samplerate(sample_rate);
435 _logic_data->set_samplerate(sample_rate);
438 void SigSession::load_session_thread_proc(
439 function<void (const QString)> error_handler)
443 sr_session_datafeed_callback_add(data_feed_in_proc, NULL);
445 set_capture_state(Running);
449 sr_session_destroy();
450 set_capture_state(Stopped);
452 // Confirm that SR_DF_END was received
453 assert(!_cur_logic_snapshot);
454 assert(!_cur_analog_snapshot);
457 void SigSession::load_input_thread_proc(const string name,
458 sr_input *in, function<void (const QString)> error_handler)
465 sr_session_datafeed_callback_add(data_feed_in_proc, NULL);
467 set_capture_state(Running);
469 in->format->loadfile(in, name.c_str());
471 sr_session_destroy();
472 set_capture_state(Stopped);
474 // Confirm that SR_DF_END was received
475 assert(!_cur_logic_snapshot);
476 assert(!_cur_analog_snapshot);
481 void SigSession::sample_thread_proc(struct sr_dev_inst *sdi,
482 uint64_t record_length,
483 function<void (const QString)> error_handler)
486 assert(error_handler);
489 sr_session_datafeed_callback_add(data_feed_in_proc, NULL);
491 if (sr_session_dev_add(sdi) != SR_OK) {
492 error_handler(tr("Failed to use device."));
493 sr_session_destroy();
497 // Set the sample limit
498 if (sr_config_set(sdi, SR_CONF_LIMIT_SAMPLES,
499 g_variant_new_uint64(record_length)) != SR_OK) {
500 error_handler(tr("Failed to configure "
501 "time-based sample limit."));
502 sr_session_destroy();
506 if (sr_session_start() != SR_OK) {
507 error_handler(tr("Failed to start session."));
511 set_capture_state(is_trigger_enabled() ? AwaitingTrigger : Running);
514 sr_session_destroy();
516 set_capture_state(Stopped);
518 // Confirm that SR_DF_END was received
519 assert(!_cur_logic_snapshot);
520 assert(!_cur_analog_snapshot);
523 void SigSession::feed_in_header(const sr_dev_inst *sdi)
525 read_sample_rate(sdi);
528 void SigSession::feed_in_meta(const sr_dev_inst *sdi,
529 const sr_datafeed_meta &meta)
533 for (const GSList *l = meta.config; l; l = l->next) {
534 const sr_config *const src = (const sr_config*)l->data;
536 case SR_CONF_SAMPLERATE:
537 /// @todo handle samplerate changes
538 /// samplerate = (uint64_t *)src->value;
541 // Unknown metadata is not an error.
549 void SigSession::feed_in_logic(const sr_datafeed_logic &logic)
551 lock_guard<mutex> lock(_data_mutex);
555 qDebug() << "Unexpected logic packet";
559 if (!_cur_logic_snapshot)
561 set_capture_state(Running);
563 // Create a new data snapshot
564 _cur_logic_snapshot = shared_ptr<data::LogicSnapshot>(
565 new data::LogicSnapshot(logic));
566 _logic_data->push_snapshot(_cur_logic_snapshot);
570 // Append to the existing data snapshot
571 _cur_logic_snapshot->append_payload(logic);
577 void SigSession::feed_in_analog(const sr_datafeed_analog &analog)
579 lock_guard<mutex> lock(_data_mutex);
583 qDebug() << "Unexpected analog packet";
584 return; // This analog packet was not expected.
587 if (!_cur_analog_snapshot)
589 set_capture_state(Running);
591 // Create a new data snapshot
592 _cur_analog_snapshot = shared_ptr<data::AnalogSnapshot>(
593 new data::AnalogSnapshot(analog));
594 _analog_data->push_snapshot(_cur_analog_snapshot);
598 // Append to the existing data snapshot
599 _cur_analog_snapshot->append_payload(analog);
605 void SigSession::data_feed_in(const struct sr_dev_inst *sdi,
606 const struct sr_datafeed_packet *packet)
611 switch (packet->type) {
617 assert(packet->payload);
619 *(const sr_datafeed_meta*)packet->payload);
623 assert(packet->payload);
624 feed_in_logic(*(const sr_datafeed_logic*)packet->payload);
628 assert(packet->payload);
629 feed_in_analog(*(const sr_datafeed_analog*)packet->payload);
635 lock_guard<mutex> lock(_data_mutex);
636 _cur_logic_snapshot.reset();
637 _cur_analog_snapshot.reset();
645 void SigSession::data_feed_in_proc(const struct sr_dev_inst *sdi,
646 const struct sr_datafeed_packet *packet, void *cb_data)
650 _session->data_feed_in(sdi, packet);