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 // Windows: Avoid boost/thread namespace pollution (which includes windows.h).
26 #include <boost/thread/locks.hpp>
27 #include <boost/thread/shared_mutex.hpp>
30 #include <libsigrokdecode/libsigrokdecode.h>
33 #include "session.hpp"
35 #include "devicemanager.hpp"
37 #include "data/analog.hpp"
38 #include "data/analogsegment.hpp"
39 #include "data/decoderstack.hpp"
40 #include "data/logic.hpp"
41 #include "data/logicsegment.hpp"
42 #include "data/decode/decoder.hpp"
44 #include "devices/hardwaredevice.hpp"
45 #include "devices/sessionfile.hpp"
47 #include "view/analogsignal.hpp"
48 #include "view/decodetrace.hpp"
49 #include "view/logicsignal.hpp"
59 #include <libsigrokcxx/libsigrokcxx.hpp>
61 using boost::shared_lock;
62 using boost::shared_mutex;
63 using boost::unique_lock;
65 using std::dynamic_pointer_cast;
67 using std::lock_guard;
71 using std::recursive_mutex;
73 using std::shared_ptr;
75 using std::unordered_set;
79 using sigrok::Channel;
80 using sigrok::ChannelType;
81 using sigrok::ConfigKey;
82 using sigrok::DatafeedCallbackFunction;
88 using sigrok::PacketPayload;
89 using sigrok::Session;
90 using sigrok::SessionDevice;
92 using Glib::VariantBase;
96 Session::Session(DeviceManager &device_manager) :
97 device_manager_(device_manager),
98 capture_state_(Stopped),
105 // Stop and join to the thread
109 DeviceManager& Session::device_manager()
111 return device_manager_;
114 const DeviceManager& Session::device_manager() const
116 return device_manager_;
119 shared_ptr<sigrok::Session> Session::session() const
122 return shared_ptr<sigrok::Session>();
123 return device_->session();
126 shared_ptr<devices::Device> Session::device() const
131 void Session::set_device(shared_ptr<devices::Device> device)
135 // Ensure we are not capturing before setting the device
143 // Remove all stored data
146 shared_lock<shared_mutex> lock(signals_mutex_);
147 for (const shared_ptr<data::SignalData> d : all_signal_data_)
150 all_signal_data_.clear();
151 cur_logic_segment_.reset();
153 for (auto entry : cur_analog_segments_) {
154 shared_ptr<sigrok::Channel>(entry.first).reset();
155 shared_ptr<data::AnalogSegment>(entry.second).reset();
159 decode_traces_.clear();
163 device_ = std::move(device);
165 device_->session()->add_datafeed_callback([=]
166 (shared_ptr<sigrok::Device> device, shared_ptr<Packet> packet) {
167 data_feed_in(device, packet);
174 void Session::set_default_device()
176 const list< shared_ptr<devices::HardwareDevice> > &devices =
177 device_manager_.devices();
182 // Try and find the demo device and select that by default
183 const auto iter = std::find_if(devices.begin(), devices.end(),
184 [] (const shared_ptr<devices::HardwareDevice> &d) {
185 return d->hardware_device()->driver()->name() ==
187 set_device((iter == devices.end()) ? devices.front() : *iter);
190 Session::capture_state Session::get_capture_state() const
192 lock_guard<mutex> lock(sampling_mutex_);
193 return capture_state_;
196 void Session::start_capture(function<void (const QString)> error_handler)
199 error_handler(tr("No active device set, can't start acquisition."));
205 // Check that at least one channel is enabled
206 const shared_ptr<sigrok::Device> sr_dev = device_->device();
208 const auto channels = sr_dev->channels();
209 if (!std::any_of(channels.begin(), channels.end(),
210 [](shared_ptr<Channel> channel) {
211 return channel->enabled(); })) {
212 error_handler(tr("No channels enabled."));
219 shared_lock<shared_mutex> lock(signals_mutex_);
220 for (const shared_ptr<data::SignalData> d : all_signal_data_)
225 sampling_thread_ = std::thread(
226 &Session::sample_thread_proc, this, error_handler);
229 void Session::stop_capture()
231 if (get_capture_state() != Stopped)
234 // Check that sampling stopped
235 if (sampling_thread_.joinable())
236 sampling_thread_.join();
239 double Session::get_samplerate() const
241 double samplerate = 0.0;
244 shared_lock<shared_mutex> lock(signals_mutex_);
245 for (const shared_ptr<pv::data::SignalData> d : all_signal_data_) {
247 const vector< shared_ptr<pv::data::Segment> > segments =
249 for (const shared_ptr<pv::data::Segment> &s : segments)
250 samplerate = std::max(samplerate, s->samplerate());
253 // If there is no sample rate given we use samples as unit
254 if (samplerate == 0.0)
260 const unordered_set< shared_ptr<view::Signal> > Session::signals() const
262 shared_lock<shared_mutex> lock(signals_mutex_);
267 bool Session::add_decoder(srd_decoder *const dec)
269 map<const srd_channel*, shared_ptr<view::LogicSignal> > channels;
270 shared_ptr<data::DecoderStack> decoder_stack;
273 lock_guard<boost::shared_mutex> lock(signals_mutex_);
275 // Create the decoder
276 decoder_stack = shared_ptr<data::DecoderStack>(
277 new data::DecoderStack(*this, dec));
279 // Make a list of all the channels
280 std::vector<const srd_channel*> all_channels;
281 for (const GSList *i = dec->channels; i; i = i->next)
282 all_channels.push_back((const srd_channel*)i->data);
283 for (const GSList *i = dec->opt_channels; i; i = i->next)
284 all_channels.push_back((const srd_channel*)i->data);
286 // Auto select the initial channels
287 for (const srd_channel *pdch : all_channels)
288 for (shared_ptr<view::Signal> s : signals_) {
289 shared_ptr<view::LogicSignal> l =
290 dynamic_pointer_cast<view::LogicSignal>(s);
291 if (l && QString::fromUtf8(pdch->name).
293 l->name().toLower()))
297 assert(decoder_stack);
298 assert(!decoder_stack->stack().empty());
299 assert(decoder_stack->stack().front());
300 decoder_stack->stack().front()->set_channels(channels);
302 // Create the decode signal
303 shared_ptr<view::DecodeTrace> d(
304 new view::DecodeTrace(*this, decoder_stack,
305 decode_traces_.size()));
306 decode_traces_.push_back(d);
307 } catch (std::runtime_error e) {
313 // Do an initial decode
314 decoder_stack->begin_decode();
319 vector< shared_ptr<view::DecodeTrace> > Session::get_decode_signals() const
321 shared_lock<shared_mutex> lock(signals_mutex_);
322 return decode_traces_;
325 void Session::remove_decode_signal(view::DecodeTrace *signal)
327 for (auto i = decode_traces_.begin(); i != decode_traces_.end(); i++)
328 if ((*i).get() == signal) {
329 decode_traces_.erase(i);
336 void Session::set_capture_state(capture_state state)
341 lock_guard<mutex> lock(sampling_mutex_);
342 changed = capture_state_ != state;
343 capture_state_ = state;
347 capture_state_changed(state);
350 void Session::update_signals()
358 lock_guard<recursive_mutex> lock(data_mutex_);
360 const shared_ptr<sigrok::Device> sr_dev = device_->device();
367 // Detect what data types we will receive
368 auto channels = sr_dev->channels();
369 unsigned int logic_channel_count = std::count_if(
370 channels.begin(), channels.end(),
371 [] (shared_ptr<Channel> channel) {
372 return channel->type() == ChannelType::LOGIC; });
374 // Create data containers for the logic data segments
376 lock_guard<recursive_mutex> data_lock(data_mutex_);
378 if (logic_channel_count == 0) {
380 } else if (!logic_data_ ||
381 logic_data_->num_channels() != logic_channel_count) {
382 logic_data_.reset(new data::Logic(
383 logic_channel_count));
388 // Make the Signals list
390 unique_lock<shared_mutex> lock(signals_mutex_);
392 unordered_set< shared_ptr<view::Signal> > prev_sigs(signals_);
395 for (auto channel : sr_dev->channels()) {
396 shared_ptr<view::Signal> signal;
398 // Find the channel in the old signals
399 const auto iter = std::find_if(
400 prev_sigs.cbegin(), prev_sigs.cend(),
401 [&](const shared_ptr<view::Signal> &s) {
402 return s->channel() == channel;
404 if (iter != prev_sigs.end()) {
405 // Copy the signal from the old set to the new
407 auto logic_signal = dynamic_pointer_cast<
408 view::LogicSignal>(signal);
410 logic_signal->set_logic_data(
413 // Create a new signal
414 switch(channel->type()->id()) {
415 case SR_CHANNEL_LOGIC:
416 signal = shared_ptr<view::Signal>(
417 new view::LogicSignal(*this,
420 all_signal_data_.insert(logic_data_);
423 case SR_CHANNEL_ANALOG:
425 shared_ptr<data::Analog> data(
427 signal = shared_ptr<view::Signal>(
428 new view::AnalogSignal(
429 *this, channel, data));
430 all_signal_data_.insert(data);
441 signals_.insert(signal);
448 shared_ptr<view::Signal> Session::signal_from_channel(
449 shared_ptr<Channel> channel) const
451 lock_guard<boost::shared_mutex> lock(signals_mutex_);
452 for (shared_ptr<view::Signal> sig : signals_) {
454 if (sig->channel() == channel)
457 return shared_ptr<view::Signal>();
460 void Session::sample_thread_proc(function<void (const QString)> error_handler)
462 assert(error_handler);
467 cur_samplerate_ = device_->read_config<uint64_t>(ConfigKey::SAMPLERATE);
469 out_of_memory_ = false;
474 error_handler(e.what());
478 set_capture_state(device_->session()->trigger() ?
479 AwaitingTrigger : Running);
482 set_capture_state(Stopped);
484 // Confirm that SR_DF_END was received
485 if (cur_logic_segment_) {
486 qDebug("SR_DF_END was not received.");
491 error_handler(tr("Out of memory, acquisition stopped."));
494 void Session::feed_in_header()
496 cur_samplerate_ = device_->read_config<uint64_t>(ConfigKey::SAMPLERATE);
499 void Session::feed_in_meta(shared_ptr<Meta> meta)
501 for (auto entry : meta->config()) {
502 switch (entry.first->id()) {
503 case SR_CONF_SAMPLERATE:
504 // We can't rely on the header to always contain the sample rate,
505 // so in case it's supplied via a meta packet, we use it.
506 if (!cur_samplerate_)
507 cur_samplerate_ = g_variant_get_uint64(entry.second.gobj());
509 /// @todo handle samplerate changes
512 // Unknown metadata is not an error.
520 void Session::feed_in_trigger()
522 // The channel containing most samples should be most accurate
523 uint64_t sample_count = 0;
526 shared_lock<shared_mutex> lock(signals_mutex_);
527 for (const shared_ptr<pv::data::SignalData> d : all_signal_data_) {
529 uint64_t temp_count = 0;
531 const vector< shared_ptr<pv::data::Segment> > segments =
533 for (const shared_ptr<pv::data::Segment> &s : segments)
534 temp_count += s->get_sample_count();
536 if (temp_count > sample_count)
537 sample_count = temp_count;
541 trigger_event(sample_count / get_samplerate());
544 void Session::feed_in_frame_begin()
546 if (cur_logic_segment_ || !cur_analog_segments_.empty())
550 void Session::feed_in_logic(shared_ptr<Logic> logic)
552 lock_guard<recursive_mutex> lock(data_mutex_);
554 const size_t sample_count = logic->data_length() / logic->unit_size();
557 // The only reason logic_data_ would not have been created is
558 // if it was not possible to determine the signals when the
559 // device was created.
563 if (!cur_logic_segment_) {
564 // This could be the first packet after a trigger
565 set_capture_state(Running);
567 // Create a new data segment
568 cur_logic_segment_ = shared_ptr<data::LogicSegment>(
569 new data::LogicSegment(
570 logic, cur_samplerate_, sample_count));
571 logic_data_->push_segment(cur_logic_segment_);
573 // @todo Putting this here means that only listeners querying
574 // for logic will be notified. Currently the only user of
575 // frame_began is DecoderStack, but in future we need to signal
576 // this after both analog and logic sweeps have begun.
579 // Append to the existing data segment
580 cur_logic_segment_->append_payload(logic);
586 void Session::feed_in_analog(shared_ptr<Analog> analog)
588 lock_guard<recursive_mutex> lock(data_mutex_);
590 const vector<shared_ptr<Channel>> channels = analog->channels();
591 const unsigned int channel_count = channels.size();
592 const size_t sample_count = analog->num_samples() / channel_count;
593 const float *data = static_cast<const float *>(analog->data_pointer());
594 bool sweep_beginning = false;
596 if (signals_.empty())
599 for (auto channel : channels) {
600 shared_ptr<data::AnalogSegment> segment;
602 // Try to get the segment of the channel
603 const map< shared_ptr<Channel>, shared_ptr<data::AnalogSegment> >::
604 iterator iter = cur_analog_segments_.find(channel);
605 if (iter != cur_analog_segments_.end())
606 segment = (*iter).second;
608 // If no segment was found, this means we haven't
609 // created one yet. i.e. this is the first packet
610 // in the sweep containing this segment.
611 sweep_beginning = true;
613 // Create a segment, keep it in the maps of channels
614 segment = shared_ptr<data::AnalogSegment>(
615 new data::AnalogSegment(
616 cur_samplerate_, sample_count));
617 cur_analog_segments_[channel] = segment;
619 // Find the analog data associated with the channel
620 shared_ptr<view::AnalogSignal> sig =
621 dynamic_pointer_cast<view::AnalogSignal>(
622 signal_from_channel(channel));
625 shared_ptr<data::Analog> data(sig->analog_data());
628 // Push the segment into the analog data.
629 data->push_segment(segment);
634 // Append the samples in the segment
635 segment->append_interleaved_samples(data++, sample_count,
639 if (sweep_beginning) {
640 // This could be the first packet after a trigger
641 set_capture_state(Running);
647 void Session::data_feed_in(shared_ptr<sigrok::Device> device,
648 shared_ptr<Packet> packet)
653 assert(device == device_->device());
656 switch (packet->type()->id()) {
662 feed_in_meta(dynamic_pointer_cast<Meta>(packet->payload()));
669 case SR_DF_FRAME_BEGIN:
670 feed_in_frame_begin();
675 feed_in_logic(dynamic_pointer_cast<Logic>(packet->payload()));
676 } catch (std::bad_alloc) {
677 out_of_memory_ = true;
684 feed_in_analog(dynamic_pointer_cast<Analog>(packet->payload()));
685 } catch (std::bad_alloc) {
686 out_of_memory_ = true;
694 lock_guard<recursive_mutex> lock(data_mutex_);
695 cur_logic_segment_.reset();
696 cur_analog_segments_.clear();