margen v1.2.5

* feat: Github CI

* add verbose to gcc

* reorder jobs

* add extra warnings and small fix

.github/workflows/ci.yml

@@ -0,0 +1,33 @@
+name: C-lang CI
+
+on:
+  push:
+    branches: ["master"]
+  pull_request:
+    branches: ["master"]
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: gcc
+        run: mkdir -p build && gcc -v -Wall -Wextra -Werror src/*.c src/*.h -lm
+
+  build-release:
+    needs: lint
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: aclocal
+        run: aclocal
+      - name: autoconf
+        run: autoconf
+      - name: automake
+        run: automake --add-missing
+      - name: configure
+        run: ./configure
+      - name: make
+        run: make
+      - name: make distcheck
+        run: make distcheck

.gitignore

@@ -1,4 +1,26 @@
 build
 .vscode
 *.bmp
-!images/*
+!images/*
+*.cache
+.deps
+Makefile
+*.log
+*.o
+*.h.gch
+*.out
+.dirstamp
+aclocal.m4
+compile
+install-sh
+missing
+depcomp
+Makefile.in
+configure~
+config.status
+margen
+*.tar.gz
+configure
+src/margen*
+*.pkg.tar.zst
+pkg

Makefile.am

@@ -0,0 +1,5 @@
+AUTOMAKE_OPTIONS = foreign subdir-objects -Wall
+bin_PROGRAMS = margen
+margen_SOURCES = src/main.c src/args.c src/bmp.c src/generator.c src/rand.c
+margen_CFLAGS = -Ofast -march=native -flto -funroll-loops -fprefetch-loop-arrays -fno-exceptions -fopenmp
+include_HEADERS = src/main.h src/args.h src/bmp.h src/generator.h src/rand.h src/config.h src/types.h

Makefile.dev

@@ -9,7 +9,7 @@ clean:
 
 build:
 	@mkdir -p build
-	gcc -Wall src/*.c src/*.h -lm -o build/$(TARGET)
+	gcc -v -Wall -Wextra src/*.c src/*.h -lm -o build/$(TARGET)
 
 .PHONY: install
 install: build
@@ -24,21 +24,24 @@ valgrind: build
 	valgrind --leak-check=full -s ./build/$(TARGET) $(TEST_ARGS)
 
 .PHONY: release
-release: clean build time
-	@echo -n "Version (x.y.z): "
-	@read VERSION; \
-		sed -i "s/#define VERSION.*/#define VERSION \"v$$VERSION\"/g" ./src/const.h; \
-		git add ./src/const.h; \
-		git diff origin/master; \
-		git commit -m "$(TARGET) v$$VERSION"; \
-		git tag v$$VERSION -m "$(TARGET) v$$VERSION"
-	@echo updated ./src/const.h and tagged version
+release:
+	aclocal
+	autoconf
+	automake --add-missing
+	./configure
+	make distcheck
+
+.PHONY: release-arch
+release-arch: clean
+	mkdir -p build
+	cp PKGBUILD build
+	cd build && makepkg
 
 .PHONY: gif
 gif: build
 	mkdir -p tmp
 	for i in {1..50}; do \
-		./build/margen -w=1920 -h=720 --seed=$$i$$i -o=tmp/image$$i.bmp ; \
+		./build/$(TARGET) -w=1920 -h=720 --seed=$$i$$i -o=tmp/image$$i.bmp ; \
 	done
 	ffmpeg -y -f image2 -framerate 1 -i tmp/image%d.bmp -vf scale=960x360 images/sample.gif
-	rm -rf tmp
+	rm -rf tmp

PKGBUILD

@@ -0,0 +1,20 @@
+pkgname=margen
+pkgver=1.2.5
+pkgrel=1
+pkgdesc="Generate a marble-like pattern bitmap image, blazing fast."
+arch=('i686' 'pentium4' 'x86_64' 'arm' 'armv7h' 'armv6h' 'aarch64' 'riscv64')
+url="https://github.com/klemek/margen"
+source=("${pkgname}-${pkgver}.tar.gz::https://github.com/klemek/margen/releases/download/v${pkgver}/${pkgname}-${pkgver}.tar.gz")
+sha256sums=('ff4375dacec14bce1f67bb6964232c54b184f820aaad02fda4313c58d78133c6')
+srcdir=build
+
+build() {
+  cd "$srcdir/$pkgname-$pkgver"
+  ./configure --prefix=/usr
+  make
+}
+
+package() {
+  cd "$srcdir/$pkgname-$pkgver"
+  sudo make DESTDIR="$pkgdir" install
+}

README.md

@@ -10,13 +10,38 @@ Written in pure C without librairies.
 
 ## Install
 
-You only need **gcc** and **make**.
+### From release
 
-```bash
+See [Releases](https://github.com/klemek/margen/releases)
+
+```sh
+tar xvzf margen-x.y.z.tar.gz
+cd margen-x.y.z
+./configure
+make
+make install
+```
+
+### From repository (PKGBUILD)
+
+```sh
 git clone https://github.com/klemek/margen
 cd margen
-make clean build install
-# margen is now installed in ~/.local/bin
+makepkg -si
+```
+
+
+### From repository (dev version)
+
+```sh
+git clone https://github.com/klemek/margen
+cd margen
+aclocal
+autoconf
+automake --add-missing
+./configure
+make
+make install
 ```
 
 ## CLI arguments
@@ -28,11 +53,12 @@ generate a marble-like pattern bitmap image, blazing fast.
 
 options:
   --help             show this help message and exit
+  -v, --version      print version
   -q, --quiet        do not print to console
   -w, --width        image width (default: 1920)
   -h, --height       image height (default: 1080)
   -o, --output       output file (default: output.bmp)
-  -seed              random seed (default: time based)
+  --seed             random seed (default: time based)
   -p, --pixel        pixel size (default: random)
   -s, --slope        slope [0-255] (default: random)
   -c, --color        base color [0-255,0-255,0-255] (default: random)
@@ -42,6 +68,24 @@ options:
   -m, --monochrome   grayscale generation
 ```
 
-## TODO
+## Release guide
 
-- configure, make, make install
+```bash
+# get latest version
+git pull origin master
+# update configure.ac with new version
+$EDITOR configure.ac
+# make full build
+make -f Makefile.dev release
+# update PKGBUILD with new version and sha256 sum
+sha256sum margen-x.y.z.tar.gz
+$EDITOR PKGBUILD
+# push to repo
+git commit -am "margen vX.Y.Z"
+git tag vX.Y.Z
+git push origin master --tags
+# create release from tag on github
+# attach .tar.gz to the github release
+make -f Makefile.dev release-arch
+# attach .pkg.tar.zst to the github release
+```

configure.ac

@@ -0,0 +1,10 @@
+AC_INIT([margen], [1.2.5], [klemek.dev@proton.me])
+AM_INIT_AUTOMAKE
+AC_PROG_CC
+AC_CHECK_HEADERS([stdio.h])
+AC_CHECK_HEADERS([stdlib.h])
+AC_CHECK_HEADERS([stdbool.h])
+AC_CHECK_HEADERS([string.h])
+AC_CHECK_HEADERS([time.h])
+AC_CONFIG_FILES([Makefile])
+AC_OUTPUT

src/args.c

@@ -1,15 +1,16 @@
 #include "args.h"
-#include "const.h"
+#include "config.h"
 #include "rand.h"
+#include <stdbool.h>
 #include <stdio.h>
 #include <stdlib.h>
 #include <string.h>
 #include <time.h>
 
 void print_help(int status_code) {
-  puts(NAME
+  puts(PACKAGE
        " " VERSION "\n\n"
-       "usage: " NAME " "
+       "usage: " PACKAGE " "
        "[--help] "
        "[-v] "
        "[-q] "
@@ -23,16 +24,17 @@ void print_help(int status_code) {
        "[-va=R,G,B] "
        "[-vr=VAR_RANGE] "
        "[-r=ROTATION] "
-       //  "[-m]"
+       "[-m]"
        "\n\n"
        "generate a marble-like pattern bitmap image, blazing fast.\n\n"
        "options:\n"
        "  --help             show this help message and exit\n"
+       "  -v, --version      print version\n"
        "  -q, --quiet        do not print to console\n"
        "  -w, --width        image width (default: 1920)\n"
        "  -h, --height       image height (default: 1080)\n"
        "  -o, --output       output file (default: output.bmp)\n"
-       "  -seed              random seed (default: time based)\n"
+       "  --seed             random seed (default: time based)\n"
        "  -p, --pixel        pixel size (default: random)\n"
        "  -s, --slope        slope [0-255] (default: random)\n"
        "  -c, --color        base color [0-255,0-255,0-255] (default: random)\n"
@@ -68,7 +70,7 @@ bool is_number(char *value) {
     return false;
   }
   unsigned long value_len = strlen(value);
-  int i;
+  unsigned int i;
   for (i = 0; i < value_len; i++) {
     if (!is_digit(value[i])) {
       return false;
@@ -99,7 +101,7 @@ unsigned short parse_ushort(char *arg, char *value) {
   return (unsigned short)tmp_value;
 }
 
-unsigned short parse_ulong(char *arg, char *value) {
+unsigned long parse_ulong(char *arg, char *value) {
   if (!is_number(value)) {
     invalid_value(arg, value);
   }
@@ -145,7 +147,7 @@ parameters parse_args(int argc, char **argv) {
     } else if (is_arg(arg, "-q") || is_arg(arg, "--quiet")) {
       params.quiet = true;
     } else if (is_arg(arg, "-v") || is_arg(arg, "--version")) {
-      puts(NAME " " VERSION);
+      puts(PACKAGE " " VERSION);
       exit(0);
     } else if (is_arg(arg, "-w") || is_arg(arg, "--width")) {
       params.width = parse_ushort(arg, value);
@@ -216,9 +218,9 @@ parameters parse_args(int argc, char **argv) {
   }
 
   if (!var_set) {
-    params.var[0] = rand_uchar(var_range);
-    params.var[1] = rand_uchar(var_range);
-    params.var[2] = rand_uchar(var_range);
+    params.var[0] = rand_uchar(var_range + 1);
+    params.var[1] = rand_uchar(var_range + 1);
+    params.var[2] = rand_uchar(var_range + 1);
   }
 
   if (!rot_set) {

src/config.h

@@ -0,0 +1,12 @@
+#ifndef CONFIG_H
+#define CONFIG_H
+
+#ifndef PACKAGE
+#define PACKAGE "margen"
+#endif
+
+#ifndef VERSION
+#define VERSION "(dev)"
+#endif
+
+#endif

src/const.h

@@ -1,7 +0,0 @@
-#ifndef CONST_H
-#define CONST_H
-
-#define NAME "margen"
-#define VERSION "v1.1.0"
-
-#endif

src/generator.c

@@ -1,8 +1,7 @@
 #include "args.h"
 #include "bmp.h"
-#include "const.h"
+#include "config.h"
 #include "rand.h"
-#include <math.h>
 #include <stdio.h>
 #include <stdlib.h>
 #include <time.h>
@@ -18,11 +17,10 @@ unsigned char *current_line;
 
 unsigned char generate_pixel(unsigned char depth, unsigned char top_pixel,
                              unsigned char left_pixel) {
-  float v = fminf(
-      255.0, fmaxf(0.0, (rand_float(2.0) - 1.0) * global_params.var[depth] +
-                            ((float)left_pixel) * slope +
-                            ((float)top_pixel) * (1.0 - slope)));
-  return (unsigned char)v;
+  short k = rand_uchar(global_params.var[depth] + 1);
+  short v = (rand_uchar(2) == 0 ? k : -k) + (left_pixel)*slope +
+            (top_pixel) * (1.0 - slope);
+  return (unsigned char)(v < 0 ? 0 : (v > 255 ? (unsigned char)255 : v));
 }
 
 void generate_line() {
@@ -62,6 +60,7 @@ void debug_parameters(parameters params) {
     printf("  width   %d\n", params.width);
     printf("  height  %d\n", params.height);
     printf("  pixel   %d\n", params.size);
+    printf("  slope   %d\n", params.slope);
     if (params.monochrome) {
       printf("  color   %u\n", params.start[0]);
       printf("  var.    %u\n", params.var[0]);
@@ -104,7 +103,7 @@ void print_time(parameters params, clock_t start) {
 
 void generate(parameters params) {
   if (!params.quiet) {
-    puts(NAME " " VERSION);
+    puts(PACKAGE " " VERSION);
   }
   clock_t start = clock();
   init(params);

src/rand.c

@@ -1,21 +1,25 @@
-#include <math.h>
+static unsigned long long mcg_state = 0xcafef00dd15ea5e5u; // Must be odd
+static unsigned long long const multiplier = 6364136223846793005u;
 
-float seed;
+// https://en.wikipedia.org/wiki/Permuted_congruential_generator
+unsigned long rand(void) {
+  unsigned long long x = mcg_state;
+  unsigned count = (unsigned)(x >> 61);
 
-void set_seed(unsigned long new_seed) { seed = (float)(new_seed % 1000000); }
-
-float rand(float seed) {
-  float v = powf(seed, 6. / 7.);
-  v *= sinf(v) + 1.;
-  return v - floorf(v);
+  mcg_state = x * multiplier;
+  x ^= x >> 22;
+  return (unsigned long)(x >> (22 + count));
 }
 
-float rand_float(const float max) { return rand(seed++) * max; }
+void set_seed(unsigned long long seed) {
+  mcg_state = 2 * seed + 1;
+  (void)rand();
+}
 
 unsigned char rand_uchar(const unsigned int max) {
-  return (unsigned char)(rand(seed++) * max);
+  return max == 0 ? 0 : (unsigned char)(rand() % max);
 }
 
 unsigned short rand_ushort(const unsigned int max) {
-  return (unsigned short)(rand(seed++) * max);
+  return max == 0 ? 0 : (unsigned short)(rand() % max);
 }

src/rand.h

@@ -1,8 +1,7 @@
 #ifndef RAND_H
 #define RAND_H
 
-void set_seed(unsigned long new_seed);
-float rand_float(const float max);
+void set_seed(unsigned long long seed);
 unsigned char rand_uchar(unsigned int max);
 unsigned short rand_ushort(unsigned int max);