Implement Const-Correctness in Public API

autotest/autotest.c

@@ -374,13 +374,13 @@ int liquid_autotest_validate_psd_spgramcf(spgramcf _q,
 
 // callback function to simplify testing for framing objects
 int framing_autotest_callback(
-    unsigned char *  _header,
-    int              _header_valid,
-    unsigned char *  _payload,
-    unsigned int     _payload_len,
-    int              _payload_valid,
-    framesyncstats_s _stats,
-    void *           _context)
+    const unsigned char *  _header,
+    int                    _header_valid,
+    const unsigned char *  _payload,
+    unsigned int           _payload_len,
+    int                    _payload_valid,
+    framesyncstats_s       _stats,
+    void *                 _context)
 {
     printf("*** callback invoked (%s) ***\n", _payload_valid ? "pass" : "FAIL");
     unsigned int * secret = (unsigned int*) _context;

autotest/autotest.h

@@ -323,13 +323,13 @@ int liquid_autotest_validate_psd_spgramcf(spgramcf _q,
 // callback function to simplify testing for framing objects
 #define FRAMING_AUTOTEST_SECRET 0x01234567
 int framing_autotest_callback(
-    unsigned char *  _header,
-    int              _header_valid,
-    unsigned char *  _payload,
-    unsigned int     _payload_len,
-    int              _payload_valid,
-    framesyncstats_s _stats,
-    void *           _context);
+    const unsigned char *  _header,
+    int                    _header_valid,
+    const unsigned char *  _payload,
+    unsigned int           _payload_len,
+    int                    _payload_valid,
+    framesyncstats_s       _stats,
+    void *                 _context);
 
 #endif // __LIQUID_AUTOTEST_H__
 

examples/bpacketsync_example.c

@@ -10,11 +10,11 @@
 
 #include "liquid.h"
 
-int callback(unsigned char *  _payload,
-             int              _payload_valid,
-             unsigned int     _payload_len,
-             framesyncstats_s _stats,
-             void *           _userdata)
+int callback(const unsigned char *  _payload,
+             int                    _payload_valid,
+             unsigned int           _payload_len,
+             framesyncstats_s       _stats,
+             void *                 _userdata)
 {
     printf("callback invoked, payload (%u bytes) : %s\n",
             _payload_len,

examples/dsssframe64sync_example.c

@@ -11,13 +11,13 @@
 #include "liquid.h"
 
 // static callback function
-static int callback(unsigned char *  _header,
-                    int              _header_valid,
-                    unsigned char *  _payload,
-                    unsigned int     _payload_len,
-                    int              _payload_valid,
-                    framesyncstats_s _stats,
-                    void *           _context)
+static int callback(const unsigned char *  _header,
+                    int                    _header_valid,
+                    const unsigned char *  _payload,
+                    unsigned int           _payload_len,
+                    int                    _payload_valid,
+                    framesyncstats_s       _stats,
+                    void *                 _context)
 {
     printf("*** callback invoked (%s) ***\n", _payload_valid ? "pass" : "FAIL");
     framesyncstats_print(&_stats);

examples/dsssframesync_example.c

@@ -28,13 +28,13 @@ void usage()
 }
 
 // dsssframesync callback function
-static int callback(unsigned char *  _header,
-                    int              _header_valid,
-                    unsigned char *  _payload,
-                    unsigned int     _payload_len,
-                    int              _payload_valid,
-                    framesyncstats_s _stats,
-                    void *           _userdata);
+static int callback(const unsigned char *  _header,
+                    int                    _header_valid,
+                    const unsigned char *  _payload,
+                    unsigned int           _payload_len,
+                    int                    _payload_valid,
+                    framesyncstats_s       _stats,
+                    void *                 _userdata);
 
 int main(int argc, char * argv[])
 {
@@ -128,13 +128,13 @@ int main(int argc, char * argv[])
     return 0;
 }
 
-static int callback(unsigned char *  _header,
-                    int              _header_valid,
-                    unsigned char *  _payload,
-                    unsigned int     _payload_len,
-                    int              _payload_valid,
-                    framesyncstats_s _stats,
-                    void *           _userdata)
+static int callback(const unsigned char *  _header,
+                    int                    _header_valid,
+                    const unsigned char *  _payload,
+                    unsigned int           _payload_len,
+                    int                    _payload_valid,
+                    framesyncstats_s       _stats,
+                    void *                 _userdata)
 {
     printf("******** callback invoked\n");
 

examples/flexframesync_debug_example.c

@@ -11,13 +11,13 @@
 #include "liquid.h"
 
 // flexframesync callback function
-static int callback(unsigned char *  _header,
-                    int              _header_valid,
-                    unsigned char *  _payload,
-                    unsigned int     _payload_len,
-                    int              _payload_valid,
-                    framesyncstats_s _stats,
-                    void *           _userdata)
+static int callback(const unsigned char *  _header,
+                    int                    _header_valid,
+                    const unsigned char *  _payload,
+                    unsigned int           _payload_len,
+                    int                    _payload_valid,
+                    framesyncstats_s       _stats,
+                    void *                 _userdata)
 {
     const char * filename = (const char*)_userdata;
     FILE * fid = fopen(filename,"w");

examples/flexframesync_example.c

@@ -43,13 +43,13 @@ void usage()
 }
 
 // flexframesync callback function
-static int callback(unsigned char *  _header,
-                    int              _header_valid,
-                    unsigned char *  _payload,
-                    unsigned int     _payload_len,
-                    int              _payload_valid,
-                    framesyncstats_s _stats,
-                    void *           _userdata);
+static int callback(const unsigned char *  _header,
+                    int                    _header_valid,
+                    const unsigned char *  _payload,
+                    unsigned int           _payload_len,
+                    int                    _payload_valid,
+                    framesyncstats_s       _stats,
+                    void *                 _userdata);
 
 int main(int argc, char *argv[])
 {
@@ -146,13 +146,13 @@ int main(int argc, char *argv[])
     return 0;
 }
 
-static int callback(unsigned char *  _header,
-                    int              _header_valid,
-                    unsigned char *  _payload,
-                    unsigned int     _payload_len,
-                    int              _payload_valid,
-                    framesyncstats_s _stats,
-                    void *           _userdata)
+static int callback(const unsigned char *  _header,
+                    int                    _header_valid,
+                    const unsigned char *  _payload,
+                    unsigned int           _payload_len,
+                    int                    _payload_valid,
+                    framesyncstats_s       _stats,
+                    void *                 _userdata)
 {
     printf("******** callback invoked\n");
 

examples/framesync64_example.c

@@ -16,13 +16,13 @@
 #define OUTPUT_FILENAME  "framesync64_example.m"
 
 // static callback function
-static int callback(unsigned char *  _header,
-                    int              _header_valid,
-                    unsigned char *  _payload,
-                    unsigned int     _payload_len,
-                    int              _payload_valid,
-                    framesyncstats_s _stats,
-                    void *           _userdata)
+static int callback(const unsigned char *  _header,
+                    int                    _header_valid,
+                    const unsigned char *  _payload,
+                    unsigned int           _payload_len,
+                    int                    _payload_valid,
+                    framesyncstats_s       _stats,
+                    void *                 _userdata)
 {
     printf("*** callback invoked ***\n");
     framesyncstats_print(&_stats);

examples/fskframesync_example.c

@@ -25,13 +25,13 @@ void usage()
 }
 
 // static callback function
-static int callback(unsigned char *  _header,
-                    int              _header_valid,
-                    unsigned char *  _payload,
-                    unsigned int     _payload_len,
-                    int              _payload_valid,
-                    framesyncstats_s _stats,
-                    void *           _userdata);
+static int callback(const unsigned char *  _header,
+                    int                    _header_valid,
+                    const unsigned char *  _payload,
+                    unsigned int           _payload_len,
+                    int                    _payload_valid,
+                    framesyncstats_s       _stats,
+                    void *                 _userdata);
 
 // global arrays
 unsigned char header[8];
@@ -162,13 +162,13 @@ int main(int argc, char*argv[])
 }
 
 // static callback function
-static int callback(unsigned char *  _header,
-                    int              _header_valid,
-                    unsigned char *  _payload,
-                    unsigned int     _payload_len,
-                    int              _payload_valid,
-                    framesyncstats_s _stats,
-                    void *           _userdata)
+static int callback(const unsigned char *  _header,
+                    int                    _header_valid,
+                    const unsigned char *  _payload,
+                    unsigned int           _payload_len,
+                    int                    _payload_valid,
+                    framesyncstats_s       _stats,
+                    void *                 _userdata)
 {
     printf("*** callback invoked ***\n");
     printf("    error vector mag.   : %12.8f dB\n", _stats.evm);

examples/gmskframesync_example.c

@@ -7,13 +7,13 @@
 #define OUTPUT_FILENAME "gmskframesync_example.m"
 
 // callback function
-int callback(unsigned char *  _header,
-             int              _header_valid,
-             unsigned char *  _payload,
-             unsigned int     _payload_len,
-             int              _payload_valid,
-             framesyncstats_s _stats,
-             void *           _userdata)
+int callback(const unsigned char *  _header,
+             int                    _header_valid,
+             const unsigned char *  _payload,
+             unsigned int           _payload_len,
+             int                    _payload_valid,
+             framesyncstats_s       _stats,
+             void *                 _userdata)
 {
     printf("***** gmskframesync callback invoked *****\n");
     return 0;

examples/gradsearch_datafit_example.c

@@ -22,11 +22,11 @@ struct gsdataset {
 
 // gradient search curve-fit error
 float gserror(void * _dataset,
-              float * _v,
+              const float * _v,
               unsigned int _n);
 
 // parameterized function
-float gsfunc(float _x, float * _v)
+float gsfunc(float _x, const float * _v)
 {
     float c0 = _v[0];
     float c1 = _v[1];
@@ -124,7 +124,7 @@ int main() {
 
 // gradient search fit
 float gserror(void * _dataset,
-              float * _v,
+              const float * _v,
               unsigned int _n)
 {
     struct gsdataset * p = (struct gsdataset *) _dataset;

examples/ofdmflexframesync_example.c

@@ -33,13 +33,13 @@ void usage()
 }
 
 // callback function
-int callback(unsigned char *  _header,
-             int              _header_valid,
-             unsigned char *  _payload,
-             unsigned int     _payload_len,
-             int              _payload_valid,
-             framesyncstats_s _stats,
-             void *           _userdata);
+int callback(const unsigned char *  _header,
+             int                    _header_valid,
+             const unsigned char *  _payload,
+             unsigned int           _payload_len,
+             int                    _payload_valid,
+             framesyncstats_s       _stats,
+             void *                 _userdata);
 
 int main(int argc, char*argv[])
 {
@@ -148,13 +148,13 @@ int main(int argc, char*argv[])
 }
 
 // callback function
-int callback(unsigned char *  _header,
-             int              _header_valid,
-             unsigned char *  _payload,
-             unsigned int     _payload_len,
-             int              _payload_valid,
-             framesyncstats_s _stats,
-             void *           _userdata)
+int callback(const unsigned char *  _header,
+             int                    _header_valid,
+             const unsigned char *  _payload,
+             unsigned int           _payload_len,
+             int                    _payload_valid,
+             framesyncstats_s       _stats,
+             void *                 _userdata)
 {
     printf("**** callback invoked : rssi = %8.3f dB, evm = %8.3f dB, cfo = %8.5f\n", _stats.rssi, _stats.evm, _stats.cfo);
 

examples/ofdmframesync_example.c

@@ -33,10 +33,10 @@ void usage()
 //  _p          : subcarrier allocation array [size: _M x 1]
 //  _M          : number of subcarriers
 //  _userdata   : user-defined data pointer
-static int callback(float complex * _X,
-                    unsigned char * _p,
-                    unsigned int    _M,
-                    void *          _userdata);
+static int callback(float complex *       _X,
+                    const unsigned char * _p,
+                    unsigned int          _M,
+                    void *                _userdata);
 
 // custom data type to pass to callback function
 struct rx_symbols {
@@ -242,10 +242,10 @@ int main(int argc, char*argv[])
 //  _p          : subcarrier allocation array [size: _M x 1]
 //  _M          : number of subcarriers
 //  _userdata   : user-defined data pointer
-static int callback(float complex * _X,
-                    unsigned char * _p,
-                    unsigned int    _M,
-                    void *          _userdata)
+static int callback(float complex *       _X,
+                    const unsigned char * _p,
+                    unsigned int          _M,
+                    void *                _userdata)
 {
     // print status to the screen
     printf("**** callback invoked\n");