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)
200 // Check that at least one channel is enabled
202 const shared_ptr<sigrok::Device> sr_dev = device_->device();
204 const auto channels = sr_dev->channels();
205 if (!std::any_of(channels.begin(), channels.end(),
206 [](shared_ptr<Channel> channel) {
207 return channel->enabled(); })) {
208 error_handler(tr("No channels enabled."));
215 shared_lock<shared_mutex> lock(signals_mutex_);
216 for (const shared_ptr<data::SignalData> d : all_signal_data_)
221 sampling_thread_ = std::thread(
222 &Session::sample_thread_proc, this, device_,
226 void Session::stop_capture()
228 if (get_capture_state() != Stopped)
231 // Check that sampling stopped
232 if (sampling_thread_.joinable())
233 sampling_thread_.join();
236 double Session::get_samplerate() const
238 double samplerate = 0.0;
241 shared_lock<shared_mutex> lock(signals_mutex_);
242 for (const shared_ptr<pv::data::SignalData> d : all_signal_data_) {
244 const vector< shared_ptr<pv::data::Segment> > segments =
246 for (const shared_ptr<pv::data::Segment> &s : segments)
247 samplerate = std::max(samplerate, s->samplerate());
250 // If there is no sample rate given we use samples as unit
251 if (samplerate == 0.0)
257 const unordered_set< shared_ptr<view::Signal> > Session::signals() const
259 shared_lock<shared_mutex> lock(signals_mutex_);
264 bool Session::add_decoder(srd_decoder *const dec)
266 map<const srd_channel*, shared_ptr<view::LogicSignal> > channels;
267 shared_ptr<data::DecoderStack> decoder_stack;
270 lock_guard<boost::shared_mutex> lock(signals_mutex_);
272 // Create the decoder
273 decoder_stack = shared_ptr<data::DecoderStack>(
274 new data::DecoderStack(*this, dec));
276 // Make a list of all the channels
277 std::vector<const srd_channel*> all_channels;
278 for (const GSList *i = dec->channels; i; i = i->next)
279 all_channels.push_back((const srd_channel*)i->data);
280 for (const GSList *i = dec->opt_channels; i; i = i->next)
281 all_channels.push_back((const srd_channel*)i->data);
283 // Auto select the initial channels
284 for (const srd_channel *pdch : all_channels)
285 for (shared_ptr<view::Signal> s : signals_) {
286 shared_ptr<view::LogicSignal> l =
287 dynamic_pointer_cast<view::LogicSignal>(s);
288 if (l && QString::fromUtf8(pdch->name).
290 l->name().toLower()))
294 assert(decoder_stack);
295 assert(!decoder_stack->stack().empty());
296 assert(decoder_stack->stack().front());
297 decoder_stack->stack().front()->set_channels(channels);
299 // Create the decode signal
300 shared_ptr<view::DecodeTrace> d(
301 new view::DecodeTrace(*this, decoder_stack,
302 decode_traces_.size()));
303 decode_traces_.push_back(d);
304 } catch (std::runtime_error e) {
310 // Do an initial decode
311 decoder_stack->begin_decode();
316 vector< shared_ptr<view::DecodeTrace> > Session::get_decode_signals() const
318 shared_lock<shared_mutex> lock(signals_mutex_);
319 return decode_traces_;
322 void Session::remove_decode_signal(view::DecodeTrace *signal)
324 for (auto i = decode_traces_.begin(); i != decode_traces_.end(); i++)
325 if ((*i).get() == signal) {
326 decode_traces_.erase(i);
333 void Session::set_capture_state(capture_state state)
338 lock_guard<mutex> lock(sampling_mutex_);
339 changed = capture_state_ != state;
340 capture_state_ = state;
344 capture_state_changed(state);
347 void Session::update_signals()
355 lock_guard<recursive_mutex> lock(data_mutex_);
357 const shared_ptr<sigrok::Device> sr_dev = device_->device();
364 // Detect what data types we will receive
365 auto channels = sr_dev->channels();
366 unsigned int logic_channel_count = std::count_if(
367 channels.begin(), channels.end(),
368 [] (shared_ptr<Channel> channel) {
369 return channel->type() == ChannelType::LOGIC; });
371 // Create data containers for the logic data segments
373 lock_guard<recursive_mutex> data_lock(data_mutex_);
375 if (logic_channel_count == 0) {
377 } else if (!logic_data_ ||
378 logic_data_->num_channels() != logic_channel_count) {
379 logic_data_.reset(new data::Logic(
380 logic_channel_count));
385 // Make the Signals list
387 unique_lock<shared_mutex> lock(signals_mutex_);
389 unordered_set< shared_ptr<view::Signal> > prev_sigs(signals_);
392 for (auto channel : sr_dev->channels()) {
393 shared_ptr<view::Signal> signal;
395 // Find the channel in the old signals
396 const auto iter = std::find_if(
397 prev_sigs.cbegin(), prev_sigs.cend(),
398 [&](const shared_ptr<view::Signal> &s) {
399 return s->channel() == channel;
401 if (iter != prev_sigs.end()) {
402 // Copy the signal from the old set to the new
404 auto logic_signal = dynamic_pointer_cast<
405 view::LogicSignal>(signal);
407 logic_signal->set_logic_data(
410 // Create a new signal
411 switch(channel->type()->id()) {
412 case SR_CHANNEL_LOGIC:
413 signal = shared_ptr<view::Signal>(
414 new view::LogicSignal(*this,
417 all_signal_data_.insert(logic_data_);
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));
427 all_signal_data_.insert(data);
438 signals_.insert(signal);
445 shared_ptr<view::Signal> Session::signal_from_channel(
446 shared_ptr<Channel> channel) const
448 lock_guard<boost::shared_mutex> lock(signals_mutex_);
449 for (shared_ptr<view::Signal> sig : signals_) {
451 if (sig->channel() == channel)
454 return shared_ptr<view::Signal>();
457 void Session::sample_thread_proc(shared_ptr<devices::Device> device,
458 function<void (const QString)> error_handler)
461 assert(error_handler);
465 cur_samplerate_ = device_->read_config<uint64_t>(ConfigKey::SAMPLERATE);
467 out_of_memory_ = false;
472 error_handler(e.what());
476 set_capture_state(device_->session()->trigger() ?
477 AwaitingTrigger : Running);
480 set_capture_state(Stopped);
482 // Confirm that SR_DF_END was received
483 if (cur_logic_segment_) {
484 qDebug("SR_DF_END was not received.");
489 error_handler(tr("Out of memory, acquisition stopped."));
492 void Session::feed_in_header()
494 cur_samplerate_ = device_->read_config<uint64_t>(ConfigKey::SAMPLERATE);
497 void Session::feed_in_meta(shared_ptr<Meta> meta)
499 for (auto entry : meta->config()) {
500 switch (entry.first->id()) {
501 case SR_CONF_SAMPLERATE:
502 // We can't rely on the header to always contain the sample rate,
503 // so in case it's supplied via a meta packet, we use it.
504 if (!cur_samplerate_)
505 cur_samplerate_ = g_variant_get_uint64(entry.second.gobj());
507 /// @todo handle samplerate changes
510 // Unknown metadata is not an error.
518 void Session::feed_in_trigger()
520 // The channel containing most samples should be most accurate
521 uint64_t sample_count = 0;
524 shared_lock<shared_mutex> lock(signals_mutex_);
525 for (const shared_ptr<pv::data::SignalData> d : all_signal_data_) {
527 uint64_t temp_count = 0;
529 const vector< shared_ptr<pv::data::Segment> > segments =
531 for (const shared_ptr<pv::data::Segment> &s : segments)
532 temp_count += s->get_sample_count();
534 if (temp_count > sample_count)
535 sample_count = temp_count;
539 trigger_event(sample_count / get_samplerate());
542 void Session::feed_in_frame_begin()
544 if (cur_logic_segment_ || !cur_analog_segments_.empty())
548 void Session::feed_in_logic(shared_ptr<Logic> logic)
550 lock_guard<recursive_mutex> lock(data_mutex_);
552 const size_t sample_count = logic->data_length() / logic->unit_size();
555 // The only reason logic_data_ would not have been created is
556 // if it was not possible to determine the signals when the
557 // device was created.
561 if (!cur_logic_segment_) {
562 // This could be the first packet after a trigger
563 set_capture_state(Running);
565 // Create a new data segment
566 cur_logic_segment_ = shared_ptr<data::LogicSegment>(
567 new data::LogicSegment(
568 logic, cur_samplerate_, sample_count));
569 logic_data_->push_segment(cur_logic_segment_);
571 // @todo Putting this here means that only listeners querying
572 // for logic will be notified. Currently the only user of
573 // frame_began is DecoderStack, but in future we need to signal
574 // this after both analog and logic sweeps have begun.
577 // Append to the existing data segment
578 cur_logic_segment_->append_payload(logic);
584 void Session::feed_in_analog(shared_ptr<Analog> analog)
586 lock_guard<recursive_mutex> lock(data_mutex_);
588 const vector<shared_ptr<Channel>> channels = analog->channels();
589 const unsigned int channel_count = channels.size();
590 const size_t sample_count = analog->num_samples() / channel_count;
591 const float *data = static_cast<const float *>(analog->data_pointer());
592 bool sweep_beginning = false;
594 if (signals_.empty())
597 for (auto channel : channels) {
598 shared_ptr<data::AnalogSegment> segment;
600 // Try to get the segment of the channel
601 const map< shared_ptr<Channel>, shared_ptr<data::AnalogSegment> >::
602 iterator iter = cur_analog_segments_.find(channel);
603 if (iter != cur_analog_segments_.end())
604 segment = (*iter).second;
606 // If no segment was found, this means we haven't
607 // created one yet. i.e. this is the first packet
608 // in the sweep containing this segment.
609 sweep_beginning = true;
611 // Create a segment, keep it in the maps of channels
612 segment = shared_ptr<data::AnalogSegment>(
613 new data::AnalogSegment(
614 cur_samplerate_, sample_count));
615 cur_analog_segments_[channel] = segment;
617 // Find the analog data associated with the channel
618 shared_ptr<view::AnalogSignal> sig =
619 dynamic_pointer_cast<view::AnalogSignal>(
620 signal_from_channel(channel));
623 shared_ptr<data::Analog> data(sig->analog_data());
626 // Push the segment into the analog data.
627 data->push_segment(segment);
632 // Append the samples in the segment
633 segment->append_interleaved_samples(data++, sample_count,
637 if (sweep_beginning) {
638 // This could be the first packet after a trigger
639 set_capture_state(Running);
645 void Session::data_feed_in(shared_ptr<sigrok::Device> device,
646 shared_ptr<Packet> packet)
651 assert(device == device_->device());
654 switch (packet->type()->id()) {
660 feed_in_meta(dynamic_pointer_cast<Meta>(packet->payload()));
667 case SR_DF_FRAME_BEGIN:
668 feed_in_frame_begin();
673 feed_in_logic(dynamic_pointer_cast<Logic>(packet->payload()));
674 } catch (std::bad_alloc) {
675 out_of_memory_ = true;
682 feed_in_analog(dynamic_pointer_cast<Analog>(packet->payload()));
683 } catch (std::bad_alloc) {
684 out_of_memory_ = true;
692 lock_guard<recursive_mutex> lock(data_mutex_);
693 cur_logic_segment_.reset();
694 cur_analog_segments_.clear();