]> sigrok.org Git - pulseview.git/blobdiff - pv/data/decoderstack.cpp
Rename 'probe' to 'channel' everywhere.
[pulseview.git] / pv / data / decoderstack.cpp
index 9b02f9e929cc41b9ca75709acc27f3793745c333..5c26371b891f2d856fc04342a435ba3fdd413257 100644 (file)
@@ -20,9 +20,6 @@
 
 #include <libsigrokdecode/libsigrokdecode.h>
 
-#include <boost/foreach.hpp>
-#include <boost/thread/thread.hpp>
-
 #include <stdexcept>
 
 #include <QDebug>
 #include <pv/data/logicsnapshot.h>
 #include <pv/data/decode/decoder.h>
 #include <pv/data/decode/annotation.h>
+#include <pv/sigsession.h>
 #include <pv/view/logicsignal.h>
 
-using boost::lock_guard;
-using boost::mutex;
-using boost::shared_ptr;
+using std::lock_guard;
+using std::mutex;
+using boost::optional;
+using std::unique_lock;
 using std::deque;
 using std::make_pair;
 using std::max;
@@ -45,6 +44,7 @@ using std::min;
 using std::list;
 using std::map;
 using std::pair;
+using std::shared_ptr;
 using std::vector;
 
 using namespace pv::data::decode;
@@ -55,29 +55,44 @@ namespace data {
 const double DecoderStack::DecodeMargin = 1.0;
 const double DecoderStack::DecodeThreshold = 0.2;
 const int64_t DecoderStack::DecodeChunkLength = 4096;
+const unsigned int DecoderStack::DecodeNotifyPeriod = 65536;
 
 mutex DecoderStack::_global_decode_mutex;
 
-DecoderStack::DecoderStack(const srd_decoder *const dec) :
+DecoderStack::DecoderStack(pv::SigSession &session,
+       const srd_decoder *const dec) :
+       _session(session),
+       _sample_count(0),
+       _frame_complete(false),
        _samples_decoded(0)
 {
+       connect(&_session, SIGNAL(frame_began()),
+               this, SLOT(on_new_frame()));
+       connect(&_session, SIGNAL(data_received()),
+               this, SLOT(on_data_received()));
+       connect(&_session, SIGNAL(frame_ended()),
+               this, SLOT(on_frame_ended()));
+
        _stack.push_back(shared_ptr<decode::Decoder>(
                new decode::Decoder(dec)));
 }
 
 DecoderStack::~DecoderStack()
 {
-       _decode_thread.interrupt();
-       _decode_thread.join();
+       if (_decode_thread.joinable()) {
+               _interrupt = true;
+               _input_cond.notify_one();
+               _decode_thread.join();
+       }
 }
 
-const std::list< boost::shared_ptr<decode::Decoder> >&
+const std::list< std::shared_ptr<decode::Decoder> >&
 DecoderStack::stack() const
 {
        return _stack;
 }
 
-void DecoderStack::push(boost::shared_ptr<decode::Decoder> decoder)
+void DecoderStack::push(std::shared_ptr<decode::Decoder> decoder)
 {
        assert(decoder);
        _stack.push_back(decoder);
@@ -89,7 +104,7 @@ void DecoderStack::remove(int index)
        assert(index < (int)_stack.size());
 
        // Find the decoder in the stack
-       list< shared_ptr<Decoder> >::iterator iter = _stack.begin();
+       auto iter = _stack.begin();
        for(int i = 0; i < index; i++, iter++)
                assert(iter != _stack.end());
 
@@ -99,17 +114,17 @@ void DecoderStack::remove(int index)
 
 int64_t DecoderStack::samples_decoded() const
 {
-       lock_guard<mutex> decode_lock(_mutex);
+       lock_guard<mutex> decode_lock(_output_mutex);
        return _samples_decoded;
 }
 
 std::vector<Row> DecoderStack::get_visible_rows() const
 {
-       lock_guard<mutex> lock(_mutex);
+       lock_guard<mutex> lock(_output_mutex);
 
        vector<Row> rows;
 
-       BOOST_FOREACH (const shared_ptr<decode::Decoder> &dec, _stack)
+       for (const shared_ptr<decode::Decoder> &dec : _stack)
        {
                assert(dec);
                if (!dec->shown())
@@ -140,10 +155,9 @@ void DecoderStack::get_annotation_subset(
        const Row &row, uint64_t start_sample,
        uint64_t end_sample) const
 {
-       lock_guard<mutex> lock(_mutex);
+       lock_guard<mutex> lock(_output_mutex);
 
-       std::map<const Row, decode::RowData>::const_iterator iter =
-               _rows.find(row);
+       const auto iter = _rows.find(row);
        if (iter != _rows.end())
                (*iter).second.get_annotation_subset(dest,
                        start_sample, end_sample);
@@ -151,12 +165,14 @@ void DecoderStack::get_annotation_subset(
 
 QString DecoderStack::error_message()
 {
-       lock_guard<mutex> lock(_mutex);
+       lock_guard<mutex> lock(_output_mutex);
        return _error_message;
 }
 
 void DecoderStack::clear()
 {
+       _sample_count = 0;
+       _frame_complete = false;
        _samples_decoded = 0;
        _error_message = QString();
        _rows.clear();
@@ -168,13 +184,24 @@ void DecoderStack::begin_decode()
        shared_ptr<pv::view::LogicSignal> logic_signal;
        shared_ptr<pv::data::Logic> data;
 
-       _decode_thread.interrupt();
-       _decode_thread.join();
+       if (_decode_thread.joinable()) {
+               _interrupt = true;
+               _input_cond.notify_one();
+               _decode_thread.join();
+       }
 
        clear();
 
+       // Check that all decoders have the required channels
+       for (const shared_ptr<decode::Decoder> &dec : _stack)
+               if (!dec->have_required_channels()) {
+                       _error_message = tr("One or more required channels "
+                               "have not been specified");
+                       return;
+               }
+
        // Add classes
-       BOOST_FOREACH (const shared_ptr<decode::Decoder> &dec, _stack)
+       for (const shared_ptr<decode::Decoder> &dec : _stack)
        {
                assert(dec);
                const srd_decoder *const decc = dec->decoder();
@@ -204,72 +231,109 @@ void DecoderStack::begin_decode()
                }
        }
 
-       // We get the logic data of the first probe in the list.
+       // We get the logic data of the first channel in the list.
        // This works because we are currently assuming all
        // LogicSignals have the same data/snapshot
-       BOOST_FOREACH (const shared_ptr<decode::Decoder> &dec, _stack)
-               if (dec && !dec->probes().empty() &&
-                       ((logic_signal = (*dec->probes().begin()).second)) &&
+       for (const shared_ptr<decode::Decoder> &dec : _stack)
+               if (dec && !dec->channels().empty() &&
+                       ((logic_signal = (*dec->channels().begin()).second)) &&
                        ((data = logic_signal->logic_data())))
                        break;
 
        if (!data)
                return;
 
+       // Check we have a snapshot of data
+       const deque< shared_ptr<pv::data::LogicSnapshot> > &snapshots =
+               data->get_snapshots();
+       if (snapshots.empty())
+               return;
+       _snapshot = snapshots.front();
+
        // Get the samplerate and start time
        _start_time = data->get_start_time();
        _samplerate = data->samplerate();
        if (_samplerate == 0.0)
                _samplerate = 1.0;
 
-       _decode_thread = boost::thread(&DecoderStack::decode_proc, this,
-               data);
+       _interrupt = false;
+       _decode_thread = std::thread(&DecoderStack::decode_proc, this);
 }
 
 uint64_t DecoderStack::get_max_sample_count() const
 {
        uint64_t max_sample_count = 0;
 
-       for (map<const Row, RowData>::const_iterator i = _rows.begin();
-               i != _rows.end(); i++)
+       for (auto i = _rows.cbegin(); i != _rows.end(); i++)
                max_sample_count = max(max_sample_count,
                        (*i).second.get_max_sample());
 
        return max_sample_count;
 }
 
-void DecoderStack::decode_proc(shared_ptr<data::Logic> data)
+optional<int64_t> DecoderStack::wait_for_data() const
+{
+       unique_lock<mutex> input_lock(_input_mutex);
+       while(!_interrupt && !_frame_complete &&
+               _samples_decoded >= _sample_count)
+               _input_cond.wait(input_lock);
+       return boost::make_optional(!_interrupt &&
+               (_samples_decoded < _sample_count || !_frame_complete),
+               _sample_count);
+}
+
+void DecoderStack::decode_data(
+       const int64_t sample_count, const unsigned int unit_size,
+       srd_session *const session)
 {
-       srd_session *session;
        uint8_t chunk[DecodeChunkLength];
-       srd_decoder_inst *prev_di = NULL;
 
-       assert(data);
+       const unsigned int chunk_sample_count =
+               DecodeChunkLength / _snapshot->unit_size();
 
-       // Check we have a snapshot of data
-       const deque< shared_ptr<pv::data::LogicSnapshot> > &snapshots =
-               data->get_snapshots();
-       if (snapshots.empty())
-               return;
+       for (int64_t i = 0; !_interrupt && i < sample_count;
+               i += chunk_sample_count)
+       {
+               lock_guard<mutex> decode_lock(_global_decode_mutex);
 
-       // Check that all decoders have the required probes
-       BOOST_FOREACH(const shared_ptr<decode::Decoder> &dec, _stack)
-               if (!dec->have_required_probes())
-                       return;
+               const int64_t chunk_end = min(
+                       i + chunk_sample_count, sample_count);
+               _snapshot->get_samples(chunk, i, chunk_end);
 
-       const shared_ptr<pv::data::LogicSnapshot> &snapshot =
-               snapshots.front();
-       const int64_t sample_count = snapshot->get_sample_count();
-       const unsigned int unit_size = snapshot->unit_size();
-       const unsigned int chunk_sample_count =
-               DecodeChunkLength / unit_size;
+               if (srd_session_send(session, i, i + sample_count, chunk,
+                               (chunk_end - i) * unit_size) != SRD_OK) {
+                       _error_message = tr("Decoder reported an error");
+                       break;
+               }
+
+               {
+                       lock_guard<mutex> lock(_output_mutex);
+                       _samples_decoded = chunk_end;
+               }
+
+               if (i % DecodeNotifyPeriod == 0)
+                       new_decode_data();
+       }
+
+       new_decode_data();
+}
+
+void DecoderStack::decode_proc()
+{
+       optional<int64_t> sample_count;
+       srd_session *session;
+       srd_decoder_inst *prev_di = NULL;
+
+       assert(_snapshot);
 
        // Create the session
        srd_session_new(&session);
        assert(session);
 
        // Create the decoders
-       BOOST_FOREACH(const shared_ptr<decode::Decoder> &dec, _stack)
+       const unsigned int unit_size = _snapshot->unit_size();
+
+       for (const shared_ptr<decode::Decoder> &dec : _stack)
        {
                srd_decoder_inst *const di = dec->create_decoder_inst(session, unit_size);
 
@@ -286,6 +350,12 @@ void DecoderStack::decode_proc(shared_ptr<data::Logic> data)
                prev_di = di;
        }
 
+       // Get the intial sample count
+       {
+               unique_lock<mutex> input_lock(_input_mutex);
+               sample_count = _sample_count = _snapshot->get_sample_count();
+       }
+
        // Start the session
        srd_session_metadata_set(session, SRD_CONF_SAMPLERATE,
                g_variant_new_uint64((uint64_t)_samplerate));
@@ -295,28 +365,9 @@ void DecoderStack::decode_proc(shared_ptr<data::Logic> data)
 
        srd_session_start(session);
 
-       for (int64_t i = 0;
-               !boost::this_thread::interruption_requested() &&
-                       i < sample_count;
-               i += chunk_sample_count)
-       {
-               lock_guard<mutex> decode_lock(_global_decode_mutex);
-
-               const int64_t chunk_end = min(
-                       i + chunk_sample_count, sample_count);
-               snapshot->get_samples(chunk, i, chunk_end);
-
-               if (srd_session_send(session, i, i + sample_count, chunk,
-                               (chunk_end - i) * unit_size) != SRD_OK) {
-                       _error_message = tr("Decoder reported an error");
-                       break;
-               }
-
-               {
-                       lock_guard<mutex> lock(_mutex);
-                       _samples_decoded = chunk_end;
-               }
-       }
+       do {
+               decode_data(*sample_count, unit_size, session);
+       } while(_error_message.isEmpty() && (sample_count = wait_for_data()));
 
        // Destroy the session
        srd_session_destroy(session);
@@ -330,7 +381,7 @@ void DecoderStack::annotation_callback(srd_proto_data *pdata, void *decoder)
        DecoderStack *const d = (DecoderStack*)decoder;
        assert(d);
 
-       lock_guard<mutex> lock(d->_mutex);
+       lock_guard<mutex> lock(d->_output_mutex);
 
        const Annotation a(pdata);
 
@@ -340,11 +391,10 @@ void DecoderStack::annotation_callback(srd_proto_data *pdata, void *decoder)
        const srd_decoder *const decc = pdata->pdo->di->decoder;
        assert(decc);
 
-       map<const Row, decode::RowData>::iterator row_iter = d->_rows.end();
+       auto row_iter = d->_rows.end();
        
        // Try looking up the sub-row of this class
-       const map<pair<const srd_decoder*, int>, Row>::const_iterator r =
-               d->_class_rows.find(make_pair(decc, a.format()));
+       const auto r = d->_class_rows.find(make_pair(decc, a.format()));
        if (r != d->_class_rows.end())
                row_iter = d->_rows.find((*r).second);
        else
@@ -363,8 +413,31 @@ void DecoderStack::annotation_callback(srd_proto_data *pdata, void *decoder)
 
        // Add the annotation
        (*row_iter).second.push_annotation(a);
+}
+
+void DecoderStack::on_new_frame()
+{
+       begin_decode();
+}
+
+void DecoderStack::on_data_received()
+{
+       {
+               unique_lock<mutex> lock(_input_mutex);
+               if (_snapshot)
+                       _sample_count = _snapshot->get_sample_count();
+       }
+       _input_cond.notify_one();
+}
 
-       d->new_decode_data();
+void DecoderStack::on_frame_ended()
+{
+       {
+               unique_lock<mutex> lock(_input_mutex);
+               if (_snapshot)
+                       _frame_complete = true;
+       }
+       _input_cond.notify_one();
 }
 
 } // namespace data