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>
37 #include "session.hpp"
38 #include "devicemanager.hpp"
40 #include "data/analog.hpp"
41 #include "data/analogsegment.hpp"
42 #include "data/decoderstack.hpp"
43 #include "data/logic.hpp"
44 #include "data/logicsegment.hpp"
45 #include "data/signalbase.hpp"
46 #include "data/decode/decoder.hpp"
48 #include "devices/hardwaredevice.hpp"
49 #include "devices/sessionfile.hpp"
51 #include "toolbars/mainbar.hpp"
53 #include "view/analogsignal.hpp"
54 #include "view/decodetrace.hpp"
55 #include "view/logicsignal.hpp"
56 #include "view/signal.hpp"
57 #include "view/view.hpp"
59 #include <libsigrokcxx/libsigrokcxx.hpp>
62 #include <libsigrokdecode/libsigrokdecode.h>
65 using boost::shared_lock;
66 using boost::shared_mutex;
67 using boost::unique_lock;
69 using std::dynamic_pointer_cast;
71 using std::lock_guard;
75 using std::recursive_mutex;
77 using std::shared_ptr;
79 using std::unordered_set;
83 using sigrok::Channel;
84 using sigrok::ChannelType;
85 using sigrok::ConfigKey;
86 using sigrok::DatafeedCallbackFunction;
92 using sigrok::PacketPayload;
93 using sigrok::Session;
94 using sigrok::SessionDevice;
96 using Glib::VariantBase;
100 Session::Session(DeviceManager &device_manager, QString name) :
101 device_manager_(device_manager),
103 capture_state_(Stopped),
110 // Stop and join to the thread
114 DeviceManager& Session::device_manager()
116 return device_manager_;
119 const DeviceManager& Session::device_manager() const
121 return device_manager_;
124 shared_ptr<sigrok::Session> Session::session() const
127 return shared_ptr<sigrok::Session>();
128 return device_->session();
131 shared_ptr<devices::Device> Session::device() const
136 QString Session::name() const
141 void Session::set_name(QString name)
143 if (default_name_.isEmpty())
144 default_name_ = name;
151 std::shared_ptr<pv::view::View> Session::main_view() const
156 void Session::set_main_bar(std::shared_ptr<pv::toolbars::MainBar> main_bar)
158 main_bar_ = main_bar;
161 shared_ptr<pv::toolbars::MainBar> Session::main_bar() const
166 void Session::save_settings(QSettings &settings) const
168 map<string, string> dev_info;
169 list<string> key_list;
170 int stacks = 0, views = 0;
173 shared_ptr<devices::HardwareDevice> hw_device =
174 dynamic_pointer_cast< devices::HardwareDevice >(device_);
177 settings.setValue("device_type", "hardware");
178 settings.beginGroup("device");
180 key_list.push_back("vendor");
181 key_list.push_back("model");
182 key_list.push_back("version");
183 key_list.push_back("serial_num");
184 key_list.push_back("connection_id");
186 dev_info = device_manager_.get_device_info(device_);
188 for (string key : key_list) {
189 if (dev_info.count(key))
190 settings.setValue(QString::fromUtf8(key.c_str()),
191 QString::fromUtf8(dev_info.at(key).c_str()));
193 settings.remove(QString::fromUtf8(key.c_str()));
199 shared_ptr<devices::SessionFile> sessionfile_device =
200 dynamic_pointer_cast< devices::SessionFile >(device_);
202 if (sessionfile_device) {
203 settings.setValue("device_type", "sessionfile");
204 settings.beginGroup("device");
205 settings.setValue("filename", QString::fromStdString(
206 sessionfile_device->full_name()));
210 // Save channels and decoders
211 for (shared_ptr<data::SignalBase> base : signalbases_) {
213 if (base->is_decode_signal()) {
214 shared_ptr<pv::data::DecoderStack> decoder_stack =
215 base->decoder_stack();
216 std::shared_ptr<data::decode::Decoder> top_decoder =
217 decoder_stack->stack().front();
219 settings.beginGroup("decoder_stack" + QString::number(stacks++));
220 settings.setValue("id", top_decoder->decoder()->id);
221 settings.setValue("name", top_decoder->decoder()->name);
226 settings.beginGroup(base->internal_name());
227 base->save_settings(settings);
232 settings.setValue("decoder_stacks", stacks);
234 // Save view states and their signal settings
235 // Note: main_view must be saved as view0
236 settings.beginGroup("view" + QString::number(views++));
237 main_view_->save_settings(settings);
240 for (shared_ptr<view::View> view : views_) {
241 if (view != main_view_) {
242 settings.beginGroup("view" + QString::number(views++));
243 view->save_settings(settings);
248 settings.setValue("views", views);
252 void Session::restore_settings(QSettings &settings)
254 shared_ptr<devices::Device> device;
256 QString device_type = settings.value("device_type").toString();
258 if (device_type == "hardware") {
259 map<string, string> dev_info;
260 list<string> key_list;
262 // Re-select last used device if possible but only if it's not demo
263 settings.beginGroup("device");
264 key_list.push_back("vendor");
265 key_list.push_back("model");
266 key_list.push_back("version");
267 key_list.push_back("serial_num");
268 key_list.push_back("connection_id");
270 for (string key : key_list) {
271 const QString k = QString::fromStdString(key);
272 if (!settings.contains(k))
275 const string value = settings.value(k).toString().toStdString();
277 dev_info.insert(std::make_pair(key, value));
280 if (dev_info.count("model") > 0)
281 device = device_manager_.find_device_from_info(dev_info);
289 if (device_type == "sessionfile") {
290 settings.beginGroup("device");
291 QString filename = settings.value("filename").toString();
294 if (QFileInfo(filename).isReadable()) {
295 device = std::make_shared<devices::SessionFile>(device_manager_.context(),
296 filename.toStdString());
300 // TODO Perform error handling
301 start_capture([](QString infoMessage) { (void)infoMessage; });
307 for (shared_ptr<data::SignalBase> base : signalbases_) {
308 settings.beginGroup(base->internal_name());
309 base->restore_settings(settings);
315 int stacks = settings.value("decoder_stacks").toInt();
317 for (int i = 0; i < stacks; i++) {
318 settings.beginGroup("decoder_stack" + QString::number(i++));
320 QString id = settings.value("id").toString();
321 add_decoder(srd_decoder_get_by_id(id.toStdString().c_str()));
328 int views = settings.value("views").toInt();
330 for (int i = 0; i < views; i++) {
331 settings.beginGroup("view" + QString::number(i));
334 view::ViewType type = (view::ViewType)settings.value("type").toInt();
335 add_view(name_, type, this);
336 views_.back()->restore_settings(settings);
338 main_view_->restore_settings(settings);
345 void Session::set_device(shared_ptr<devices::Device> device)
349 // Ensure we are not capturing before setting the device
357 // Revert name back to default name (e.g. "Untitled-1") as the data is gone
358 name_ = default_name_;
361 // Remove all stored data
362 for (std::shared_ptr<pv::view::View> view : views_) {
363 view->clear_signals();
365 view->clear_decode_traces();
368 for (const shared_ptr<data::SignalData> d : all_signal_data_)
370 all_signal_data_.clear();
371 signalbases_.clear();
372 cur_logic_segment_.reset();
374 for (auto entry : cur_analog_segments_) {
375 shared_ptr<sigrok::Channel>(entry.first).reset();
376 shared_ptr<data::AnalogSegment>(entry.second).reset();
383 device_ = std::move(device);
387 } catch (const QString &e) {
393 device_->session()->add_datafeed_callback([=]
394 (shared_ptr<sigrok::Device> device, shared_ptr<Packet> packet) {
395 data_feed_in(device, packet);
402 void Session::set_default_device()
404 const list< shared_ptr<devices::HardwareDevice> > &devices =
405 device_manager_.devices();
410 // Try and find the demo device and select that by default
411 const auto iter = std::find_if(devices.begin(), devices.end(),
412 [] (const shared_ptr<devices::HardwareDevice> &d) {
413 return d->hardware_device()->driver()->name() ==
415 set_device((iter == devices.end()) ? devices.front() : *iter);
418 Session::capture_state Session::get_capture_state() const
420 lock_guard<mutex> lock(sampling_mutex_);
421 return capture_state_;
424 void Session::start_capture(function<void (const QString)> error_handler)
427 error_handler(tr("No active device set, can't start acquisition."));
433 // Check that at least one channel is enabled
434 const shared_ptr<sigrok::Device> sr_dev = device_->device();
436 const auto channels = sr_dev->channels();
437 if (!std::any_of(channels.begin(), channels.end(),
438 [](shared_ptr<Channel> channel) {
439 return channel->enabled(); })) {
440 error_handler(tr("No channels enabled."));
446 for (const shared_ptr<data::SignalData> d : all_signal_data_)
449 // Revert name back to default name (e.g. "Untitled-1") as the data is gone
450 name_ = default_name_;
454 sampling_thread_ = std::thread(
455 &Session::sample_thread_proc, this, error_handler);
458 void Session::stop_capture()
460 if (get_capture_state() != Stopped)
463 // Check that sampling stopped
464 if (sampling_thread_.joinable())
465 sampling_thread_.join();
468 void Session::register_view(std::shared_ptr<pv::view::View> view)
470 if (views_.empty()) {
474 views_.push_back(view);
477 void Session::deregister_view(std::shared_ptr<pv::view::View> view)
479 views_.remove_if([&](std::shared_ptr<pv::view::View> v) {
480 return v == view; });
482 if (views_.empty()) {
485 // Without a view there can be no main bar
490 bool Session::has_view(std::shared_ptr<pv::view::View> view)
492 for (std::shared_ptr<pv::view::View> v : views_)
499 double Session::get_samplerate() const
501 double samplerate = 0.0;
503 for (const shared_ptr<pv::data::SignalData> d : all_signal_data_) {
505 const vector< shared_ptr<pv::data::Segment> > segments =
507 for (const shared_ptr<pv::data::Segment> &s : segments)
508 samplerate = std::max(samplerate, s->samplerate());
510 // If there is no sample rate given we use samples as unit
511 if (samplerate == 0.0)
517 const std::unordered_set< std::shared_ptr<data::SignalBase> >
518 Session::signalbases() const
524 bool Session::add_decoder(srd_decoder *const dec)
526 map<const srd_channel*, shared_ptr<data::SignalBase> > channels;
527 shared_ptr<data::DecoderStack> decoder_stack;
530 // Create the decoder
531 decoder_stack = shared_ptr<data::DecoderStack>(
532 new data::DecoderStack(*this, dec));
534 // Make a list of all the channels
535 std::vector<const srd_channel*> all_channels;
536 for (const GSList *i = dec->channels; i; i = i->next)
537 all_channels.push_back((const srd_channel*)i->data);
538 for (const GSList *i = dec->opt_channels; i; i = i->next)
539 all_channels.push_back((const srd_channel*)i->data);
541 // Auto select the initial channels
542 for (const srd_channel *pdch : all_channels)
543 for (shared_ptr<data::SignalBase> b : signalbases_) {
544 if (b->type() == ChannelType::LOGIC) {
545 if (QString::fromUtf8(pdch->name).toLower().
546 contains(b->name().toLower()))
551 assert(decoder_stack);
552 assert(!decoder_stack->stack().empty());
553 assert(decoder_stack->stack().front());
554 decoder_stack->stack().front()->set_channels(channels);
556 // Create the decode signal
557 shared_ptr<data::SignalBase> signalbase =
558 shared_ptr<data::SignalBase>(new data::SignalBase(nullptr));
560 signalbase->set_decoder_stack(decoder_stack);
561 signalbases_.insert(signalbase);
563 for (std::shared_ptr<pv::view::View> view : views_)
564 view->add_decode_trace(signalbase);
565 } catch (std::runtime_error e) {
571 // Do an initial decode
572 decoder_stack->begin_decode();
577 void Session::remove_decode_signal(shared_ptr<data::SignalBase> signalbase)
579 for (std::shared_ptr<pv::view::View> view : views_)
580 view->remove_decode_trace(signalbase);
584 void Session::set_capture_state(capture_state state)
589 lock_guard<mutex> lock(sampling_mutex_);
590 changed = capture_state_ != state;
591 capture_state_ = state;
595 capture_state_changed(state);
598 void Session::update_signals()
601 signalbases_.clear();
603 for (std::shared_ptr<pv::view::View> view : views_) {
604 view->clear_signals();
606 view->clear_decode_traces();
612 lock_guard<recursive_mutex> lock(data_mutex_);
614 const shared_ptr<sigrok::Device> sr_dev = device_->device();
616 signalbases_.clear();
618 for (std::shared_ptr<pv::view::View> view : views_) {
619 view->clear_signals();
621 view->clear_decode_traces();
627 // Detect what data types we will receive
628 auto channels = sr_dev->channels();
629 unsigned int logic_channel_count = std::count_if(
630 channels.begin(), channels.end(),
631 [] (shared_ptr<Channel> channel) {
632 return channel->type() == ChannelType::LOGIC; });
634 // Create data containers for the logic data segments
636 lock_guard<recursive_mutex> data_lock(data_mutex_);
638 if (logic_channel_count == 0) {
640 } else if (!logic_data_ ||
641 logic_data_->num_channels() != logic_channel_count) {
642 logic_data_.reset(new data::Logic(
643 logic_channel_count));
648 // Make the signals list
649 for (std::shared_ptr<pv::view::View> view : views_) {
650 unordered_set< shared_ptr<view::Signal> > prev_sigs(view->signals());
651 view->clear_signals();
653 for (auto channel : sr_dev->channels()) {
654 shared_ptr<data::SignalBase> signalbase;
655 shared_ptr<view::Signal> signal;
657 // Find the channel in the old signals
658 const auto iter = std::find_if(
659 prev_sigs.cbegin(), prev_sigs.cend(),
660 [&](const shared_ptr<view::Signal> &s) {
661 return s->base()->channel() == channel;
663 if (iter != prev_sigs.end()) {
664 // Copy the signal from the old set to the new
667 // Find the signalbase for this channel if possible
669 for (const shared_ptr<data::SignalBase> b : signalbases_)
670 if (b->channel() == channel)
673 switch(channel->type()->id()) {
674 case SR_CHANNEL_LOGIC:
676 signalbase = shared_ptr<data::SignalBase>(
677 new data::SignalBase(channel));
678 signalbases_.insert(signalbase);
680 all_signal_data_.insert(logic_data_);
681 signalbase->set_data(logic_data_);
684 signal = shared_ptr<view::Signal>(
685 new view::LogicSignal(*this,
686 device_, signalbase));
687 view->add_signal(signal);
690 case SR_CHANNEL_ANALOG:
693 signalbase = shared_ptr<data::SignalBase>(
694 new data::SignalBase(channel));
695 signalbases_.insert(signalbase);
697 shared_ptr<data::Analog> data(new data::Analog());
698 all_signal_data_.insert(data);
699 signalbase->set_data(data);
702 signal = shared_ptr<view::Signal>(
703 new view::AnalogSignal(
705 view->add_signal(signal);
720 shared_ptr<data::SignalBase> Session::signalbase_from_channel(
721 shared_ptr<sigrok::Channel> channel) const
723 for (shared_ptr<data::SignalBase> sig : signalbases_) {
725 if (sig->channel() == channel)
728 return shared_ptr<data::SignalBase>();
731 void Session::sample_thread_proc(function<void (const QString)> error_handler)
733 assert(error_handler);
738 cur_samplerate_ = device_->read_config<uint64_t>(ConfigKey::SAMPLERATE);
740 out_of_memory_ = false;
745 error_handler(e.what());
749 set_capture_state(device_->session()->trigger() ?
750 AwaitingTrigger : Running);
753 set_capture_state(Stopped);
755 // Confirm that SR_DF_END was received
756 if (cur_logic_segment_) {
757 qDebug("SR_DF_END was not received.");
762 error_handler(tr("Out of memory, acquisition stopped."));
765 void Session::feed_in_header()
767 cur_samplerate_ = device_->read_config<uint64_t>(ConfigKey::SAMPLERATE);
770 void Session::feed_in_meta(shared_ptr<Meta> meta)
772 for (auto entry : meta->config()) {
773 switch (entry.first->id()) {
774 case SR_CONF_SAMPLERATE:
775 // We can't rely on the header to always contain the sample rate,
776 // so in case it's supplied via a meta packet, we use it.
777 if (!cur_samplerate_)
778 cur_samplerate_ = g_variant_get_uint64(entry.second.gobj());
780 /// @todo handle samplerate changes
783 // Unknown metadata is not an error.
791 void Session::feed_in_trigger()
793 // The channel containing most samples should be most accurate
794 uint64_t sample_count = 0;
797 for (const shared_ptr<pv::data::SignalData> d : all_signal_data_) {
799 uint64_t temp_count = 0;
801 const vector< shared_ptr<pv::data::Segment> > segments =
803 for (const shared_ptr<pv::data::Segment> &s : segments)
804 temp_count += s->get_sample_count();
806 if (temp_count > sample_count)
807 sample_count = temp_count;
811 trigger_event(sample_count / get_samplerate());
814 void Session::feed_in_frame_begin()
816 if (cur_logic_segment_ || !cur_analog_segments_.empty())
820 void Session::feed_in_logic(shared_ptr<Logic> logic)
822 lock_guard<recursive_mutex> lock(data_mutex_);
824 const size_t sample_count = logic->data_length() / logic->unit_size();
827 // The only reason logic_data_ would not have been created is
828 // if it was not possible to determine the signals when the
829 // device was created.
833 if (!cur_logic_segment_) {
834 // This could be the first packet after a trigger
835 set_capture_state(Running);
837 // Create a new data segment
838 cur_logic_segment_ = shared_ptr<data::LogicSegment>(
839 new data::LogicSegment(
840 logic, cur_samplerate_, sample_count));
841 logic_data_->push_segment(cur_logic_segment_);
843 // @todo Putting this here means that only listeners querying
844 // for logic will be notified. Currently the only user of
845 // frame_began is DecoderStack, but in future we need to signal
846 // this after both analog and logic sweeps have begun.
849 // Append to the existing data segment
850 cur_logic_segment_->append_payload(logic);
856 void Session::feed_in_analog(shared_ptr<Analog> analog)
858 lock_guard<recursive_mutex> lock(data_mutex_);
860 const vector<shared_ptr<Channel>> channels = analog->channels();
861 const unsigned int channel_count = channels.size();
862 const size_t sample_count = analog->num_samples() / channel_count;
863 const float *data = static_cast<const float *>(analog->data_pointer());
864 bool sweep_beginning = false;
866 if (signalbases_.empty())
869 for (auto channel : channels) {
870 shared_ptr<data::AnalogSegment> segment;
872 // Try to get the segment of the channel
873 const map< shared_ptr<Channel>, shared_ptr<data::AnalogSegment> >::
874 iterator iter = cur_analog_segments_.find(channel);
875 if (iter != cur_analog_segments_.end())
876 segment = (*iter).second;
878 // If no segment was found, this means we haven't
879 // created one yet. i.e. this is the first packet
880 // in the sweep containing this segment.
881 sweep_beginning = true;
883 // Create a segment, keep it in the maps of channels
884 segment = shared_ptr<data::AnalogSegment>(
885 new data::AnalogSegment(
886 cur_samplerate_, sample_count));
887 cur_analog_segments_[channel] = segment;
889 // Find the analog data associated with the channel
890 shared_ptr<data::SignalBase> base = signalbase_from_channel(channel);
893 shared_ptr<data::Analog> data(base->analog_data());
896 // Push the segment into the analog data.
897 data->push_segment(segment);
902 // Append the samples in the segment
903 segment->append_interleaved_samples(data++, sample_count,
907 if (sweep_beginning) {
908 // This could be the first packet after a trigger
909 set_capture_state(Running);
915 void Session::data_feed_in(shared_ptr<sigrok::Device> device,
916 shared_ptr<Packet> packet)
921 assert(device == device_->device());
924 switch (packet->type()->id()) {
930 feed_in_meta(dynamic_pointer_cast<Meta>(packet->payload()));
937 case SR_DF_FRAME_BEGIN:
938 feed_in_frame_begin();
943 feed_in_logic(dynamic_pointer_cast<Logic>(packet->payload()));
944 } catch (std::bad_alloc) {
945 out_of_memory_ = true;
952 feed_in_analog(dynamic_pointer_cast<Analog>(packet->payload()));
953 } catch (std::bad_alloc) {
954 out_of_memory_ = true;
962 lock_guard<recursive_mutex> lock(data_mutex_);
963 cur_logic_segment_.reset();
964 cur_analog_segments_.clear();