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
145 cur_logic_segment_.reset();
147 for (auto entry : cur_analog_segments_) {
148 shared_ptr<sigrok::Channel>(entry.first).reset();
149 shared_ptr<data::AnalogSegment>(entry.second).reset();
153 decode_traces_.clear();
157 device_ = std::move(device);
159 device_->session()->add_datafeed_callback([=]
160 (shared_ptr<sigrok::Device> device, shared_ptr<Packet> packet) {
161 data_feed_in(device, packet);
168 void Session::set_default_device()
170 const list< shared_ptr<devices::HardwareDevice> > &devices =
171 device_manager_.devices();
176 // Try and find the demo device and select that by default
177 const auto iter = std::find_if(devices.begin(), devices.end(),
178 [] (const shared_ptr<devices::HardwareDevice> &d) {
179 return d->hardware_device()->driver()->name() ==
181 set_device((iter == devices.end()) ? devices.front() : *iter);
184 Session::capture_state Session::get_capture_state() const
186 lock_guard<mutex> lock(sampling_mutex_);
187 return capture_state_;
190 void Session::start_capture(function<void (const QString)> error_handler)
194 // Check that at least one channel is enabled
196 const shared_ptr<sigrok::Device> sr_dev = device_->device();
198 const auto channels = sr_dev->channels();
199 if (!std::any_of(channels.begin(), channels.end(),
200 [](shared_ptr<Channel> channel) {
201 return channel->enabled(); })) {
202 error_handler(tr("No channels enabled."));
208 for (const shared_ptr<data::SignalData> d : get_data())
212 sampling_thread_ = std::thread(
213 &Session::sample_thread_proc, this, device_,
217 void Session::stop_capture()
219 if (get_capture_state() != Stopped)
222 // Check that sampling stopped
223 if (sampling_thread_.joinable())
224 sampling_thread_.join();
227 set< shared_ptr<data::SignalData> > Session::get_data() const
229 shared_lock<shared_mutex> lock(signals_mutex_);
230 set< shared_ptr<data::SignalData> > data;
231 for (const shared_ptr<view::Signal> sig : signals_) {
233 data.insert(sig->data());
239 double Session::get_samplerate() const
241 double samplerate = 0.0;
243 for (const shared_ptr<pv::data::SignalData> d : get_data()) {
245 const vector< shared_ptr<pv::data::Segment> > segments =
247 for (const shared_ptr<pv::data::Segment> &s : segments)
248 samplerate = std::max(samplerate, s->samplerate());
251 // If there is no sample rate given we use samples as unit
252 if (samplerate == 0.0)
258 const unordered_set< shared_ptr<view::Signal> > Session::signals() const
260 shared_lock<shared_mutex> lock(signals_mutex_);
265 bool Session::add_decoder(srd_decoder *const dec)
267 map<const srd_channel*, shared_ptr<view::LogicSignal> > channels;
268 shared_ptr<data::DecoderStack> decoder_stack;
271 lock_guard<boost::shared_mutex> lock(signals_mutex_);
273 // Create the decoder
274 decoder_stack = shared_ptr<data::DecoderStack>(
275 new data::DecoderStack(*this, dec));
277 // Make a list of all the channels
278 std::vector<const srd_channel*> all_channels;
279 for (const GSList *i = dec->channels; i; i = i->next)
280 all_channels.push_back((const srd_channel*)i->data);
281 for (const GSList *i = dec->opt_channels; i; i = i->next)
282 all_channels.push_back((const srd_channel*)i->data);
284 // Auto select the initial channels
285 for (const srd_channel *pdch : all_channels)
286 for (shared_ptr<view::Signal> s : signals_) {
287 shared_ptr<view::LogicSignal> l =
288 dynamic_pointer_cast<view::LogicSignal>(s);
289 if (l && QString::fromUtf8(pdch->name).
291 l->name().toLower()))
295 assert(decoder_stack);
296 assert(!decoder_stack->stack().empty());
297 assert(decoder_stack->stack().front());
298 decoder_stack->stack().front()->set_channels(channels);
300 // Create the decode signal
301 shared_ptr<view::DecodeTrace> d(
302 new view::DecodeTrace(*this, decoder_stack,
303 decode_traces_.size()));
304 decode_traces_.push_back(d);
305 } catch (std::runtime_error e) {
311 // Do an initial decode
312 decoder_stack->begin_decode();
317 vector< shared_ptr<view::DecodeTrace> > Session::get_decode_signals() const
319 shared_lock<shared_mutex> lock(signals_mutex_);
320 return decode_traces_;
323 void Session::remove_decode_signal(view::DecodeTrace *signal)
325 for (auto i = decode_traces_.begin(); i != decode_traces_.end(); i++)
326 if ((*i).get() == signal) {
327 decode_traces_.erase(i);
334 void Session::set_capture_state(capture_state state)
339 lock_guard<mutex> lock(sampling_mutex_);
340 changed = capture_state_ != state;
341 capture_state_ = state;
345 capture_state_changed(state);
348 void Session::update_signals()
356 lock_guard<recursive_mutex> lock(data_mutex_);
358 const shared_ptr<sigrok::Device> sr_dev = device_->device();
365 // Detect what data types we will receive
366 auto channels = sr_dev->channels();
367 unsigned int logic_channel_count = std::count_if(
368 channels.begin(), channels.end(),
369 [] (shared_ptr<Channel> channel) {
370 return channel->type() == ChannelType::LOGIC; });
372 // Create data containers for the logic data segments
374 lock_guard<recursive_mutex> data_lock(data_mutex_);
376 if (logic_channel_count == 0) {
378 } else if (!logic_data_ ||
379 logic_data_->num_channels() != logic_channel_count) {
380 logic_data_.reset(new data::Logic(
381 logic_channel_count));
386 // Make the Signals list
388 unique_lock<shared_mutex> lock(signals_mutex_);
390 unordered_set< shared_ptr<view::Signal> > prev_sigs(signals_);
393 for (auto channel : sr_dev->channels()) {
394 shared_ptr<view::Signal> signal;
396 // Find the channel in the old signals
397 const auto iter = std::find_if(
398 prev_sigs.cbegin(), prev_sigs.cend(),
399 [&](const shared_ptr<view::Signal> &s) {
400 return s->channel() == channel;
402 if (iter != prev_sigs.end()) {
403 // Copy the signal from the old set to the new
405 auto logic_signal = dynamic_pointer_cast<
406 view::LogicSignal>(signal);
408 logic_signal->set_logic_data(
411 // Create a new signal
412 switch(channel->type()->id()) {
413 case SR_CHANNEL_LOGIC:
414 signal = shared_ptr<view::Signal>(
415 new view::LogicSignal(*this,
420 case SR_CHANNEL_ANALOG:
422 shared_ptr<data::Analog> data(
424 signal = shared_ptr<view::Signal>(
425 new view::AnalogSignal(
426 *this, channel, data));
437 signals_.insert(signal);
444 shared_ptr<view::Signal> Session::signal_from_channel(
445 shared_ptr<Channel> channel) const
447 lock_guard<boost::shared_mutex> lock(signals_mutex_);
448 for (shared_ptr<view::Signal> sig : signals_) {
450 if (sig->channel() == channel)
453 return shared_ptr<view::Signal>();
456 void Session::sample_thread_proc(shared_ptr<devices::Device> device,
457 function<void (const QString)> error_handler)
460 assert(error_handler);
464 cur_samplerate_ = device_->read_config<uint64_t>(ConfigKey::SAMPLERATE);
466 out_of_memory_ = false;
471 error_handler(e.what());
475 set_capture_state(device_->session()->trigger() ?
476 AwaitingTrigger : Running);
479 set_capture_state(Stopped);
481 // Confirm that SR_DF_END was received
482 if (cur_logic_segment_) {
483 qDebug("SR_DF_END was not received.");
488 error_handler(tr("Out of memory, acquisition stopped."));
491 void Session::feed_in_header()
493 cur_samplerate_ = device_->read_config<uint64_t>(ConfigKey::SAMPLERATE);
496 void Session::feed_in_meta(shared_ptr<Meta> meta)
498 for (auto entry : meta->config()) {
499 switch (entry.first->id()) {
500 case SR_CONF_SAMPLERATE:
501 // We can't rely on the header to always contain the sample rate,
502 // so in case it's supplied via a meta packet, we use it.
503 if (!cur_samplerate_)
504 cur_samplerate_ = g_variant_get_uint64(entry.second.gobj());
506 /// @todo handle samplerate changes
509 // Unknown metadata is not an error.
517 void Session::feed_in_trigger()
519 // The channel containing most samples should be most accurate
520 uint64_t sample_count = 0;
522 for (const shared_ptr<pv::data::SignalData> d : get_data()) {
524 uint64_t temp_count = 0;
526 const vector< shared_ptr<pv::data::Segment> > segments =
528 for (const shared_ptr<pv::data::Segment> &s : segments)
529 temp_count += s->get_sample_count();
531 if (temp_count > sample_count)
532 sample_count = temp_count;
535 trigger_event(sample_count / get_samplerate());
538 void Session::feed_in_frame_begin()
540 if (cur_logic_segment_ || !cur_analog_segments_.empty())
544 void Session::feed_in_logic(shared_ptr<Logic> logic)
546 lock_guard<recursive_mutex> lock(data_mutex_);
548 const size_t sample_count = logic->data_length() / logic->unit_size();
551 // The only reason logic_data_ would not have been created is
552 // if it was not possible to determine the signals when the
553 // device was created.
557 if (!cur_logic_segment_) {
558 // This could be the first packet after a trigger
559 set_capture_state(Running);
561 // Create a new data segment
562 cur_logic_segment_ = shared_ptr<data::LogicSegment>(
563 new data::LogicSegment(
564 logic, cur_samplerate_, sample_count));
565 logic_data_->push_segment(cur_logic_segment_);
567 // @todo Putting this here means that only listeners querying
568 // for logic will be notified. Currently the only user of
569 // frame_began is DecoderStack, but in future we need to signal
570 // this after both analog and logic sweeps have begun.
573 // Append to the existing data segment
574 cur_logic_segment_->append_payload(logic);
580 void Session::feed_in_analog(shared_ptr<Analog> analog)
582 lock_guard<recursive_mutex> lock(data_mutex_);
584 const vector<shared_ptr<Channel>> channels = analog->channels();
585 const unsigned int channel_count = channels.size();
586 const size_t sample_count = analog->num_samples() / channel_count;
587 const float *data = static_cast<const float *>(analog->data_pointer());
588 bool sweep_beginning = false;
590 if (signals_.empty())
593 for (auto channel : channels) {
594 shared_ptr<data::AnalogSegment> segment;
596 // Try to get the segment of the channel
597 const map< shared_ptr<Channel>, shared_ptr<data::AnalogSegment> >::
598 iterator iter = cur_analog_segments_.find(channel);
599 if (iter != cur_analog_segments_.end())
600 segment = (*iter).second;
602 // If no segment was found, this means we haven't
603 // created one yet. i.e. this is the first packet
604 // in the sweep containing this segment.
605 sweep_beginning = true;
607 // Create a segment, keep it in the maps of channels
608 segment = shared_ptr<data::AnalogSegment>(
609 new data::AnalogSegment(
610 cur_samplerate_, sample_count));
611 cur_analog_segments_[channel] = segment;
613 // Find the analog data associated with the channel
614 shared_ptr<view::AnalogSignal> sig =
615 dynamic_pointer_cast<view::AnalogSignal>(
616 signal_from_channel(channel));
619 shared_ptr<data::Analog> data(sig->analog_data());
622 // Push the segment into the analog data.
623 data->push_segment(segment);
628 // Append the samples in the segment
629 segment->append_interleaved_samples(data++, sample_count,
633 if (sweep_beginning) {
634 // This could be the first packet after a trigger
635 set_capture_state(Running);
641 void Session::data_feed_in(shared_ptr<sigrok::Device> device,
642 shared_ptr<Packet> packet)
647 assert(device == device_->device());
650 switch (packet->type()->id()) {
656 feed_in_meta(dynamic_pointer_cast<Meta>(packet->payload()));
663 case SR_DF_FRAME_BEGIN:
664 feed_in_frame_begin();
669 feed_in_logic(dynamic_pointer_cast<Logic>(packet->payload()));
670 } catch (std::bad_alloc) {
671 out_of_memory_ = true;
678 feed_in_analog(dynamic_pointer_cast<Analog>(packet->payload()));
679 } catch (std::bad_alloc) {
680 out_of_memory_ = true;
688 lock_guard<recursive_mutex> lock(data_mutex_);
689 cur_logic_segment_.reset();
690 cur_analog_segments_.clear();