]> sigrok.org Git - pulseview.git/blobdiff - pv/data/decoderstack.cpp
Rework decode sample count getters
[pulseview.git] / pv / data / decoderstack.cpp
index 2668df2937acb3e29035ab39ceffaf86953f1195..c7504f58ab5af94c90b762b9316e544918131152 100644 (file)
@@ -14,8 +14,7 @@
  * GNU General Public License for more details.
  *
  * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
+ * along with this program; if not, see <http://www.gnu.org/licenses/>.
  */
 
 #include <libsigrokdecode/libsigrokdecode.h>
 
 #include "decoderstack.hpp"
 
+#include <pv/data/decode/annotation.hpp>
+#include <pv/data/decode/decoder.hpp>
 #include <pv/data/logic.hpp>
 #include <pv/data/logicsegment.hpp>
-#include <pv/data/decode/decoder.hpp>
-#include <pv/data/decode/annotation.hpp>
 #include <pv/session.hpp>
-#include <pv/view/logicsignal.hpp>
+#include <pv/views/trace/logicsignal.hpp>
 
 using std::lock_guard;
 using std::mutex;
-using boost::optional;
 using std::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::shared_ptr;
+using std::make_shared;
 using std::vector;
 
+using boost::optional;
+
 using namespace pv::data::decode;
 
 namespace pv {
@@ -54,10 +53,10 @@ 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;
+const int64_t DecoderStack::DecodeChunkLength = 10 * 1024 * 1024;
+const unsigned int DecoderStack::DecodeNotifyPeriod = 1024;
 
-mutex DecoderStack::global_decode_mutex_;
+mutex DecoderStack::global_srd_mutex_;
 
 DecoderStack::DecoderStack(pv::Session &session,
        const srd_decoder *const dec) :
@@ -75,8 +74,7 @@ DecoderStack::DecoderStack(pv::Session &session,
        connect(&session_, SIGNAL(frame_ended()),
                this, SLOT(on_frame_ended()));
 
-       stack_.push_back(shared_ptr<decode::Decoder>(
-               new decode::Decoder(dec)));
+       stack_.push_back(make_shared<decode::Decoder>(dec));
 }
 
 DecoderStack::~DecoderStack()
@@ -88,13 +86,12 @@ DecoderStack::~DecoderStack()
        }
 }
 
-const std::list< std::shared_ptr<decode::Decoder> >&
-DecoderStack::stack() const
+const list< shared_ptr<decode::Decoder> >& DecoderStack::stack() const
 {
        return stack_;
 }
 
-void DecoderStack::push(std::shared_ptr<decode::Decoder> decoder)
+void DecoderStack::push(shared_ptr<decode::Decoder> decoder)
 {
        assert(decoder);
        stack_.push_back(decoder);
@@ -130,7 +127,7 @@ int64_t DecoderStack::samples_decoded() const
        return samples_decoded_;
 }
 
-std::vector<Row> DecoderStack::get_visible_rows() const
+vector<Row> DecoderStack::get_visible_rows() const
 {
        lock_guard<mutex> lock(output_mutex_);
 
@@ -146,22 +143,27 @@ std::vector<Row> DecoderStack::get_visible_rows() const
 
                // Add a row for the decoder if it doesn't have a row list
                if (!decc->annotation_rows)
-                       rows.push_back(Row(decc));
+                       rows.emplace_back(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));
+                       rows.emplace_back(decc, ann_row);
                }
        }
 
        return rows;
 }
 
+uint64_t DecoderStack::inc_annotation_count()
+{
+       return (annotation_count_++);
+}
+
 void DecoderStack::get_annotation_subset(
-       std::vector<pv::data::decode::Annotation> &dest,
+       vector<pv::data::decode::Annotation> &dest,
        const Row &row, uint64_t start_sample,
        uint64_t end_sample) const
 {
@@ -182,6 +184,7 @@ QString DecoderStack::error_message()
 void DecoderStack::clear()
 {
        sample_count_ = 0;
+       annotation_count_ = 0;
        frame_complete_ = false;
        samples_decoded_ = 0;
        error_message_ = QString();
@@ -191,9 +194,6 @@ void DecoderStack::clear()
 
 void DecoderStack::begin_decode()
 {
-       shared_ptr<pv::view::LogicSignal> logic_signal;
-       shared_ptr<pv::data::Logic> data;
-
        if (decode_thread_.joinable()) {
                interrupt_ = true;
                input_cond_.notify_one();
@@ -241,11 +241,14 @@ void DecoderStack::begin_decode()
 
        // 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/segment
+       // logic signals have the same data/segment
+       pv::data::SignalBase *signalbase;
+       pv::data::Logic *data = nullptr;
+
        for (const shared_ptr<decode::Decoder> &dec : stack_)
                if (dec && !dec->channels().empty() &&
-                       ((logic_signal = (*dec->channels().begin()).second)) &&
-                       ((data = logic_signal->logic_data())))
+                       ((signalbase = (*dec->channels().begin()).second.get())) &&
+                       ((data = signalbase->logic_data().get())))
                        break;
 
        if (!data)
@@ -272,9 +275,9 @@ uint64_t DecoderStack::max_sample_count() const
 {
        uint64_t max_sample_count = 0;
 
-       for (auto i = rows_.cbegin(); i != rows_.end(); i++)
+       for (const auto& row : rows_)
                max_sample_count = max(max_sample_count,
-                       (*i).second.get_max_sample());
+                       row.second.get_max_sample());
 
        return max_sample_count;
 }
@@ -282,47 +285,52 @@ uint64_t DecoderStack::max_sample_count() const
 optional<int64_t> DecoderStack::wait_for_data() const
 {
        unique_lock<mutex> input_lock(input_mutex_);
+
+       // Do wait if we decoded all samples but we're still capturing
+       // Do not wait if we're done capturing
        while (!interrupt_ && !frame_complete_ &&
-               samples_decoded_ >= sample_count_)
+               (samples_decoded_ >= sample_count_) &&
+               (session_.get_capture_state() != Session::Stopped)) {
+
                input_cond_.wait(input_lock);
+       }
+
+       // Return value is valid if we're not aborting the decode,
        return boost::make_optional(!interrupt_ &&
-               (samples_decoded_ < sample_count_ || !frame_complete_),
+               // and there's more work to do...
+               (samples_decoded_ < sample_count_ || !frame_complete_) &&
+               // and if the end of the data hasn't been reached yet
+               (!((samples_decoded_ >= sample_count_) && (session_.get_capture_state() == Session::Stopped))),
                sample_count_);
 }
 
 void DecoderStack::decode_data(
-       const int64_t sample_count, const unsigned int unit_size,
+       const int64_t abs_start_samplenum, const int64_t sample_count, const unsigned int unit_size,
        srd_session *const session)
 {
-       uint8_t chunk[DecodeChunkLength];
-
        const unsigned int chunk_sample_count =
                DecodeChunkLength / segment_->unit_size();
 
-       for (int64_t i = 0; !interrupt_ && i < sample_count;
+       for (int64_t i = abs_start_samplenum; !interrupt_ && 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);
-               segment_->get_samples(chunk, i, chunk_end);
+               const uint8_t* chunk = segment_->get_samples(i, chunk_end);
 
                if (srd_session_send(session, i, chunk_end, chunk,
                                (chunk_end - i) * unit_size, unit_size) != SRD_OK) {
                        error_message_ = tr("Decoder reported an error");
+                       delete[] chunk;
                        break;
                }
+               delete[] chunk;
 
                {
                        lock_guard<mutex> lock(output_mutex_);
                        samples_decoded_ = chunk_end;
                }
-
-               if (i % DecodeNotifyPeriod == 0)
-                       new_decode_data();
        }
-
-       new_decode_data();
 }
 
 void DecoderStack::decode_proc()
@@ -333,6 +341,9 @@ void DecoderStack::decode_proc()
 
        assert(segment_);
 
+       // Prevent any other decode threads from accessing libsigrokdecode
+       lock_guard<mutex> srd_lock(global_srd_mutex_);
+
        // Create the session
        srd_session_new(&session);
        assert(session);
@@ -370,23 +381,28 @@ void DecoderStack::decode_proc()
 
        srd_session_start(session);
 
+       int64_t abs_start_samplenum = 0;
        do {
-               decode_data(*sample_count, unit_size, session);
+               decode_data(abs_start_samplenum, *sample_count, unit_size, session);
+               abs_start_samplenum = *sample_count;
        } while (error_message_.isEmpty() && (sample_count = wait_for_data()));
 
+       // Make sure all annotations are known to the frontend
+       new_annotations();
+
        // Destroy the session
        srd_session_destroy(session);
 }
 
-void DecoderStack::annotation_callback(srd_proto_data *pdata, void *decoder)
+void DecoderStack::annotation_callback(srd_proto_data *pdata, void *decoder_stack)
 {
        assert(pdata);
        assert(decoder);
 
-       DecoderStack *const d = (DecoderStack*)decoder;
-       assert(d);
+       DecoderStack *const ds = (DecoderStack*)decoder_stack;
+       assert(ds);
 
-       lock_guard<mutex> lock(d->output_mutex_);
+       lock_guard<mutex> lock(ds->output_mutex_);
 
        const Annotation a(pdata);
 
@@ -396,27 +412,31 @@ void DecoderStack::annotation_callback(srd_proto_data *pdata, void *decoder)
        const srd_decoder *const decc = pdata->pdo->di->decoder;
        assert(decc);
 
-       auto row_iter = d->rows_.end();
+       auto row_iter = ds->rows_.end();
 
        // Try looking up the sub-row of this class
-       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);
+       const auto r = ds->class_rows_.find(make_pair(decc, a.format()));
+       if (r != ds->class_rows_.end())
+               row_iter = ds->rows_.find((*r).second);
        else {
                // Failing that, use the decoder as a key
-               row_iter = d->rows_.find(Row(decc));    
+               row_iter = ds->rows_.find(Row(decc));
        }
 
-       assert(row_iter != d->rows_.end());
-       if (row_iter == d->rows_.end()) {
+       assert(row_iter != ds->rows_.end());
+       if (row_iter == ds->rows_.end()) {
                qDebug() << "Unexpected annotation: decoder = " << decc <<
                        ", format = " << a.format();
-               assert(0);
+               assert(false);
                return;
        }
 
        // Add the annotation
        (*row_iter).second.push_annotation(a);
+
+       // Notify the frontend every DecodeNotifyPeriod annotations
+       if (ds->inc_annotation_count() % DecodeNotifyPeriod == 0)
+               ds->new_annotations();
 }
 
 void DecoderStack::on_new_frame()