summaryrefslogtreecommitdiff
path: root/farbfeld.5
blob: accae576e6e62cdcd4e7b9b4a5abf053ec448443 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
.Dd 2017-04-14
.Dt FARBFELD 5
.Os suckless.org
.Sh NAME
.Nm farbfeld
.Nd suckless image format
.Sh DESCRIPTION
.Nm
is a
.Em lossless
image format which is easy to parse, pipe and compress.
It has the following format:
.Bd -literal -offset left
BYTES    DESCRIPTION
8        "farbfeld" magic value
4        32-Bit BE unsigned integer (width)
4        32-Bit BE unsigned integer (height)
[2222]   4*16-Bit BE unsigned integers [RGBA] / pixel, row-major
.Ed
.Pp
The RGB-data should be sRGB for best interoperability and not
alpha-premultiplied.
.Sh USAGE
.Nm
provides the tools
.Xr 2ff 1 ,
.Xr jpg2ff 1 ,
.Xr png2ff 1
and
.Xr ff2jpg 1 ,
.Xr ff2pam 1 ,
.Xr ff2png 1 ,
.Xr ff2ppm 1
to
.Em convert
to and from farbfeld images respectively.
.Pp
.Xr bzip2 1
is recommended for
.Em compression ,
giving results comparable with PNG for photographs and much better results
for other image types.
.sp
The
.Em file extension
is ".ff" and compression extensions shall be
appended (e.g. ".ff.bz2").
.Sh MOTIVATION
.Nm
was created because the author was not satisfied with the boilerplate
and inherent complexity involved in handling common image formats
(PNG, JPEG, GIF,...), having to rely on bloated libraries while not being
able to focus on the task at hand for a given image processing problem.
.Sh EXAMPLES
Below is an example for a color inverter usable in a pipeline. No external
libraries other than libc are needed to handle the image data:
.Bd -literal -offset left
#include <arpa/inet.h>

#include <stdint.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>

int
main(int argc, char *argv[])
{
	uint32_t width, height, i, j, k;
	uint16_t rgba[4];
	uint8_t hdr[strlen("farbfeld") + 2 * sizeof(uint32_t)];

	if (argc > 1) {
		fprintf(stderr, "usage: %s\\n", argv[0]);
		return 1;
	}

	if (fread(hdr, 1, sizeof(hdr), stdin) != sizeof(hdr)) {
		fprintf(stderr, "incomplete header\\n");
		return 1;
	}
	if (memcmp("farbfeld", hdr, strlen("farbfeld"))) {
		fprintf(stderr, "invalid magic\\n");
		return 1;
	}
	width = ntohl(*((uint32_t *)(hdr + 8)));
	height = ntohl(*((uint32_t *)(hdr + 12)));

	if (fwrite(hdr, 1, sizeof(hdr), stdout) != sizeof(hdr)) {
		fprintf(stderr, "write error\\n");
		return 1;
	}

	for (i = 0; i < height; i++) {
		for (j = 0; j < width; j++) {
			if (fread(rgba, sizeof(uint16_t), 4,
			          stdin) != 4) {
				fprintf(stderr, "unexpected EOF\\n");
				return 1;
			}
			for (k = 0; k < 4; k++) {
				rgba[k] = ntohs(rgba[k]);
			}

			/* invert colors */
			rgba[0] = 65535 - rgba[0];
			rgba[1] = 65535 - rgba[1];
			rgba[2] = 65535 - rgba[2];

			for (k = 0; k < 4; k++) {
				rgba[k] = htons(rgba[k]);
			}
			if (fwrite(rgba, sizeof(uint16_t), 4,
			           stdout) != 4) {
				fprintf(stderr, "write error\\n");
				return 1;
			}
		}
	}

	return 0;
}
.Ed
.Sh SEE ALSO
.Xr 2ff 1 ,
.Xr ff2jpg 1 ,
.Xr ff2pam 1 ,
.Xr ff2png 1 ,
.Xr ff2ppm 1 ,
.Xr jpg2ff 1 ,
.Xr png2ff 1
.Sh AUTHORS
.An Laslo Hunhold Aq Mt dev@frign.de