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, see <http://www.gnu.org/licenses/>.
21 // Windows: Avoid boost/thread namespace pollution (which includes windows.h).
25 #include <boost/thread/locks.hpp>
26 #include <boost/thread/shared_mutex.hpp>
36 #include "session.hpp"
37 #include "devicemanager.hpp"
39 #include "data/analog.hpp"
40 #include "data/analogsegment.hpp"
41 #include "data/decoderstack.hpp"
42 #include "data/logic.hpp"
43 #include "data/logicsegment.hpp"
44 #include "data/signalbase.hpp"
45 #include "data/decode/decoder.hpp"
47 #include "devices/hardwaredevice.hpp"
48 #include "devices/inputfile.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;
76 using std::recursive_mutex;
78 using std::shared_ptr;
79 using std::make_shared;
81 using std::unordered_set;
85 using sigrok::Channel;
86 using sigrok::ChannelType;
87 using sigrok::ConfigKey;
88 using sigrok::DatafeedCallbackFunction;
91 using sigrok::InputFormat;
94 using sigrok::OutputFormat;
96 using sigrok::PacketPayload;
97 using sigrok::Session;
98 using sigrok::SessionDevice;
100 using Glib::VariantBase;
104 Session::Session(DeviceManager &device_manager, QString name) :
105 device_manager_(device_manager),
108 capture_state_(Stopped),
116 // Stop and join to the thread
120 DeviceManager& Session::device_manager()
122 return device_manager_;
125 const DeviceManager& Session::device_manager() const
127 return device_manager_;
130 shared_ptr<sigrok::Session> Session::session() const
133 return shared_ptr<sigrok::Session>();
134 return device_->session();
137 shared_ptr<devices::Device> Session::device() const
142 QString Session::name() const
147 void Session::set_name(QString name)
149 if (default_name_.isEmpty())
150 default_name_ = name;
157 const std::list< std::shared_ptr<views::ViewBase> > Session::views() const
162 std::shared_ptr<views::ViewBase> Session::main_view() const
167 void Session::set_main_bar(std::shared_ptr<pv::toolbars::MainBar> main_bar)
169 main_bar_ = main_bar;
172 shared_ptr<pv::toolbars::MainBar> Session::main_bar() const
177 bool Session::data_saved() const
182 void Session::save_settings(QSettings &settings) const
184 map<string, string> dev_info;
185 list<string> key_list;
186 int stacks = 0, views = 0;
189 shared_ptr<devices::HardwareDevice> hw_device =
190 dynamic_pointer_cast< devices::HardwareDevice >(device_);
193 settings.setValue("device_type", "hardware");
194 settings.beginGroup("device");
196 key_list.emplace_back("vendor");
197 key_list.emplace_back("model");
198 key_list.emplace_back("version");
199 key_list.emplace_back("serial_num");
200 key_list.emplace_back("connection_id");
202 dev_info = device_manager_.get_device_info(device_);
204 for (string key : key_list) {
205 if (dev_info.count(key))
206 settings.setValue(QString::fromUtf8(key.c_str()),
207 QString::fromUtf8(dev_info.at(key).c_str()));
209 settings.remove(QString::fromUtf8(key.c_str()));
215 shared_ptr<devices::SessionFile> sessionfile_device =
216 dynamic_pointer_cast< devices::SessionFile >(device_);
218 if (sessionfile_device) {
219 settings.setValue("device_type", "sessionfile");
220 settings.beginGroup("device");
221 settings.setValue("filename", QString::fromStdString(
222 sessionfile_device->full_name()));
226 // Save channels and decoders
227 for (shared_ptr<data::SignalBase> base : signalbases_) {
229 if (base->is_decode_signal()) {
230 shared_ptr<pv::data::DecoderStack> decoder_stack =
231 base->decoder_stack();
232 std::shared_ptr<data::decode::Decoder> top_decoder =
233 decoder_stack->stack().front();
235 settings.beginGroup("decoder_stack" + QString::number(stacks++));
236 settings.setValue("id", top_decoder->decoder()->id);
237 settings.setValue("name", top_decoder->decoder()->name);
242 settings.beginGroup(base->internal_name());
243 base->save_settings(settings);
248 settings.setValue("decoder_stacks", stacks);
250 // Save view states and their signal settings
251 // Note: main_view must be saved as view0
252 settings.beginGroup("view" + QString::number(views++));
253 main_view_->save_settings(settings);
256 for (shared_ptr<views::ViewBase> view : views_) {
257 if (view != main_view_) {
258 settings.beginGroup("view" + QString::number(views++));
259 view->save_settings(settings);
264 settings.setValue("views", views);
268 void Session::restore_settings(QSettings &settings)
270 shared_ptr<devices::Device> device;
272 QString device_type = settings.value("device_type").toString();
274 if (device_type == "hardware") {
275 map<string, string> dev_info;
276 list<string> key_list;
278 // Re-select last used device if possible but only if it's not demo
279 settings.beginGroup("device");
280 key_list.emplace_back("vendor");
281 key_list.emplace_back("model");
282 key_list.emplace_back("version");
283 key_list.emplace_back("serial_num");
284 key_list.emplace_back("connection_id");
286 for (string key : key_list) {
287 const QString k = QString::fromStdString(key);
288 if (!settings.contains(k))
291 const string value = settings.value(k).toString().toStdString();
293 dev_info.insert(std::make_pair(key, value));
296 if (dev_info.count("model") > 0)
297 device = device_manager_.find_device_from_info(dev_info);
305 if (device_type == "sessionfile") {
306 settings.beginGroup("device");
307 QString filename = settings.value("filename").toString();
310 if (QFileInfo(filename).isReadable()) {
311 device = make_shared<devices::SessionFile>(device_manager_.context(),
312 filename.toStdString());
315 // TODO Perform error handling
316 start_capture([](QString infoMessage) { (void)infoMessage; });
318 set_name(QFileInfo(filename).fileName());
324 for (shared_ptr<data::SignalBase> base : signalbases_) {
325 settings.beginGroup(base->internal_name());
326 base->restore_settings(settings);
332 int stacks = settings.value("decoder_stacks").toInt();
334 for (int i = 0; i < stacks; i++) {
335 settings.beginGroup("decoder_stack" + QString::number(i++));
337 QString id = settings.value("id").toString();
338 add_decoder(srd_decoder_get_by_id(id.toStdString().c_str()));
345 int views = settings.value("views").toInt();
347 for (int i = 0; i < views; i++) {
348 settings.beginGroup("view" + QString::number(i));
351 views::ViewType type = (views::ViewType)settings.value("type").toInt();
352 add_view(name_, type, this);
353 views_.back()->restore_settings(settings);
355 main_view_->restore_settings(settings);
362 void Session::select_device(shared_ptr<devices::Device> device)
368 set_default_device();
369 } catch (const QString &e) {
370 main_bar_->session_error(tr("Failed to Select Device"),
371 tr("Failed to Select Device"));
375 void Session::set_device(shared_ptr<devices::Device> device)
379 // Ensure we are not capturing before setting the device
387 // Revert name back to default name (e.g. "Session 1") as the data is gone
388 name_ = default_name_;
391 // Remove all stored data
392 for (std::shared_ptr<views::ViewBase> view : views_) {
393 view->clear_signals();
395 view->clear_decode_signals();
398 for (const shared_ptr<data::SignalData> d : all_signal_data_)
400 all_signal_data_.clear();
401 signalbases_.clear();
402 cur_logic_segment_.reset();
404 for (auto entry : cur_analog_segments_) {
405 shared_ptr<sigrok::Channel>(entry.first).reset();
406 shared_ptr<data::AnalogSegment>(entry.second).reset();
413 device_ = std::move(device);
417 } catch (const QString &e) {
422 device_->session()->add_datafeed_callback([=]
423 (shared_ptr<sigrok::Device> device, shared_ptr<Packet> packet) {
424 data_feed_in(device, packet);
433 void Session::set_default_device()
435 const list< shared_ptr<devices::HardwareDevice> > &devices =
436 device_manager_.devices();
441 // Try and find the demo device and select that by default
442 const auto iter = std::find_if(devices.begin(), devices.end(),
443 [] (const shared_ptr<devices::HardwareDevice> &d) {
444 return d->hardware_device()->driver()->name() ==
446 set_device((iter == devices.end()) ? devices.front() : *iter);
449 void Session::load_init_file(const std::string &file_name,
450 const std::string &format)
452 shared_ptr<InputFormat> input_format;
454 if (!format.empty()) {
455 const map<string, shared_ptr<InputFormat> > formats =
456 device_manager_.context()->input_formats();
457 const auto iter = find_if(formats.begin(), formats.end(),
458 [&](const pair<string, shared_ptr<InputFormat> > f) {
459 return f.first == format; });
460 if (iter == formats.end()) {
461 main_bar_->session_error(tr("Error"),
462 tr("Unexpected input format: %s").arg(QString::fromStdString(format)));
466 input_format = (*iter).second;
469 load_file(QString::fromStdString(file_name), input_format);
472 void Session::load_file(QString file_name,
473 std::shared_ptr<sigrok::InputFormat> format,
474 const std::map<std::string, Glib::VariantBase> &options)
476 const QString errorMessage(
477 QString("Failed to load file %1").arg(file_name));
481 set_device(shared_ptr<devices::Device>(
482 new devices::InputFile(
483 device_manager_.context(),
484 file_name.toStdString(),
487 set_device(shared_ptr<devices::Device>(
488 new devices::SessionFile(
489 device_manager_.context(),
490 file_name.toStdString())));
492 main_bar_->session_error(tr("Failed to load ") + file_name, e.what());
493 set_default_device();
494 main_bar_->update_device_list();
498 main_bar_->update_device_list();
500 start_capture([&, errorMessage](QString infoMessage) {
501 main_bar_->session_error(errorMessage, infoMessage); });
503 set_name(QFileInfo(file_name).fileName());
506 Session::capture_state Session::get_capture_state() const
508 lock_guard<mutex> lock(sampling_mutex_);
509 return capture_state_;
512 void Session::start_capture(function<void (const QString)> error_handler)
515 error_handler(tr("No active device set, can't start acquisition."));
521 // Check that at least one channel is enabled
522 const shared_ptr<sigrok::Device> sr_dev = device_->device();
524 const auto channels = sr_dev->channels();
525 if (!std::any_of(channels.begin(), channels.end(),
526 [](shared_ptr<Channel> channel) {
527 return channel->enabled(); })) {
528 error_handler(tr("No channels enabled."));
534 for (const shared_ptr<data::SignalData> d : all_signal_data_)
537 // Revert name back to default name (e.g. "Session 1") for real devices
538 // as the (possibly saved) data is gone. File devices keep their name.
539 shared_ptr<devices::HardwareDevice> hw_device =
540 dynamic_pointer_cast< devices::HardwareDevice >(device_);
543 name_ = default_name_;
548 sampling_thread_ = std::thread(
549 &Session::sample_thread_proc, this, error_handler);
552 void Session::stop_capture()
554 if (get_capture_state() != Stopped)
557 // Check that sampling stopped
558 if (sampling_thread_.joinable())
559 sampling_thread_.join();
562 void Session::register_view(std::shared_ptr<views::ViewBase> view)
564 if (views_.empty()) {
568 views_.push_back(view);
573 void Session::deregister_view(std::shared_ptr<views::ViewBase> view)
575 views_.remove_if([&](std::shared_ptr<views::ViewBase> v) {
576 return v == view; });
578 if (views_.empty()) {
581 // Without a view there can be no main bar
586 bool Session::has_view(std::shared_ptr<views::ViewBase> view)
588 for (std::shared_ptr<views::ViewBase> v : views_)
595 double Session::get_samplerate() const
597 double samplerate = 0.0;
599 for (const shared_ptr<pv::data::SignalData> d : all_signal_data_) {
601 const vector< shared_ptr<pv::data::Segment> > segments =
603 for (const shared_ptr<pv::data::Segment> &s : segments)
604 samplerate = std::max(samplerate, s->samplerate());
606 // If there is no sample rate given we use samples as unit
607 if (samplerate == 0.0)
613 const std::unordered_set< std::shared_ptr<data::SignalBase> >
614 Session::signalbases() const
620 bool Session::add_decoder(srd_decoder *const dec)
622 map<const srd_channel*, shared_ptr<data::SignalBase> > channels;
623 shared_ptr<data::DecoderStack> decoder_stack;
626 // Create the decoder
627 decoder_stack = make_shared<data::DecoderStack>(*this, dec);
629 // Make a list of all the channels
630 std::vector<const srd_channel*> all_channels;
631 for (const GSList *i = dec->channels; i; i = i->next)
632 all_channels.push_back((const srd_channel*)i->data);
633 for (const GSList *i = dec->opt_channels; i; i = i->next)
634 all_channels.push_back((const srd_channel*)i->data);
636 // Auto select the initial channels
637 for (const srd_channel *pdch : all_channels)
638 for (shared_ptr<data::SignalBase> b : signalbases_) {
639 if (b->type() == ChannelType::LOGIC) {
640 if (QString::fromUtf8(pdch->name).toLower().
641 contains(b->name().toLower()))
646 assert(decoder_stack);
647 assert(!decoder_stack->stack().empty());
648 assert(decoder_stack->stack().front());
649 decoder_stack->stack().front()->set_channels(channels);
651 // Create the decode signal
652 shared_ptr<data::SignalBase> signalbase =
653 make_shared<data::SignalBase>(nullptr);
655 signalbase->set_decoder_stack(decoder_stack);
656 signalbases_.insert(signalbase);
658 for (std::shared_ptr<views::ViewBase> view : views_)
659 view->add_decode_signal(signalbase);
660 } catch (std::runtime_error e) {
666 // Do an initial decode
667 decoder_stack->begin_decode();
672 void Session::remove_decode_signal(shared_ptr<data::SignalBase> signalbase)
674 signalbases_.erase(signalbase);
676 for (std::shared_ptr<views::ViewBase> view : views_)
677 view->remove_decode_signal(signalbase);
683 void Session::set_capture_state(capture_state state)
688 lock_guard<mutex> lock(sampling_mutex_);
689 changed = capture_state_ != state;
690 capture_state_ = state;
694 capture_state_changed(state);
697 void Session::update_signals()
700 signalbases_.clear();
702 for (std::shared_ptr<views::ViewBase> view : views_) {
703 view->clear_signals();
705 view->clear_decode_signals();
711 lock_guard<recursive_mutex> lock(data_mutex_);
713 const shared_ptr<sigrok::Device> sr_dev = device_->device();
715 signalbases_.clear();
717 for (std::shared_ptr<views::ViewBase> view : views_) {
718 view->clear_signals();
720 view->clear_decode_signals();
726 // Detect what data types we will receive
727 auto channels = sr_dev->channels();
728 unsigned int logic_channel_count = std::count_if(
729 channels.begin(), channels.end(),
730 [] (shared_ptr<Channel> channel) {
731 return channel->type() == ChannelType::LOGIC; });
733 // Create data containers for the logic data segments
735 lock_guard<recursive_mutex> data_lock(data_mutex_);
737 if (logic_channel_count == 0) {
739 } else if (!logic_data_ ||
740 logic_data_->num_channels() != logic_channel_count) {
741 logic_data_.reset(new data::Logic(
742 logic_channel_count));
747 // Make the signals list
748 for (std::shared_ptr<views::ViewBase> viewbase : views_) {
749 views::TraceView::View *trace_view =
750 qobject_cast<views::TraceView::View*>(viewbase.get());
753 unordered_set< shared_ptr<views::TraceView::Signal> >
754 prev_sigs(trace_view->signals());
755 trace_view->clear_signals();
757 for (auto channel : sr_dev->channels()) {
758 shared_ptr<data::SignalBase> signalbase;
759 shared_ptr<views::TraceView::Signal> signal;
761 // Find the channel in the old signals
762 const auto iter = std::find_if(
763 prev_sigs.cbegin(), prev_sigs.cend(),
764 [&](const shared_ptr<views::TraceView::Signal> &s) {
765 return s->base()->channel() == channel;
767 if (iter != prev_sigs.end()) {
768 // Copy the signal from the old set to the new
770 trace_view->add_signal(signal);
772 // Find the signalbase for this channel if possible
774 for (const shared_ptr<data::SignalBase> b : signalbases_)
775 if (b->channel() == channel)
778 switch(channel->type()->id()) {
779 case SR_CHANNEL_LOGIC:
781 signalbase = make_shared<data::SignalBase>(channel);
782 signalbases_.insert(signalbase);
784 all_signal_data_.insert(logic_data_);
785 signalbase->set_data(logic_data_);
788 signal = shared_ptr<views::TraceView::Signal>(
789 new views::TraceView::LogicSignal(*this,
790 device_, signalbase));
791 trace_view->add_signal(signal);
794 case SR_CHANNEL_ANALOG:
797 signalbase = make_shared<data::SignalBase>(channel);
798 signalbases_.insert(signalbase);
800 shared_ptr<data::Analog> data(new data::Analog());
801 all_signal_data_.insert(data);
802 signalbase->set_data(data);
805 signal = shared_ptr<views::TraceView::Signal>(
806 new views::TraceView::AnalogSignal(
808 trace_view->add_signal(signal);
824 shared_ptr<data::SignalBase> Session::signalbase_from_channel(
825 shared_ptr<sigrok::Channel> channel) const
827 for (shared_ptr<data::SignalBase> sig : signalbases_) {
829 if (sig->channel() == channel)
832 return shared_ptr<data::SignalBase>();
835 void Session::sample_thread_proc(function<void (const QString)> error_handler)
837 assert(error_handler);
842 cur_samplerate_ = device_->read_config<uint64_t>(ConfigKey::SAMPLERATE);
844 out_of_memory_ = false;
849 error_handler(e.what());
853 set_capture_state(device_->session()->trigger() ?
854 AwaitingTrigger : Running);
857 set_capture_state(Stopped);
859 // Confirm that SR_DF_END was received
860 if (cur_logic_segment_) {
861 qDebug("SR_DF_END was not received.");
865 // Optimize memory usage
866 free_unused_memory();
868 // We now have unsaved data unless we just "captured" from a file
869 shared_ptr<devices::File> file_device =
870 dynamic_pointer_cast<devices::File>(device_);
876 error_handler(tr("Out of memory, acquisition stopped."));
879 void Session::free_unused_memory()
881 for (shared_ptr<data::SignalData> data : all_signal_data_) {
882 const vector< shared_ptr<data::Segment> > segments = data->segments();
884 for (shared_ptr<data::Segment> segment : segments) {
885 segment->free_unused_memory();
890 void Session::feed_in_header()
892 cur_samplerate_ = device_->read_config<uint64_t>(ConfigKey::SAMPLERATE);
895 void Session::feed_in_meta(shared_ptr<Meta> meta)
897 for (auto entry : meta->config()) {
898 switch (entry.first->id()) {
899 case SR_CONF_SAMPLERATE:
900 // We can't rely on the header to always contain the sample rate,
901 // so in case it's supplied via a meta packet, we use it.
902 if (!cur_samplerate_)
903 cur_samplerate_ = g_variant_get_uint64(entry.second.gobj());
905 /// @todo handle samplerate changes
908 // Unknown metadata is not an error.
916 void Session::feed_in_trigger()
918 // The channel containing most samples should be most accurate
919 uint64_t sample_count = 0;
922 for (const shared_ptr<pv::data::SignalData> d : all_signal_data_) {
924 uint64_t temp_count = 0;
926 const vector< shared_ptr<pv::data::Segment> > segments =
928 for (const shared_ptr<pv::data::Segment> &s : segments)
929 temp_count += s->get_sample_count();
931 if (temp_count > sample_count)
932 sample_count = temp_count;
936 trigger_event(sample_count / get_samplerate());
939 void Session::feed_in_frame_begin()
941 if (cur_logic_segment_ || !cur_analog_segments_.empty())
945 void Session::feed_in_logic(shared_ptr<Logic> logic)
947 lock_guard<recursive_mutex> lock(data_mutex_);
950 // The only reason logic_data_ would not have been created is
951 // if it was not possible to determine the signals when the
952 // device was created.
956 if (!cur_logic_segment_) {
957 // This could be the first packet after a trigger
958 set_capture_state(Running);
960 // Create a new data segment
961 cur_logic_segment_ = make_shared<data::LogicSegment>(
962 *logic_data_, logic, cur_samplerate_);
963 logic_data_->push_segment(cur_logic_segment_);
965 // @todo Putting this here means that only listeners querying
966 // for logic will be notified. Currently the only user of
967 // frame_began is DecoderStack, but in future we need to signal
968 // this after both analog and logic sweeps have begun.
971 // Append to the existing data segment
972 cur_logic_segment_->append_payload(logic);
978 void Session::feed_in_analog(shared_ptr<Analog> analog)
980 lock_guard<recursive_mutex> lock(data_mutex_);
982 const vector<shared_ptr<Channel>> channels = analog->channels();
983 const unsigned int channel_count = channels.size();
984 const size_t sample_count = analog->num_samples() / channel_count;
985 const float *data = static_cast<const float *>(analog->data_pointer());
986 bool sweep_beginning = false;
988 if (signalbases_.empty())
991 for (auto channel : channels) {
992 shared_ptr<data::AnalogSegment> segment;
994 // Try to get the segment of the channel
995 const map< shared_ptr<Channel>, shared_ptr<data::AnalogSegment> >::
996 iterator iter = cur_analog_segments_.find(channel);
997 if (iter != cur_analog_segments_.end())
998 segment = (*iter).second;
1000 // If no segment was found, this means we haven't
1001 // created one yet. i.e. this is the first packet
1002 // in the sweep containing this segment.
1003 sweep_beginning = true;
1005 // Find the analog data associated with the channel
1006 shared_ptr<data::SignalBase> base = signalbase_from_channel(channel);
1009 shared_ptr<data::Analog> data(base->analog_data());
1012 // Create a segment, keep it in the maps of channels
1013 segment = make_shared<data::AnalogSegment>(
1014 *data, cur_samplerate_);
1015 cur_analog_segments_[channel] = segment;
1017 // Push the segment into the analog data.
1018 data->push_segment(segment);
1023 // Append the samples in the segment
1024 segment->append_interleaved_samples(data++, sample_count,
1028 if (sweep_beginning) {
1029 // This could be the first packet after a trigger
1030 set_capture_state(Running);
1036 void Session::data_feed_in(shared_ptr<sigrok::Device> device,
1037 shared_ptr<Packet> packet)
1039 static bool frame_began=false;
1044 assert(device == device_->device());
1047 switch (packet->type()->id()) {
1053 feed_in_meta(dynamic_pointer_cast<Meta>(packet->payload()));
1060 case SR_DF_FRAME_BEGIN:
1061 feed_in_frame_begin();
1067 feed_in_logic(dynamic_pointer_cast<Logic>(packet->payload()));
1068 } catch (std::bad_alloc) {
1069 out_of_memory_ = true;
1076 feed_in_analog(dynamic_pointer_cast<Analog>(packet->payload()));
1077 } catch (std::bad_alloc) {
1078 out_of_memory_ = true;
1083 case SR_DF_FRAME_END:
1087 lock_guard<recursive_mutex> lock(data_mutex_);
1088 cur_logic_segment_.reset();
1089 cur_analog_segments_.clear();
1092 frame_began = false;
1102 void Session::on_data_saved()