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 "session.hpp"
27 #include "devicemanager.hpp"
29 #include "data/analog.hpp"
30 #include "data/analogsegment.hpp"
31 #include "data/decoderstack.hpp"
32 #include "data/logic.hpp"
33 #include "data/logicsegment.hpp"
34 #include "data/decode/decoder.hpp"
36 #include "devices/hardwaredevice.hpp"
37 #include "devices/sessionfile.hpp"
39 #include "view/analogsignal.hpp"
40 #include "view/decodetrace.hpp"
41 #include "view/logicsignal.hpp"
51 #include <libsigrokcxx/libsigrokcxx.hpp>
53 using boost::shared_lock;
54 using boost::shared_mutex;
55 using boost::unique_lock;
57 using std::dynamic_pointer_cast;
59 using std::lock_guard;
63 using std::recursive_mutex;
65 using std::shared_ptr;
67 using std::unordered_set;
71 using sigrok::Channel;
72 using sigrok::ChannelType;
73 using sigrok::ConfigKey;
74 using sigrok::DatafeedCallbackFunction;
80 using sigrok::PacketPayload;
81 using sigrok::Session;
82 using sigrok::SessionDevice;
84 using Glib::VariantBase;
88 Session::Session(DeviceManager &device_manager) :
89 device_manager_(device_manager),
90 capture_state_(Stopped),
97 // Stop and join to the thread
101 DeviceManager& Session::device_manager()
103 return device_manager_;
106 const DeviceManager& Session::device_manager() const
108 return device_manager_;
111 shared_ptr<sigrok::Session> Session::session() const
114 return shared_ptr<sigrok::Session>();
115 return device_->session();
118 shared_ptr<devices::Device> Session::device() const
123 void Session::set_device(shared_ptr<devices::Device> device)
127 // Ensure we are not capturing before setting the device
130 device_ = std::move(device);
132 device_->session()->add_datafeed_callback([=]
133 (shared_ptr<sigrok::Device> device, shared_ptr<Packet> packet) {
134 data_feed_in(device, packet);
138 decode_traces_.clear();
143 void Session::set_default_device()
145 const list< shared_ptr<devices::HardwareDevice> > &devices =
146 device_manager_.devices();
151 // Try and find the demo device and select that by default
152 const auto iter = std::find_if(devices.begin(), devices.end(),
153 [] (const shared_ptr<devices::HardwareDevice> &d) {
154 return d->hardware_device()->driver()->name() ==
156 set_device((iter == devices.end()) ? devices.front() : *iter);
159 Session::capture_state Session::get_capture_state() const
161 lock_guard<mutex> lock(sampling_mutex_);
162 return capture_state_;
165 void Session::start_capture(function<void (const QString)> error_handler)
169 // Check that at least one channel is enabled
171 const shared_ptr<sigrok::Device> sr_dev = device_->device();
173 const auto channels = sr_dev->channels();
174 if (!std::any_of(channels.begin(), channels.end(),
175 [](shared_ptr<Channel> channel) {
176 return channel->enabled(); })) {
177 error_handler(tr("No channels enabled."));
183 for (const shared_ptr<data::SignalData> d : get_data())
187 sampling_thread_ = std::thread(
188 &Session::sample_thread_proc, this, device_,
192 void Session::stop_capture()
194 if (get_capture_state() != Stopped)
197 // Check that sampling stopped
198 if (sampling_thread_.joinable())
199 sampling_thread_.join();
202 set< shared_ptr<data::SignalData> > Session::get_data() const
204 shared_lock<shared_mutex> lock(signals_mutex_);
205 set< shared_ptr<data::SignalData> > data;
206 for (const shared_ptr<view::Signal> sig : signals_) {
208 data.insert(sig->data());
214 boost::shared_mutex& Session::signals_mutex() const
216 return signals_mutex_;
219 const unordered_set< shared_ptr<view::Signal> >& Session::signals() const
225 bool Session::add_decoder(srd_decoder *const dec)
227 map<const srd_channel*, shared_ptr<view::LogicSignal> > channels;
228 shared_ptr<data::DecoderStack> decoder_stack;
232 lock_guard<boost::shared_mutex> lock(signals_mutex_);
234 // Create the decoder
235 decoder_stack = shared_ptr<data::DecoderStack>(
236 new data::DecoderStack(*this, dec));
238 // Make a list of all the channels
239 std::vector<const srd_channel*> all_channels;
240 for (const GSList *i = dec->channels; i; i = i->next)
241 all_channels.push_back((const srd_channel*)i->data);
242 for (const GSList *i = dec->opt_channels; i; i = i->next)
243 all_channels.push_back((const srd_channel*)i->data);
245 // Auto select the initial channels
246 for (const srd_channel *pdch : all_channels)
247 for (shared_ptr<view::Signal> s : signals_)
249 shared_ptr<view::LogicSignal> l =
250 dynamic_pointer_cast<view::LogicSignal>(s);
251 if (l && QString::fromUtf8(pdch->name).
253 l->name().toLower()))
257 assert(decoder_stack);
258 assert(!decoder_stack->stack().empty());
259 assert(decoder_stack->stack().front());
260 decoder_stack->stack().front()->set_channels(channels);
262 // Create the decode signal
263 shared_ptr<view::DecodeTrace> d(
264 new view::DecodeTrace(*this, decoder_stack,
265 decode_traces_.size()));
266 decode_traces_.push_back(d);
268 catch(std::runtime_error e)
275 // Do an initial decode
276 decoder_stack->begin_decode();
281 vector< shared_ptr<view::DecodeTrace> > Session::get_decode_signals() const
283 shared_lock<shared_mutex> lock(signals_mutex_);
284 return decode_traces_;
287 void Session::remove_decode_signal(view::DecodeTrace *signal)
289 for (auto i = decode_traces_.begin(); i != decode_traces_.end(); i++)
290 if ((*i).get() == signal)
292 decode_traces_.erase(i);
299 void Session::set_capture_state(capture_state state)
301 lock_guard<mutex> lock(sampling_mutex_);
302 const bool changed = capture_state_ != state;
303 capture_state_ = state;
305 capture_state_changed(state);
308 void Session::update_signals()
312 lock_guard<recursive_mutex> lock(data_mutex_);
314 const shared_ptr<sigrok::Device> sr_dev = device_->device();
321 // Detect what data types we will receive
322 auto channels = sr_dev->channels();
323 unsigned int logic_channel_count = std::count_if(
324 channels.begin(), channels.end(),
325 [] (shared_ptr<Channel> channel) {
326 return channel->type() == ChannelType::LOGIC; });
328 // Create data containers for the logic data segments
330 lock_guard<recursive_mutex> data_lock(data_mutex_);
332 if (logic_channel_count == 0) {
334 } else if (!logic_data_ ||
335 logic_data_->num_channels() != logic_channel_count) {
336 logic_data_.reset(new data::Logic(
337 logic_channel_count));
342 // Make the Signals list
344 unique_lock<shared_mutex> lock(signals_mutex_);
346 unordered_set< shared_ptr<view::Signal> > prev_sigs(signals_);
349 for (auto channel : sr_dev->channels()) {
350 shared_ptr<view::Signal> signal;
352 // Find the channel in the old signals
353 const auto iter = std::find_if(
354 prev_sigs.cbegin(), prev_sigs.cend(),
355 [&](const shared_ptr<view::Signal> &s) {
356 return s->channel() == channel;
358 if (iter != prev_sigs.end()) {
359 // Copy the signal from the old set to the new
361 auto logic_signal = dynamic_pointer_cast<
362 view::LogicSignal>(signal);
364 logic_signal->set_logic_data(
367 // Create a new signal
368 switch(channel->type()->id()) {
369 case SR_CHANNEL_LOGIC:
370 signal = shared_ptr<view::Signal>(
371 new view::LogicSignal(*this,
376 case SR_CHANNEL_ANALOG:
378 shared_ptr<data::Analog> data(
380 signal = shared_ptr<view::Signal>(
381 new view::AnalogSignal(
382 *this, channel, data));
393 signals_.insert(signal);
400 shared_ptr<view::Signal> Session::signal_from_channel(
401 shared_ptr<Channel> channel) const
403 lock_guard<boost::shared_mutex> lock(signals_mutex_);
404 for (shared_ptr<view::Signal> sig : signals_) {
406 if (sig->channel() == channel)
409 return shared_ptr<view::Signal>();
412 void Session::sample_thread_proc(shared_ptr<devices::Device> device,
413 function<void (const QString)> error_handler)
416 assert(error_handler);
420 cur_samplerate_ = device_->read_config<uint64_t>(ConfigKey::SAMPLERATE);
425 error_handler(e.what());
429 set_capture_state(device_->session()->trigger() ?
430 AwaitingTrigger : Running);
433 set_capture_state(Stopped);
435 // Confirm that SR_DF_END was received
436 if (cur_logic_segment_)
438 qDebug("SR_DF_END was not received.");
443 void Session::feed_in_header()
445 cur_samplerate_ = device_->read_config<uint64_t>(ConfigKey::SAMPLERATE);
448 void Session::feed_in_meta(shared_ptr<Meta> meta)
450 for (auto entry : meta->config()) {
451 switch (entry.first->id()) {
452 case SR_CONF_SAMPLERATE:
453 /// @todo handle samplerate changes
456 // Unknown metadata is not an error.
464 void Session::feed_in_frame_begin()
466 if (cur_logic_segment_ || !cur_analog_segments_.empty())
470 void Session::feed_in_logic(shared_ptr<Logic> logic)
472 lock_guard<recursive_mutex> lock(data_mutex_);
476 // The only reason logic_data_ would not have been created is
477 // if it was not possible to determine the signals when the
478 // device was created.
482 if (!cur_logic_segment_)
484 // This could be the first packet after a trigger
485 set_capture_state(Running);
488 const uint64_t sample_limit = device_->read_config<uint64_t>(
489 ConfigKey::LIMIT_SAMPLES);
491 // Create a new data segment
492 cur_logic_segment_ = shared_ptr<data::LogicSegment>(
493 new data::LogicSegment(
494 logic, cur_samplerate_, sample_limit));
495 logic_data_->push_segment(cur_logic_segment_);
497 // @todo Putting this here means that only listeners querying
498 // for logic will be notified. Currently the only user of
499 // frame_began is DecoderStack, but in future we need to signal
500 // this after both analog and logic sweeps have begun.
505 // Append to the existing data segment
506 cur_logic_segment_->append_payload(logic);
512 void Session::feed_in_analog(shared_ptr<Analog> analog)
514 lock_guard<recursive_mutex> lock(data_mutex_);
516 const vector<shared_ptr<Channel>> channels = analog->channels();
517 const unsigned int channel_count = channels.size();
518 const size_t sample_count = analog->num_samples() / channel_count;
519 const float *data = analog->data_pointer();
520 bool sweep_beginning = false;
522 for (auto channel : channels)
524 shared_ptr<data::AnalogSegment> segment;
526 // Try to get the segment of the channel
527 const map< shared_ptr<Channel>, shared_ptr<data::AnalogSegment> >::
528 iterator iter = cur_analog_segments_.find(channel);
529 if (iter != cur_analog_segments_.end())
530 segment = (*iter).second;
533 // If no segment was found, this means we havn't
534 // created one yet. i.e. this is the first packet
535 // in the sweep containing this segment.
536 sweep_beginning = true;
539 uint64_t sample_limit;
542 const std::shared_ptr<sigrok::Device> device =
545 sample_limit = VariantBase::cast_dynamic<Variant<guint64>>(
546 device->config_get(ConfigKey::LIMIT_SAMPLES)).get();
551 // Create a segment, keep it in the maps of channels
552 segment = shared_ptr<data::AnalogSegment>(
553 new data::AnalogSegment(
554 cur_samplerate_, sample_limit));
555 cur_analog_segments_[channel] = segment;
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 segment into the analog data.
567 data->push_segment(segment);
572 // Append the samples in the segment
573 segment->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 Session::data_feed_in(shared_ptr<sigrok::Device> device,
586 shared_ptr<Packet> packet)
591 assert(device == device_->device());
594 switch (packet->type()->id()) {
600 feed_in_meta(dynamic_pointer_cast<Meta>(packet->payload()));
603 case SR_DF_FRAME_BEGIN:
604 feed_in_frame_begin();
608 feed_in_logic(dynamic_pointer_cast<Logic>(packet->payload()));
612 feed_in_analog(dynamic_pointer_cast<Analog>(packet->payload()));
618 lock_guard<recursive_mutex> lock(data_mutex_);
619 cur_logic_segment_.reset();
620 cur_analog_segments_.clear();