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/signalbase.hpp"
43 #include "data/decode/decoder.hpp"
45 #include "devices/hardwaredevice.hpp"
46 #include "devices/sessionfile.hpp"
48 #include "view/analogsignal.hpp"
49 #include "view/decodetrace.hpp"
50 #include "view/logicsignal.hpp"
51 #include "view/signal.hpp"
52 #include "view/view.hpp"
62 #include <libsigrokcxx/libsigrokcxx.hpp>
64 using boost::shared_lock;
65 using boost::shared_mutex;
66 using boost::unique_lock;
68 using std::dynamic_pointer_cast;
70 using std::lock_guard;
74 using std::recursive_mutex;
76 using std::shared_ptr;
78 using std::unordered_set;
82 using sigrok::Channel;
83 using sigrok::ChannelType;
84 using sigrok::ConfigKey;
85 using sigrok::DatafeedCallbackFunction;
91 using sigrok::PacketPayload;
92 using sigrok::Session;
93 using sigrok::SessionDevice;
95 using Glib::VariantBase;
99 Session::Session(DeviceManager &device_manager) :
100 device_manager_(device_manager),
101 capture_state_(Stopped),
108 // Stop and join to the thread
112 DeviceManager& Session::device_manager()
114 return device_manager_;
117 const DeviceManager& Session::device_manager() const
119 return device_manager_;
122 shared_ptr<sigrok::Session> Session::session() const
125 return shared_ptr<sigrok::Session>();
126 return device_->session();
129 shared_ptr<devices::Device> Session::device() const
134 void Session::set_device(shared_ptr<devices::Device> device)
138 // Ensure we are not capturing before setting the device
146 // Remove all stored data
147 for (std::shared_ptr<pv::view::View> view : views_) {
148 view->clear_signals();
150 view->clear_decode_traces();
153 for (const shared_ptr<data::SignalData> d : all_signal_data_)
155 all_signal_data_.clear();
156 signalbases_.clear();
157 cur_logic_segment_.reset();
159 for (auto entry : cur_analog_segments_) {
160 shared_ptr<sigrok::Channel>(entry.first).reset();
161 shared_ptr<data::AnalogSegment>(entry.second).reset();
168 device_ = std::move(device);
172 } catch (const QString &e) {
178 device_->session()->add_datafeed_callback([=]
179 (shared_ptr<sigrok::Device> device, shared_ptr<Packet> packet) {
180 data_feed_in(device, packet);
187 void Session::set_default_device()
189 const list< shared_ptr<devices::HardwareDevice> > &devices =
190 device_manager_.devices();
195 // Try and find the demo device and select that by default
196 const auto iter = std::find_if(devices.begin(), devices.end(),
197 [] (const shared_ptr<devices::HardwareDevice> &d) {
198 return d->hardware_device()->driver()->name() ==
200 set_device((iter == devices.end()) ? devices.front() : *iter);
203 Session::capture_state Session::get_capture_state() const
205 lock_guard<mutex> lock(sampling_mutex_);
206 return capture_state_;
209 void Session::start_capture(function<void (const QString)> error_handler)
212 error_handler(tr("No active device set, can't start acquisition."));
218 // Check that at least one channel is enabled
219 const shared_ptr<sigrok::Device> sr_dev = device_->device();
221 const auto channels = sr_dev->channels();
222 if (!std::any_of(channels.begin(), channels.end(),
223 [](shared_ptr<Channel> channel) {
224 return channel->enabled(); })) {
225 error_handler(tr("No channels enabled."));
231 for (const shared_ptr<data::SignalData> d : all_signal_data_)
235 sampling_thread_ = std::thread(
236 &Session::sample_thread_proc, this, error_handler);
239 void Session::stop_capture()
241 if (get_capture_state() != Stopped)
244 // Check that sampling stopped
245 if (sampling_thread_.joinable())
246 sampling_thread_.join();
249 void Session::register_view(std::shared_ptr<pv::view::View> view)
254 void Session::deregister_view(std::shared_ptr<pv::view::View> view)
259 double Session::get_samplerate() const
261 double samplerate = 0.0;
263 for (const shared_ptr<pv::data::SignalData> d : all_signal_data_) {
265 const vector< shared_ptr<pv::data::Segment> > segments =
267 for (const shared_ptr<pv::data::Segment> &s : segments)
268 samplerate = std::max(samplerate, s->samplerate());
270 // If there is no sample rate given we use samples as unit
271 if (samplerate == 0.0)
277 const std::unordered_set< std::shared_ptr<data::SignalBase> >
278 Session::signalbases() const
284 bool Session::add_decoder(srd_decoder *const dec)
286 map<const srd_channel*, shared_ptr<data::SignalBase> > channels;
287 shared_ptr<data::DecoderStack> decoder_stack;
290 // Create the decoder
291 decoder_stack = shared_ptr<data::DecoderStack>(
292 new data::DecoderStack(*this, dec));
294 // Make a list of all the channels
295 std::vector<const srd_channel*> all_channels;
296 for (const GSList *i = dec->channels; i; i = i->next)
297 all_channels.push_back((const srd_channel*)i->data);
298 for (const GSList *i = dec->opt_channels; i; i = i->next)
299 all_channels.push_back((const srd_channel*)i->data);
301 // Auto select the initial channels
302 for (const srd_channel *pdch : all_channels)
303 for (shared_ptr<data::SignalBase> b : signalbases_) {
304 if (b->type() == ChannelType::LOGIC) {
305 if (QString::fromUtf8(pdch->name).toLower().
306 contains(b->name().toLower()))
311 assert(decoder_stack);
312 assert(!decoder_stack->stack().empty());
313 assert(decoder_stack->stack().front());
314 decoder_stack->stack().front()->set_channels(channels);
316 // Create the decode signal
317 shared_ptr<data::SignalBase> signalbase =
318 shared_ptr<data::SignalBase>(new data::SignalBase(nullptr));
320 signalbase->set_decoder_stack(decoder_stack);
322 for (std::shared_ptr<pv::view::View> view : views_)
323 view->add_decode_trace(signalbase);
324 } catch (std::runtime_error e) {
330 // Do an initial decode
331 decoder_stack->begin_decode();
336 void Session::remove_decode_signal(shared_ptr<data::SignalBase> signalbase)
338 for (std::shared_ptr<pv::view::View> view : views_)
339 view->remove_decode_trace(signalbase);
343 void Session::set_capture_state(capture_state state)
348 lock_guard<mutex> lock(sampling_mutex_);
349 changed = capture_state_ != state;
350 capture_state_ = state;
354 capture_state_changed(state);
357 void Session::update_signals()
360 signalbases_.clear();
362 for (std::shared_ptr<pv::view::View> view : views_) {
363 view->clear_signals();
365 view->clear_decode_traces();
371 lock_guard<recursive_mutex> lock(data_mutex_);
373 const shared_ptr<sigrok::Device> sr_dev = device_->device();
375 signalbases_.clear();
377 for (std::shared_ptr<pv::view::View> view : views_) {
378 view->clear_signals();
380 view->clear_decode_traces();
386 // Detect what data types we will receive
387 auto channels = sr_dev->channels();
388 unsigned int logic_channel_count = std::count_if(
389 channels.begin(), channels.end(),
390 [] (shared_ptr<Channel> channel) {
391 return channel->type() == ChannelType::LOGIC; });
393 // Create data containers for the logic data segments
395 lock_guard<recursive_mutex> data_lock(data_mutex_);
397 if (logic_channel_count == 0) {
399 } else if (!logic_data_ ||
400 logic_data_->num_channels() != logic_channel_count) {
401 logic_data_.reset(new data::Logic(
402 logic_channel_count));
407 // Make the signals list
408 for (std::shared_ptr<pv::view::View> view : views_) {
409 unordered_set< shared_ptr<view::Signal> > prev_sigs(view->signals());
410 view->clear_signals();
412 for (auto channel : sr_dev->channels()) {
413 shared_ptr<data::SignalBase> signalbase;
414 shared_ptr<view::Signal> signal;
416 // Find the channel in the old signals
417 const auto iter = std::find_if(
418 prev_sigs.cbegin(), prev_sigs.cend(),
419 [&](const shared_ptr<view::Signal> &s) {
420 return s->base()->channel() == channel;
422 if (iter != prev_sigs.end()) {
423 // Copy the signal from the old set to the new
426 // Find the signalbase for this channel if possible
428 for (const shared_ptr<data::SignalBase> b : signalbases_)
429 if (b->channel() == channel)
432 switch(channel->type()->id()) {
433 case SR_CHANNEL_LOGIC:
435 signalbase = shared_ptr<data::SignalBase>(
436 new data::SignalBase(channel));
437 signalbases_.insert(signalbase);
439 all_signal_data_.insert(logic_data_);
440 signalbase->set_data(logic_data_);
443 signal = shared_ptr<view::Signal>(
444 new view::LogicSignal(*this,
445 device_, signalbase));
446 view->add_signal(signal);
449 case SR_CHANNEL_ANALOG:
452 signalbase = shared_ptr<data::SignalBase>(
453 new data::SignalBase(channel));
454 signalbases_.insert(signalbase);
456 shared_ptr<data::Analog> data(new data::Analog());
457 all_signal_data_.insert(data);
458 signalbase->set_data(data);
461 signal = shared_ptr<view::Signal>(
462 new view::AnalogSignal(
464 view->add_signal(signal);
479 shared_ptr<data::SignalBase> Session::signalbase_from_channel(
480 shared_ptr<sigrok::Channel> channel) const
482 for (shared_ptr<data::SignalBase> sig : signalbases_) {
484 if (sig->channel() == channel)
487 return shared_ptr<data::SignalBase>();
490 void Session::sample_thread_proc(function<void (const QString)> error_handler)
492 assert(error_handler);
497 cur_samplerate_ = device_->read_config<uint64_t>(ConfigKey::SAMPLERATE);
499 out_of_memory_ = false;
504 error_handler(e.what());
508 set_capture_state(device_->session()->trigger() ?
509 AwaitingTrigger : Running);
512 set_capture_state(Stopped);
514 // Confirm that SR_DF_END was received
515 if (cur_logic_segment_) {
516 qDebug("SR_DF_END was not received.");
521 error_handler(tr("Out of memory, acquisition stopped."));
524 void Session::feed_in_header()
526 cur_samplerate_ = device_->read_config<uint64_t>(ConfigKey::SAMPLERATE);
529 void Session::feed_in_meta(shared_ptr<Meta> meta)
531 for (auto entry : meta->config()) {
532 switch (entry.first->id()) {
533 case SR_CONF_SAMPLERATE:
534 // We can't rely on the header to always contain the sample rate,
535 // so in case it's supplied via a meta packet, we use it.
536 if (!cur_samplerate_)
537 cur_samplerate_ = g_variant_get_uint64(entry.second.gobj());
539 /// @todo handle samplerate changes
542 // Unknown metadata is not an error.
550 void Session::feed_in_trigger()
552 // The channel containing most samples should be most accurate
553 uint64_t sample_count = 0;
556 for (const shared_ptr<pv::data::SignalData> d : all_signal_data_) {
558 uint64_t temp_count = 0;
560 const vector< shared_ptr<pv::data::Segment> > segments =
562 for (const shared_ptr<pv::data::Segment> &s : segments)
563 temp_count += s->get_sample_count();
565 if (temp_count > sample_count)
566 sample_count = temp_count;
570 trigger_event(sample_count / get_samplerate());
573 void Session::feed_in_frame_begin()
575 if (cur_logic_segment_ || !cur_analog_segments_.empty())
579 void Session::feed_in_logic(shared_ptr<Logic> logic)
581 lock_guard<recursive_mutex> lock(data_mutex_);
583 const size_t sample_count = logic->data_length() / logic->unit_size();
586 // The only reason logic_data_ would not have been created is
587 // if it was not possible to determine the signals when the
588 // device was created.
592 if (!cur_logic_segment_) {
593 // This could be the first packet after a trigger
594 set_capture_state(Running);
596 // Create a new data segment
597 cur_logic_segment_ = shared_ptr<data::LogicSegment>(
598 new data::LogicSegment(
599 logic, cur_samplerate_, sample_count));
600 logic_data_->push_segment(cur_logic_segment_);
602 // @todo Putting this here means that only listeners querying
603 // for logic will be notified. Currently the only user of
604 // frame_began is DecoderStack, but in future we need to signal
605 // this after both analog and logic sweeps have begun.
608 // Append to the existing data segment
609 cur_logic_segment_->append_payload(logic);
615 void Session::feed_in_analog(shared_ptr<Analog> analog)
617 lock_guard<recursive_mutex> lock(data_mutex_);
619 const vector<shared_ptr<Channel>> channels = analog->channels();
620 const unsigned int channel_count = channels.size();
621 const size_t sample_count = analog->num_samples() / channel_count;
622 const float *data = static_cast<const float *>(analog->data_pointer());
623 bool sweep_beginning = false;
625 if (signalbases_.empty())
628 for (auto channel : channels) {
629 shared_ptr<data::AnalogSegment> segment;
631 // Try to get the segment of the channel
632 const map< shared_ptr<Channel>, shared_ptr<data::AnalogSegment> >::
633 iterator iter = cur_analog_segments_.find(channel);
634 if (iter != cur_analog_segments_.end())
635 segment = (*iter).second;
637 // If no segment was found, this means we haven't
638 // created one yet. i.e. this is the first packet
639 // in the sweep containing this segment.
640 sweep_beginning = true;
642 // Create a segment, keep it in the maps of channels
643 segment = shared_ptr<data::AnalogSegment>(
644 new data::AnalogSegment(
645 cur_samplerate_, sample_count));
646 cur_analog_segments_[channel] = segment;
648 // Find the analog data associated with the channel
649 shared_ptr<data::SignalBase> base = signalbase_from_channel(channel);
652 shared_ptr<data::Analog> data(base->analog_data());
655 // Push the segment into the analog data.
656 data->push_segment(segment);
661 // Append the samples in the segment
662 segment->append_interleaved_samples(data++, sample_count,
666 if (sweep_beginning) {
667 // This could be the first packet after a trigger
668 set_capture_state(Running);
674 void Session::data_feed_in(shared_ptr<sigrok::Device> device,
675 shared_ptr<Packet> packet)
680 assert(device == device_->device());
683 switch (packet->type()->id()) {
689 feed_in_meta(dynamic_pointer_cast<Meta>(packet->payload()));
696 case SR_DF_FRAME_BEGIN:
697 feed_in_frame_begin();
702 feed_in_logic(dynamic_pointer_cast<Logic>(packet->payload()));
703 } catch (std::bad_alloc) {
704 out_of_memory_ = true;
711 feed_in_analog(dynamic_pointer_cast<Analog>(packet->payload()));
712 } catch (std::bad_alloc) {
713 out_of_memory_ = true;
721 lock_guard<recursive_mutex> lock(data_mutex_);
722 cur_logic_segment_.reset();
723 cur_analog_segments_.clear();