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;
80 using std::unordered_set;
84 using sigrok::Channel;
85 using sigrok::ChannelType;
86 using sigrok::ConfigKey;
87 using sigrok::DatafeedCallbackFunction;
90 using sigrok::InputFormat;
93 using sigrok::OutputFormat;
95 using sigrok::PacketPayload;
96 using sigrok::Session;
97 using sigrok::SessionDevice;
99 using Glib::VariantBase;
103 Session::Session(DeviceManager &device_manager, QString name) :
104 device_manager_(device_manager),
107 capture_state_(Stopped),
115 // Stop and join to the thread
119 DeviceManager& Session::device_manager()
121 return device_manager_;
124 const DeviceManager& Session::device_manager() const
126 return device_manager_;
129 shared_ptr<sigrok::Session> Session::session() const
132 return shared_ptr<sigrok::Session>();
133 return device_->session();
136 shared_ptr<devices::Device> Session::device() const
141 QString Session::name() const
146 void Session::set_name(QString name)
148 if (default_name_.isEmpty())
149 default_name_ = name;
156 const std::list< std::shared_ptr<views::ViewBase> > Session::views() const
161 std::shared_ptr<views::ViewBase> Session::main_view() const
166 void Session::set_main_bar(std::shared_ptr<pv::toolbars::MainBar> main_bar)
168 main_bar_ = main_bar;
171 shared_ptr<pv::toolbars::MainBar> Session::main_bar() const
176 bool Session::data_saved() const
181 void Session::save_settings(QSettings &settings) const
183 map<string, string> dev_info;
184 list<string> key_list;
185 int stacks = 0, views = 0;
188 shared_ptr<devices::HardwareDevice> hw_device =
189 dynamic_pointer_cast< devices::HardwareDevice >(device_);
192 settings.setValue("device_type", "hardware");
193 settings.beginGroup("device");
195 key_list.push_back("vendor");
196 key_list.push_back("model");
197 key_list.push_back("version");
198 key_list.push_back("serial_num");
199 key_list.push_back("connection_id");
201 dev_info = device_manager_.get_device_info(device_);
203 for (string key : key_list) {
204 if (dev_info.count(key))
205 settings.setValue(QString::fromUtf8(key.c_str()),
206 QString::fromUtf8(dev_info.at(key).c_str()));
208 settings.remove(QString::fromUtf8(key.c_str()));
214 shared_ptr<devices::SessionFile> sessionfile_device =
215 dynamic_pointer_cast< devices::SessionFile >(device_);
217 if (sessionfile_device) {
218 settings.setValue("device_type", "sessionfile");
219 settings.beginGroup("device");
220 settings.setValue("filename", QString::fromStdString(
221 sessionfile_device->full_name()));
225 // Save channels and decoders
226 for (shared_ptr<data::SignalBase> base : signalbases_) {
228 if (base->is_decode_signal()) {
229 shared_ptr<pv::data::DecoderStack> decoder_stack =
230 base->decoder_stack();
231 std::shared_ptr<data::decode::Decoder> top_decoder =
232 decoder_stack->stack().front();
234 settings.beginGroup("decoder_stack" + QString::number(stacks++));
235 settings.setValue("id", top_decoder->decoder()->id);
236 settings.setValue("name", top_decoder->decoder()->name);
241 settings.beginGroup(base->internal_name());
242 base->save_settings(settings);
247 settings.setValue("decoder_stacks", stacks);
249 // Save view states and their signal settings
250 // Note: main_view must be saved as view0
251 settings.beginGroup("view" + QString::number(views++));
252 main_view_->save_settings(settings);
255 for (shared_ptr<views::ViewBase> view : views_) {
256 if (view != main_view_) {
257 settings.beginGroup("view" + QString::number(views++));
258 view->save_settings(settings);
263 settings.setValue("views", views);
267 void Session::restore_settings(QSettings &settings)
269 shared_ptr<devices::Device> device;
271 QString device_type = settings.value("device_type").toString();
273 if (device_type == "hardware") {
274 map<string, string> dev_info;
275 list<string> key_list;
277 // Re-select last used device if possible but only if it's not demo
278 settings.beginGroup("device");
279 key_list.push_back("vendor");
280 key_list.push_back("model");
281 key_list.push_back("version");
282 key_list.push_back("serial_num");
283 key_list.push_back("connection_id");
285 for (string key : key_list) {
286 const QString k = QString::fromStdString(key);
287 if (!settings.contains(k))
290 const string value = settings.value(k).toString().toStdString();
292 dev_info.insert(std::make_pair(key, value));
295 if (dev_info.count("model") > 0)
296 device = device_manager_.find_device_from_info(dev_info);
304 if (device_type == "sessionfile") {
305 settings.beginGroup("device");
306 QString filename = settings.value("filename").toString();
309 if (QFileInfo(filename).isReadable()) {
310 device = std::make_shared<devices::SessionFile>(device_manager_.context(),
311 filename.toStdString());
314 // TODO Perform error handling
315 start_capture([](QString infoMessage) { (void)infoMessage; });
317 set_name(QFileInfo(filename).fileName());
323 for (shared_ptr<data::SignalBase> base : signalbases_) {
324 settings.beginGroup(base->internal_name());
325 base->restore_settings(settings);
331 int stacks = settings.value("decoder_stacks").toInt();
333 for (int i = 0; i < stacks; i++) {
334 settings.beginGroup("decoder_stack" + QString::number(i++));
336 QString id = settings.value("id").toString();
337 add_decoder(srd_decoder_get_by_id(id.toStdString().c_str()));
344 int views = settings.value("views").toInt();
346 for (int i = 0; i < views; i++) {
347 settings.beginGroup("view" + QString::number(i));
350 views::ViewType type = (views::ViewType)settings.value("type").toInt();
351 add_view(name_, type, this);
352 views_.back()->restore_settings(settings);
354 main_view_->restore_settings(settings);
361 void Session::select_device(shared_ptr<devices::Device> device)
367 set_default_device();
368 } catch (const QString &e) {
369 main_bar_->session_error(tr("Failed to Select Device"),
370 tr("Failed to Select Device"));
374 void Session::set_device(shared_ptr<devices::Device> device)
378 // Ensure we are not capturing before setting the device
386 // Revert name back to default name (e.g. "Session 1") as the data is gone
387 name_ = default_name_;
390 // Remove all stored data
391 for (std::shared_ptr<views::ViewBase> view : views_) {
392 view->clear_signals();
394 view->clear_decode_signals();
397 for (const shared_ptr<data::SignalData> d : all_signal_data_)
399 all_signal_data_.clear();
400 signalbases_.clear();
401 cur_logic_segment_.reset();
403 for (auto entry : cur_analog_segments_) {
404 shared_ptr<sigrok::Channel>(entry.first).reset();
405 shared_ptr<data::AnalogSegment>(entry.second).reset();
412 device_ = std::move(device);
416 } catch (const QString &e) {
421 device_->session()->add_datafeed_callback([=]
422 (shared_ptr<sigrok::Device> device, shared_ptr<Packet> packet) {
423 data_feed_in(device, packet);
432 void Session::set_default_device()
434 const list< shared_ptr<devices::HardwareDevice> > &devices =
435 device_manager_.devices();
440 // Try and find the demo device and select that by default
441 const auto iter = std::find_if(devices.begin(), devices.end(),
442 [] (const shared_ptr<devices::HardwareDevice> &d) {
443 return d->hardware_device()->driver()->name() ==
445 set_device((iter == devices.end()) ? devices.front() : *iter);
448 void Session::load_init_file(const std::string &file_name,
449 const std::string &format)
451 shared_ptr<InputFormat> input_format;
453 if (!format.empty()) {
454 const map<string, shared_ptr<InputFormat> > formats =
455 device_manager_.context()->input_formats();
456 const auto iter = find_if(formats.begin(), formats.end(),
457 [&](const pair<string, shared_ptr<InputFormat> > f) {
458 return f.first == format; });
459 if (iter == formats.end()) {
460 main_bar_->session_error(tr("Error"),
461 tr("Unexpected input format: %s").arg(QString::fromStdString(format)));
465 input_format = (*iter).second;
468 load_file(QString::fromStdString(file_name), input_format);
471 void Session::load_file(QString file_name,
472 std::shared_ptr<sigrok::InputFormat> format,
473 const std::map<std::string, Glib::VariantBase> &options)
475 const QString errorMessage(
476 QString("Failed to load file %1").arg(file_name));
480 set_device(shared_ptr<devices::Device>(
481 new devices::InputFile(
482 device_manager_.context(),
483 file_name.toStdString(),
486 set_device(shared_ptr<devices::Device>(
487 new devices::SessionFile(
488 device_manager_.context(),
489 file_name.toStdString())));
491 main_bar_->session_error(tr("Failed to load ") + file_name, e.what());
492 set_default_device();
493 main_bar_->update_device_list();
497 main_bar_->update_device_list();
499 start_capture([&, errorMessage](QString infoMessage) {
500 main_bar_->session_error(errorMessage, infoMessage); });
502 set_name(QFileInfo(file_name).fileName());
505 Session::capture_state Session::get_capture_state() const
507 lock_guard<mutex> lock(sampling_mutex_);
508 return capture_state_;
511 void Session::start_capture(function<void (const QString)> error_handler)
514 error_handler(tr("No active device set, can't start acquisition."));
520 // Check that at least one channel is enabled
521 const shared_ptr<sigrok::Device> sr_dev = device_->device();
523 const auto channels = sr_dev->channels();
524 if (!std::any_of(channels.begin(), channels.end(),
525 [](shared_ptr<Channel> channel) {
526 return channel->enabled(); })) {
527 error_handler(tr("No channels enabled."));
533 for (const shared_ptr<data::SignalData> d : all_signal_data_)
536 // Revert name back to default name (e.g. "Session 1") as the data is gone
537 name_ = default_name_;
541 sampling_thread_ = std::thread(
542 &Session::sample_thread_proc, this, error_handler);
545 void Session::stop_capture()
547 if (get_capture_state() != Stopped)
550 // Check that sampling stopped
551 if (sampling_thread_.joinable())
552 sampling_thread_.join();
555 void Session::register_view(std::shared_ptr<views::ViewBase> view)
557 if (views_.empty()) {
561 views_.push_back(view);
566 void Session::deregister_view(std::shared_ptr<views::ViewBase> view)
568 views_.remove_if([&](std::shared_ptr<views::ViewBase> v) {
569 return v == view; });
571 if (views_.empty()) {
574 // Without a view there can be no main bar
579 bool Session::has_view(std::shared_ptr<views::ViewBase> view)
581 for (std::shared_ptr<views::ViewBase> v : views_)
588 double Session::get_samplerate() const
590 double samplerate = 0.0;
592 for (const shared_ptr<pv::data::SignalData> d : all_signal_data_) {
594 const vector< shared_ptr<pv::data::Segment> > segments =
596 for (const shared_ptr<pv::data::Segment> &s : segments)
597 samplerate = std::max(samplerate, s->samplerate());
599 // If there is no sample rate given we use samples as unit
600 if (samplerate == 0.0)
606 const std::unordered_set< std::shared_ptr<data::SignalBase> >
607 Session::signalbases() const
613 bool Session::add_decoder(srd_decoder *const dec)
615 map<const srd_channel*, shared_ptr<data::SignalBase> > channels;
616 shared_ptr<data::DecoderStack> decoder_stack;
619 // Create the decoder
620 decoder_stack = shared_ptr<data::DecoderStack>(
621 new data::DecoderStack(*this, dec));
623 // Make a list of all the channels
624 std::vector<const srd_channel*> all_channels;
625 for (const GSList *i = dec->channels; i; i = i->next)
626 all_channels.push_back((const srd_channel*)i->data);
627 for (const GSList *i = dec->opt_channels; i; i = i->next)
628 all_channels.push_back((const srd_channel*)i->data);
630 // Auto select the initial channels
631 for (const srd_channel *pdch : all_channels)
632 for (shared_ptr<data::SignalBase> b : signalbases_) {
633 if (b->type() == ChannelType::LOGIC) {
634 if (QString::fromUtf8(pdch->name).toLower().
635 contains(b->name().toLower()))
640 assert(decoder_stack);
641 assert(!decoder_stack->stack().empty());
642 assert(decoder_stack->stack().front());
643 decoder_stack->stack().front()->set_channels(channels);
645 // Create the decode signal
646 shared_ptr<data::SignalBase> signalbase =
647 shared_ptr<data::SignalBase>(new data::SignalBase(nullptr));
649 signalbase->set_decoder_stack(decoder_stack);
650 signalbases_.insert(signalbase);
652 for (std::shared_ptr<views::ViewBase> view : views_)
653 view->add_decode_signal(signalbase);
654 } catch (std::runtime_error e) {
660 // Do an initial decode
661 decoder_stack->begin_decode();
666 void Session::remove_decode_signal(shared_ptr<data::SignalBase> signalbase)
668 signalbases_.erase(signalbase);
670 for (std::shared_ptr<views::ViewBase> view : views_)
671 view->remove_decode_signal(signalbase);
677 void Session::set_capture_state(capture_state state)
682 lock_guard<mutex> lock(sampling_mutex_);
683 changed = capture_state_ != state;
684 capture_state_ = state;
688 capture_state_changed(state);
691 void Session::update_signals()
694 signalbases_.clear();
696 for (std::shared_ptr<views::ViewBase> view : views_) {
697 view->clear_signals();
699 view->clear_decode_signals();
705 lock_guard<recursive_mutex> lock(data_mutex_);
707 const shared_ptr<sigrok::Device> sr_dev = device_->device();
709 signalbases_.clear();
711 for (std::shared_ptr<views::ViewBase> view : views_) {
712 view->clear_signals();
714 view->clear_decode_signals();
720 // Detect what data types we will receive
721 auto channels = sr_dev->channels();
722 unsigned int logic_channel_count = std::count_if(
723 channels.begin(), channels.end(),
724 [] (shared_ptr<Channel> channel) {
725 return channel->type() == ChannelType::LOGIC; });
727 // Create data containers for the logic data segments
729 lock_guard<recursive_mutex> data_lock(data_mutex_);
731 if (logic_channel_count == 0) {
733 } else if (!logic_data_ ||
734 logic_data_->num_channels() != logic_channel_count) {
735 logic_data_.reset(new data::Logic(
736 logic_channel_count));
741 // Make the signals list
742 for (std::shared_ptr<views::ViewBase> viewbase : views_) {
743 views::TraceView::View *trace_view =
744 qobject_cast<views::TraceView::View*>(viewbase.get());
747 unordered_set< shared_ptr<views::TraceView::Signal> >
748 prev_sigs(trace_view->signals());
749 trace_view->clear_signals();
751 for (auto channel : sr_dev->channels()) {
752 shared_ptr<data::SignalBase> signalbase;
753 shared_ptr<views::TraceView::Signal> signal;
755 // Find the channel in the old signals
756 const auto iter = std::find_if(
757 prev_sigs.cbegin(), prev_sigs.cend(),
758 [&](const shared_ptr<views::TraceView::Signal> &s) {
759 return s->base()->channel() == channel;
761 if (iter != prev_sigs.end()) {
762 // Copy the signal from the old set to the new
764 trace_view->add_signal(signal);
766 // Find the signalbase for this channel if possible
768 for (const shared_ptr<data::SignalBase> b : signalbases_)
769 if (b->channel() == channel)
772 switch(channel->type()->id()) {
773 case SR_CHANNEL_LOGIC:
775 signalbase = shared_ptr<data::SignalBase>(
776 new data::SignalBase(channel));
777 signalbases_.insert(signalbase);
779 all_signal_data_.insert(logic_data_);
780 signalbase->set_data(logic_data_);
783 signal = shared_ptr<views::TraceView::Signal>(
784 new views::TraceView::LogicSignal(*this,
785 device_, signalbase));
786 trace_view->add_signal(signal);
789 case SR_CHANNEL_ANALOG:
792 signalbase = shared_ptr<data::SignalBase>(
793 new data::SignalBase(channel));
794 signalbases_.insert(signalbase);
796 shared_ptr<data::Analog> data(new data::Analog());
797 all_signal_data_.insert(data);
798 signalbase->set_data(data);
801 signal = shared_ptr<views::TraceView::Signal>(
802 new views::TraceView::AnalogSignal(
804 trace_view->add_signal(signal);
820 shared_ptr<data::SignalBase> Session::signalbase_from_channel(
821 shared_ptr<sigrok::Channel> channel) const
823 for (shared_ptr<data::SignalBase> sig : signalbases_) {
825 if (sig->channel() == channel)
828 return shared_ptr<data::SignalBase>();
831 void Session::sample_thread_proc(function<void (const QString)> error_handler)
833 assert(error_handler);
838 cur_samplerate_ = device_->read_config<uint64_t>(ConfigKey::SAMPLERATE);
840 out_of_memory_ = false;
845 error_handler(e.what());
849 set_capture_state(device_->session()->trigger() ?
850 AwaitingTrigger : Running);
853 set_capture_state(Stopped);
855 // Confirm that SR_DF_END was received
856 if (cur_logic_segment_) {
857 qDebug("SR_DF_END was not received.");
861 // Optimize memory usage
862 free_unused_memory();
864 // We now have unsaved data unless we just "captured" from a file
865 shared_ptr<devices::File> file_device =
866 dynamic_pointer_cast<devices::File>(device_);
872 error_handler(tr("Out of memory, acquisition stopped."));
875 void Session::free_unused_memory()
877 for (shared_ptr<data::SignalData> data : all_signal_data_) {
878 const vector< shared_ptr<data::Segment> > segments = data->segments();
880 for (shared_ptr<data::Segment> segment : segments) {
881 segment->free_unused_memory();
886 void Session::feed_in_header()
888 cur_samplerate_ = device_->read_config<uint64_t>(ConfigKey::SAMPLERATE);
891 void Session::feed_in_meta(shared_ptr<Meta> meta)
893 for (auto entry : meta->config()) {
894 switch (entry.first->id()) {
895 case SR_CONF_SAMPLERATE:
896 // We can't rely on the header to always contain the sample rate,
897 // so in case it's supplied via a meta packet, we use it.
898 if (!cur_samplerate_)
899 cur_samplerate_ = g_variant_get_uint64(entry.second.gobj());
901 /// @todo handle samplerate changes
904 // Unknown metadata is not an error.
912 void Session::feed_in_trigger()
914 // The channel containing most samples should be most accurate
915 uint64_t sample_count = 0;
918 for (const shared_ptr<pv::data::SignalData> d : all_signal_data_) {
920 uint64_t temp_count = 0;
922 const vector< shared_ptr<pv::data::Segment> > segments =
924 for (const shared_ptr<pv::data::Segment> &s : segments)
925 temp_count += s->get_sample_count();
927 if (temp_count > sample_count)
928 sample_count = temp_count;
932 trigger_event(sample_count / get_samplerate());
935 void Session::feed_in_frame_begin()
937 if (cur_logic_segment_ || !cur_analog_segments_.empty())
941 void Session::feed_in_logic(shared_ptr<Logic> logic)
943 lock_guard<recursive_mutex> lock(data_mutex_);
946 // The only reason logic_data_ would not have been created is
947 // if it was not possible to determine the signals when the
948 // device was created.
952 if (!cur_logic_segment_) {
953 // This could be the first packet after a trigger
954 set_capture_state(Running);
956 // Create a new data segment
957 cur_logic_segment_ = shared_ptr<data::LogicSegment>(
958 new data::LogicSegment(*logic_data_, logic, cur_samplerate_));
959 logic_data_->push_segment(cur_logic_segment_);
961 // @todo Putting this here means that only listeners querying
962 // for logic will be notified. Currently the only user of
963 // frame_began is DecoderStack, but in future we need to signal
964 // this after both analog and logic sweeps have begun.
967 // Append to the existing data segment
968 cur_logic_segment_->append_payload(logic);
974 void Session::feed_in_analog(shared_ptr<Analog> analog)
976 lock_guard<recursive_mutex> lock(data_mutex_);
978 const vector<shared_ptr<Channel>> channels = analog->channels();
979 const unsigned int channel_count = channels.size();
980 const size_t sample_count = analog->num_samples() / channel_count;
981 const float *data = static_cast<const float *>(analog->data_pointer());
982 bool sweep_beginning = false;
984 if (signalbases_.empty())
987 for (auto channel : channels) {
988 shared_ptr<data::AnalogSegment> segment;
990 // Try to get the segment of the channel
991 const map< shared_ptr<Channel>, shared_ptr<data::AnalogSegment> >::
992 iterator iter = cur_analog_segments_.find(channel);
993 if (iter != cur_analog_segments_.end())
994 segment = (*iter).second;
996 // If no segment was found, this means we haven't
997 // created one yet. i.e. this is the first packet
998 // in the sweep containing this segment.
999 sweep_beginning = true;
1001 // Find the analog data associated with the channel
1002 shared_ptr<data::SignalBase> base = signalbase_from_channel(channel);
1005 shared_ptr<data::Analog> data(base->analog_data());
1008 // Create a segment, keep it in the maps of channels
1009 segment = shared_ptr<data::AnalogSegment>(
1010 new data::AnalogSegment(*data, cur_samplerate_));
1011 cur_analog_segments_[channel] = segment;
1013 // Push the segment into the analog data.
1014 data->push_segment(segment);
1019 // Append the samples in the segment
1020 segment->append_interleaved_samples(data++, sample_count,
1024 if (sweep_beginning) {
1025 // This could be the first packet after a trigger
1026 set_capture_state(Running);
1032 void Session::data_feed_in(shared_ptr<sigrok::Device> device,
1033 shared_ptr<Packet> packet)
1035 static bool frame_began=false;
1040 assert(device == device_->device());
1043 switch (packet->type()->id()) {
1049 feed_in_meta(dynamic_pointer_cast<Meta>(packet->payload()));
1056 case SR_DF_FRAME_BEGIN:
1057 feed_in_frame_begin();
1063 feed_in_logic(dynamic_pointer_cast<Logic>(packet->payload()));
1064 } catch (std::bad_alloc) {
1065 out_of_memory_ = true;
1072 feed_in_analog(dynamic_pointer_cast<Analog>(packet->payload()));
1073 } catch (std::bad_alloc) {
1074 out_of_memory_ = true;
1079 case SR_DF_FRAME_END:
1083 lock_guard<recursive_mutex> lock(data_mutex_);
1084 cur_logic_segment_.reset();
1085 cur_analog_segments_.clear();
1088 frame_began = false;
1098 void Session::on_data_saved()