tempo-plotter Changeset - 14ef268b5d60 · protofusion repositories

Changeset - 14ef268b5d60

Parent rev.

Child rev.

[Not reviewed]

stream

0 5 1

Hasan Yavuz ÖZDERYA - 8 years ago 2018-04-03 16:32:06
hy@ozderya.net

reworked BinaryStreamReader as `Source`, ONLY the tests compiles, no functional tests yet

6 files changed with 96 insertions and 103 deletions:

src/abstractreader.cpp

src/abstractreader.h

src/binarystreamreader.cpp

src/binarystreamreader.h

tests/CMakeLists.txt

tests/test_readers.cpp

0 comments (0 inline, 0 general)

src/abstractreader.cpp

➞

Show inline comments

 /*
-  Copyright © 2017 Hasan Yavuz Özderya
+  Copyright © 2018 Hasan Yavuz Özderya
   This file is part of serialplot.
   serialplot is free software: you can redistribute it and/or modify
   it under the terms of the GNU General Public License as published by
   the Free Software Foundation, either version 3 of the License, or
   (at your option) any later version.
   serialplot is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   GNU General Public License for more details.
   You should have received a copy of the GNU General Public License
   along with serialplot.  If not, see <http://www.gnu.org/licenses/>.
 */
 #include "abstractreader.h"
 AbstractReader::AbstractReader(QIODevice* device, ChannelManager* channelMan,
                                DataRecorder* recorder, QObject* parent) :
 AbstractReader::AbstractReader(QIODevice* device, QObject* parent) :
     QObject(parent)
+{
     _device = device;
     _channelMan = channelMan;
     _recorder = recorder;
     recording = false;
     // initialize sps counter
     sampleCount = 0;
     samplesPerSecond = 0;
     QObject::connect(&spsTimer, &QTimer::timeout,
                      this, &AbstractReader::spsTimerTimeout);
     // TODO: start sps timer when reader is enabled
     spsTimer.start(SPS_UPDATE_TIMEOUT * 1000);
+}
 void AbstractReader::spsTimerTimeout()
+{
     unsigned currentSps = samplesPerSecond;
     samplesPerSecond = (sampleCount/numOfChannels())/SPS_UPDATE_TIMEOUT;
     if (currentSps != samplesPerSecond)
+    {
         emit samplesPerSecondChanged(samplesPerSecond);
+    }
     sampleCount = 0;
+}
 void AbstractReader::addData(double* samples, unsigned length)
+{
     _channelMan->addData(samples, length);
     if (recording)
+    {
         _recorder->addData(samples, length, numOfChannels());
+    }
     sampleCount += length;
+}

src/abstractreader.h

➞

Show inline comments

 /*
-  Copyright © 2017 Hasan Yavuz Özderya
+  Copyright © 2018 Hasan Yavuz Özderya
   This file is part of serialplot.
   serialplot is free software: you can redistribute it and/or modify
   it under the terms of the GNU General Public License as published by
   the Free Software Foundation, either version 3 of the License, or
   (at your option) any later version.
   serialplot is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   GNU General Public License for more details.
@@ @@ -16,89 +16,54 @@ @@
   You should have received a copy of the GNU General Public License
   along with serialplot.  If not, see <http://www.gnu.org/licenses/>.
 */
 #ifndef ABSTRACTREADER_H
 #define ABSTRACTREADER_H
 #include <QObject>
 #include <QIODevice>
 #include <QWidget>
 #include <QTimer>
 #include "channelmanager.h"
 #include "datarecorder.h"
 #include "source.h"
 /**
  * All reader classes must inherit this class.
  */
 class AbstractReader : public QObject
+class AbstractReader : public QObject, public Source
+{
     Q_OBJECT
 public:
     explicit AbstractReader(QIODevice* device, ChannelManager* channelMan,
                             DataRecorder* recorder, QObject* parent = 0);
     bool recording;                 /// is recording started
     explicit AbstractReader(QIODevice* device, QObject* parent = 0);
     /**
      * Returns a widget to be shown in data format panel when reader
      * is selected.
      */
     virtual QWidget* settingsWidget() = 0;
     /**
      * Number of channels being read.
+     *
      * This number may be user selected or automatically determined
      * from incoming stream.
      */
     virtual unsigned numOfChannels() = 0;
     /// Reader should only read when enabled. Default state should be
     /// 'disabled'.
     virtual void enable(bool enabled = true) = 0;
     /**
      * @brief Starts sending data to recorder.
+     *
      * @note recorder must have been started!
      */
     void startRecording();
     /// Stops recording.
     void stopRecording();
     /// None of the current readers support X channel at the moment
     bool hasX() const final { return false; };
 signals:
     // TODO: should we keep this?
     void numOfChannelsChanged(unsigned);
     void samplesPerSecondChanged(unsigned);
 public slots:
     /**
      * Pauses the reading.
+     *
      * Reader should actually continue reading to keep the
      * synchronization but shouldn't commit data.
      */
     virtual void pause(bool) = 0;
 protected:
     QIODevice* _device;
     /// Should be called with read data
     void addData(double* samples, unsigned length);
 private:
     const int SPS_UPDATE_TIMEOUT = 1;  // second
     unsigned sampleCount;
     unsigned samplesPerSecond;
     ChannelManager* _channelMan;
     DataRecorder* _recorder;
     QTimer spsTimer;
 private slots:
     void spsTimerTimeout();
 };
 #endif // ABSTRACTREADER_H

src/binarystreamreader.cpp

➞

Show inline comments

 /*
-  Copyright © 2017 Hasan Yavuz Özderya
+  Copyright © 2018 Hasan Yavuz Özderya
   This file is part of serialplot.
   serialplot is free software: you can redistribute it and/or modify
   it under the terms of the GNU General Public License as published by
   the Free Software Foundation, either version 3 of the License, or
   (at your option) any later version.
   serialplot is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   GNU General Public License for more details.
   You should have received a copy of the GNU General Public License
   along with serialplot.  If not, see <http://www.gnu.org/licenses/>.
 */
 #include <QtEndian>
 #include <QtDebug>
 #include "binarystreamreader.h"
 #include "floatswap.h"
 BinaryStreamReader::BinaryStreamReader(QIODevice* device, ChannelManager* channelMan,
                                        DataRecorder* recorder, QObject* parent) :
     AbstractReader(device, channelMan, recorder, parent)
 BinaryStreamReader::BinaryStreamReader(QIODevice* device, QObject* parent) :
     AbstractReader(device, parent)
+{
     paused = false;
     skipByteRequested = false;
     skipSampleRequested = false;
     _numOfChannels = _settingsWidget.numOfChannels();
     connect(&_settingsWidget, &BinaryStreamReaderSettings::numOfChannelsChanged,
             this, &BinaryStreamReader::numOfChannelsChanged);
     _numChannels = _settingsWidget.numOfChannels();
     connect(&_settingsWidget, &BinaryStreamReaderSettings::numOfChannelsChanged,
             this, &BinaryStreamReader::onNumOfChannelsChanged);
     // initial number format selection
     onNumberFormatChanged(_settingsWidget.numberFormat());
     connect(&_settingsWidget, &BinaryStreamReaderSettings::numberFormatChanged,
             this, &BinaryStreamReader::onNumberFormatChanged);
     // enable skip byte and sample buttons
     connect(&_settingsWidget, &BinaryStreamReaderSettings::skipByteRequested,
             [this]()
+            {
@@ @@ -51,39 +48,40 @@ BinaryStreamReader::BinaryStreamReader(Q @@
     connect(&_settingsWidget, &BinaryStreamReaderSettings::skipSampleRequested,
             [this]()
+            {
                 skipSampleRequested = true;
             });
+}
 QWidget* BinaryStreamReader::settingsWidget()
+{
     return &_settingsWidget;
+}
-unsigned BinaryStreamReader::numOfChannels()
+unsigned BinaryStreamReader::numChannels() const
+{
-    return _numOfChannels;
+    return _numChannels;
+}
 void BinaryStreamReader::enable(bool enabled)
+{
     if (enabled)
+    {
         QObject::connect(_device, &QIODevice::readyRead,
                          this, &BinaryStreamReader::onDataReady);
+    }
     else
+    {
         QObject::disconnect(_device, 0, this, 0);
         disconnectSinks();
+    }
+}
 void BinaryStreamReader::pause(bool enabled)
+{
     paused = enabled;
+}
 void BinaryStreamReader::onNumberFormatChanged(NumberFormat numberFormat)
+{
     switch(numberFormat)
+    {
@@ @@ -114,31 +112,33 @@ void BinaryStreamReader::onNumberFormatC @@
         case NumberFormat_float:
             sampleSize = 4;
             readSample = &BinaryStreamReader::readSampleAs<float>;
             break;
         case NumberFormat_INVALID:
             Q_ASSERT(1); // never
             break;
+    }
+}
 void BinaryStreamReader::onNumOfChannelsChanged(unsigned value)
+{
     _numOfChannels = value;
     _numChannels = value;
     updateNumChannels();
     emit numOfChannelsChanged(value);
+}
 void BinaryStreamReader::onDataReady()
+{
     // a package is a set of channel data like {CHAN0_SAMPLE, CHAN1_SAMPLE...}
-    int packageSize = sampleSize * _numOfChannels;
+    int packageSize = sampleSize * _numChannels;
     int bytesAvailable = _device->bytesAvailable();
     // skip 1 byte if requested
     if (bytesAvailable > 0 && skipByteRequested)
+    {
         _device->read(1);
         skipByteRequested = false;
         bytesAvailable--;
+    }
     // skip 1 sample (channel) if requested
     if (bytesAvailable >= (int) sampleSize && skipSampleRequested)
@@ @@ -151,38 +151,34 @@ void BinaryStreamReader::onDataReady() @@
     if (bytesAvailable < packageSize) return;
     int numOfPackagesToRead =
         (bytesAvailable - (bytesAvailable % packageSize)) / packageSize;
     if (paused)
+    {
         // read and discard data
         _device->read(numOfPackagesToRead*packageSize);
         return;
+    }
     double* channelSamples = new double[numOfPackagesToRead*_numOfChannels];
     // actual reading
     SamplePack samples(numOfPackagesToRead, _numChannels);
     for (int i = 0; i < numOfPackagesToRead; i++)
+    {
-        for (unsigned int ci = 0; ci < _numOfChannels; ci++)
+        for (unsigned int ci = 0; ci < _numChannels; ci++)
+        {
             // channelSamples[ci].replace(i, (this->*readSample)());
             channelSamples[ci*numOfPackagesToRead+i] = (this->*readSample)();
             samples.data(ci)[i] = (this->*readSample)();
+        }
+    }
     addData(channelSamples, numOfPackagesToRead*_numOfChannels);
     delete[] channelSamples;
     feedOut(samples);
+}
 template<typename T> double BinaryStreamReader::readSampleAs()
+{
     T data;
     _device->read((char*) &data, sizeof(data));
     if (_settingsWidget.endianness() == LittleEndian)
+    {
         data = qFromLittleEndian(data);
+    }

src/binarystreamreader.h

➞

Show inline comments

 /*
-  Copyright © 2017 Hasan Yavuz Özderya
+  Copyright © 2018 Hasan Yavuz Özderya
   This file is part of serialplot.
   serialplot is free software: you can redistribute it and/or modify
   it under the terms of the GNU General Public License as published by
   the Free Software Foundation, either version 3 of the License, or
   (at your option) any later version.
   serialplot is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   GNU General Public License for more details.
@@ @@ -25,40 +25,39 @@ @@
 #include "abstractreader.h"
 #include "binarystreamreadersettings.h"
 /**
  * Reads a simple stream of samples in binary form from the
  * device. There is no means of synchronization other than a button
  * that should be manually triggered by user.
  */
 class BinaryStreamReader : public AbstractReader
+{
     Q_OBJECT
 public:
     explicit BinaryStreamReader(QIODevice* device, ChannelManager* channelMan,
                                 DataRecorder* recorder, QObject *parent = 0);
     explicit BinaryStreamReader(QIODevice* device, QObject *parent = 0);
     QWidget* settingsWidget();
-    unsigned numOfChannels();
+    unsigned numChannels() const;
     void enable(bool enabled = true);
     /// Stores settings into a `QSettings`
     void saveSettings(QSettings* settings);
     /// Loads settings from a `QSettings`.
     void loadSettings(QSettings* settings);
 public slots:
     void pause(bool);
 private:
     BinaryStreamReaderSettings _settingsWidget;
-    unsigned _numOfChannels;
+    unsigned _numChannels;
     unsigned sampleSize;
     bool paused;
     bool skipByteRequested;
     bool skipSampleRequested;
     /// points to the readSampleAs function for currently selected number format
     double (BinaryStreamReader::*readSample)();
     /**
      * Reads 1 sample from the device in given format.
+     *
      * @note Device should already have enough bytes present before

tests/CMakeLists.txt

➞

Show inline comments

@@ @@ -30,15 +30,38 @@ add_executable(Test EXCLUDE_FROM_ALL @@
   ../src/source.cpp
   ../src/indexbuffer.cpp
   ../src/linindexbuffer.cpp
   ../src/ringbuffer.cpp
   ../src/readonlybuffer.cpp
   ../src/stream.cpp
   ../src/streamchannel.cpp
   ../src/channelinfomodel.cpp
+  )
 add_test(NAME test1 COMMAND Test)
 qt5_use_modules(Test Widgets)
 qt5_wrap_ui(UI_FILES_T
   ../src/binarystreamreadersettings.ui
   ../src/numberformatbox.ui
   ../src/endiannessbox.ui
+  )
 # test for readers
 add_executable(TestReaders EXCLUDE_FROM_ALL
   test_readers.cpp
   ../src/samplepack.cpp
   ../src/sink.cpp
   ../src/source.cpp
   ../src/binarystreamreader.cpp
   ../src/abstractreader.cpp
   ../src/binarystreamreadersettings.cpp
   ../src/endiannessbox.cpp
   ../src/numberformatbox.cpp
   ../src/numberformat.cpp
   ${UI_FILES_T}
+  )
 qt5_use_modules(TestReaders Widgets)
 add_test(NAME test_readers COMMAND TestReaders)
 set(CMAKE_CTEST_COMMAND ctest -V)
 add_custom_target(check COMMAND ${CMAKE_CTEST_COMMAND})
 add_dependencies(check Test)
+add_dependencies(check Test TestReaders)

tests/test_readers.cpp

➞

Show inline comments

@@ new file 100644 @@
 /*
   Copyright © 2018 Hasan Yavuz Özderya
   This file is part of serialplot.
   serialplot is free software: you can redistribute it and/or modify
   it under the terms of the GNU General Public License as published by
   the Free Software Foundation, either version 3 of the License, or
   (at your option) any later version.
   serialplot is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   GNU General Public License for more details.
   You should have received a copy of the GNU General Public License
   along with serialplot.  If not, see <http://www.gnu.org/licenses/>.
 */
 // This tells Catch to provide a main() - only do this in one cpp file per executable
 #define CATCH_CONFIG_RUNNER
 #include "catch.hpp"
 #include <QBuffer>
 #include "binarystreamreader.h"
 TEST_CASE("creating a BinaryStreamReader", "[reader]")
+{
     QBuffer buffer;
     BinaryStreamReader bs(&buffer);
+}
 // Note: this is added because `QApplication` is a must be created for widgets
 #include <QApplication>
 int main(int argc, char* argv[])
+{
     QApplication a(argc, argv);
     int result = Catch::Session().run( argc, argv );
     return result;
+}

0 comments (0 inline, 0 general)