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/decode/decoder.hpp"
44 #include "devices/hardwaredevice.hpp"
45 #include "devices/sessionfile.hpp"
47 #include "view/analogsignal.hpp"
48 #include "view/decodetrace.hpp"
49 #include "view/logicsignal.hpp"
59 #include <libsigrokcxx/libsigrokcxx.hpp>
61 using boost::shared_lock;
62 using boost::shared_mutex;
63 using boost::unique_lock;
65 using std::dynamic_pointer_cast;
67 using std::lock_guard;
71 using std::recursive_mutex;
73 using std::shared_ptr;
75 using std::unordered_set;
79 using sigrok::Channel;
80 using sigrok::ChannelType;
81 using sigrok::ConfigKey;
82 using sigrok::DatafeedCallbackFunction;
88 using sigrok::PacketPayload;
89 using sigrok::Session;
90 using sigrok::SessionDevice;
92 using Glib::VariantBase;
96 Session::Session(DeviceManager &device_manager) :
97 device_manager_(device_manager),
98 capture_state_(Stopped),
105 // Stop and join to the thread
109 DeviceManager& Session::device_manager()
111 return device_manager_;
114 const DeviceManager& Session::device_manager() const
116 return device_manager_;
119 shared_ptr<sigrok::Session> Session::session() const
122 return shared_ptr<sigrok::Session>();
123 return device_->session();
126 shared_ptr<devices::Device> Session::device() const
131 void Session::set_device(shared_ptr<devices::Device> device)
135 // Ensure we are not capturing before setting the device
141 device_ = std::move(device);
143 device_->session()->add_datafeed_callback([=]
144 (shared_ptr<sigrok::Device> device, shared_ptr<Packet> packet) {
145 data_feed_in(device, packet);
149 decode_traces_.clear();
154 void Session::set_default_device()
156 const list< shared_ptr<devices::HardwareDevice> > &devices =
157 device_manager_.devices();
162 // Try and find the demo device and select that by default
163 const auto iter = std::find_if(devices.begin(), devices.end(),
164 [] (const shared_ptr<devices::HardwareDevice> &d) {
165 return d->hardware_device()->driver()->name() ==
167 set_device((iter == devices.end()) ? devices.front() : *iter);
170 Session::capture_state Session::get_capture_state() const
172 lock_guard<mutex> lock(sampling_mutex_);
173 return capture_state_;
176 void Session::start_capture(function<void (const QString)> error_handler)
180 // Check that at least one channel is enabled
182 const shared_ptr<sigrok::Device> sr_dev = device_->device();
184 const auto channels = sr_dev->channels();
185 if (!std::any_of(channels.begin(), channels.end(),
186 [](shared_ptr<Channel> channel) {
187 return channel->enabled(); })) {
188 error_handler(tr("No channels enabled."));
194 for (const shared_ptr<data::SignalData> d : get_data())
198 sampling_thread_ = std::thread(
199 &Session::sample_thread_proc, this, device_,
203 void Session::stop_capture()
205 if (get_capture_state() != Stopped)
208 // Check that sampling stopped
209 if (sampling_thread_.joinable())
210 sampling_thread_.join();
213 set< shared_ptr<data::SignalData> > Session::get_data() const
215 shared_lock<shared_mutex> lock(signals_mutex_);
216 set< shared_ptr<data::SignalData> > data;
217 for (const shared_ptr<view::Signal> sig : signals_) {
219 data.insert(sig->data());
225 double Session::get_samplerate() const
227 double samplerate = 0.0;
229 for (const shared_ptr<pv::data::SignalData> d : get_data()) {
231 const vector< shared_ptr<pv::data::Segment> > segments =
233 for (const shared_ptr<pv::data::Segment> &s : segments)
234 samplerate = std::max(samplerate, s->samplerate());
237 // If there is no sample rate given we use samples as unit
238 if (samplerate == 0.0)
244 const unordered_set< shared_ptr<view::Signal> > Session::signals() const
246 shared_lock<shared_mutex> lock(signals_mutex_);
251 bool Session::add_decoder(srd_decoder *const dec)
253 map<const srd_channel*, shared_ptr<view::LogicSignal> > channels;
254 shared_ptr<data::DecoderStack> decoder_stack;
258 lock_guard<boost::shared_mutex> lock(signals_mutex_);
260 // Create the decoder
261 decoder_stack = shared_ptr<data::DecoderStack>(
262 new data::DecoderStack(*this, dec));
264 // Make a list of all the channels
265 std::vector<const srd_channel*> all_channels;
266 for (const GSList *i = dec->channels; i; i = i->next)
267 all_channels.push_back((const srd_channel*)i->data);
268 for (const GSList *i = dec->opt_channels; i; i = i->next)
269 all_channels.push_back((const srd_channel*)i->data);
271 // Auto select the initial channels
272 for (const srd_channel *pdch : all_channels)
273 for (shared_ptr<view::Signal> s : signals_)
275 shared_ptr<view::LogicSignal> l =
276 dynamic_pointer_cast<view::LogicSignal>(s);
277 if (l && QString::fromUtf8(pdch->name).
279 l->name().toLower()))
283 assert(decoder_stack);
284 assert(!decoder_stack->stack().empty());
285 assert(decoder_stack->stack().front());
286 decoder_stack->stack().front()->set_channels(channels);
288 // Create the decode signal
289 shared_ptr<view::DecodeTrace> d(
290 new view::DecodeTrace(*this, decoder_stack,
291 decode_traces_.size()));
292 decode_traces_.push_back(d);
294 catch(std::runtime_error e)
301 // Do an initial decode
302 decoder_stack->begin_decode();
307 vector< shared_ptr<view::DecodeTrace> > Session::get_decode_signals() const
309 shared_lock<shared_mutex> lock(signals_mutex_);
310 return decode_traces_;
313 void Session::remove_decode_signal(view::DecodeTrace *signal)
315 for (auto i = decode_traces_.begin(); i != decode_traces_.end(); i++)
316 if ((*i).get() == signal)
318 decode_traces_.erase(i);
325 void Session::set_capture_state(capture_state state)
327 lock_guard<mutex> lock(sampling_mutex_);
328 const bool changed = capture_state_ != state;
329 capture_state_ = state;
331 capture_state_changed(state);
334 void Session::update_signals()
338 lock_guard<recursive_mutex> lock(data_mutex_);
340 const shared_ptr<sigrok::Device> sr_dev = device_->device();
347 // Detect what data types we will receive
348 auto channels = sr_dev->channels();
349 unsigned int logic_channel_count = std::count_if(
350 channels.begin(), channels.end(),
351 [] (shared_ptr<Channel> channel) {
352 return channel->type() == ChannelType::LOGIC; });
354 // Create data containers for the logic data segments
356 lock_guard<recursive_mutex> data_lock(data_mutex_);
358 if (logic_channel_count == 0) {
360 } else if (!logic_data_ ||
361 logic_data_->num_channels() != logic_channel_count) {
362 logic_data_.reset(new data::Logic(
363 logic_channel_count));
368 // Make the Signals list
370 unique_lock<shared_mutex> lock(signals_mutex_);
372 unordered_set< shared_ptr<view::Signal> > prev_sigs(signals_);
375 for (auto channel : sr_dev->channels()) {
376 shared_ptr<view::Signal> signal;
378 // Find the channel in the old signals
379 const auto iter = std::find_if(
380 prev_sigs.cbegin(), prev_sigs.cend(),
381 [&](const shared_ptr<view::Signal> &s) {
382 return s->channel() == channel;
384 if (iter != prev_sigs.end()) {
385 // Copy the signal from the old set to the new
387 auto logic_signal = dynamic_pointer_cast<
388 view::LogicSignal>(signal);
390 logic_signal->set_logic_data(
393 // Create a new signal
394 switch(channel->type()->id()) {
395 case SR_CHANNEL_LOGIC:
396 signal = shared_ptr<view::Signal>(
397 new view::LogicSignal(*this,
402 case SR_CHANNEL_ANALOG:
404 shared_ptr<data::Analog> data(
406 signal = shared_ptr<view::Signal>(
407 new view::AnalogSignal(
408 *this, channel, data));
419 signals_.insert(signal);
426 shared_ptr<view::Signal> Session::signal_from_channel(
427 shared_ptr<Channel> channel) const
429 lock_guard<boost::shared_mutex> lock(signals_mutex_);
430 for (shared_ptr<view::Signal> sig : signals_) {
432 if (sig->channel() == channel)
435 return shared_ptr<view::Signal>();
438 void Session::sample_thread_proc(shared_ptr<devices::Device> device,
439 function<void (const QString)> error_handler)
442 assert(error_handler);
446 cur_samplerate_ = device_->read_config<uint64_t>(ConfigKey::SAMPLERATE);
448 out_of_memory_ = false;
453 error_handler(e.what());
457 set_capture_state(device_->session()->trigger() ?
458 AwaitingTrigger : Running);
461 set_capture_state(Stopped);
463 // Confirm that SR_DF_END was received
464 if (cur_logic_segment_)
466 qDebug("SR_DF_END was not received.");
471 error_handler(tr("Out of memory, acquisition stopped."));
474 void Session::feed_in_header()
476 cur_samplerate_ = device_->read_config<uint64_t>(ConfigKey::SAMPLERATE);
479 void Session::feed_in_meta(shared_ptr<Meta> meta)
481 for (auto entry : meta->config()) {
482 switch (entry.first->id()) {
483 case SR_CONF_SAMPLERATE:
484 /// @todo handle samplerate changes
487 // Unknown metadata is not an error.
495 void Session::feed_in_trigger()
497 // The channel containing most samples should be most accurate
498 uint64_t sample_count = 0;
500 for (const shared_ptr<pv::data::SignalData> d : get_data()) {
502 uint64_t temp_count = 0;
504 const vector< shared_ptr<pv::data::Segment> > segments =
506 for (const shared_ptr<pv::data::Segment> &s : segments)
507 temp_count += s->get_sample_count();
509 if (temp_count > sample_count)
510 sample_count = temp_count;
513 trigger_event(sample_count / get_samplerate());
516 void Session::feed_in_frame_begin()
518 if (cur_logic_segment_ || !cur_analog_segments_.empty())
522 void Session::feed_in_logic(shared_ptr<Logic> logic)
524 lock_guard<recursive_mutex> lock(data_mutex_);
526 const size_t sample_count = logic->data_length() / logic->unit_size();
530 // The only reason logic_data_ would not have been created is
531 // if it was not possible to determine the signals when the
532 // device was created.
536 if (!cur_logic_segment_)
538 // This could be the first packet after a trigger
539 set_capture_state(Running);
541 // Create a new data segment
542 cur_logic_segment_ = shared_ptr<data::LogicSegment>(
543 new data::LogicSegment(
544 logic, cur_samplerate_, sample_count));
545 logic_data_->push_segment(cur_logic_segment_);
547 // @todo Putting this here means that only listeners querying
548 // for logic will be notified. Currently the only user of
549 // frame_began is DecoderStack, but in future we need to signal
550 // this after both analog and logic sweeps have begun.
555 // Append to the existing data segment
556 cur_logic_segment_->append_payload(logic);
562 void Session::feed_in_analog(shared_ptr<Analog> analog)
564 lock_guard<recursive_mutex> lock(data_mutex_);
566 const vector<shared_ptr<Channel>> channels = analog->channels();
567 const unsigned int channel_count = channels.size();
568 const size_t sample_count = analog->num_samples() / channel_count;
569 const float *data = static_cast<const float *>(analog->data_pointer());
570 bool sweep_beginning = false;
572 for (auto channel : channels)
574 shared_ptr<data::AnalogSegment> segment;
576 // Try to get the segment of the channel
577 const map< shared_ptr<Channel>, shared_ptr<data::AnalogSegment> >::
578 iterator iter = cur_analog_segments_.find(channel);
579 if (iter != cur_analog_segments_.end())
580 segment = (*iter).second;
583 // If no segment was found, this means we havn't
584 // created one yet. i.e. this is the first packet
585 // in the sweep containing this segment.
586 sweep_beginning = true;
588 // Create a segment, keep it in the maps of channels
589 segment = shared_ptr<data::AnalogSegment>(
590 new data::AnalogSegment(
591 cur_samplerate_, sample_count));
592 cur_analog_segments_[channel] = segment;
594 // Find the analog data associated with the channel
595 shared_ptr<view::AnalogSignal> sig =
596 dynamic_pointer_cast<view::AnalogSignal>(
597 signal_from_channel(channel));
600 shared_ptr<data::Analog> data(sig->analog_data());
603 // Push the segment into the analog data.
604 data->push_segment(segment);
609 // Append the samples in the segment
610 segment->append_interleaved_samples(data++, sample_count,
614 if (sweep_beginning) {
615 // This could be the first packet after a trigger
616 set_capture_state(Running);
622 void Session::data_feed_in(shared_ptr<sigrok::Device> device,
623 shared_ptr<Packet> packet)
628 assert(device == device_->device());
631 switch (packet->type()->id()) {
637 feed_in_meta(dynamic_pointer_cast<Meta>(packet->payload()));
644 case SR_DF_FRAME_BEGIN:
645 feed_in_frame_begin();
650 feed_in_logic(dynamic_pointer_cast<Logic>(packet->payload()));
651 } catch (std::bad_alloc) {
652 out_of_memory_ = true;
659 feed_in_analog(dynamic_pointer_cast<Analog>(packet->payload()));
660 } catch (std::bad_alloc) {
661 out_of_memory_ = true;
669 lock_guard<recursive_mutex> lock(data_mutex_);
670 cur_logic_segment_.reset();
671 cur_analog_segments_.clear();