0.2: Makefile

Author: zvezdochiot

license.txt LICENSElicense.txt renamed to LICENSE

@@ -0,0 +1,33 @@
+CC ?= gcc
+CFLAGS ?= -Wall -O2
+LDFLAGS ?= -Wall -s
+AR = ar
+TARGET = slac
+SRCL = src/libslac.c
+SRCT = src/main.c
+OBJL = $(SRCL:%.c=%.o)
+OBJT = $(SRCT:%.c=%.o)
+SOVER = 0
+
+ifeq ($(SHARED), Y)
+	TLIB = lib$(TARGET).so.$(SOVER)
+else
+	TLIB = lib$(TARGET).a
+endif
+
+all: $(TARGET)
+
+$(TARGET): $(OBJT) $(TLIB)
+	$(CC) $(LDFLAGS) $^ -o $@
+
+lib$(TARGET).a: $(OBJL)
+	$(AR) rcs $@ $^
+
+lib$(TARGET).so.$(SOVER): $(OBJL)
+	$(CC) $(LDFLAGS) -shared -Wl,-soname,$@ $^ -o $@
+
+%.o: %.c
+	$(CC) $(CFLAGS) -c $< -o $@
+
+clean:
+	rm -rf $(TARGET) $(TLIB) $(OBJT) $(OBJL)

Makefile

@@ -1,18 +1,28 @@
-////////////////////////////////////////////////////////////////////////////
-//                           ****** SLAC ******                           //
-//                    Simple Lossless Audio Compressor                    //
-//                 Copyright (c) 2019 - 2022 David Bryant                 //
-//                          All Rights Reserved.                          //
-//      Distributed under the BSD Software License (see license.txt)      //
-////////////////////////////////////////////////////////////////////////////
-
-Update: Since I developed and named this codec I have been made aware of a
-        proprietary audio compression algorithm from Texas Instruments for
-        its CC85xx line of chips (and perhaps others) also called SLAC
-        (Slightly Lossy Audio Codec). There is no relation between the two
-        codecs (mine is completely original and neither lossy nor
-        proprietary). I apologize for any confusion.
-
+`ORG.SLM:`
+![GitHub release (latest by date)](https://img.shields.io/github/v/release/Sound-Linux-More/slac)
+![GitHub Release Date](https://img.shields.io/github/release-date/Sound-Linux-More/slac)
+![GitHub repo size](https://img.shields.io/github/repo-size/Sound-Linux-More/slac)
+![GitHub all releases](https://img.shields.io/github/downloads/Sound-Linux-More/slac/total)
+![GitHub](https://img.shields.io/github/license/Sound-Linux-More/slac)  
+
+# SLAC
+
+| ****** SLAC ****** |
+|:---:|
+| Simple Lossless Audio Compressor |
+| Copyright (c) 2019 - 2022 David Bryant. |
+| All Rights Reserved. |
+| Distributed under the BSD Software License (see license.txt) |
+
+## Update
+Since I developed and named this codec I have been made aware of a
+proprietary audio compression algorithm from Texas Instruments for
+its CC85xx line of chips (and perhaps others) also called SLAC
+(Slightly Lossy Audio Codec). There is no relation between the two
+codecs (mine is completely original and neither lossy nor
+proprietary). I apologize for any confusion.
+
+## Intro
 A very simple lossless audio compressor. Designed to achieve about the same
 compression as flac -0 or shorten with the absolute minimum amount of
 complexity (in fact, the entire library for both encoding and decoding is a
@@ -34,29 +44,46 @@ no error detection, and no seeking capability. The format COULD be used
 inside of another container format like Matroska, but I'm not sure that
 would have any value.
 
+## Build
 To build the demo app:
-
-    $ gcc -O2 *.c -o slac
-
-The "help" display from the demo app:
-
- Usage:     SLAC [-options] infile.wav outfile.slac
-            SLAC -d [-options] infile.slac outfile.wav
-
- Pipes:     specify '-' for filename, but not WAV output
-
- Options:  -d     = decode operation (default = encode))
-           -bn    = override block samples (default = 1024)
-           -h     = display this help message
-           -j0    = encode stereo files as L/R
-           -j1    = encode stereo files as M/S (default)
-           -j2    = encode stereo files using best (slow)
-           -q     = quiet mode (display errors only)
-           -r     = raw output (no WAV header written)
-           -v     = verbose (display lots of info)
-           -y     = overwrite outfile if it exists
-
-
+```sh
+    $ make
+```
+or
+```sh
+    $ make SHARED=Y
+```
+or
+```sh
+    $ gcc -Wall -O2 src/*.c -o slac
+```
+
+## Use
+
+### Usage
+```sh
+     slac [-options] infile.wav outfile.slac
+     slac -d [-options] infile.slac outfile.wav
+```
+
+### Pipes
+Specify `-` for filename, but not WAV output
+
+### Options
+```sh
+    -d     = decode operation (default = encode))
+    -bn    = override block samples (default = 1024)
+    -h     = display this help message
+    -j0    = encode stereo files as L/R
+    -j1    = encode stereo files as M/S (default)
+    -j2    = encode stereo files using best (slow)
+    -q     = quiet mode (display errors only)
+    -r     = raw output (no WAV header written)
+    -v     = verbose (display lots of info)
+    -y     = overwrite outfile if it exists
+```
+
+## Algorithm
 The compression algorithm uses only standard techniques:
 
 1. The audio data samples are divided into blocks. By default these are 1024