add miniz support (#83)

* ci: run tests with miniz * read_chunk_bytes: do stricter arg check * update README, docs * update wrap to fix deprecation warning
2025-03-28 21:13:20 +00:00 · 2020-06-07 12:03:13 +02:00 · 2020-06-07 12:03:13 +02:00 · ea07b27873
commit ea07b27873
parent 9b179304a6
7 changed files with 122 additions and 85 deletions
--- a/.gitlab-ci.yml
+++ b/.gitlab-ci.yml
@ -12,8 +12,12 @@ test:
  stage: test
  script:
    - CC=clang-7 CXX=clang++-7 meson -Ddev_build=true -Db_sanitize=address,undefined -Db_lundef=false clang_build
-    - ninja -C clang_build test
-    - ninja -C clang_build scan-build # this uses gcc due to a bug: https://github.com/mesonbuild/meson/issues/5716
+    - cd clang_build
+    - ninja test
+    - ninja scan-build # this uses gcc due to a bug: https://github.com/mesonbuild/meson/issues/5716
+    - meson configure -Duse_miniz=true
+    - ninja test
+    - cd ..
    - CC=gcc CXX=g++ meson -Ddev_build=true -Db_sanitize=address,undefined -Db_coverage=true gcc_build
    - cd gcc_build
    - ninja
--- a/README.md
+++ b/README.md
@ -24,24 +24,24 @@ it outperforms the reference implementation in common use cases.

 ## Features

-| Feature                              | libspng | libpng | stb_image | lodepng |
-|--------------------------------------|---------|--------|-----------|---------|
-| Decode from stream                   | ✅      |  ✅   | ✅       | ❌      |
-| Gamma correction                     | ✅      |  ✅   | ❌       | ❌      |
-| No known security bugs<sup>[1]</sup> | ✅      |  ✅   | ❌       | ✅      |
-| Progressive image read               | ✅      |  ✅   | ❌       | ❌      |
-| Parses all standard chunks           | ✅      |  ✅   | ❌       | ❌      |
-| Doesn't require zlib                 | ❌*     |  ❌   | ✅       | ✅      |
-| Encoding                             | ❌*     |  ✅   | ✅       | ✅      |
-| Animated PNG                         | ❌*     |  ✅** | ❌       | ❌      |
+| Feature                              | libspng | libpng             | stb_image | lodepng |
+|--------------------------------------|---------|--------------------|-----------|---------|
+| Decode from stream                   | ✅      |  ✅               | ✅       | ❌      |
+| Gamma correction                     | ✅      |  ✅               | ❌       | ❌      |
+| No known security bugs<sup>[1]</sup> | ✅      |  ✅               | ❌       | ✅      |
+| Progressive image read               | ✅      |  ✅               | ❌       | ❌      |
+| Parses all standard chunks           | ✅      |  ✅               | ❌       | ❌      |
+| Doesn't require zlib<sup>[2]</sup>   | ✅      |  ❌               | ✅       | ✅      |
+| Encoding                             | Planned  |  ✅               | ✅       | ✅      |
+| Animated PNG                         | Planned  |  ✅<sup>[3]</sup> | ❌       | ❌      |

-[1] The project is fuzz tested on [OSS-Fuzz](https://github.com/google/oss-fuzz) and vulnerabilities are fixed before they become public.
+<sup>[1]</sup> The project is fuzz tested on [OSS-Fuzz](https://github.com/google/oss-fuzz) and vulnerabilities are fixed before they become public.

-\* Work in progress
+<sup>[2]</sup> Building with miniz is [supported](docs/build.md#miniz).

-\*\* With a 3rd party patch
+<sup>[3]</sup> With a 3rd party patch

-## Getting spng
+## Getting libspng

 Download the [latest release](https://libspng.org/download) and include `spng.c/spng.h` in your project,
 you can also build with CMake or Meson. Refer to the [documentation](https://libspng.org/docs) for details.
@ -65,7 +65,7 @@ spng_decode_image(ctx, out, out_size, SPNG_FMT_RGBA8, 0);
 spng_ctx_free(ctx);
 ```

-See [example.c](https://github.com/randy408/libspng/blob/v0.5.0/examples/example.c).
+See [example.c](https://github.com/randy408/libspng/blob/v0.6.0/examples/example.c).

 ## License

--- a/docs/build.md
+++ b/docs/build.md
@ -37,6 +37,8 @@ any configuration, intrinsics are enabled by default.

 # Build options

+## Optimizations
+
 Architecture-specific intrinsics are enabled by default,
 this can be disabled with the `SPNG_DISABLE_OPT` compiler option.

@ -56,6 +58,18 @@ for multiple instruction sets, this is enabled by the
 of GCC and glibc.
 For the Meson project this is always enabled if the target supports it.

+## miniz
+
+[miniz](https://github.com/richgel999/miniz) is a single source file replacement for zlib,
+linking against miniz allows libspng to be embedded into a project with just
+four files: `spng.c`, `miniz.c` and their headers.
+
+For building with miniz use the `SPNG_USE_MINIZ` compiler option,
+this handles some minor issues with the API.
+The Meson build option for this is `use_miniz`.
+Performance is mostly identical, slightly better in some cases
+compared to stock zlib.
+
 # Profile-guided optimization

 [Profile-guided optimization (PGO)](https://clang.llvm.org/docs/UsersManual.html#profile-guided-optimization)
--- a/meson.build
+++ b/meson.build
@ -4,10 +4,15 @@ cc = meson.get_compiler('c')

 spng_inc = include_directories('.')

-if cc.get_define('__ANDROID__') != ''
-    zlib_dep = cc.find_library('z')
+if get_option('use_miniz') == true
+    add_project_arguments('-DSPNG_USE_MINIZ', language : 'c')
+    zlib_dep = dependency('miniz', fallback : [ 'miniz', 'miniz_dep'])
 else
-    zlib_dep = dependency('zlib', fallback : ['zlib', 'zlib_dep'], static : get_option('static_zlib'))
+    if cc.get_define('__ANDROID__') != ''
+        zlib_dep = cc.find_library('z')
+    else
+        zlib_dep = dependency('zlib', fallback : ['zlib', 'zlib_dep'], static : get_option('static_zlib'))
+    endif
 endif

 m_dep = cc.find_library('m', required : false)
--- a/meson_options.txt
+++ b/meson_options.txt
@ -1,5 +1,6 @@
 option('dev_build', type : 'boolean', value : false, description : 'Enable the testsuite, requires libpng')
 option('enable_opt', type : 'boolean', value : true, description : 'Enable architecture-specific optimizations')
+option('use_miniz', type : 'boolean', value : false, description : 'Compile with miniz instead of zlib, disables some features')
 option('static_zlib', type : 'boolean', value : false, description : 'Link the static version of zlib')
 option('benchmarks', type : 'boolean', value : false, description : 'Enable benchmarks, requires Git LFS')

--- a/spng.c
+++ b/spng.c
@ -12,7 +12,11 @@
    #define SPNG_DISABLE_OPT
    #include "tests/framac_stubs.h"
 #else
-    #include <zlib.h>
+    #ifdef SPNG_USE_MINIZ
+        #include <miniz.h>
+    #else
+        #include <zlib.h>
+    #endif
 #endif

 #ifdef SPNG_MULTITHREADING
@ -317,7 +321,11 @@ static inline void spng__free(spng_ctx *ctx, void *ptr)
    ctx->alloc.free_fn(ptr);
 }

+#if defined(SPNG_USE_MINIZ)
+static void *spng__zalloc(void *opaque, long unsigned items, long unsigned size)
+#else
 static void *spng__zalloc(void *opaque, unsigned items, unsigned size)
+#endif
 {
    spng_ctx *ctx = opaque;

@ -344,10 +352,10 @@ static int spng__inflate_init(spng_ctx *ctx)

    if(inflateInit(&ctx->zstream) != Z_OK) return SPNG_EZLIB;

-#if ZLIB_VERNUM >= 0x1290
+#if ZLIB_VERNUM >= 0x1290 && !defined(SPNG_USE_MINIZ)
    if(inflateValidate(&ctx->zstream, ctx->flags & SPNG_CTX_IGNORE_ADLER32)) return SPNG_EZLIB;
-#else
-    #warning "zlib >= 1.2.11 is required for SPNG_CTX_IGNORE_ADLER32"
+#else /* This requires zlib >= 1.2.11 */
+    #warning "inflateValidate() not available, SPNG_CTX_IGNORE_ADLER32 will be ignored"
 #endif

    return 0;
@ -595,7 +603,7 @@ static inline int read_header(spng_ctx *ctx, int *discard)
 static int read_chunk_bytes(spng_ctx *ctx, uint32_t bytes)
 {
    if(ctx == NULL) return 1;
-    if(!bytes) return 0;
+    if(!ctx->cur_chunk_bytes_left || !bytes) return 1;
    if(bytes > ctx->cur_chunk_bytes_left) return 1; /* XXX: more specific error? */

    int ret;
@ -619,7 +627,7 @@ skip_crc:
 static int read_chunk_bytes2(spng_ctx *ctx, void *out, uint32_t bytes)
 {
    if(ctx == NULL) return 1;
-    if(!bytes) return 0;
+    if(!ctx->cur_chunk_bytes_left || !bytes) return 1;
    if(bytes > ctx->cur_chunk_bytes_left) return 1; /* XXX: more specific error? */

    int ret;
@ -726,49 +734,54 @@ static int spng__inflate_stream(spng_ctx *ctx, char **out, size_t *len, int extr
    stream->avail_out = size;
    stream->next_out = buf;

-    do
+    while(ret != Z_STREAM_END)
    {
-        if(ret != Z_OK)
+        ret = inflate(stream, 0);
+
+        if(ret == Z_OK) continue;
+
+        if(ret == Z_STREAM_END) break;
+
+        if(ret == Z_BUF_ERROR)
+        {
+            if(!stream->avail_out) /* Resize buffer */
+            {
+                /* overflow or reached chunk/cache limit */
+                if( (2 > SIZE_MAX / size) || (size > max / 2) ) goto mem;
+
+                size *= 2;
+
+                t = spng__realloc(ctx, buf, size);
+                if(t == NULL) goto mem;
+
+                buf = t;
+
+                stream->avail_out = size / 2;
+                stream->next_out = (unsigned char*)buf + size / 2;
+            }
+
+            if(!stream->avail_in) /* Read more chunk bytes */
+            {
+                read_size = ctx->cur_chunk_bytes_left;
+                if(ctx->streaming && read_size > SPNG_READ_SIZE) read_size = SPNG_READ_SIZE;
+
+                ret = read_chunk_bytes(ctx, read_size);
+                if(ret)
+                {
+                    spng__free(ctx, buf);
+                    return ret;
+                }
+
+                stream->avail_in = read_size;
+                stream->next_in = ctx->data;
+            }
+        }
+        else
        {
            spng__free(ctx, buf);
            return SPNG_EZLIB;
        }
-
-        if(!stream->avail_out)
-        {
-            /* overflow or reached chunk/cache limit */
-            if( (2 > SIZE_MAX / size) || (size > max / 2) ) goto mem;
-
-            size *= 2;
-
-            t = spng__realloc(ctx, buf, size);
-            if(t == NULL) goto mem;
-
-           buf = t;
-
-            stream->avail_out = size / 2;
-            stream->next_out = (unsigned char*)buf + size / 2;
-        }
-
-        if(!stream->avail_in) /* Read more chunk bytes */
-        {
-            read_size = ctx->cur_chunk_bytes_left;
-            if(ctx->streaming && read_size > SPNG_READ_SIZE) read_size = SPNG_READ_SIZE;
-
-            ret = read_chunk_bytes(ctx, read_size);
-            if(ret)
-            {
-                spng__free(ctx, buf);
-                return ret;
-            }
-
-            stream->avail_in = read_size;
-            stream->next_in = ctx->data;
-        }
-
-        ret = inflate(stream, Z_SYNC_FLUSH);
-
-    }while(ret != Z_STREAM_END);
+    }

    size = stream->total_out;

@ -833,33 +846,33 @@ static int read_scanline_bytes(spng_ctx *ctx, unsigned char *dest, size_t len)
 {
    if(ctx == NULL || dest == NULL) return 1;

-    int ret;
+    int ret = Z_OK;
    uint32_t bytes_read;

-    ctx->zstream.avail_out = len;
-    ctx->zstream.next_out = dest;
+    z_stream *zstream = &ctx->zstream;

-    while(ctx->zstream.avail_out != 0)
+    zstream->avail_out = len;
+    zstream->next_out = dest;
+
+    while(zstream->avail_out != 0)
    {
-        if(ctx->zstream.avail_in == 0) /* Need more IDAT bytes */
+        ret = inflate(&ctx->zstream, 0);
+
+        if(ret == Z_OK) continue;
+
+        if(ret == Z_STREAM_END) /* Reached an end-marker */
+        {
+            if(zstream->avail_out != 0) return SPNG_EIDAT_TOO_SHORT;
+        }
+        else if(ret == Z_BUF_ERROR) /* Read more IDAT bytes */
        {
            ret = read_idat_bytes(ctx, &bytes_read);
            if(ret) return ret;

-            ctx->zstream.avail_in = bytes_read;
-            ctx->zstream.next_in = ctx->data;
-        }
-
-        ret = inflate(&ctx->zstream, Z_SYNC_FLUSH);
-
-        if(ret != Z_OK)
-        {
-            if(ret == Z_STREAM_END) /* zlib reached an end-marker */
-            {
-                if(ctx->zstream.avail_out != 0) return SPNG_EIDAT_TOO_SHORT;
-            }
-            else if(ret != Z_BUF_ERROR) return SPNG_EIDAT_STREAM;
+            zstream->avail_in = bytes_read;
+            zstream->next_in = ctx->data;
        }
+        else return SPNG_EIDAT_STREAM;
    }

    return 0;
--- a/subprojects/miniz.wrap
+++ b/subprojects/miniz.wrap
@ -6,6 +6,6 @@ source_url = https://github.com/richgel999/miniz/releases/download/2.1.0/miniz-2
 source_filename = miniz-2.1.0.zip
 source_hash = d133132721ad5efbcda2507699d44c54b0da5e31379e4ff049d78d6b1a571f0d

-patch_url = https://wrapdb.mesonbuild.com/v1/projects/miniz/2.1.0/1/get_zip
-patch_filename = miniz-2.1.0-1-wrap.zip
-patch_hash = 1bc43e0dd59490d12020e45d16f1b5502f2f1164c2cabf787f5d3082d12e895c
+patch_url = https://wrapdb.mesonbuild.com/v1/projects/miniz/2.1.0/2/get_zip
+patch_filename = miniz-2.1.0-2-wrap.zip
+patch_hash = 529e05709a00e5b0fd1d27669a6b4f14b9b32da82d4f6f5669933657842610b1