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"
50 using std::dynamic_pointer_cast;
52 using std::lock_guard;
57 using std::shared_ptr;
63 // TODO: This should not be necessary
64 SigSession* SigSession::_session = NULL;
66 // TODO: This should not be necessary
67 struct sr_session *SigSession::_sr_session = NULL;
69 SigSession::SigSession(DeviceManager &device_manager) :
70 _device_manager(device_manager),
71 _capture_state(Stopped)
73 // TODO: This should not be necessary
79 SigSession::~SigSession()
81 using pv::device::Device;
83 // Stop and join to the thread
88 // TODO: This should not be necessary
92 shared_ptr<device::DevInst> SigSession::get_device() const
97 void SigSession::set_device(
98 shared_ptr<device::DevInst> dev_inst) throw(QString)
100 using pv::device::Device;
102 // Ensure we are not capturing before setting the device
106 sr_session_datafeed_callback_remove_all(_sr_session);
107 _dev_inst->release();
110 _dev_inst = dev_inst;
111 _decode_traces.clear();
115 sr_session_datafeed_callback_add(_sr_session, data_feed_in_proc, NULL);
116 update_signals(dev_inst);
120 void SigSession::set_file(const string &name) throw(QString)
122 // Deselect the old device, because file type detection in File::create
123 // destroys the old session inside libsigrok.
124 set_device(shared_ptr<device::DevInst>());
125 set_device(shared_ptr<device::DevInst>(device::File::create(name)));
128 void SigSession::set_default_device()
130 shared_ptr<pv::device::DevInst> default_device;
131 const list< shared_ptr<device::Device> > &devices =
132 _device_manager.devices();
134 if (!devices.empty()) {
135 // Fall back to the first device in the list.
136 default_device = devices.front();
138 // Try and find the demo device and select that by default
139 for (shared_ptr<pv::device::Device> dev : devices)
140 if (strcmp(dev->dev_inst()->driver->name,
142 default_device = dev;
147 set_device(default_device);
150 void SigSession::release_device(device::DevInst *dev_inst)
153 assert(_dev_inst.get() == dev_inst);
155 assert(_capture_state == Stopped);
156 _dev_inst = shared_ptr<device::DevInst>();
159 SigSession::capture_state SigSession::get_capture_state() const
161 lock_guard<mutex> lock(_sampling_mutex);
162 return _capture_state;
165 void SigSession::start_capture(function<void (const QString)> error_handler)
169 // Check that a device instance has been selected.
171 qDebug() << "No device selected";
175 assert(_dev_inst->dev_inst());
177 // Check that at least one probe is enabled
179 for (l = _dev_inst->dev_inst()->channels; l; l = l->next) {
180 sr_channel *const probe = (sr_channel*)l->data;
187 error_handler(tr("No channels enabled."));
192 _sampling_thread = std::thread(
193 &SigSession::sample_thread_proc, this, _dev_inst,
197 void SigSession::stop_capture()
199 if (get_capture_state() != Stopped)
200 sr_session_stop(_sr_session);
202 // Check that sampling stopped
203 if (_sampling_thread.joinable())
204 _sampling_thread.join();
207 set< shared_ptr<data::SignalData> > SigSession::get_data() const
209 lock_guard<mutex> lock(_signals_mutex);
210 set< shared_ptr<data::SignalData> > data;
211 for (const shared_ptr<view::Signal> sig : _signals) {
213 data.insert(sig->data());
219 vector< shared_ptr<view::Signal> > SigSession::get_signals() const
221 lock_guard<mutex> lock(_signals_mutex);
226 bool SigSession::add_decoder(srd_decoder *const dec)
228 map<const srd_channel*, shared_ptr<view::LogicSignal> > probes;
229 shared_ptr<data::DecoderStack> decoder_stack;
233 lock_guard<mutex> lock(_signals_mutex);
235 // Create the decoder
236 decoder_stack = shared_ptr<data::DecoderStack>(
237 new data::DecoderStack(*this, dec));
239 // Make a list of all the probes
240 std::vector<const srd_channel*> all_probes;
241 for(const GSList *i = dec->channels; i; i = i->next)
242 all_probes.push_back((const srd_channel*)i->data);
243 for(const GSList *i = dec->opt_channels; i; i = i->next)
244 all_probes.push_back((const srd_channel*)i->data);
246 // Auto select the initial probes
247 for (const srd_channel *pdch : all_probes)
248 for (shared_ptr<view::Signal> s : _signals)
250 shared_ptr<view::LogicSignal> l =
251 dynamic_pointer_cast<view::LogicSignal>(s);
252 if (l && QString::fromUtf8(pdch->name).
254 l->get_name().toLower()))
258 assert(decoder_stack);
259 assert(!decoder_stack->stack().empty());
260 assert(decoder_stack->stack().front());
261 decoder_stack->stack().front()->set_probes(probes);
263 // Create the decode signal
264 shared_ptr<view::DecodeTrace> d(
265 new view::DecodeTrace(*this, decoder_stack,
266 _decode_traces.size()));
267 _decode_traces.push_back(d);
269 catch(std::runtime_error e)
276 // Do an initial decode
277 decoder_stack->begin_decode();
282 vector< shared_ptr<view::DecodeTrace> > SigSession::get_decode_signals() const
284 lock_guard<mutex> lock(_signals_mutex);
285 return _decode_traces;
288 void SigSession::remove_decode_signal(view::DecodeTrace *signal)
290 for (auto i = _decode_traces.begin(); i != _decode_traces.end(); i++)
291 if ((*i).get() == signal)
293 _decode_traces.erase(i);
300 void SigSession::set_capture_state(capture_state state)
302 lock_guard<mutex> lock(_sampling_mutex);
303 const bool changed = _capture_state != state;
304 _capture_state = state;
306 capture_state_changed(state);
309 void SigSession::update_signals(shared_ptr<device::DevInst> dev_inst)
312 assert(_capture_state == Stopped);
314 unsigned int logic_probe_count = 0;
316 // Clear the decode traces
317 _decode_traces.clear();
319 // Detect what data types we will receive
321 assert(dev_inst->dev_inst());
322 for (const GSList *l = dev_inst->dev_inst()->channels;
324 const sr_channel *const probe = (const sr_channel *)l->data;
328 switch(probe->type) {
329 case SR_CHANNEL_LOGIC:
336 // Create data containers for the logic data snapshots
338 lock_guard<mutex> data_lock(_data_mutex);
341 if (logic_probe_count != 0) {
342 _logic_data.reset(new data::Logic(
348 // Make the Signals list
350 lock_guard<mutex> lock(_signals_mutex);
357 assert(dev_inst->dev_inst());
358 for (const GSList *l = dev_inst->dev_inst()->channels;
360 shared_ptr<view::Signal> signal;
361 sr_channel *const probe = (sr_channel *)l->data;
364 switch(probe->type) {
365 case SR_CHANNEL_LOGIC:
366 signal = shared_ptr<view::Signal>(
367 new view::LogicSignal(dev_inst,
368 probe, _logic_data));
371 case SR_CHANNEL_ANALOG:
373 shared_ptr<data::Analog> data(
375 signal = shared_ptr<view::Signal>(
376 new view::AnalogSignal(dev_inst,
387 _signals.push_back(signal);
395 shared_ptr<view::Signal> SigSession::signal_from_probe(
396 const sr_channel *probe) const
398 lock_guard<mutex> lock(_signals_mutex);
399 for (shared_ptr<view::Signal> sig : _signals) {
401 if (sig->probe() == probe)
404 return shared_ptr<view::Signal>();
407 void SigSession::read_sample_rate(const sr_dev_inst *const sdi)
410 uint64_t sample_rate = 0;
412 // Read out the sample rate
415 const int ret = sr_config_get(sdi->driver, sdi, NULL,
416 SR_CONF_SAMPLERATE, &gvar);
418 qDebug("Failed to get samplerate\n");
422 sample_rate = g_variant_get_uint64(gvar);
423 g_variant_unref(gvar);
426 // Set the sample rate of all data
427 const set< shared_ptr<data::SignalData> > data_set = get_data();
428 for (shared_ptr<data::SignalData> data : data_set) {
430 data->set_samplerate(sample_rate);
434 void SigSession::sample_thread_proc(shared_ptr<device::DevInst> dev_inst,
435 function<void (const QString)> error_handler)
438 assert(dev_inst->dev_inst());
439 assert(error_handler);
441 read_sample_rate(dev_inst->dev_inst());
445 } catch(const QString e) {
450 set_capture_state(sr_session_trigger_get(_sr_session) ?
451 AwaitingTrigger : Running);
454 set_capture_state(Stopped);
456 // Confirm that SR_DF_END was received
457 if (_cur_logic_snapshot)
459 qDebug("SR_DF_END was not received.");
464 void SigSession::feed_in_header(const sr_dev_inst *sdi)
466 read_sample_rate(sdi);
469 void SigSession::feed_in_meta(const sr_dev_inst *sdi,
470 const sr_datafeed_meta &meta)
474 for (const GSList *l = meta.config; l; l = l->next) {
475 const sr_config *const src = (const sr_config*)l->data;
477 case SR_CONF_SAMPLERATE:
478 /// @todo handle samplerate changes
479 /// samplerate = (uint64_t *)src->value;
482 // Unknown metadata is not an error.
490 void SigSession::feed_in_frame_begin()
492 if (_cur_logic_snapshot || !_cur_analog_snapshots.empty())
496 void SigSession::feed_in_logic(const sr_datafeed_logic &logic)
498 lock_guard<mutex> lock(_data_mutex);
502 qDebug() << "Unexpected logic packet";
506 if (!_cur_logic_snapshot)
508 // This could be the first packet after a trigger
509 set_capture_state(Running);
511 // Create a new data snapshot
512 _cur_logic_snapshot = shared_ptr<data::LogicSnapshot>(
513 new data::LogicSnapshot(logic, _dev_inst->get_sample_limit()));
514 _logic_data->push_snapshot(_cur_logic_snapshot);
516 // @todo Putting this here means that only listeners querying
517 // for logic will be notified. Currently the only user of
518 // frame_began is DecoderStack, but in future we need to signal
519 // this after both analog and logic sweeps have begun.
524 // Append to the existing data snapshot
525 _cur_logic_snapshot->append_payload(logic);
531 void SigSession::feed_in_analog(const sr_datafeed_analog &analog)
533 lock_guard<mutex> lock(_data_mutex);
535 const unsigned int probe_count = g_slist_length(analog.channels);
536 const size_t sample_count = analog.num_samples / probe_count;
537 const float *data = analog.data;
538 bool sweep_beginning = false;
540 for (GSList *p = analog.channels; p; p = p->next)
542 shared_ptr<data::AnalogSnapshot> snapshot;
544 sr_channel *const probe = (sr_channel*)p->data;
547 // Try to get the snapshot of the probe
548 const map< const sr_channel*, shared_ptr<data::AnalogSnapshot> >::
549 iterator iter = _cur_analog_snapshots.find(probe);
550 if (iter != _cur_analog_snapshots.end())
551 snapshot = (*iter).second;
554 // If no snapshot was found, this means we havn't
555 // created one yet. i.e. this is the first packet
556 // in the sweep containing this snapshot.
557 sweep_beginning = true;
559 // Create a snapshot, keep it in the maps of probes
560 snapshot = shared_ptr<data::AnalogSnapshot>(
561 new data::AnalogSnapshot(_dev_inst->get_sample_limit()));
562 _cur_analog_snapshots[probe] = snapshot;
564 // Find the annalog data associated with the probe
565 shared_ptr<view::AnalogSignal> sig =
566 dynamic_pointer_cast<view::AnalogSignal>(
567 signal_from_probe(probe));
570 shared_ptr<data::Analog> data(sig->analog_data());
573 // Push the snapshot into the analog data.
574 data->push_snapshot(snapshot);
579 // Append the samples in the snapshot
580 snapshot->append_interleaved_samples(data++, sample_count,
584 if (sweep_beginning) {
585 // This could be the first packet after a trigger
586 set_capture_state(Running);
592 void SigSession::data_feed_in(const struct sr_dev_inst *sdi,
593 const struct sr_datafeed_packet *packet)
598 switch (packet->type) {
604 assert(packet->payload);
606 *(const sr_datafeed_meta*)packet->payload);
609 case SR_DF_FRAME_BEGIN:
610 feed_in_frame_begin();
614 assert(packet->payload);
615 feed_in_logic(*(const sr_datafeed_logic*)packet->payload);
619 assert(packet->payload);
620 feed_in_analog(*(const sr_datafeed_analog*)packet->payload);
626 lock_guard<mutex> lock(_data_mutex);
627 _cur_logic_snapshot.reset();
628 _cur_analog_snapshots.clear();
636 void SigSession::data_feed_in_proc(const struct sr_dev_inst *sdi,
637 const struct sr_datafeed_packet *packet, void *cb_data)
641 _session->data_feed_in(sdi, packet);