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
21 #include <boost/thread/locks.hpp>
22 #include <boost/thread/shared_mutex.hpp>
25 #include <libsigrokdecode/libsigrokdecode.h>
28 #include "session.hpp"
30 #include "devicemanager.hpp"
32 #include "data/analog.hpp"
33 #include "data/analogsegment.hpp"
34 #include "data/decoderstack.hpp"
35 #include "data/logic.hpp"
36 #include "data/logicsegment.hpp"
37 #include "data/decode/decoder.hpp"
39 #include "devices/hardwaredevice.hpp"
40 #include "devices/sessionfile.hpp"
42 #include "view/analogsignal.hpp"
43 #include "view/decodetrace.hpp"
44 #include "view/logicsignal.hpp"
54 #include <libsigrokcxx/libsigrokcxx.hpp>
56 using boost::shared_lock;
57 using boost::shared_mutex;
58 using boost::unique_lock;
60 using std::dynamic_pointer_cast;
62 using std::lock_guard;
66 using std::recursive_mutex;
68 using std::shared_ptr;
70 using std::unordered_set;
74 using sigrok::Channel;
75 using sigrok::ChannelType;
76 using sigrok::ConfigKey;
77 using sigrok::DatafeedCallbackFunction;
83 using sigrok::PacketPayload;
84 using sigrok::Session;
85 using sigrok::SessionDevice;
87 using Glib::VariantBase;
91 Session::Session(DeviceManager &device_manager) :
92 device_manager_(device_manager),
93 capture_state_(Stopped),
100 // Stop and join to the thread
104 DeviceManager& Session::device_manager()
106 return device_manager_;
109 const DeviceManager& Session::device_manager() const
111 return device_manager_;
114 shared_ptr<sigrok::Session> Session::session() const
117 return shared_ptr<sigrok::Session>();
118 return device_->session();
121 shared_ptr<devices::Device> Session::device() const
126 void Session::set_device(shared_ptr<devices::Device> device)
130 // Ensure we are not capturing before setting the device
136 device_ = std::move(device);
138 device_->session()->add_datafeed_callback([=]
139 (shared_ptr<sigrok::Device> device, shared_ptr<Packet> packet) {
140 data_feed_in(device, packet);
144 decode_traces_.clear();
149 void Session::set_default_device()
151 const list< shared_ptr<devices::HardwareDevice> > &devices =
152 device_manager_.devices();
157 // Try and find the demo device and select that by default
158 const auto iter = std::find_if(devices.begin(), devices.end(),
159 [] (const shared_ptr<devices::HardwareDevice> &d) {
160 return d->hardware_device()->driver()->name() ==
162 set_device((iter == devices.end()) ? devices.front() : *iter);
165 Session::capture_state Session::get_capture_state() const
167 lock_guard<mutex> lock(sampling_mutex_);
168 return capture_state_;
171 void Session::start_capture(function<void (const QString)> error_handler)
175 // Check that at least one channel is enabled
177 const shared_ptr<sigrok::Device> sr_dev = device_->device();
179 const auto channels = sr_dev->channels();
180 if (!std::any_of(channels.begin(), channels.end(),
181 [](shared_ptr<Channel> channel) {
182 return channel->enabled(); })) {
183 error_handler(tr("No channels enabled."));
189 for (const shared_ptr<data::SignalData> d : get_data())
193 sampling_thread_ = std::thread(
194 &Session::sample_thread_proc, this, device_,
198 void Session::stop_capture()
200 if (get_capture_state() != Stopped)
203 // Check that sampling stopped
204 if (sampling_thread_.joinable())
205 sampling_thread_.join();
208 set< shared_ptr<data::SignalData> > Session::get_data() const
210 shared_lock<shared_mutex> lock(signals_mutex_);
211 set< shared_ptr<data::SignalData> > data;
212 for (const shared_ptr<view::Signal> sig : signals_) {
214 data.insert(sig->data());
220 boost::shared_mutex& Session::signals_mutex() const
222 return signals_mutex_;
225 const unordered_set< shared_ptr<view::Signal> >& Session::signals() const
231 bool Session::add_decoder(srd_decoder *const dec)
233 map<const srd_channel*, shared_ptr<view::LogicSignal> > channels;
234 shared_ptr<data::DecoderStack> decoder_stack;
238 lock_guard<boost::shared_mutex> lock(signals_mutex_);
240 // Create the decoder
241 decoder_stack = shared_ptr<data::DecoderStack>(
242 new data::DecoderStack(*this, dec));
244 // Make a list of all the channels
245 std::vector<const srd_channel*> all_channels;
246 for (const GSList *i = dec->channels; i; i = i->next)
247 all_channels.push_back((const srd_channel*)i->data);
248 for (const GSList *i = dec->opt_channels; i; i = i->next)
249 all_channels.push_back((const srd_channel*)i->data);
251 // Auto select the initial channels
252 for (const srd_channel *pdch : all_channels)
253 for (shared_ptr<view::Signal> s : signals_)
255 shared_ptr<view::LogicSignal> l =
256 dynamic_pointer_cast<view::LogicSignal>(s);
257 if (l && QString::fromUtf8(pdch->name).
259 l->name().toLower()))
263 assert(decoder_stack);
264 assert(!decoder_stack->stack().empty());
265 assert(decoder_stack->stack().front());
266 decoder_stack->stack().front()->set_channels(channels);
268 // Create the decode signal
269 shared_ptr<view::DecodeTrace> d(
270 new view::DecodeTrace(*this, decoder_stack,
271 decode_traces_.size()));
272 decode_traces_.push_back(d);
274 catch(std::runtime_error e)
281 // Do an initial decode
282 decoder_stack->begin_decode();
287 vector< shared_ptr<view::DecodeTrace> > Session::get_decode_signals() const
289 shared_lock<shared_mutex> lock(signals_mutex_);
290 return decode_traces_;
293 void Session::remove_decode_signal(view::DecodeTrace *signal)
295 for (auto i = decode_traces_.begin(); i != decode_traces_.end(); i++)
296 if ((*i).get() == signal)
298 decode_traces_.erase(i);
305 void Session::set_capture_state(capture_state state)
307 lock_guard<mutex> lock(sampling_mutex_);
308 const bool changed = capture_state_ != state;
309 capture_state_ = state;
311 capture_state_changed(state);
314 void Session::update_signals()
318 lock_guard<recursive_mutex> lock(data_mutex_);
320 const shared_ptr<sigrok::Device> sr_dev = device_->device();
327 // Detect what data types we will receive
328 auto channels = sr_dev->channels();
329 unsigned int logic_channel_count = std::count_if(
330 channels.begin(), channels.end(),
331 [] (shared_ptr<Channel> channel) {
332 return channel->type() == ChannelType::LOGIC; });
334 // Create data containers for the logic data segments
336 lock_guard<recursive_mutex> data_lock(data_mutex_);
338 if (logic_channel_count == 0) {
340 } else if (!logic_data_ ||
341 logic_data_->num_channels() != logic_channel_count) {
342 logic_data_.reset(new data::Logic(
343 logic_channel_count));
348 // Make the Signals list
350 unique_lock<shared_mutex> lock(signals_mutex_);
352 unordered_set< shared_ptr<view::Signal> > prev_sigs(signals_);
355 for (auto channel : sr_dev->channels()) {
356 shared_ptr<view::Signal> signal;
358 // Find the channel in the old signals
359 const auto iter = std::find_if(
360 prev_sigs.cbegin(), prev_sigs.cend(),
361 [&](const shared_ptr<view::Signal> &s) {
362 return s->channel() == channel;
364 if (iter != prev_sigs.end()) {
365 // Copy the signal from the old set to the new
367 auto logic_signal = dynamic_pointer_cast<
368 view::LogicSignal>(signal);
370 logic_signal->set_logic_data(
373 // Create a new signal
374 switch(channel->type()->id()) {
375 case SR_CHANNEL_LOGIC:
376 signal = shared_ptr<view::Signal>(
377 new view::LogicSignal(*this,
382 case SR_CHANNEL_ANALOG:
384 shared_ptr<data::Analog> data(
386 signal = shared_ptr<view::Signal>(
387 new view::AnalogSignal(
388 *this, channel, data));
399 signals_.insert(signal);
406 shared_ptr<view::Signal> Session::signal_from_channel(
407 shared_ptr<Channel> channel) const
409 lock_guard<boost::shared_mutex> lock(signals_mutex_);
410 for (shared_ptr<view::Signal> sig : signals_) {
412 if (sig->channel() == channel)
415 return shared_ptr<view::Signal>();
418 void Session::sample_thread_proc(shared_ptr<devices::Device> device,
419 function<void (const QString)> error_handler)
422 assert(error_handler);
426 cur_samplerate_ = device_->read_config<uint64_t>(ConfigKey::SAMPLERATE);
428 out_of_memory_ = false;
433 error_handler(e.what());
437 set_capture_state(device_->session()->trigger() ?
438 AwaitingTrigger : Running);
441 set_capture_state(Stopped);
443 // Confirm that SR_DF_END was received
444 if (cur_logic_segment_)
446 qDebug("SR_DF_END was not received.");
451 error_handler(tr("Out of memory, acquisition stopped."));
454 void Session::feed_in_header()
456 cur_samplerate_ = device_->read_config<uint64_t>(ConfigKey::SAMPLERATE);
459 void Session::feed_in_meta(shared_ptr<Meta> meta)
461 for (auto entry : meta->config()) {
462 switch (entry.first->id()) {
463 case SR_CONF_SAMPLERATE:
464 /// @todo handle samplerate changes
467 // Unknown metadata is not an error.
475 void Session::feed_in_frame_begin()
477 if (cur_logic_segment_ || !cur_analog_segments_.empty())
481 void Session::feed_in_logic(shared_ptr<Logic> logic)
483 lock_guard<recursive_mutex> lock(data_mutex_);
485 const size_t sample_count = logic->data_length() / logic->unit_size();
489 // The only reason logic_data_ would not have been created is
490 // if it was not possible to determine the signals when the
491 // device was created.
495 if (!cur_logic_segment_)
497 // This could be the first packet after a trigger
498 set_capture_state(Running);
500 // Create a new data segment
501 cur_logic_segment_ = shared_ptr<data::LogicSegment>(
502 new data::LogicSegment(
503 logic, cur_samplerate_, sample_count));
504 logic_data_->push_segment(cur_logic_segment_);
506 // @todo Putting this here means that only listeners querying
507 // for logic will be notified. Currently the only user of
508 // frame_began is DecoderStack, but in future we need to signal
509 // this after both analog and logic sweeps have begun.
514 // Append to the existing data segment
515 cur_logic_segment_->append_payload(logic);
521 void Session::feed_in_analog(shared_ptr<Analog> analog)
523 lock_guard<recursive_mutex> lock(data_mutex_);
525 const vector<shared_ptr<Channel>> channels = analog->channels();
526 const unsigned int channel_count = channels.size();
527 const size_t sample_count = analog->num_samples() / channel_count;
528 const float *data = analog->data_pointer();
529 bool sweep_beginning = false;
531 for (auto channel : channels)
533 shared_ptr<data::AnalogSegment> segment;
535 // Try to get the segment of the channel
536 const map< shared_ptr<Channel>, shared_ptr<data::AnalogSegment> >::
537 iterator iter = cur_analog_segments_.find(channel);
538 if (iter != cur_analog_segments_.end())
539 segment = (*iter).second;
542 // If no segment was found, this means we havn't
543 // created one yet. i.e. this is the first packet
544 // in the sweep containing this segment.
545 sweep_beginning = true;
547 // Create a segment, keep it in the maps of channels
548 segment = shared_ptr<data::AnalogSegment>(
549 new data::AnalogSegment(
550 cur_samplerate_, sample_count));
551 cur_analog_segments_[channel] = segment;
553 // Find the analog data associated with the channel
554 shared_ptr<view::AnalogSignal> sig =
555 dynamic_pointer_cast<view::AnalogSignal>(
556 signal_from_channel(channel));
559 shared_ptr<data::Analog> data(sig->analog_data());
562 // Push the segment into the analog data.
563 data->push_segment(segment);
568 // Append the samples in the segment
569 segment->append_interleaved_samples(data++, sample_count,
573 if (sweep_beginning) {
574 // This could be the first packet after a trigger
575 set_capture_state(Running);
581 void Session::data_feed_in(shared_ptr<sigrok::Device> device,
582 shared_ptr<Packet> packet)
587 assert(device == device_->device());
590 switch (packet->type()->id()) {
596 feed_in_meta(dynamic_pointer_cast<Meta>(packet->payload()));
599 case SR_DF_FRAME_BEGIN:
600 feed_in_frame_begin();
605 feed_in_logic(dynamic_pointer_cast<Logic>(packet->payload()));
606 } catch (std::bad_alloc) {
607 out_of_memory_ = true;
614 feed_in_analog(dynamic_pointer_cast<Analog>(packet->payload()));
615 } catch (std::bad_alloc) {
616 out_of_memory_ = true;
624 lock_guard<recursive_mutex> lock(data_mutex_);
625 cur_logic_segment_.reset();
626 cur_analog_segments_.clear();