]> sigrok.org Git - pulseview.git/blobdiff - pv/data/decoderstack.cpp
Rename 'probe' to 'channel' (libsigrokdecode change).
[pulseview.git] / pv / data / decoderstack.cpp
index 760d336e14c4dcb65628b2ebb9a8bff31849754e..c3bf26d25699c12135707b40512414c9ee0ef4f3 100644 (file)
 #include <pv/data/logic.h>
 #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>
-#include <pv/view/decode/annotation.h>
 
-using namespace boost;
-using namespace std;
+using boost::lock_guard;
+using boost::mutex;
+using boost::optional;
+using boost::shared_ptr;
+using boost::unique_lock;
+using std::deque;
+using std::make_pair;
+using std::max;
+using std::min;
+using std::list;
+using std::map;
+using std::pair;
+using std::vector;
+
+using namespace pv::data::decode;
 
 namespace pv {
 namespace data {
@@ -44,20 +58,34 @@ 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()) {
+               _decode_thread.interrupt();
+               _decode_thread.join();
+       }
 }
 
 const std::list< boost::shared_ptr<decode::Decoder> >&
@@ -74,8 +102,6 @@ void DecoderStack::push(boost::shared_ptr<decode::Decoder> decoder)
 
 void DecoderStack::remove(int index)
 {
-       using pv::data::decode::Decoder;
-
        assert(index >= 0);
        assert(index < (int)_stack.size());
 
@@ -90,91 +116,235 @@ 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;
 }
 
-const vector< shared_ptr<view::decode::Annotation> >
-       DecoderStack::annotations() const
+std::vector<Row> DecoderStack::get_visible_rows() const
+{
+       lock_guard<mutex> lock(_output_mutex);
+
+       vector<Row> rows;
+
+       BOOST_FOREACH (const shared_ptr<decode::Decoder> &dec, _stack)
+       {
+               assert(dec);
+               if (!dec->shown())
+                       continue;
+
+               const srd_decoder *const decc = dec->decoder();
+               assert(dec->decoder());
+
+               // Add a row for the decoder if it doesn't have a row list
+               if (!decc->annotation_rows)
+                       rows.push_back(Row(decc));
+
+               // Add the decoder rows
+               for (const GSList *l = decc->annotation_rows; l; l = l->next)
+               {
+                       const srd_decoder_annotation_row *const ann_row =
+                               (srd_decoder_annotation_row *)l->data;
+                       assert(ann_row);
+                       rows.push_back(Row(decc, ann_row));
+               }
+       }
+
+       return rows;
+}
+
+void DecoderStack::get_annotation_subset(
+       std::vector<pv::data::decode::Annotation> &dest,
+       const Row &row, uint64_t start_sample,
+       uint64_t end_sample) const
 {
-       lock_guard<mutex> lock(_mutex);
-       return _annotations;
+       lock_guard<mutex> lock(_output_mutex);
+
+       std::map<const Row, decode::RowData>::const_iterator iter =
+               _rows.find(row);
+       if (iter != _rows.end())
+               (*iter).second.get_annotation_subset(dest,
+                       start_sample, end_sample);
 }
 
 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();
+       _class_rows.clear();
+}
+
 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()) {
+               _decode_thread.interrupt();
+               _decode_thread.join();
+       }
 
-       _samples_decoded = 0;
+       clear();
+
+       // Check that all decoders have the required channels
+       BOOST_FOREACH(const shared_ptr<decode::Decoder> &dec, _stack)
+               if (!dec->have_required_probes()) {
+                       _error_message = tr("One or more required channels "
+                               "have not been specified");
+                       return;
+               }
+
+       // Add classes
+       BOOST_FOREACH (const shared_ptr<decode::Decoder> &dec, _stack)
+       {
+               assert(dec);
+               const srd_decoder *const decc = dec->decoder();
+               assert(dec->decoder());
+
+               // Add a row for the decoder if it doesn't have a row list
+               if (!decc->annotation_rows)
+                       _rows[Row(decc)] = decode::RowData();
+
+               // Add the decoder rows
+               for (const GSList *l = decc->annotation_rows; l; l = l->next)
+               {
+                       const srd_decoder_annotation_row *const ann_row =
+                               (srd_decoder_annotation_row *)l->data;
+                       assert(ann_row);
 
-       _annotations.clear();
+                       const Row row(decc, ann_row);
 
-       // We get the logic data of the first probe in the list.
+                       // Add a new empty row data object
+                       _rows[row] = decode::RowData();
+
+                       // Map out all the classes
+                       for (const GSList *ll = ann_row->ann_classes;
+                               ll; ll = ll->next)
+                               _class_rows[make_pair(decc,
+                                       GPOINTER_TO_INT(ll->data))] = row;
+               }
+       }
+
+       // 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)) &&
+               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->get_samplerate();
+       _samplerate = data->samplerate();
        if (_samplerate == 0.0)
                _samplerate = 1.0;
 
-       _decode_thread = boost::thread(&DecoderStack::decode_proc, this,
-               data);
+       _decode_thread = boost::thread(&DecoderStack::decode_proc, this);
 }
 
-void DecoderStack::clear()
+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++)
+               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(!boost::this_thread::interruption_requested() &&
+               !_frame_complete && _samples_decoded >= _sample_count)
+               _input_cond.wait(input_lock);
+       return boost::make_optional(
+               !boost::this_thread::interruption_requested() &&
+               (_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();
 
-       const deque< shared_ptr<pv::data::LogicSnapshot> > &snapshots =
-               data->get_snapshots();
-       if (snapshots.empty())
-               return;
+       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(_output_mutex);
+                       _samples_decoded = chunk_end;
+               }
+
+               if (i % DecodeNotifyPeriod == 0)
+                       new_decode_data();
+       }
 
-       const shared_ptr<pv::data::LogicSnapshot> &snapshot =
-               snapshots.front();
-       const int64_t sample_count = snapshot->get_sample_count() - 1;
+       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
+       const unsigned int unit_size = _snapshot->unit_size();
+
        BOOST_FOREACH(const shared_ptr<decode::Decoder> &dec, _stack)
        {
-               srd_decoder_inst *const di = dec->create_decoder_inst(session);
+               srd_decoder_inst *const di = dec->create_decoder_inst(session, unit_size);
 
                if (!di)
                {
-                       _error_message = tr("Failed to initialise decoder");
+                       _error_message = tr("Failed to create decoder instance");
                        srd_session_destroy(session);
                        return;
                }
@@ -185,6 +355,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));
@@ -194,27 +370,9 @@ void DecoderStack::decode_proc(shared_ptr<data::Logic> data)
 
        srd_session_start(session);
 
-       for (int64_t i = 0;
-               !this_thread::interruption_requested() && i < sample_count;
-               i += DecodeChunkLength)
-       {
-               lock_guard<mutex> decode_lock(_global_decode_mutex);
-
-               const int64_t chunk_end = min(
-                       i + DecodeChunkLength, sample_count);
-               snapshot->get_samples(chunk, i, chunk_end);
-
-               if (srd_session_send(session, i, i + sample_count,
-                               chunk, chunk_end - i) != SRD_OK) {
-                       _error_message = tr("Failed to initialise decoder");
-                       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);
@@ -222,18 +380,70 @@ void DecoderStack::decode_proc(shared_ptr<data::Logic> data)
 
 void DecoderStack::annotation_callback(srd_proto_data *pdata, void *decoder)
 {
-       using namespace pv::view::decode;
-
        assert(pdata);
        assert(decoder);
 
        DecoderStack *const d = (DecoderStack*)decoder;
+       assert(d);
+
+       lock_guard<mutex> lock(d->_output_mutex);
+
+       const Annotation a(pdata);
+
+       // Find the row
+       assert(pdata->pdo);
+       assert(pdata->pdo->di);
+       const srd_decoder *const decc = pdata->pdo->di->decoder;
+       assert(decc);
+
+       map<const Row, decode::RowData>::iterator 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()));
+       if (r != d->_class_rows.end())
+               row_iter = d->_rows.find((*r).second);
+       else
+       {
+               // Failing that, use the decoder as a key
+               row_iter = d->_rows.find(Row(decc));    
+       }
+
+       assert(row_iter != d->_rows.end());
+       if (row_iter == d->_rows.end()) {
+               qDebug() << "Unexpected annotation: decoder = " << decc <<
+                       ", format = " << a.format();
+               assert(0);
+               return;
+       }
+
+       // Add the annotation
+       (*row_iter).second.push_annotation(a);
+}
+
+void DecoderStack::on_new_frame()
+{
+       begin_decode();
+}
 
-       shared_ptr<Annotation> a(new Annotation(pdata));
-       lock_guard<mutex> lock(d->_mutex);
-       d->_annotations.push_back(a);
+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