2 * This file is part of the PulseView project.
4 * Copyright (C) 2012-14 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
22 #include <libsigrokdecode/libsigrokdecode.h>
25 #include "sigsession.h"
27 #include "devicemanager.h"
28 #include "device/device.h"
29 #include "device/file.h"
31 #include "data/analog.h"
32 #include "data/analogsnapshot.h"
33 #include "data/decoderstack.h"
34 #include "data/logic.h"
35 #include "data/logicsnapshot.h"
36 #include "data/decode/decoder.h"
38 #include "view/analogsignal.h"
39 #include "view/decodetrace.h"
40 #include "view/logicsignal.h"
46 #include <boost/foreach.hpp>
52 using boost::dynamic_pointer_cast;
53 using boost::function;
54 using boost::lock_guard;
56 using boost::shared_ptr;
65 // TODO: This should not be necessary
66 SigSession* SigSession::_session = NULL;
68 SigSession::SigSession(DeviceManager &device_manager) :
69 _device_manager(device_manager),
70 _capture_state(Stopped)
72 // TODO: This should not be necessary
78 SigSession::~SigSession()
80 using pv::device::Device;
84 if (_sampling_thread.joinable())
85 _sampling_thread.join();
89 // TODO: This should not be necessary
93 shared_ptr<device::DevInst> SigSession::get_device() const
98 void SigSession::set_device(
99 shared_ptr<device::DevInst> dev_inst) throw(QString)
101 using pv::device::Device;
103 // Ensure we are not capturing before setting the device
107 sr_session_datafeed_callback_remove_all();
108 _dev_inst->release();
111 _dev_inst = dev_inst;
112 _decode_traces.clear();
116 sr_session_datafeed_callback_add(data_feed_in_proc, NULL);
117 update_signals(dev_inst);
121 void SigSession::set_file(const string &name) throw(QString)
123 // Deselect the old device, because file type detection in File::create
124 // destroys the old session inside libsigrok.
125 set_device(shared_ptr<device::DevInst>());
126 set_device(shared_ptr<device::DevInst>(device::File::create(name)));
129 void SigSession::set_default_device()
131 shared_ptr<pv::device::DevInst> default_device;
132 const list< shared_ptr<device::Device> > &devices =
133 _device_manager.devices();
135 if (!devices.empty()) {
136 // Fall back to the first device in the list.
137 default_device = devices.front();
139 // Try and find the demo device and select that by default
140 BOOST_FOREACH (shared_ptr<pv::device::Device> dev, devices)
141 if (strcmp(dev->dev_inst()->driver->name,
143 default_device = dev;
148 set_device(default_device);
151 void SigSession::release_device(device::DevInst *dev_inst)
154 assert(_dev_inst.get() == dev_inst);
156 assert(_capture_state == Stopped);
157 _dev_inst = shared_ptr<device::DevInst>();
160 SigSession::capture_state SigSession::get_capture_state() const
162 lock_guard<mutex> lock(_sampling_mutex);
163 return _capture_state;
166 void SigSession::start_capture(function<void (const QString)> error_handler)
170 // Check that a device instance has been selected.
172 qDebug() << "No device selected";
176 assert(_dev_inst->dev_inst());
178 // Check that at least one probe is enabled
180 for (l = _dev_inst->dev_inst()->channels; l; l = l->next) {
181 sr_channel *const probe = (sr_channel*)l->data;
188 error_handler(tr("No channels enabled."));
193 _sampling_thread = boost::thread(
194 &SigSession::sample_thread_proc, this, _dev_inst,
198 void SigSession::stop_capture()
200 if (get_capture_state() == Stopped)
205 // Check that sampling stopped
206 if (_sampling_thread.joinable())
207 _sampling_thread.join();
210 set< shared_ptr<data::SignalData> > SigSession::get_data() const
212 lock_guard<mutex> lock(_signals_mutex);
213 set< shared_ptr<data::SignalData> > data;
214 BOOST_FOREACH(const shared_ptr<view::Signal> sig, _signals) {
216 data.insert(sig->data());
222 vector< shared_ptr<view::Signal> > SigSession::get_signals() const
224 lock_guard<mutex> lock(_signals_mutex);
229 bool SigSession::add_decoder(srd_decoder *const dec)
231 map<const srd_channel*, shared_ptr<view::LogicSignal> > probes;
232 shared_ptr<data::DecoderStack> decoder_stack;
236 lock_guard<mutex> lock(_signals_mutex);
238 // Create the decoder
239 decoder_stack = shared_ptr<data::DecoderStack>(
240 new data::DecoderStack(*this, dec));
242 // Make a list of all the probes
243 std::vector<const srd_channel*> all_probes;
244 for(const GSList *i = dec->channels; i; i = i->next)
245 all_probes.push_back((const srd_channel*)i->data);
246 for(const GSList *i = dec->opt_channels; i; i = i->next)
247 all_probes.push_back((const srd_channel*)i->data);
249 // Auto select the initial probes
250 BOOST_FOREACH(const srd_channel *pdch, all_probes)
251 BOOST_FOREACH(shared_ptr<view::Signal> s, _signals)
253 shared_ptr<view::LogicSignal> l =
254 dynamic_pointer_cast<view::LogicSignal>(s);
255 if (l && QString::fromUtf8(pdch->name).
257 l->get_name().toLower()))
261 assert(decoder_stack);
262 assert(!decoder_stack->stack().empty());
263 assert(decoder_stack->stack().front());
264 decoder_stack->stack().front()->set_probes(probes);
266 // Create the decode signal
267 shared_ptr<view::DecodeTrace> d(
268 new view::DecodeTrace(*this, decoder_stack,
269 _decode_traces.size()));
270 _decode_traces.push_back(d);
272 catch(std::runtime_error e)
279 // Do an initial decode
280 decoder_stack->begin_decode();
285 vector< shared_ptr<view::DecodeTrace> > SigSession::get_decode_signals() const
287 lock_guard<mutex> lock(_signals_mutex);
288 return _decode_traces;
291 void SigSession::remove_decode_signal(view::DecodeTrace *signal)
293 for (vector< shared_ptr<view::DecodeTrace> >::iterator i =
294 _decode_traces.begin();
295 i != _decode_traces.end();
297 if ((*i).get() == signal)
299 _decode_traces.erase(i);
306 void SigSession::set_capture_state(capture_state state)
308 lock_guard<mutex> lock(_sampling_mutex);
309 const bool changed = _capture_state != state;
310 _capture_state = state;
312 capture_state_changed(state);
315 void SigSession::update_signals(shared_ptr<device::DevInst> dev_inst)
318 assert(_capture_state == Stopped);
320 unsigned int logic_probe_count = 0;
322 // Clear the decode traces
323 _decode_traces.clear();
325 // Detect what data types we will receive
327 assert(dev_inst->dev_inst());
328 for (const GSList *l = dev_inst->dev_inst()->channels;
330 const sr_channel *const probe = (const sr_channel *)l->data;
334 switch(probe->type) {
335 case SR_CHANNEL_LOGIC:
342 // Create data containers for the logic data snapshots
344 lock_guard<mutex> data_lock(_data_mutex);
347 if (logic_probe_count != 0) {
348 _logic_data.reset(new data::Logic(
354 // Make the Signals list
356 lock_guard<mutex> lock(_signals_mutex);
363 assert(dev_inst->dev_inst());
364 for (const GSList *l = dev_inst->dev_inst()->channels;
366 shared_ptr<view::Signal> signal;
367 sr_channel *const probe = (sr_channel *)l->data;
370 switch(probe->type) {
371 case SR_CHANNEL_LOGIC:
372 signal = shared_ptr<view::Signal>(
373 new view::LogicSignal(dev_inst,
374 probe, _logic_data));
377 case SR_CHANNEL_ANALOG:
379 shared_ptr<data::Analog> data(
381 signal = shared_ptr<view::Signal>(
382 new view::AnalogSignal(dev_inst,
393 _signals.push_back(signal);
401 shared_ptr<view::Signal> SigSession::signal_from_probe(
402 const sr_channel *probe) const
404 lock_guard<mutex> lock(_signals_mutex);
405 BOOST_FOREACH(shared_ptr<view::Signal> sig, _signals) {
407 if (sig->probe() == probe)
410 return shared_ptr<view::Signal>();
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, sdi, NULL,
422 SR_CONF_SAMPLERATE, &gvar);
424 qDebug("Failed to get samplerate\n");
428 sample_rate = g_variant_get_uint64(gvar);
429 g_variant_unref(gvar);
432 // Set the sample rate of all data
433 const set< shared_ptr<data::SignalData> > data_set = get_data();
434 BOOST_FOREACH(shared_ptr<data::SignalData> data, data_set) {
436 data->set_samplerate(sample_rate);
440 void SigSession::sample_thread_proc(shared_ptr<device::DevInst> dev_inst,
441 function<void (const QString)> error_handler)
444 assert(dev_inst->dev_inst());
445 assert(error_handler);
447 read_sample_rate(dev_inst->dev_inst());
451 } catch(const QString e) {
456 set_capture_state(dev_inst->is_trigger_enabled() ?
457 AwaitingTrigger : Running);
460 set_capture_state(Stopped);
462 // Confirm that SR_DF_END was received
463 if (_cur_logic_snapshot)
465 qDebug("SR_DF_END was not received.");
470 void SigSession::feed_in_header(const sr_dev_inst *sdi)
472 read_sample_rate(sdi);
475 void SigSession::feed_in_meta(const sr_dev_inst *sdi,
476 const sr_datafeed_meta &meta)
480 for (const GSList *l = meta.config; l; l = l->next) {
481 const sr_config *const src = (const sr_config*)l->data;
483 case SR_CONF_SAMPLERATE:
484 /// @todo handle samplerate changes
485 /// samplerate = (uint64_t *)src->value;
488 // Unknown metadata is not an error.
496 void SigSession::feed_in_frame_begin()
498 if (_cur_logic_snapshot || !_cur_analog_snapshots.empty())
502 void SigSession::feed_in_logic(const sr_datafeed_logic &logic)
504 lock_guard<mutex> lock(_data_mutex);
508 qDebug() << "Unexpected logic packet";
512 if (!_cur_logic_snapshot)
514 // This could be the first packet after a trigger
515 set_capture_state(Running);
517 // Create a new data snapshot
518 _cur_logic_snapshot = shared_ptr<data::LogicSnapshot>(
519 new data::LogicSnapshot(logic, _dev_inst->get_sample_limit()));
520 _logic_data->push_snapshot(_cur_logic_snapshot);
522 // @todo Putting this here means that only listeners querying
523 // for logic will be notified. Currently the only user of
524 // frame_began is DecoderStack, but in future we need to signal
525 // this after both analog and logic sweeps have begun.
530 // Append to the existing data snapshot
531 _cur_logic_snapshot->append_payload(logic);
537 void SigSession::feed_in_analog(const sr_datafeed_analog &analog)
539 lock_guard<mutex> lock(_data_mutex);
541 const unsigned int probe_count = g_slist_length(analog.channels);
542 const size_t sample_count = analog.num_samples / probe_count;
543 const float *data = analog.data;
544 bool sweep_beginning = false;
546 for (GSList *p = analog.channels; p; p = p->next)
548 shared_ptr<data::AnalogSnapshot> snapshot;
550 sr_channel *const probe = (sr_channel*)p->data;
553 // Try to get the snapshot of the probe
554 const map< const sr_channel*, shared_ptr<data::AnalogSnapshot> >::
555 iterator iter = _cur_analog_snapshots.find(probe);
556 if (iter != _cur_analog_snapshots.end())
557 snapshot = (*iter).second;
560 // If no snapshot was found, this means we havn't
561 // created one yet. i.e. this is the first packet
562 // in the sweep containing this snapshot.
563 sweep_beginning = true;
565 // Create a snapshot, keep it in the maps of probes
566 snapshot = shared_ptr<data::AnalogSnapshot>(
567 new data::AnalogSnapshot(_dev_inst->get_sample_limit()));
568 _cur_analog_snapshots[probe] = snapshot;
570 // Find the annalog data associated with the probe
571 shared_ptr<view::AnalogSignal> sig =
572 dynamic_pointer_cast<view::AnalogSignal>(
573 signal_from_probe(probe));
576 shared_ptr<data::Analog> data(sig->analog_data());
579 // Push the snapshot into the analog data.
580 data->push_snapshot(snapshot);
585 // Append the samples in the snapshot
586 snapshot->append_interleaved_samples(data++, sample_count,
590 if (sweep_beginning) {
591 // This could be the first packet after a trigger
592 set_capture_state(Running);
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);
615 case SR_DF_FRAME_BEGIN:
616 feed_in_frame_begin();
620 assert(packet->payload);
621 feed_in_logic(*(const sr_datafeed_logic*)packet->payload);
625 assert(packet->payload);
626 feed_in_analog(*(const sr_datafeed_analog*)packet->payload);
632 lock_guard<mutex> lock(_data_mutex);
633 _cur_logic_snapshot.reset();
634 _cur_analog_snapshots.clear();
642 void SigSession::data_feed_in_proc(const struct sr_dev_inst *sdi,
643 const struct sr_datafeed_packet *packet, void *cb_data)
647 _session->data_feed_in(sdi, packet);