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"
29 #include "data/analog.h"
30 #include "data/analogsnapshot.h"
31 #include "data/decoderstack.h"
32 #include "data/logic.h"
33 #include "data/logicsnapshot.h"
34 #include "data/decode/decoder.h"
36 #include "view/analogsignal.h"
37 #include "view/decodetrace.h"
38 #include "view/logicsignal.h"
48 #include <libsigrok/libsigrok.hpp>
50 using std::dynamic_pointer_cast;
52 using std::lock_guard;
57 using std::shared_ptr;
62 using sigrok::Channel;
63 using sigrok::ChannelType;
64 using sigrok::ConfigKey;
65 using sigrok::DatafeedCallbackFunction;
68 using sigrok::HardwareDevice;
73 using sigrok::PacketPayload;
74 using sigrok::Session;
75 using sigrok::SessionDevice;
77 using Glib::VariantBase;
81 SigSession::SigSession(DeviceManager &device_manager) :
82 _device_manager(device_manager),
83 _session(device_manager.context()->create_session()),
84 _capture_state(Stopped)
89 SigSession::~SigSession()
91 // Stop and join to the thread
95 const shared_ptr<sigrok::Session>& SigSession::session() const
100 shared_ptr<Device> SigSession::device() const
105 void SigSession::set_device(shared_ptr<Device> device)
107 // Ensure we are not capturing before setting the device
110 // Are we setting a session device?
111 auto session_device = dynamic_pointer_cast<SessionDevice>(device);
112 // Did we have a session device selected previously?
113 auto prev_session_device = dynamic_pointer_cast<SessionDevice>(_device);
116 _session->remove_datafeed_callbacks();
117 if (!prev_session_device) {
119 _session->remove_devices();
124 _session = session_device->parent();
127 _decode_traces.clear();
132 _session = _device_manager.context()->create_session();
134 _session->add_device(device);
136 _session->add_datafeed_callback([=]
137 (shared_ptr<Device> device, shared_ptr<Packet> packet) {
138 data_feed_in(device, packet);
140 update_signals(device);
144 void SigSession::set_file(const string &name)
146 _session = _device_manager.context()->load_session(name);
147 _device = _session->devices()[0];
148 _decode_traces.clear();
149 _session->add_datafeed_callback([=]
150 (shared_ptr<Device> device, shared_ptr<Packet> packet) {
151 data_feed_in(device, packet);
153 _device_manager.update_display_name(_device);
154 update_signals(_device);
157 void SigSession::set_default_device()
159 shared_ptr<HardwareDevice> default_device;
160 const list< shared_ptr<HardwareDevice> > &devices =
161 _device_manager.devices();
163 if (!devices.empty()) {
164 // Fall back to the first device in the list.
165 default_device = devices.front();
167 // Try and find the demo device and select that by default
168 for (shared_ptr<HardwareDevice> dev : devices)
169 if (dev->driver()->name().compare("demo") == 0) {
170 default_device = dev;
174 set_device(default_device);
178 SigSession::capture_state SigSession::get_capture_state() const
180 lock_guard<mutex> lock(_sampling_mutex);
181 return _capture_state;
184 void SigSession::start_capture(function<void (const QString)> error_handler)
188 // Check that a device instance has been selected.
190 qDebug() << "No device selected";
194 // Check that at least one channel is enabled
195 auto channels = _device->channels();
196 bool enabled = std::any_of(channels.begin(), channels.end(),
197 [](shared_ptr<Channel> channel) { return channel->enabled(); });
200 error_handler(tr("No channels enabled."));
205 _sampling_thread = std::thread(
206 &SigSession::sample_thread_proc, this, _device,
210 void SigSession::stop_capture()
212 if (get_capture_state() != Stopped)
215 // Check that sampling stopped
216 if (_sampling_thread.joinable())
217 _sampling_thread.join();
220 set< shared_ptr<data::SignalData> > SigSession::get_data() const
222 lock_guard<mutex> lock(_signals_mutex);
223 set< shared_ptr<data::SignalData> > data;
224 for (const shared_ptr<view::Signal> sig : _signals) {
226 data.insert(sig->data());
232 vector< shared_ptr<view::Signal> > SigSession::get_signals() const
234 lock_guard<mutex> lock(_signals_mutex);
239 bool SigSession::add_decoder(srd_decoder *const dec)
241 map<const srd_channel*, shared_ptr<view::LogicSignal> > channels;
242 shared_ptr<data::DecoderStack> decoder_stack;
246 lock_guard<mutex> lock(_signals_mutex);
248 // Create the decoder
249 decoder_stack = shared_ptr<data::DecoderStack>(
250 new data::DecoderStack(*this, dec));
252 // Make a list of all the channels
253 std::vector<const srd_channel*> all_channels;
254 for(const GSList *i = dec->channels; i; i = i->next)
255 all_channels.push_back((const srd_channel*)i->data);
256 for(const GSList *i = dec->opt_channels; i; i = i->next)
257 all_channels.push_back((const srd_channel*)i->data);
259 // Auto select the initial channels
260 for (const srd_channel *pdch : all_channels)
261 for (shared_ptr<view::Signal> s : _signals)
263 shared_ptr<view::LogicSignal> l =
264 dynamic_pointer_cast<view::LogicSignal>(s);
265 if (l && QString::fromUtf8(pdch->name).
267 l->get_name().toLower()))
271 assert(decoder_stack);
272 assert(!decoder_stack->stack().empty());
273 assert(decoder_stack->stack().front());
274 decoder_stack->stack().front()->set_channels(channels);
276 // Create the decode signal
277 shared_ptr<view::DecodeTrace> d(
278 new view::DecodeTrace(*this, decoder_stack,
279 _decode_traces.size()));
280 _decode_traces.push_back(d);
282 catch(std::runtime_error e)
289 // Do an initial decode
290 decoder_stack->begin_decode();
295 vector< shared_ptr<view::DecodeTrace> > SigSession::get_decode_signals() const
297 lock_guard<mutex> lock(_signals_mutex);
298 return _decode_traces;
301 void SigSession::remove_decode_signal(view::DecodeTrace *signal)
303 for (auto i = _decode_traces.begin(); i != _decode_traces.end(); i++)
304 if ((*i).get() == signal)
306 _decode_traces.erase(i);
313 void SigSession::set_capture_state(capture_state state)
315 lock_guard<mutex> lock(_sampling_mutex);
316 const bool changed = _capture_state != state;
317 _capture_state = state;
319 capture_state_changed(state);
322 void SigSession::update_signals(shared_ptr<Device> device)
325 assert(_capture_state == Stopped);
327 // Clear the decode traces
328 _decode_traces.clear();
330 // Detect what data types we will receive
331 auto channels = device->channels();
332 unsigned int logic_channel_count = std::count_if(
333 channels.begin(), channels.end(),
334 [] (shared_ptr<Channel> channel) {
335 return channel->type() == ChannelType::LOGIC; });
337 // Create data containers for the logic data snapshots
339 lock_guard<mutex> data_lock(_data_mutex);
342 if (logic_channel_count != 0) {
343 _logic_data.reset(new data::Logic(
344 logic_channel_count));
349 // Make the Signals list
351 lock_guard<mutex> lock(_signals_mutex);
355 for (auto channel : device->channels()) {
356 shared_ptr<view::Signal> signal;
358 switch(channel->type()->id()) {
359 case SR_CHANNEL_LOGIC:
360 signal = shared_ptr<view::Signal>(
361 new view::LogicSignal(*this, device,
362 channel, _logic_data));
365 case SR_CHANNEL_ANALOG:
367 shared_ptr<data::Analog> data(
369 signal = shared_ptr<view::Signal>(
370 new view::AnalogSignal(
371 *this, channel, data));
381 _signals.push_back(signal);
389 shared_ptr<view::Signal> SigSession::signal_from_channel(
390 shared_ptr<Channel> channel) const
392 lock_guard<mutex> lock(_signals_mutex);
393 for (shared_ptr<view::Signal> sig : _signals) {
395 if (sig->channel() == channel)
398 return shared_ptr<view::Signal>();
401 void SigSession::read_sample_rate(shared_ptr<Device> device)
403 uint64_t sample_rate = VariantBase::cast_dynamic<Variant<guint64>>(
404 device->config_get(ConfigKey::SAMPLERATE)).get();
406 // Set the sample rate of all data
407 const set< shared_ptr<data::SignalData> > data_set = get_data();
408 for (shared_ptr<data::SignalData> data : data_set) {
410 data->set_samplerate(sample_rate);
414 void SigSession::sample_thread_proc(shared_ptr<Device> device,
415 function<void (const QString)> error_handler)
418 assert(error_handler);
420 read_sample_rate(device);
425 error_handler(e.what());
429 set_capture_state(_session->trigger() ?
430 AwaitingTrigger : Running);
433 set_capture_state(Stopped);
435 // Confirm that SR_DF_END was received
436 if (_cur_logic_snapshot)
438 qDebug("SR_DF_END was not received.");
443 void SigSession::feed_in_header(shared_ptr<Device> device)
445 read_sample_rate(device);
448 void SigSession::feed_in_meta(shared_ptr<Device> device,
449 shared_ptr<Meta> meta)
453 for (auto entry : meta->config()) {
454 switch (entry.first->id()) {
455 case SR_CONF_SAMPLERATE:
456 /// @todo handle samplerate changes
459 // Unknown metadata is not an error.
467 void SigSession::feed_in_frame_begin()
469 if (_cur_logic_snapshot || !_cur_analog_snapshots.empty())
473 void SigSession::feed_in_logic(shared_ptr<Logic> logic)
475 lock_guard<mutex> lock(_data_mutex);
479 qDebug() << "Unexpected logic packet";
483 if (!_cur_logic_snapshot)
485 // This could be the first packet after a trigger
486 set_capture_state(Running);
489 uint64_t sample_limit;
491 sample_limit = VariantBase::cast_dynamic<Variant<guint64>>(
492 _device->config_get(ConfigKey::LIMIT_SAMPLES)).get();
497 // Create a new data snapshot
498 _cur_logic_snapshot = shared_ptr<data::LogicSnapshot>(
499 new data::LogicSnapshot(logic, sample_limit));
500 _logic_data->push_snapshot(_cur_logic_snapshot);
502 // @todo Putting this here means that only listeners querying
503 // for logic will be notified. Currently the only user of
504 // frame_began is DecoderStack, but in future we need to signal
505 // this after both analog and logic sweeps have begun.
510 // Append to the existing data snapshot
511 _cur_logic_snapshot->append_payload(logic);
517 void SigSession::feed_in_analog(shared_ptr<Analog> analog)
519 lock_guard<mutex> lock(_data_mutex);
521 const vector<shared_ptr<Channel>> channels = analog->channels();
522 const unsigned int channel_count = channels.size();
523 const size_t sample_count = analog->num_samples() / channel_count;
524 const float *data = analog->data_pointer();
525 bool sweep_beginning = false;
527 for (auto channel : channels)
529 shared_ptr<data::AnalogSnapshot> snapshot;
531 // Try to get the snapshot of the channel
532 const map< shared_ptr<Channel>, shared_ptr<data::AnalogSnapshot> >::
533 iterator iter = _cur_analog_snapshots.find(channel);
534 if (iter != _cur_analog_snapshots.end())
535 snapshot = (*iter).second;
538 // If no snapshot was found, this means we havn't
539 // created one yet. i.e. this is the first packet
540 // in the sweep containing this snapshot.
541 sweep_beginning = true;
544 uint64_t sample_limit;
546 sample_limit = VariantBase::cast_dynamic<Variant<guint64>>(
547 _device->config_get(ConfigKey::LIMIT_SAMPLES)).get();
552 // Create a snapshot, keep it in the maps of channels
553 snapshot = shared_ptr<data::AnalogSnapshot>(
554 new data::AnalogSnapshot(sample_limit));
555 _cur_analog_snapshots[channel] = snapshot;
557 // Find the annalog data associated with the channel
558 shared_ptr<view::AnalogSignal> sig =
559 dynamic_pointer_cast<view::AnalogSignal>(
560 signal_from_channel(channel));
563 shared_ptr<data::Analog> data(sig->analog_data());
566 // Push the snapshot into the analog data.
567 data->push_snapshot(snapshot);
572 // Append the samples in the snapshot
573 snapshot->append_interleaved_samples(data++, sample_count,
577 if (sweep_beginning) {
578 // This could be the first packet after a trigger
579 set_capture_state(Running);
585 void SigSession::data_feed_in(shared_ptr<Device> device, shared_ptr<Packet> packet)
590 switch (packet->type()->id()) {
592 feed_in_header(device);
596 feed_in_meta(device, dynamic_pointer_cast<Meta>(packet->payload()));
599 case SR_DF_FRAME_BEGIN:
600 feed_in_frame_begin();
604 feed_in_logic(dynamic_pointer_cast<Logic>(packet->payload()));
608 feed_in_analog(dynamic_pointer_cast<Analog>(packet->payload()));
614 lock_guard<mutex> lock(_data_mutex);
615 _cur_logic_snapshot.reset();
616 _cur_analog_snapshots.clear();