1. 1
2. 2
3. 3
4. 4
5. 5
6. 6
7. 7
8. 8
9. 9
10. 10
11. 11
12. 12
13. 13
14. 14
15. 15
16. 16
17. 17
18. 18
19. 19
20. 20
21. 21
22. 22
23. 23
24. 24
25. 25
26. 26
27. 27
28. 28
29. 29
30. 30
31. 31
32. 32
33. 33
34. 34
35. 35
36. 36
37. 37
38. 38
39. 39
40. 40
41. 41
42. 42
43. 43
44. 44
45. 45
46. 46
47. 47
48. 48
49. 49
50. 50
51. 51
52. 52
53. 53
54. 54
55. 55
56. 56
57. 57
58. 58
59. 59
60. 60
61. 61
62. 62
63. 63
64. 64
65. 65
66. 66
67. 67
68. 68
69. 69
70. 70
71. 71
72. 72
73. 73
74. 74
75. 75
76. 76
77. 77
78. 78
79. 79
80. 80
81. 81
82. 82
83. 83
84. 84
85. 85
86. 86
87. 87
88. 88
89. 89
90. 90
91. 91
92. 92
93. 93
94. 94
95. 95
96. 96
97. 97
98. 98
99. 99
100. 100

<!--
Copyright 2025 Shota FUJI

Licensed under the Zero-Clause BSD License or the Apache License, Version 2.0, at your option.
You may not use, copy, modify, or distribute this file except according to those terms. You can
find a copy of the Zero-Clause BSD License at LICENSES/0BSD.txt, and a copy of the Apache License,
Version 2.0 at LICENSES/Apache-2.0.txt. You may also obtain a copy of the Apache License, Version
2.0 at <https://www.apache.org/licenses/LICENSE-2.0>

SPDX-License-Identifier: 0BSD OR Apache-2.0
-->

# libsood

libsood is a Zig library providing parsing and constructing of SOOD message, a binary format used in Roon Server discovery.
libsood is available as,

- Zig module (`sood`)
- static or dynamic library (C API) (`libsood`)
- WebAssembly Module (`sood.wasm`)

## Installation

This library requires Zig toolchain v0.14.

### Zig module

Add an entry with `.url = "https://git.pocka.jp/libsood.git/archive/<GIT REF>.tar.gz"` to `dependencies` section in your `build.zig.zon`.
Or, run the below command:

```
$ zig fetch --save https://git.pocka.jp/libsood.git/archive/<GIT REF>.tar.gz
```

Then, in your `build.zig`:

```zig
fn build(b: *std.Build) void {
	// [snip]

	const sood = b.dependency("sood", .{
		.target = target,
		.optimize = optimize,
	});

	// [snip]

	libOrExe.root_module.addImport("sood", sood.module("sood"));

	// [snip]
}
```

### Static library

Clone the repository and run the below command:

```
$ zig build
```

This emits files under `zig-out/`.
A static library file will be generated at `zig-out/lib/` (filename differs by platform).

### Dynamic library

Clone the repository and run the below command:

```
$ zig build -Dlinkage=dynamic
```

This emits files under `zig-out/`.
A dynamic library file will be generated at `zig-out/lib/` (filename differs by platform).

### WebAssembly module

Clone the repository and run the below command:

```
$ zig build wasm -Doptimize=ReleaseSmall
```

This emits files under `zig-out/`.
A WebAssembly module file will be generated as `zig-out/bin/sood.wasm`.
If binary size does not matter to your use-case, set `ReleaseFast` to `-Doptimize` instead.

## Documentation

Library documentation is available as man pages.

```
$ man ./man/sood.7
```

Currently, Zig module and WebAssembly module do not have API documentation.

- `sood.7` ... General documentation.
- `sood.3` ... C API index.
- `sood_*.3` ... C API function documentation.