Added support for mat file compression

Author: Bartosz Grabias

.clang-format

@@ -0,0 +1,137 @@
+---
+Language:        Cpp
+# BasedOnStyle:  LLVM
+AccessModifierOffset: -2
+AlignAfterOpenBracket: Align
+AlignConsecutiveMacros: false
+AlignConsecutiveAssignments: false
+AlignConsecutiveDeclarations: false
+AlignEscapedNewlines: Right
+AlignOperands:   true
+AlignTrailingComments: true
+AllowAllArgumentsOnNextLine: true
+AllowAllConstructorInitializersOnNextLine: true
+AllowAllParametersOfDeclarationOnNextLine: true
+AllowShortBlocksOnASingleLine: Never
+AllowShortCaseLabelsOnASingleLine: false
+AllowShortFunctionsOnASingleLine: All
+AllowShortLambdasOnASingleLine: All
+AllowShortIfStatementsOnASingleLine: Never
+AllowShortLoopsOnASingleLine: false
+AlwaysBreakAfterDefinitionReturnType: None
+AlwaysBreakAfterReturnType: None
+AlwaysBreakBeforeMultilineStrings: false
+AlwaysBreakTemplateDeclarations: MultiLine
+BinPackArguments: true
+BinPackParameters: true
+BraceWrapping:
+  AfterCaseLabel:  false
+  AfterClass:      true
+  AfterControlStatement: true
+  AfterEnum:       true
+  AfterFunction:   true
+  AfterNamespace:  true
+  AfterObjCDeclaration: false
+  AfterStruct:     true
+  AfterUnion:      true
+  AfterExternBlock: true
+  BeforeCatch:     true
+  BeforeElse:      true
+  IndentBraces:    false
+  SplitEmptyFunction: true
+  SplitEmptyRecord: true
+  SplitEmptyNamespace: true
+BreakBeforeBinaryOperators: None
+BreakBeforeBraces: Custom
+BreakBeforeInheritanceComma: false
+BreakInheritanceList: BeforeColon
+BreakBeforeTernaryOperators: true
+BreakConstructorInitializersBeforeComma: false
+BreakConstructorInitializers: BeforeColon
+BreakAfterJavaFieldAnnotations: false
+BreakStringLiterals: true
+ColumnLimit:     120
+CommentPragmas:  '^ IWYU pragma:'
+CompactNamespaces: false
+ConstructorInitializerAllOnOneLineOrOnePerLine: false
+ConstructorInitializerIndentWidth: 4
+ContinuationIndentWidth: 4
+Cpp11BracedListStyle: true
+DeriveLineEnding: true
+DerivePointerAlignment: false
+DisableFormat:   false
+ExperimentalAutoDetectBinPacking: false
+FixNamespaceComments: true
+ForEachMacros:
+  - foreach
+  - Q_FOREACH
+  - BOOST_FOREACH
+IncludeBlocks:   Preserve
+IncludeCategories:
+  - Regex:           '^"(llvm|llvm-c|clang|clang-c)/'
+    Priority:        2
+    SortPriority:    0
+  - Regex:           '^(<|"(gtest|gmock|isl|json)/)'
+    Priority:        3
+    SortPriority:    0
+  - Regex:           '.*'
+    Priority:        1
+    SortPriority:    0
+IncludeIsMainRegex: '(Test)?$'
+IncludeIsMainSourceRegex: ''
+IndentCaseLabels: false
+IndentGotoLabels: true
+IndentPPDirectives: None
+IndentWidth:     4
+IndentWrappedFunctionNames: false
+JavaScriptQuotes: Leave
+JavaScriptWrapImports: true
+KeepEmptyLinesAtTheStartOfBlocks: true
+MacroBlockBegin: ''
+MacroBlockEnd:   ''
+MaxEmptyLinesToKeep: 1
+NamespaceIndentation: All
+ObjCBinPackProtocolList: Auto
+ObjCBlockIndentWidth: 2
+ObjCSpaceAfterProperty: false
+ObjCSpaceBeforeProtocolList: true
+PenaltyBreakAssignment: 2
+PenaltyBreakBeforeFirstCallParameter: 19
+PenaltyBreakComment: 300
+PenaltyBreakFirstLessLess: 120
+PenaltyBreakString: 1000
+PenaltyBreakTemplateDeclaration: 10
+PenaltyExcessCharacter: 1000000
+PenaltyReturnTypeOnItsOwnLine: 60
+PointerAlignment: Right
+ReflowComments:  true
+SortIncludes:    true
+SortUsingDeclarations: true
+SpaceAfterCStyleCast: false
+SpaceAfterLogicalNot: false
+SpaceAfterTemplateKeyword: true
+SpaceBeforeAssignmentOperators: true
+SpaceBeforeCpp11BracedList: false
+SpaceBeforeCtorInitializerColon: true
+SpaceBeforeInheritanceColon: true
+SpaceBeforeParens: ControlStatements
+SpaceBeforeRangeBasedForLoopColon: true
+SpaceInEmptyBlock: false
+SpaceInEmptyParentheses: false
+SpacesBeforeTrailingComments: 1
+SpacesInAngles:  false
+SpacesInConditionalStatement: false
+SpacesInContainerLiterals: true
+SpacesInCStyleCastParentheses: false
+SpacesInParentheses: false
+SpacesInSquareBrackets: false
+SpaceBeforeSquareBrackets: false
+Standard:        Latest
+StatementMacros:
+  - Q_UNUSED
+  - QT_REQUIRE_VERSION
+TabWidth:        8
+UseCRLF:         false
+UseTab:          Never
+...
+

CMakeLists.txt

@@ -1,6 +1,11 @@
 cmake_minimum_required(VERSION 3.1)
+
 project (scope_receiver)
 
+find_package(ZLIB REQUIRED)
+
+set(CXXOPTS_BUILD_EXAMPLES no)
+set(SPDLOG_BUILD_EXAMPLE no)
 set(CMAKE_CXX_STANDARD 17)
 
 add_subdirectory(spdlog)
@@ -10,6 +15,9 @@ add_subdirectory(cxxopts)
 add_executable(scope_receiver
 	src/main.cpp
 	src/mat_writer.cpp
+	src/mat_writer_compressed.cpp
 )
 
-target_link_libraries(scope_receiver librigol spdlog cxxopts)
+set_target_properties(scope_receiver PROPERTIES CXX_STANDARD 17)
+target_include_directories(scope_receiver PRIVATE ${ZLIB_INCLUDE_DIRS})
+target_link_libraries(scope_receiver librigol spdlog cxxopts ${ZLIB_LIBRARIES})

README.md

@@ -25,3 +25,7 @@ Run: `./scope_receiver`
 
 TODO...
 For now please run `scope_receiver -h`
+
+# Others
+
+Mat file format documentation: https://pub.ist.ac.at/~schloegl/matlab/matfile_format.pdf

librigol/CMakeLists.txt

@@ -7,6 +7,7 @@ add_library(librigol
 	src/scpi_command.cpp
 )
 
+set_target_properties(librigol PROPERTIES CXX_STANDARD 17)
 target_include_directories(librigol PUBLIC include/)
 target_link_libraries(librigol spdlog)
 

librigol/include/connection.h

@@ -1,7 +1,7 @@
 #pragma once
 
-#include <cstdint>
 #include <cstddef>
+#include <cstdint>
 #include <string>
 
 #ifdef __WIN32__
@@ -12,21 +12,22 @@ namespace rigol
 {
     class connection
     {
-    private:
-        connection(const connection&) = delete;
-        connection& operator=(const connection&) = delete;
+      private:
+        connection(const connection &) = delete;
+        connection &operator=(const connection &) = delete;
 
-    protected:
-        connection() {};
+      protected:
+        connection(){};
 
-        virtual std::size_t read(std::uint8_t* buffer, std::size_t max_len) = 0;
-        virtual std::size_t write(const std::uint8_t* buffer, std::size_t max_len) = 0;
-    public:
-        virtual ~connection() {};
+        virtual std::size_t read(std::uint8_t *buffer, std::size_t max_len) = 0;
+        virtual std::size_t write(const std::uint8_t *buffer, std::size_t max_len) = 0;
 
-        void write(const std::string& s);
-        void read_line(std::string& out);
-        void read(std::string& out, size_t count);
+      public:
+        virtual ~connection(){};
+
+        void write(const std::string &s);
+        void read_line(std::string &out);
+        void read(std::string &out, size_t count);
         std::string read_line();
     };
 
@@ -37,12 +38,12 @@ namespace rigol
 #else
         int m_fd;
 #endif
-    public:
-        tcp_connection(const std::string& address, std::uint16_t port);
+      public:
+        tcp_connection(const std::string &address, std::uint16_t port);
         ~tcp_connection();
-    
-    protected:
-        std::size_t read(std::uint8_t* buffer, std::size_t max_len) override;
-        std::size_t write(const std::uint8_t* buffer, std::size_t max_len) override;
+
+      protected:
+        std::size_t read(std::uint8_t *buffer, std::size_t max_len) override;
+        std::size_t write(const std::uint8_t *buffer, std::size_t max_len) override;
     };
-}
+} // namespace rigol

librigol/include/scope.h

@@ -1,9 +1,9 @@
 #pragma once
 
+#include "connection.h"
 #include <memory>
-#include <vector>
 #include <ostream>
-#include "connection.h"
+#include <vector>
 
 namespace rigol
 {
@@ -24,14 +24,22 @@ namespace rigol
         CHANNEL_4,
     };
 
-    inline std::ostream& operator<<(std::ostream& str, channel ch)
+    inline std::ostream &operator<<(std::ostream &str, channel ch)
     {
         switch (ch)
         {
-            case channel::CHANNEL_1: str << "CHANNEL_1"; return str;
-            case channel::CHANNEL_2: str << "CHANNEL_2"; return str;
-            case channel::CHANNEL_3: str << "CHANNEL_3"; return str;
-            case channel::CHANNEL_4: str << "CHANNEL_4"; return str;
+        case channel::CHANNEL_1:
+            str << "CHANNEL_1";
+            return str;
+        case channel::CHANNEL_2:
+            str << "CHANNEL_2";
+            return str;
+        case channel::CHANNEL_3:
+            str << "CHANNEL_3";
+            return str;
+        case channel::CHANNEL_4:
+            str << "CHANNEL_4";
+            return str;
         }
         str << "Unknown channel";
         return str;
@@ -40,9 +48,10 @@ namespace rigol
     class scope
     {
         std::unique_ptr<connection> m_connection;
-    public:
-        scope(std::unique_ptr<connection>&& connection);
-        
+
+      public:
+        scope(std::unique_ptr<connection> &&connection);
+
         void run();
         void stop();
         void single();
@@ -51,8 +60,8 @@ namespace rigol
 
         void select_channel(channel ch);
 
-        void read_buffer(std::vector<float>& buffer);
-        void read_buffer(std::vector<uint8_t>& buffer);
+        void read_buffer(std::vector<float> &buffer);
+        void read_buffer(std::vector<uint8_t> &buffer);
 
         double x_origin();
         double x_increment();
@@ -61,4 +70,4 @@ namespace rigol
         double y_increment();
         double y_reference();
     };
-}
+} // namespace rigol

librigol/include/scpi_command.h

@@ -1,42 +1,44 @@
 #pragma once
 
-#include <string>
 #include <initializer_list>
+#include <string>
 
 namespace rigol
 {
     class connection;
 
     class scpi_command
     {
-    protected:
-        scpi_command() {};
+      protected:
+        scpi_command(){};
 
-    public:
-        virtual ~scpi_command() {};
+      public:
+        virtual ~scpi_command(){};
 
-        virtual void run_on(connection& connection) = 0;
+        virtual void run_on(connection &connection) = 0;
     };
 
     class no_response_scpi_command : public scpi_command
     {
         std::string m_command;
-    public:
-        no_response_scpi_command(const std::string& command);
-        no_response_scpi_command(const std::initializer_list<std::string>& parts, const std::string& args = {});
 
-        void run_on(connection& connection) override;
+      public:
+        no_response_scpi_command(const std::string &command);
+        no_response_scpi_command(const std::initializer_list<std::string> &parts, const std::string &args = {});
+
+        void run_on(connection &connection) override;
     };
 
     class text_query_scpi_command : public scpi_command
     {
         std::string m_command;
         std::string m_last_response;
-    public:
-        text_query_scpi_command(const std::string& command);
-        text_query_scpi_command(const std::initializer_list<std::string>& parts);
 
-        void run_on(connection& connection) override;
-        const std::string& last_response() const { return m_last_response; };
+      public:
+        text_query_scpi_command(const std::string &command);
+        text_query_scpi_command(const std::initializer_list<std::string> &parts);
+
+        void run_on(connection &connection) override;
+        const std::string &last_response() const { return m_last_response; };
     };
-}
+} // namespace rigol