]> sigrok.org Git - pulseview.git/blobdiff - pv/sigsession.cpp
Rename 'probe' to 'channel' (libsigrokdecode change).
[pulseview.git] / pv / sigsession.cpp
index 5da1551fc51cee4e1e5e3f539654359280933c37..b441dab8aaf429608dc6d848b47be4156902e57d 100644 (file)
@@ -25,7 +25,8 @@
 #include "sigsession.h"
 
 #include "devicemanager.h"
-#include "devinst.h"
+#include "device/device.h"
+#include "device/file.h"
 
 #include "data/analog.h"
 #include "data/analogsnapshot.h"
@@ -53,6 +54,7 @@ using boost::function;
 using boost::lock_guard;
 using boost::mutex;
 using boost::shared_ptr;
+using std::list;
 using std::map;
 using std::set;
 using std::string;
@@ -69,89 +71,90 @@ SigSession::SigSession(DeviceManager &device_manager) :
 {
        // TODO: This should not be necessary
        _session = this;
+
+       set_default_device();
 }
 
 SigSession::~SigSession()
 {
+       using pv::device::Device;
+
        stop_capture();
 
-       _sampling_thread.join();
+       if (_sampling_thread.joinable())
+               _sampling_thread.join();
 
-       if (_dev_inst)
-               _device_manager.release_device(_dev_inst);
+       _dev_inst->release();
 
        // TODO: This should not be necessary
        _session = NULL;
 }
 
-shared_ptr<DevInst> SigSession::get_device() const
+shared_ptr<device::DevInst> SigSession::get_device() const
 {
        return _dev_inst;
 }
 
-void SigSession::set_device(shared_ptr<DevInst> dev_inst)
+void SigSession::set_device(
+       shared_ptr<device::DevInst> dev_inst) throw(QString)
 {
+       using pv::device::Device;
+
        // Ensure we are not capturing before setting the device
        stop_capture();
 
-       if (_dev_inst)
-               _device_manager.release_device(_dev_inst);
-       if (dev_inst)
-               _device_manager.use_device(dev_inst, this);
+       if (_dev_inst) {
+               sr_session_datafeed_callback_remove_all();
+               _dev_inst->release();
+       }
+
        _dev_inst = dev_inst;
-       update_signals(dev_inst);
+       _decode_traces.clear();
+
+       if (dev_inst) {
+               dev_inst->use(this);
+               sr_session_datafeed_callback_add(data_feed_in_proc, NULL);
+               update_signals(dev_inst);
+       }
 }
 
-void SigSession::release_device(shared_ptr<DevInst> dev_inst)
+void SigSession::set_file(const string &name) throw(QString)
 {
-       (void)dev_inst;
-
-       assert(_capture_state == Stopped);
-       _dev_inst = shared_ptr<DevInst>();
+       // Deslect the old device, because file type detection in File::create
+       // destorys the old session inside libsigrok.
+       set_device(shared_ptr<device::DevInst>());
+       set_device(shared_ptr<device::DevInst>(device::File::create(name)));
 }
 
-void SigSession::load_file(const string &name,
-       function<void (const QString)> error_handler)
+void SigSession::set_default_device()
 {
-       stop_capture();
-
-       if (sr_session_load(name.c_str()) == SR_OK) {
-               GSList *devlist = NULL;
-               sr_session_dev_list(&devlist);
-
-               if (!devlist || !devlist->data ||
-                       sr_session_start() != SR_OK) {
-                       error_handler(tr("Failed to start session."));
-                       return;
-               }
-
-               shared_ptr<DevInst> dev_inst(
-                       new DevInst((sr_dev_inst*)devlist->data));
-               g_slist_free(devlist);
-
-               _decode_traces.clear();
-               update_signals(dev_inst);
-               read_sample_rate(dev_inst->dev_inst());
-
-               _sampling_thread = boost::thread(
-                       &SigSession::load_session_thread_proc, this,
-                       error_handler);
-
-       } else {
-               sr_input *in = NULL;
+       shared_ptr<pv::device::DevInst> default_device;
+       const list< shared_ptr<device::Device> > &devices =
+               _device_manager.devices();
+
+       if (!devices.empty()) {
+               // Fall back to the first device in the list.
+               default_device = devices.front();
+
+               // Try and find the demo device and select that by default
+               BOOST_FOREACH (shared_ptr<pv::device::Device> dev, devices)
+                       if (strcmp(dev->dev_inst()->driver->name,
+                               "demo") == 0) {
+                               default_device = dev;
+                               break;
+                       }
+       }
 
-               if (!(in = load_input_file_format(name.c_str(),
-                       error_handler)))
-                       return;
+       set_device(default_device);
+}
 
-               _decode_traces.clear();
-               update_signals(shared_ptr<DevInst>(new DevInst(in->sdi)));
-               read_sample_rate(in->sdi);
+void SigSession::release_device(device::DevInst *dev_inst)
+{
+       (void)dev_inst;
+       assert(_dev_inst.get() == dev_inst);
 
-               _sampling_thread = boost::thread(
-                       &SigSession::load_input_thread_proc, this,
-                       name, in, error_handler);
-       }
+       assert(_capture_state == Stopped);
+       _dev_inst = shared_ptr<device::DevInst>();
 }
 
 SigSession::capture_state SigSession::get_capture_state() const
@@ -174,15 +177,15 @@ void SigSession::start_capture(function<void (const QString)> error_handler)
 
        // Check that at least one probe is enabled
        const GSList *l;
-       for (l = _dev_inst->dev_inst()->probes; l; l = l->next) {
-               sr_probe *const probe = (sr_probe*)l->data;
+       for (l = _dev_inst->dev_inst()->channels; l; l = l->next) {
+               sr_channel *const probe = (sr_channel*)l->data;
                assert(probe);
                if (probe->enabled)
                        break;
        }
 
        if (!l) {
-               error_handler(tr("No probes enabled."));
+               error_handler(tr("No channels enabled."));
                return;
        }
 
@@ -200,7 +203,8 @@ void SigSession::stop_capture()
        sr_session_stop();
 
        // Check that sampling stopped
-       _sampling_thread.join();
+       if (_sampling_thread.joinable())
+               _sampling_thread.join();
 }
 
 set< shared_ptr<data::SignalData> > SigSession::get_data() const
@@ -224,7 +228,7 @@ vector< shared_ptr<view::Signal> > SigSession::get_signals() const
 #ifdef ENABLE_DECODE
 bool SigSession::add_decoder(srd_decoder *const dec)
 {
-       map<const srd_probe*, shared_ptr<view::LogicSignal> > probes;
+       map<const srd_channel*, shared_ptr<view::LogicSignal> > probes;
        shared_ptr<data::DecoderStack> decoder_stack;
 
        try
@@ -233,25 +237,25 @@ bool SigSession::add_decoder(srd_decoder *const dec)
 
                // Create the decoder
                decoder_stack = shared_ptr<data::DecoderStack>(
-                       new data::DecoderStack(dec));
+                       new data::DecoderStack(*this, dec));
 
                // Make a list of all the probes
-               std::vector<const srd_probe*> all_probes;
-               for(const GSList *i = dec->probes; i; i = i->next)
-                       all_probes.push_back((const srd_probe*)i->data);
-               for(const GSList *i = dec->opt_probes; i; i = i->next)
-                       all_probes.push_back((const srd_probe*)i->data);
+               std::vector<const srd_channel*> all_probes;
+               for(const GSList *i = dec->channels; i; i = i->next)
+                       all_probes.push_back((const srd_channel*)i->data);
+               for(const GSList *i = dec->opt_channels; i; i = i->next)
+                       all_probes.push_back((const srd_channel*)i->data);
 
                // Auto select the initial probes
-               BOOST_FOREACH(const srd_probe *probe, all_probes)
+               BOOST_FOREACH(const srd_channel *pdch, all_probes)
                        BOOST_FOREACH(shared_ptr<view::Signal> s, _signals)
                        {
                                shared_ptr<view::LogicSignal> l =
                                        dynamic_pointer_cast<view::LogicSignal>(s);
-                               if (l && QString::fromUtf8(probe->name).
+                               if (l && QString::fromUtf8(pdch->name).
                                        toLower().contains(
                                        l->get_name().toLower()))
-                                       probes[probe] = l;
+                                       probes[pdch] = l;
                        }
 
                assert(decoder_stack);
@@ -308,83 +312,7 @@ void SigSession::set_capture_state(capture_state state)
                capture_state_changed(state);
 }
 
-/**
- * Attempts to autodetect the format. Failing that
- * @param filename The filename of the input file.
- * @return A pointer to the 'struct sr_input_format' that should be used,
- *         or NULL if no input format was selected or auto-detected.
- */
-sr_input_format* SigSession::determine_input_file_format(
-       const string &filename)
-{
-       int i;
-
-       /* If there are no input formats, return NULL right away. */
-       sr_input_format *const *const inputs = sr_input_list();
-       if (!inputs) {
-               g_critical("No supported input formats available.");
-               return NULL;
-       }
-
-       /* Otherwise, try to find an input module that can handle this file. */
-       for (i = 0; inputs[i]; i++) {
-               if (inputs[i]->format_match(filename.c_str()))
-                       break;
-       }
-
-       /* Return NULL if no input module wanted to touch this. */
-       if (!inputs[i]) {
-               g_critical("Error: no matching input module found.");
-               return NULL;
-       }
-
-       return inputs[i];
-}
-
-sr_input* SigSession::load_input_file_format(const string &filename,
-       function<void (const QString)> error_handler,
-       sr_input_format *format)
-{
-       struct stat st;
-       sr_input *in;
-
-       if (!format && !(format =
-               determine_input_file_format(filename.c_str()))) {
-               /* The exact cause was already logged. */
-               return NULL;
-       }
-
-       if (stat(filename.c_str(), &st) == -1) {
-               error_handler(tr("Failed to load file"));
-               return NULL;
-       }
-
-       /* Initialize the input module. */
-       if (!(in = new sr_input)) {
-               qDebug("Failed to allocate input module.\n");
-               return NULL;
-       }
-
-       in->format = format;
-       in->param = NULL;
-       if (in->format->init &&
-               in->format->init(in, filename.c_str()) != SR_OK) {
-               qDebug("Input format init failed.\n");
-               return NULL;
-       }
-
-       sr_session_new();
-
-       if (sr_session_dev_add(in->sdi) != SR_OK) {
-               qDebug("Failed to use device.\n");
-               sr_session_destroy();
-               return NULL;
-       }
-
-       return in;
-}
-
-void SigSession::update_signals(shared_ptr<DevInst> dev_inst)
+void SigSession::update_signals(shared_ptr<device::DevInst> dev_inst)
 {
        assert(dev_inst);
        assert(_capture_state == Stopped);
@@ -397,14 +325,14 @@ void SigSession::update_signals(shared_ptr<DevInst> dev_inst)
        // Detect what data types we will receive
        if(dev_inst) {
                assert(dev_inst->dev_inst());
-               for (const GSList *l = dev_inst->dev_inst()->probes;
+               for (const GSList *l = dev_inst->dev_inst()->channels;
                        l; l = l->next) {
-                       const sr_probe *const probe = (const sr_probe *)l->data;
+                       const sr_channel *const probe = (const sr_channel *)l->data;
                        if (!probe->enabled)
                                continue;
 
                        switch(probe->type) {
-                       case SR_PROBE_LOGIC:
+                       case SR_CHANNEL_LOGIC:
                                logic_probe_count++;
                                break;
                        }
@@ -433,20 +361,20 @@ void SigSession::update_signals(shared_ptr<DevInst> dev_inst)
                        break;
 
                assert(dev_inst->dev_inst());
-               for (const GSList *l = dev_inst->dev_inst()->probes;
+               for (const GSList *l = dev_inst->dev_inst()->channels;
                        l; l = l->next) {
                        shared_ptr<view::Signal> signal;
-                       sr_probe *const probe = (sr_probe *)l->data;
+                       sr_channel *const probe = (sr_channel *)l->data;
                        assert(probe);
 
                        switch(probe->type) {
-                       case SR_PROBE_LOGIC:
+                       case SR_CHANNEL_LOGIC:
                                signal = shared_ptr<view::Signal>(
                                        new view::LogicSignal(dev_inst,
                                                probe, _logic_data));
                                break;
 
-                       case SR_PROBE_ANALOG:
+                       case SR_CHANNEL_ANALOG:
                        {
                                shared_ptr<data::Analog> data(
                                        new data::Analog());
@@ -470,22 +398,8 @@ void SigSession::update_signals(shared_ptr<DevInst> dev_inst)
        signals_changed();
 }
 
-bool SigSession::is_trigger_enabled() const
-{
-       assert(_dev_inst);
-       assert(_dev_inst->dev_inst());
-       for (const GSList *l = _dev_inst->dev_inst()->probes; l; l = l->next) {
-               const sr_probe *const p = (const sr_probe *)l->data;
-               assert(p);
-               if (p->trigger && p->trigger[0] != '\0')
-                       return true;
-       }
-
-       return false;
-}
-
 shared_ptr<view::Signal> SigSession::signal_from_probe(
-       const sr_probe *probe) const
+       const sr_channel *probe) const
 {
        lock_guard<mutex> lock(_signals_mutex);
        BOOST_FOREACH(shared_ptr<view::Signal> sig, _signals) {
@@ -523,75 +437,26 @@ void SigSession::read_sample_rate(const sr_dev_inst *const sdi)
        }
 }
 
-void SigSession::load_session_thread_proc(
-       function<void (const QString)> error_handler)
-{
-       (void)error_handler;
-
-       sr_session_datafeed_callback_add(data_feed_in_proc, NULL);
-
-       set_capture_state(Running);
-
-       sr_session_run();
-
-       sr_session_destroy();
-       set_capture_state(Stopped);
-
-       // Confirm that SR_DF_END was received
-       assert(!_cur_logic_snapshot);
-       assert(_cur_analog_snapshots.empty());
-}
-
-void SigSession::load_input_thread_proc(const string name,
-       sr_input *in, function<void (const QString)> error_handler)
-{
-       (void)error_handler;
-
-       assert(in);
-       assert(in->format);
-
-       sr_session_datafeed_callback_add(data_feed_in_proc, NULL);
-
-       set_capture_state(Running);
-
-       in->format->loadfile(in, name.c_str());
-
-       sr_session_destroy();
-       set_capture_state(Stopped);
-
-       // Confirm that SR_DF_END was received
-       assert(!_cur_logic_snapshot);
-       assert(_cur_analog_snapshots.empty());
-
-       delete in;
-}
-
-void SigSession::sample_thread_proc(shared_ptr<DevInst> dev_inst,
+void SigSession::sample_thread_proc(shared_ptr<device::DevInst> dev_inst,
        function<void (const QString)> error_handler)
 {
        assert(dev_inst);
        assert(dev_inst->dev_inst());
        assert(error_handler);
 
-       sr_session_new();
-       sr_session_datafeed_callback_add(data_feed_in_proc, NULL);
-
-       if (sr_session_dev_add(dev_inst->dev_inst()) != SR_OK) {
-               error_handler(tr("Failed to use device."));
-               sr_session_destroy();
-               return;
-       }
+       read_sample_rate(dev_inst->dev_inst());
 
-       if (sr_session_start() != SR_OK) {
-               error_handler(tr("Failed to start session."));
+       try {
+               dev_inst->start();
+       } catch(const QString e) {
+               error_handler(e);
                return;
        }
 
-       set_capture_state(is_trigger_enabled() ? AwaitingTrigger : Running);
-
-       sr_session_run();
-       sr_session_destroy();
+       set_capture_state(dev_inst->is_trigger_enabled() ?
+               AwaitingTrigger : Running);
 
+       dev_inst->run();
        set_capture_state(Stopped);
 
        // Confirm that SR_DF_END was received
@@ -628,6 +493,12 @@ void SigSession::feed_in_meta(const sr_dev_inst *sdi,
        signals_changed();
 }
 
+void SigSession::feed_in_frame_begin()
+{
+       if (_cur_logic_snapshot || !_cur_analog_snapshots.empty())
+               frame_began();
+}
+
 void SigSession::feed_in_logic(const sr_datafeed_logic &logic)
 {
        lock_guard<mutex> lock(_data_mutex);
@@ -645,8 +516,14 @@ void SigSession::feed_in_logic(const sr_datafeed_logic &logic)
 
                // Create a new data snapshot
                _cur_logic_snapshot = shared_ptr<data::LogicSnapshot>(
-                       new data::LogicSnapshot(logic));
+                       new data::LogicSnapshot(logic, _dev_inst->get_sample_limit()));
                _logic_data->push_snapshot(_cur_logic_snapshot);
+
+               // @todo Putting this here means that only listeners querying
+               // for logic will be notified. Currently the only user of
+               // frame_began is DecoderStack, but in future we need to signal
+               // this after both analog and logic sweeps have begun.
+               frame_began();
        }
        else
        {
@@ -654,27 +531,27 @@ void SigSession::feed_in_logic(const sr_datafeed_logic &logic)
                _cur_logic_snapshot->append_payload(logic);
        }
 
-       data_updated();
+       data_received();
 }
 
 void SigSession::feed_in_analog(const sr_datafeed_analog &analog)
 {
        lock_guard<mutex> lock(_data_mutex);
 
-       const unsigned int probe_count = g_slist_length(analog.probes);
+       const unsigned int probe_count = g_slist_length(analog.channels);
        const size_t sample_count = analog.num_samples / probe_count;
        const float *data = analog.data;
        bool sweep_beginning = false;
 
-       for (GSList *p = analog.probes; p; p = p->next)
+       for (GSList *p = analog.channels; p; p = p->next)
        {
                shared_ptr<data::AnalogSnapshot> snapshot;
 
-               sr_probe *const probe = (sr_probe*)p->data;
+               sr_channel *const probe = (sr_channel*)p->data;
                assert(probe);
 
                // Try to get the snapshot of the probe
-               const map< const sr_probe*, shared_ptr<data::AnalogSnapshot> >::
+               const map< const sr_channel*, shared_ptr<data::AnalogSnapshot> >::
                        iterator iter = _cur_analog_snapshots.find(probe);
                if (iter != _cur_analog_snapshots.end())
                        snapshot = (*iter).second;
@@ -687,7 +564,7 @@ void SigSession::feed_in_analog(const sr_datafeed_analog &analog)
 
                        // Create a snapshot, keep it in the maps of probes
                        snapshot = shared_ptr<data::AnalogSnapshot>(
-                               new data::AnalogSnapshot());
+                               new data::AnalogSnapshot(_dev_inst->get_sample_limit()));
                        _cur_analog_snapshots[probe] = snapshot;
 
                        // Find the annalog data associated with the probe
@@ -715,7 +592,7 @@ void SigSession::feed_in_analog(const sr_datafeed_analog &analog)
                set_capture_state(Running);
        }
 
-       data_updated();
+       data_received();
 }
 
 void SigSession::data_feed_in(const struct sr_dev_inst *sdi,
@@ -735,6 +612,10 @@ void SigSession::data_feed_in(const struct sr_dev_inst *sdi,
                        *(const sr_datafeed_meta*)packet->payload);
                break;
 
+       case SR_DF_FRAME_BEGIN:
+               feed_in_frame_begin();
+               break;
+
        case SR_DF_LOGIC:
                assert(packet->payload);
                feed_in_logic(*(const sr_datafeed_logic*)packet->payload);
@@ -752,7 +633,7 @@ void SigSession::data_feed_in(const struct sr_dev_inst *sdi,
                        _cur_logic_snapshot.reset();
                        _cur_analog_snapshots.clear();
                }
-               data_updated();
+               frame_ended();
                break;
        }
        }