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
|
.TH AUDIOWMARK 1 "January 2026" "audiowmark" "User Commands"
.SH NAME
audiowmark \- audio watermarking tool
.SH SYNOPSIS
.B audiowmark
.RI [ options ]
.I command
.RI [ args... ]
.SH DESCRIPTION
.B audiowmark
is an open-source C++ audio watermarking utility that embeds and retrieves
128-bit messages in audio files in a way that is inaudible to most listeners.
.PP
It supports blind decoding (watermark extraction without access to the
original file) and robust forward error correction, allowing watermarks to
survive lossy compression formats such as MP3 and OGG.
.SH COMMANDS
.TP
.BI "add " input_wav " " watermarked_wav " " message_hex
Create a watermarked WAV file containing the provided message.
.TP
.BI "get " watermarked_wav
Retrieve the embedded watermark message from a watermarked WAV file and
print it to standard output.
.TP
.BI "cmp " watermarked_wav " " message_hex
Compare the embedded watermark message against the expected message.
.TP
.BI "gen-key " key_file " [ --name " key_name " ]"
Generate a 128-bit watermarking key and write it to
.IR key_file .
.SH GLOBAL OPTIONS
These options apply to all commands.
.TP
.BR \-q ", " \-\-quiet
Disable informational messages.
.TP
.B \-\-strict
Treat minor problems as errors.
.SH OPTIONS FOR GET / CMP
.TP
.B \-\-detect-speed
Detect and correct replay speed differences.
.TP
.B \-\-detect-speed-patient
Slower but more accurate replay speed detection.
.TP
.BI "\-\-json " file
Write JSON-formatted results to
.IR file .
.SH OPTIONS FOR ADD / GET / CMP
.TP
.BI "\-\-key " file
Load watermarking key material from
.IR file .
.TP
.BI "\-\-short " bits
Enable short payload mode using the specified number of bits.
.TP
.BI "\-\-strength " s
Set watermark strength.
The default value is 10.
.TP
.B \-\-input-format raw
Use a raw audio stream as input.
.TP
.B \-\-output-format raw
Use a raw audio stream as output.
.TP
.B \-\-format raw
Use raw audio streams for both input and output.
.PP
Options to configure raw stream parameters (such as sample rate or channel
count) are documented in the upstream README.
.SH EXAMPLES
Embed a watermark into an audio file:
.PP
.nf
audiowmark add input.wav output.wav 00112233445566778899aabbccddeeff
.fi
.PP
Extract a watermark from an audio file:
.PP
.nf
audiowmark get output.wav
.fi
.PP
Compare a watermark with an expected message:
.PP
.nf
audiowmark cmp output.wav 00112233445566778899aabbccddeeff
.fi
.PP
Generate a watermarking key:
.PP
.nf
audiowmark gen-key key.bin --name "example key"
.fi
.SH EXIT STATUS
.TP
.B 0
The operation completed successfully.
.TP
.B >0
An error occurred.
.SH SEE ALSO
.BR ffmpeg (1),
.BR sox (1)
.SH AUTHOR
audiowmark was written by Stefan Westerfeld <stefan@space.twc.de>.
.PP
This manual page was written and maintained for Debian by Christopher Obbard.
.SH COPYRIGHT
Copyright \(co 2018\-2020 Stefan Westerfeld <stefan@space.twc.de>.
Licensed under the GNU General Public License, version 3 or later.
|
