]> sigrok.org Git - pulseview.git/blobdiff - pv/data/decoderstack.cpp
Rename 'probe' to 'channel' (libsigrokdecode change).
[pulseview.git] / pv / data / decoderstack.cpp
index 716d778b390c1c344e2a829c53498b4d4e5894f8..c3bf26d25699c12135707b40512414c9ee0ef4f3 100644 (file)
@@ -38,7 +38,9 @@
 
 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;
@@ -56,15 +58,23 @@ 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(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(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)));
@@ -106,13 +116,13 @@ 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;
 
@@ -147,7 +157,7 @@ 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);
@@ -158,12 +168,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();
@@ -182,6 +194,14 @@ void DecoderStack::begin_decode()
 
        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)
        {
@@ -213,26 +233,32 @@ 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)) &&
+               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);
+       _decode_thread = boost::thread(&DecoderStack::decode_proc, this);
 }
 
 uint64_t DecoderStack::get_max_sample_count() const
@@ -247,16 +273,26 @@ uint64_t DecoderStack::get_max_sample_count() const
        return max_sample_count;
 }
 
+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 shared_ptr<pv::data::LogicSnapshot> &snapshot,
+       const int64_t sample_count, const unsigned int unit_size,
        srd_session *const session)
 {
        uint8_t chunk[DecodeChunkLength];
 
-       const int64_t sample_count = snapshot->get_sample_count();
-       const unsigned int unit_size = snapshot->unit_size();
        const unsigned int chunk_sample_count =
-               DecodeChunkLength / snapshot->unit_size();
+               DecodeChunkLength / _snapshot->unit_size();
 
        for (int64_t i = 0;
                !boost::this_thread::interruption_requested() &&
@@ -267,7 +303,7 @@ void DecoderStack::decode_data(
 
                const int64_t chunk_end = min(
                        i + chunk_sample_count, sample_count);
-               snapshot->get_samples(chunk, i, chunk_end);
+               _snapshot->get_samples(chunk, i, chunk_end);
 
                if (srd_session_send(session, i, i + sample_count, chunk,
                                (chunk_end - i) * unit_size) != SRD_OK) {
@@ -276,38 +312,31 @@ void DecoderStack::decode_data(
                }
 
                {
-                       lock_guard<mutex> lock(_mutex);
+                       lock_guard<mutex> lock(_output_mutex);
                        _samples_decoded = chunk_end;
                }
+
+               if (i % DecodeNotifyPeriod == 0)
+                       new_decode_data();
        }
 
+       new_decode_data();
 }
 
-void DecoderStack::decode_proc(shared_ptr<data::Logic> data)
+void DecoderStack::decode_proc()
 {
+       optional<int64_t> sample_count;
        srd_session *session;
        srd_decoder_inst *prev_di = NULL;
 
-       assert(data);
-
-       // Check we have a snapshot of data
-       const deque< shared_ptr<pv::data::LogicSnapshot> > &snapshots =
-               data->get_snapshots();
-       if (snapshots.empty())
-               return;
-
-       // Check that all decoders have the required probes
-       BOOST_FOREACH(const shared_ptr<decode::Decoder> &dec, _stack)
-               if (!dec->have_required_probes())
-                       return;
+       assert(_snapshot);
 
        // Create the session
        srd_session_new(&session);
        assert(session);
 
        // Create the decoders
-       const shared_ptr<pv::data::LogicSnapshot> &snapshot = snapshots.front();
-       const unsigned int unit_size = snapshot->unit_size();
+       const unsigned int unit_size = _snapshot->unit_size();
 
        BOOST_FOREACH(const shared_ptr<decode::Decoder> &dec, _stack)
        {
@@ -326,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));
@@ -335,7 +370,9 @@ void DecoderStack::decode_proc(shared_ptr<data::Logic> data)
 
        srd_session_start(session);
 
-       decode_data(snapshot, session);
+       do {
+               decode_data(*sample_count, unit_size, session);
+       } while(_error_message.isEmpty() && (sample_count = wait_for_data()));
 
        // Destroy the session
        srd_session_destroy(session);
@@ -349,7 +386,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);
 
@@ -382,8 +419,6 @@ void DecoderStack::annotation_callback(srd_proto_data *pdata, void *decoder)
 
        // Add the annotation
        (*row_iter).second.push_annotation(a);
-
-       d->new_decode_data();
 }
 
 void DecoderStack::on_new_frame()
@@ -391,5 +426,25 @@ 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();
+}
+
+void DecoderStack::on_frame_ended()
+{
+       {
+               unique_lock<mutex> lock(_input_mutex);
+               if (_snapshot)
+                       _frame_complete = true;
+       }
+       _input_cond.notify_one();
+}
+
 } // namespace data
 } // namespace pv