2 * This file is part of the PulseView project.
4 * Copyright (C) 2012 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 "sigsession.h"
23 #include "devicemanager.h"
24 #include "data/analog.h"
25 #include "data/analogsnapshot.h"
26 #include "data/logic.h"
27 #include "data/logicsnapshot.h"
28 #include "view/analogsignal.h"
29 #include "view/logicsignal.h"
37 using namespace boost;
42 // TODO: This should not be necessary
43 SigSession* SigSession::_session = NULL;
45 SigSession::SigSession(DeviceManager &device_manager) :
46 _device_manager(device_manager),
48 _capture_state(Stopped)
50 // TODO: This should not be necessary
54 SigSession::~SigSession()
58 if (_sampling_thread.get())
59 _sampling_thread->join();
60 _sampling_thread.reset();
63 _device_manager.release_device(_sdi);
66 // TODO: This should not be necessary
70 struct sr_dev_inst* SigSession::get_device() const
75 void SigSession::set_device(struct sr_dev_inst *sdi)
78 _device_manager.release_device(_sdi);
80 _device_manager.use_device(sdi, this);
84 void SigSession::release_device(struct sr_dev_inst *sdi)
88 assert(_capture_state == Stopped);
92 void SigSession::load_file(const string &name,
93 function<void (const QString)> error_handler)
96 _sampling_thread.reset(new boost::thread(
97 &SigSession::load_thread_proc, this, name,
101 SigSession::capture_state SigSession::get_capture_state() const
103 lock_guard<mutex> lock(_sampling_mutex);
104 return _capture_state;
107 void SigSession::start_capture(uint64_t record_length,
108 function<void (const QString)> error_handler)
112 // Check that a device instance has been selected.
114 qDebug() << "No device selected";
118 // Check that at least one probe is enabled
120 for (l = _sdi->probes; l; l = l->next) {
121 sr_probe *const probe = (sr_probe*)l->data;
128 error_handler(tr("No probes enabled."));
133 _sampling_thread.reset(new boost::thread(
134 &SigSession::sample_thread_proc, this, _sdi,
135 record_length, error_handler));
138 void SigSession::stop_capture()
140 if (get_capture_state() == Stopped)
145 // Check that sampling stopped
146 if (_sampling_thread.get())
147 _sampling_thread->join();
148 _sampling_thread.reset();
151 vector< shared_ptr<view::Signal> > SigSession::get_signals()
153 lock_guard<mutex> lock(_signals_mutex);
157 boost::shared_ptr<data::Logic> SigSession::get_data()
162 void SigSession::set_capture_state(capture_state state)
164 lock_guard<mutex> lock(_sampling_mutex);
165 _capture_state = state;
166 capture_state_changed(state);
170 * Attempts to autodetect the format. Failing that
171 * @param filename The filename of the input file.
172 * @return A pointer to the 'struct sr_input_format' that should be used,
173 * or NULL if no input format was selected or auto-detected.
175 sr_input_format* SigSession::determine_input_file_format(
176 const string &filename)
180 /* If there are no input formats, return NULL right away. */
181 sr_input_format *const *const inputs = sr_input_list();
183 g_critical("No supported input formats available.");
187 /* Otherwise, try to find an input module that can handle this file. */
188 for (i = 0; inputs[i]; i++) {
189 if (inputs[i]->format_match(filename.c_str()))
193 /* Return NULL if no input module wanted to touch this. */
195 g_critical("Error: no matching input module found.");
202 sr_input* SigSession::load_input_file_format(const string &filename,
203 function<void (const QString)> error_handler,
204 sr_input_format *format)
209 if (!format && !(format =
210 determine_input_file_format(filename.c_str()))) {
211 /* The exact cause was already logged. */
215 if (stat(filename.c_str(), &st) == -1) {
216 error_handler(tr("Failed to load file"));
220 /* Initialize the input module. */
221 if (!(in = new sr_input)) {
222 qDebug("Failed to allocate input module.\n");
228 if (in->format->init &&
229 in->format->init(in, filename.c_str()) != SR_OK) {
230 qDebug("Input format init failed.\n");
236 if (sr_session_dev_add(in->sdi) != SR_OK) {
237 qDebug("Failed to use device.\n");
238 sr_session_destroy();
245 void SigSession::load_thread_proc(const string name,
246 function<void (const QString)> error_handler)
250 if (sr_session_load(name.c_str()) == SR_OK) {
251 if (sr_session_start() != SR_OK) {
252 error_handler(tr("Failed to start session."));
256 else if(!(in = load_input_file_format(name.c_str(), error_handler)))
259 sr_session_datafeed_callback_add(data_feed_in_proc, NULL);
261 set_capture_state(Running);
265 in->format->loadfile(in, name.c_str());
269 sr_session_destroy();
270 set_capture_state(Stopped);
272 // Confirm that SR_DF_END was received
273 assert(!_cur_logic_snapshot);
274 assert(!_cur_analog_snapshot);
279 void SigSession::sample_thread_proc(struct sr_dev_inst *sdi,
280 uint64_t record_length,
281 function<void (const QString)> error_handler)
284 assert(error_handler);
287 sr_session_datafeed_callback_add(data_feed_in_proc, NULL);
289 if (sr_session_dev_add(sdi) != SR_OK) {
290 error_handler(tr("Failed to use device."));
291 sr_session_destroy();
295 // Set the sample limit
296 if (sr_config_set(sdi, SR_CONF_LIMIT_SAMPLES,
297 g_variant_new_uint64(record_length)) != SR_OK) {
298 error_handler(tr("Failed to configure "
299 "time-based sample limit."));
300 sr_session_destroy();
304 if (sr_session_start() != SR_OK) {
305 error_handler(tr("Failed to start session."));
309 set_capture_state(Running);
312 sr_session_destroy();
314 set_capture_state(Stopped);
316 // Confirm that SR_DF_END was received
317 assert(!_cur_logic_snapshot);
318 assert(!_cur_analog_snapshot);
321 void SigSession::feed_in_header(const sr_dev_inst *sdi)
323 shared_ptr<view::Signal> signal;
325 uint64_t sample_rate = 0;
326 unsigned int logic_probe_count = 0;
327 unsigned int analog_probe_count = 0;
329 // Detect what data types we will receive
330 for (const GSList *l = sdi->probes; l; l = l->next) {
331 const sr_probe *const probe = (const sr_probe *)l->data;
335 switch(probe->type) {
340 case SR_PROBE_ANALOG:
341 analog_probe_count++;
346 // Read out the sample rate
349 const int ret = sr_config_get(sdi->driver,
350 SR_CONF_SAMPLERATE, &gvar, sdi);
352 qDebug("Failed to get samplerate\n");
356 sample_rate = g_variant_get_uint64(gvar);
357 g_variant_unref(gvar);
360 // Create data containers for the coming data snapshots
362 lock_guard<mutex> data_lock(_data_mutex);
364 if (logic_probe_count != 0) {
365 _logic_data.reset(new data::Logic(
366 logic_probe_count, sample_rate));
370 if (analog_probe_count != 0) {
371 _analog_data.reset(new data::Analog(sample_rate));
372 assert(_analog_data);
376 // Make the logic probe list
378 lock_guard<mutex> lock(_signals_mutex);
382 for (const GSList *l = sdi->probes; l; l = l->next) {
383 const sr_probe *const probe =
384 (const sr_probe *)l->data;
389 switch(probe->type) {
391 signal = shared_ptr<view::Signal>(
392 new view::LogicSignal(probe->name,
393 _logic_data, probe->index));
396 case SR_PROBE_ANALOG:
397 signal = shared_ptr<view::Signal>(
398 new view::AnalogSignal(probe->name,
399 _analog_data, probe->index));
403 _signals.push_back(signal);
410 void SigSession::feed_in_meta(const sr_dev_inst *sdi,
411 const sr_datafeed_meta &meta)
415 for (const GSList *l = meta.config; l; l = l->next) {
416 const sr_config *const src = (const sr_config*)l->data;
418 case SR_CONF_SAMPLERATE:
419 /// @todo handle samplerate changes
420 /// samplerate = (uint64_t *)src->value;
423 // Unknown metadata is not an error.
429 void SigSession::feed_in_logic(const sr_datafeed_logic &logic)
431 lock_guard<mutex> lock(_data_mutex);
435 qDebug() << "Unexpected logic packet";
439 if (!_cur_logic_snapshot)
441 // Create a new data snapshot
442 _cur_logic_snapshot = shared_ptr<data::LogicSnapshot>(
443 new data::LogicSnapshot(logic));
444 _logic_data->push_snapshot(_cur_logic_snapshot);
448 // Append to the existing data snapshot
449 _cur_logic_snapshot->append_payload(logic);
455 void SigSession::feed_in_analog(const sr_datafeed_analog &analog)
457 lock_guard<mutex> lock(_data_mutex);
461 qDebug() << "Unexpected analog packet";
462 return; // This analog packet was not expected.
465 if (!_cur_analog_snapshot)
467 // Create a new data snapshot
468 _cur_analog_snapshot = shared_ptr<data::AnalogSnapshot>(
469 new data::AnalogSnapshot(analog));
470 _analog_data->push_snapshot(_cur_analog_snapshot);
474 // Append to the existing data snapshot
475 _cur_analog_snapshot->append_payload(analog);
481 void SigSession::data_feed_in(const struct sr_dev_inst *sdi,
482 const struct sr_datafeed_packet *packet)
487 switch (packet->type) {
493 assert(packet->payload);
495 *(const sr_datafeed_meta*)packet->payload);
499 assert(packet->payload);
500 feed_in_logic(*(const sr_datafeed_logic*)packet->payload);
504 assert(packet->payload);
505 feed_in_analog(*(const sr_datafeed_analog*)packet->payload);
511 lock_guard<mutex> lock(_data_mutex);
512 _cur_logic_snapshot.reset();
513 _cur_analog_snapshot.reset();
521 void SigSession::data_feed_in_proc(const struct sr_dev_inst *sdi,
522 const struct sr_datafeed_packet *packet, void *cb_data)
526 _session->data_feed_in(sdi, packet);