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 const std::list< std::shared_ptr<pv::view::View> > Session::views() const
156 std::shared_ptr<pv::view::View> Session::main_view() const
161 void Session::set_main_bar(std::shared_ptr<pv::toolbars::MainBar> main_bar)
163 main_bar_ = main_bar;
166 shared_ptr<pv::toolbars::MainBar> Session::main_bar() const
171 void Session::save_settings(QSettings &settings) const
173 map<string, string> dev_info;
174 list<string> key_list;
175 int stacks = 0, views = 0;
178 shared_ptr<devices::HardwareDevice> hw_device =
179 dynamic_pointer_cast< devices::HardwareDevice >(device_);
182 settings.setValue("device_type", "hardware");
183 settings.beginGroup("device");
185 key_list.push_back("vendor");
186 key_list.push_back("model");
187 key_list.push_back("version");
188 key_list.push_back("serial_num");
189 key_list.push_back("connection_id");
191 dev_info = device_manager_.get_device_info(device_);
193 for (string key : key_list) {
194 if (dev_info.count(key))
195 settings.setValue(QString::fromUtf8(key.c_str()),
196 QString::fromUtf8(dev_info.at(key).c_str()));
198 settings.remove(QString::fromUtf8(key.c_str()));
204 shared_ptr<devices::SessionFile> sessionfile_device =
205 dynamic_pointer_cast< devices::SessionFile >(device_);
207 if (sessionfile_device) {
208 settings.setValue("device_type", "sessionfile");
209 settings.beginGroup("device");
210 settings.setValue("filename", QString::fromStdString(
211 sessionfile_device->full_name()));
215 // Save channels and decoders
216 for (shared_ptr<data::SignalBase> base : signalbases_) {
218 if (base->is_decode_signal()) {
219 shared_ptr<pv::data::DecoderStack> decoder_stack =
220 base->decoder_stack();
221 std::shared_ptr<data::decode::Decoder> top_decoder =
222 decoder_stack->stack().front();
224 settings.beginGroup("decoder_stack" + QString::number(stacks++));
225 settings.setValue("id", top_decoder->decoder()->id);
226 settings.setValue("name", top_decoder->decoder()->name);
231 settings.beginGroup(base->internal_name());
232 base->save_settings(settings);
237 settings.setValue("decoder_stacks", stacks);
239 // Save view states and their signal settings
240 // Note: main_view must be saved as view0
241 settings.beginGroup("view" + QString::number(views++));
242 main_view_->save_settings(settings);
245 for (shared_ptr<view::View> view : views_) {
246 if (view != main_view_) {
247 settings.beginGroup("view" + QString::number(views++));
248 view->save_settings(settings);
253 settings.setValue("views", views);
257 void Session::restore_settings(QSettings &settings)
259 shared_ptr<devices::Device> device;
261 QString device_type = settings.value("device_type").toString();
263 if (device_type == "hardware") {
264 map<string, string> dev_info;
265 list<string> key_list;
267 // Re-select last used device if possible but only if it's not demo
268 settings.beginGroup("device");
269 key_list.push_back("vendor");
270 key_list.push_back("model");
271 key_list.push_back("version");
272 key_list.push_back("serial_num");
273 key_list.push_back("connection_id");
275 for (string key : key_list) {
276 const QString k = QString::fromStdString(key);
277 if (!settings.contains(k))
280 const string value = settings.value(k).toString().toStdString();
282 dev_info.insert(std::make_pair(key, value));
285 if (dev_info.count("model") > 0)
286 device = device_manager_.find_device_from_info(dev_info);
294 if (device_type == "sessionfile") {
295 settings.beginGroup("device");
296 QString filename = settings.value("filename").toString();
299 if (QFileInfo(filename).isReadable()) {
300 device = std::make_shared<devices::SessionFile>(device_manager_.context(),
301 filename.toStdString());
305 // TODO Perform error handling
306 start_capture([](QString infoMessage) { (void)infoMessage; });
312 for (shared_ptr<data::SignalBase> base : signalbases_) {
313 settings.beginGroup(base->internal_name());
314 base->restore_settings(settings);
320 int stacks = settings.value("decoder_stacks").toInt();
322 for (int i = 0; i < stacks; i++) {
323 settings.beginGroup("decoder_stack" + QString::number(i++));
325 QString id = settings.value("id").toString();
326 add_decoder(srd_decoder_get_by_id(id.toStdString().c_str()));
333 int views = settings.value("views").toInt();
335 for (int i = 0; i < views; i++) {
336 settings.beginGroup("view" + QString::number(i));
339 view::ViewType type = (view::ViewType)settings.value("type").toInt();
340 add_view(name_, type, this);
341 views_.back()->restore_settings(settings);
343 main_view_->restore_settings(settings);
350 void Session::set_device(shared_ptr<devices::Device> device)
354 // Ensure we are not capturing before setting the device
362 // Revert name back to default name (e.g. "Untitled-1") as the data is gone
363 name_ = default_name_;
366 // Remove all stored data
367 for (std::shared_ptr<pv::view::View> view : views_) {
368 view->clear_signals();
370 view->clear_decode_traces();
373 for (const shared_ptr<data::SignalData> d : all_signal_data_)
375 all_signal_data_.clear();
376 signalbases_.clear();
377 cur_logic_segment_.reset();
379 for (auto entry : cur_analog_segments_) {
380 shared_ptr<sigrok::Channel>(entry.first).reset();
381 shared_ptr<data::AnalogSegment>(entry.second).reset();
388 device_ = std::move(device);
392 } catch (const QString &e) {
398 device_->session()->add_datafeed_callback([=]
399 (shared_ptr<sigrok::Device> device, shared_ptr<Packet> packet) {
400 data_feed_in(device, packet);
407 void Session::set_default_device()
409 const list< shared_ptr<devices::HardwareDevice> > &devices =
410 device_manager_.devices();
415 // Try and find the demo device and select that by default
416 const auto iter = std::find_if(devices.begin(), devices.end(),
417 [] (const shared_ptr<devices::HardwareDevice> &d) {
418 return d->hardware_device()->driver()->name() ==
420 set_device((iter == devices.end()) ? devices.front() : *iter);
423 Session::capture_state Session::get_capture_state() const
425 lock_guard<mutex> lock(sampling_mutex_);
426 return capture_state_;
429 void Session::start_capture(function<void (const QString)> error_handler)
432 error_handler(tr("No active device set, can't start acquisition."));
438 // Check that at least one channel is enabled
439 const shared_ptr<sigrok::Device> sr_dev = device_->device();
441 const auto channels = sr_dev->channels();
442 if (!std::any_of(channels.begin(), channels.end(),
443 [](shared_ptr<Channel> channel) {
444 return channel->enabled(); })) {
445 error_handler(tr("No channels enabled."));
451 for (const shared_ptr<data::SignalData> d : all_signal_data_)
454 // Revert name back to default name (e.g. "Untitled-1") as the data is gone
455 name_ = default_name_;
459 sampling_thread_ = std::thread(
460 &Session::sample_thread_proc, this, error_handler);
463 void Session::stop_capture()
465 if (get_capture_state() != Stopped)
468 // Check that sampling stopped
469 if (sampling_thread_.joinable())
470 sampling_thread_.join();
473 void Session::register_view(std::shared_ptr<pv::view::View> view)
475 if (views_.empty()) {
479 views_.push_back(view);
482 void Session::deregister_view(std::shared_ptr<pv::view::View> view)
484 views_.remove_if([&](std::shared_ptr<pv::view::View> v) {
485 return v == view; });
487 if (views_.empty()) {
490 // Without a view there can be no main bar
495 bool Session::has_view(std::shared_ptr<pv::view::View> view)
497 for (std::shared_ptr<pv::view::View> v : views_)
504 double Session::get_samplerate() const
506 double samplerate = 0.0;
508 for (const shared_ptr<pv::data::SignalData> d : all_signal_data_) {
510 const vector< shared_ptr<pv::data::Segment> > segments =
512 for (const shared_ptr<pv::data::Segment> &s : segments)
513 samplerate = std::max(samplerate, s->samplerate());
515 // If there is no sample rate given we use samples as unit
516 if (samplerate == 0.0)
522 const std::unordered_set< std::shared_ptr<data::SignalBase> >
523 Session::signalbases() const
529 bool Session::add_decoder(srd_decoder *const dec)
531 map<const srd_channel*, shared_ptr<data::SignalBase> > channels;
532 shared_ptr<data::DecoderStack> decoder_stack;
535 // Create the decoder
536 decoder_stack = shared_ptr<data::DecoderStack>(
537 new data::DecoderStack(*this, dec));
539 // Make a list of all the channels
540 std::vector<const srd_channel*> all_channels;
541 for (const GSList *i = dec->channels; i; i = i->next)
542 all_channels.push_back((const srd_channel*)i->data);
543 for (const GSList *i = dec->opt_channels; i; i = i->next)
544 all_channels.push_back((const srd_channel*)i->data);
546 // Auto select the initial channels
547 for (const srd_channel *pdch : all_channels)
548 for (shared_ptr<data::SignalBase> b : signalbases_) {
549 if (b->type() == ChannelType::LOGIC) {
550 if (QString::fromUtf8(pdch->name).toLower().
551 contains(b->name().toLower()))
556 assert(decoder_stack);
557 assert(!decoder_stack->stack().empty());
558 assert(decoder_stack->stack().front());
559 decoder_stack->stack().front()->set_channels(channels);
561 // Create the decode signal
562 shared_ptr<data::SignalBase> signalbase =
563 shared_ptr<data::SignalBase>(new data::SignalBase(nullptr));
565 signalbase->set_decoder_stack(decoder_stack);
566 signalbases_.insert(signalbase);
568 for (std::shared_ptr<pv::view::View> view : views_)
569 view->add_decode_trace(signalbase);
570 } catch (std::runtime_error e) {
576 // Do an initial decode
577 decoder_stack->begin_decode();
582 void Session::remove_decode_signal(shared_ptr<data::SignalBase> signalbase)
584 for (std::shared_ptr<pv::view::View> view : views_)
585 view->remove_decode_trace(signalbase);
589 void Session::set_capture_state(capture_state state)
594 lock_guard<mutex> lock(sampling_mutex_);
595 changed = capture_state_ != state;
596 capture_state_ = state;
600 capture_state_changed(state);
603 void Session::update_signals()
606 signalbases_.clear();
608 for (std::shared_ptr<pv::view::View> view : views_) {
609 view->clear_signals();
611 view->clear_decode_traces();
617 lock_guard<recursive_mutex> lock(data_mutex_);
619 const shared_ptr<sigrok::Device> sr_dev = device_->device();
621 signalbases_.clear();
623 for (std::shared_ptr<pv::view::View> view : views_) {
624 view->clear_signals();
626 view->clear_decode_traces();
632 // Detect what data types we will receive
633 auto channels = sr_dev->channels();
634 unsigned int logic_channel_count = std::count_if(
635 channels.begin(), channels.end(),
636 [] (shared_ptr<Channel> channel) {
637 return channel->type() == ChannelType::LOGIC; });
639 // Create data containers for the logic data segments
641 lock_guard<recursive_mutex> data_lock(data_mutex_);
643 if (logic_channel_count == 0) {
645 } else if (!logic_data_ ||
646 logic_data_->num_channels() != logic_channel_count) {
647 logic_data_.reset(new data::Logic(
648 logic_channel_count));
653 // Make the signals list
654 for (std::shared_ptr<pv::view::View> view : views_) {
655 unordered_set< shared_ptr<view::Signal> > prev_sigs(view->signals());
656 view->clear_signals();
658 for (auto channel : sr_dev->channels()) {
659 shared_ptr<data::SignalBase> signalbase;
660 shared_ptr<view::Signal> signal;
662 // Find the channel in the old signals
663 const auto iter = std::find_if(
664 prev_sigs.cbegin(), prev_sigs.cend(),
665 [&](const shared_ptr<view::Signal> &s) {
666 return s->base()->channel() == channel;
668 if (iter != prev_sigs.end()) {
669 // Copy the signal from the old set to the new
672 // Find the signalbase for this channel if possible
674 for (const shared_ptr<data::SignalBase> b : signalbases_)
675 if (b->channel() == channel)
678 switch(channel->type()->id()) {
679 case SR_CHANNEL_LOGIC:
681 signalbase = shared_ptr<data::SignalBase>(
682 new data::SignalBase(channel));
683 signalbases_.insert(signalbase);
685 all_signal_data_.insert(logic_data_);
686 signalbase->set_data(logic_data_);
689 signal = shared_ptr<view::Signal>(
690 new view::LogicSignal(*this,
691 device_, signalbase));
692 view->add_signal(signal);
695 case SR_CHANNEL_ANALOG:
698 signalbase = shared_ptr<data::SignalBase>(
699 new data::SignalBase(channel));
700 signalbases_.insert(signalbase);
702 shared_ptr<data::Analog> data(new data::Analog());
703 all_signal_data_.insert(data);
704 signalbase->set_data(data);
707 signal = shared_ptr<view::Signal>(
708 new view::AnalogSignal(
710 view->add_signal(signal);
725 shared_ptr<data::SignalBase> Session::signalbase_from_channel(
726 shared_ptr<sigrok::Channel> channel) const
728 for (shared_ptr<data::SignalBase> sig : signalbases_) {
730 if (sig->channel() == channel)
733 return shared_ptr<data::SignalBase>();
736 void Session::sample_thread_proc(function<void (const QString)> error_handler)
738 assert(error_handler);
743 cur_samplerate_ = device_->read_config<uint64_t>(ConfigKey::SAMPLERATE);
745 out_of_memory_ = false;
750 error_handler(e.what());
754 set_capture_state(device_->session()->trigger() ?
755 AwaitingTrigger : Running);
758 set_capture_state(Stopped);
760 // Confirm that SR_DF_END was received
761 if (cur_logic_segment_) {
762 qDebug("SR_DF_END was not received.");
767 error_handler(tr("Out of memory, acquisition stopped."));
770 void Session::feed_in_header()
772 cur_samplerate_ = device_->read_config<uint64_t>(ConfigKey::SAMPLERATE);
775 void Session::feed_in_meta(shared_ptr<Meta> meta)
777 for (auto entry : meta->config()) {
778 switch (entry.first->id()) {
779 case SR_CONF_SAMPLERATE:
780 // We can't rely on the header to always contain the sample rate,
781 // so in case it's supplied via a meta packet, we use it.
782 if (!cur_samplerate_)
783 cur_samplerate_ = g_variant_get_uint64(entry.second.gobj());
785 /// @todo handle samplerate changes
788 // Unknown metadata is not an error.
796 void Session::feed_in_trigger()
798 // The channel containing most samples should be most accurate
799 uint64_t sample_count = 0;
802 for (const shared_ptr<pv::data::SignalData> d : all_signal_data_) {
804 uint64_t temp_count = 0;
806 const vector< shared_ptr<pv::data::Segment> > segments =
808 for (const shared_ptr<pv::data::Segment> &s : segments)
809 temp_count += s->get_sample_count();
811 if (temp_count > sample_count)
812 sample_count = temp_count;
816 trigger_event(sample_count / get_samplerate());
819 void Session::feed_in_frame_begin()
821 if (cur_logic_segment_ || !cur_analog_segments_.empty())
825 void Session::feed_in_logic(shared_ptr<Logic> logic)
827 lock_guard<recursive_mutex> lock(data_mutex_);
829 const size_t sample_count = logic->data_length() / logic->unit_size();
832 // The only reason logic_data_ would not have been created is
833 // if it was not possible to determine the signals when the
834 // device was created.
838 if (!cur_logic_segment_) {
839 // This could be the first packet after a trigger
840 set_capture_state(Running);
842 // Create a new data segment
843 cur_logic_segment_ = shared_ptr<data::LogicSegment>(
844 new data::LogicSegment(
845 logic, cur_samplerate_, sample_count));
846 logic_data_->push_segment(cur_logic_segment_);
848 // @todo Putting this here means that only listeners querying
849 // for logic will be notified. Currently the only user of
850 // frame_began is DecoderStack, but in future we need to signal
851 // this after both analog and logic sweeps have begun.
854 // Append to the existing data segment
855 cur_logic_segment_->append_payload(logic);
861 void Session::feed_in_analog(shared_ptr<Analog> analog)
863 lock_guard<recursive_mutex> lock(data_mutex_);
865 const vector<shared_ptr<Channel>> channels = analog->channels();
866 const unsigned int channel_count = channels.size();
867 const size_t sample_count = analog->num_samples() / channel_count;
868 const float *data = static_cast<const float *>(analog->data_pointer());
869 bool sweep_beginning = false;
871 if (signalbases_.empty())
874 for (auto channel : channels) {
875 shared_ptr<data::AnalogSegment> segment;
877 // Try to get the segment of the channel
878 const map< shared_ptr<Channel>, shared_ptr<data::AnalogSegment> >::
879 iterator iter = cur_analog_segments_.find(channel);
880 if (iter != cur_analog_segments_.end())
881 segment = (*iter).second;
883 // If no segment was found, this means we haven't
884 // created one yet. i.e. this is the first packet
885 // in the sweep containing this segment.
886 sweep_beginning = true;
888 // Create a segment, keep it in the maps of channels
889 segment = shared_ptr<data::AnalogSegment>(
890 new data::AnalogSegment(
891 cur_samplerate_, sample_count));
892 cur_analog_segments_[channel] = segment;
894 // Find the analog data associated with the channel
895 shared_ptr<data::SignalBase> base = signalbase_from_channel(channel);
898 shared_ptr<data::Analog> data(base->analog_data());
901 // Push the segment into the analog data.
902 data->push_segment(segment);
907 // Append the samples in the segment
908 segment->append_interleaved_samples(data++, sample_count,
912 if (sweep_beginning) {
913 // This could be the first packet after a trigger
914 set_capture_state(Running);
920 void Session::data_feed_in(shared_ptr<sigrok::Device> device,
921 shared_ptr<Packet> packet)
926 assert(device == device_->device());
929 switch (packet->type()->id()) {
935 feed_in_meta(dynamic_pointer_cast<Meta>(packet->payload()));
942 case SR_DF_FRAME_BEGIN:
943 feed_in_frame_begin();
948 feed_in_logic(dynamic_pointer_cast<Logic>(packet->payload()));
949 } catch (std::bad_alloc) {
950 out_of_memory_ = true;
957 feed_in_analog(dynamic_pointer_cast<Analog>(packet->payload()));
958 } catch (std::bad_alloc) {
959 out_of_memory_ = true;
967 lock_guard<recursive_mutex> lock(data_mutex_);
968 cur_logic_segment_.reset();
969 cur_analog_segments_.clear();