Audiowmark

https://uplex.de/audiowmark
Admin
Audiowmark is an open-source solution for audio watermarking that embeds a 128-bit message into a...
Tokens:6,595
Snippets:88
Trust Score:7.8
Update:3 months ago
Show doc for...
Tokens:
Raw
### Compile Audiowmark from Source

Source: https://uplex.de/audiowmark/README.html

Compile the audiowmark tool from source code. If building from git, run `./autogen.sh` first and ensure `autoconf-archive` is installed.

```bash
./configure
make
make install
```

--------------------------------

### Configure Audiowmark with FFmpeg for HLS Support

Source: https://uplex.de/audiowmark/README.html

Use this command to enable HLS support in audiowmark by linking against FFmpeg libraries. Ensure FFmpeg is installed and its development headers are available.

```bash
./configure --with-ffmpeg
```

--------------------------------

### Get Watermark with Multiple Keys

Source: https://uplex.de/audiowmark/README.html

Retrieves a watermark from an audio file by trying multiple specified keys. This is efficient when keys are changed regularly.

```bash
audiowmark get --key oct23.key --key nov23.key --key dec23.key out.wav
```

--------------------------------

### Add and Get Watermark with Key

Source: https://uplex.de/audiowmark/README.html

Adds a watermark to an audio file using a specified key and retrieves the watermark from an audio file using the same key. The key is essential for decoding the message bits.

```bash
audiowmark add --key test.key in.wav out.wav 0123456789abcdef0011223344556677
```

```bash
audiowmark get --key test.key out.wav
```

--------------------------------

### Watermark Detection Results with Speed Detection

Source: https://uplex.de/audiowmark/README.html

Example output from audiowmark when detecting a watermark with speed detection enabled, showing the detected speed and pattern information.

```text
  speed 1.049966
  pattern  0:05 0123456789abcdef0011223344556677 1.209 0.147 A-SPEED
  pattern  0:57 0123456789abcdef0011223344556677 1.301 0.143 B-SPEED
  pattern  0:57 0123456789abcdef0011223344556677 1.255 0.145 AB-SPEED
  pattern  1:49 0123456789abcdef0011223344556677 1.380 0.173 A-SPEED
  pattern   all 0123456789abcdef0011223344556677 1.297 0.130 SPEED
```

--------------------------------

### Detecting Watermark from Audio File

Source: https://uplex.de/audiowmark/README.html

Use the `audiowmark get` command to extract potential watermark messages from a watermarked audio file. This command may return multiple patterns and confidence scores.

```shell
$ audiowmark get --key my.key song.wm.wav
```

```shell
pattern  0:05 ecd057f0d1fbb25d6430b338b5d72eb2 1.377 0.068 A
pattern  0:57 ecd057f0d1fbb25d6430b338b5d72eb2 1.392 0.109 B
[...]
```

--------------------------------

### Detect Watermark in Video File

Source: https://uplex.de/audiowmark/README.html

Use the videowmark get command to detect watermarks in a video file. The output shows the pattern, timestamp, message, and detection metrics. Multiple patterns and their variations (A, B, AB) may be reported.

```bash
  **$ videowmark get out.avi**
  pattern  0:05 0123456789abcdef0011223344556677 1.294 0.142 A
  pattern  0:57 0123456789abcdef0011223344556677 1.191 0.144 B
  pattern  0:57 0123456789abcdef0011223344556677 1.242 0.145 AB
  pattern  1:49 0123456789abcdef0011223344556677 1.215 0.120 A
  pattern  2:40 0123456789abcdef0011223344556677 1.079 0.128 B
  pattern  2:40 0123456789abcdef0011223344556677 1.147 0.126 AB
  pattern   all 0123456789abcdef0011223344556677 1.195 0.104
```

--------------------------------

### Generating 128-bit Watermark Message from String

Source: https://uplex.de/audiowmark/README.html

This example shows how to generate a 128-bit message by taking the first 32 hexadecimal characters (128 bits) of a SHA-256 hash of the metadata string. It uses `sha256sum` and `head` for this purpose.

```shell
$ STRING='Artist:Alice|Title:Dreams|User:John Smith'
$ MSG=`echo -n "$STRING" | sha256sum | head -c 32`
$ echo $MSG
```

```shell
ecd057f0d1fbb25d6430b338b5d72eb2
```

--------------------------------

### Retrieve Watermark from Audio File

Source: https://uplex.de/audiowmark/README.html

Use this command to extract the 128-bit message from a watermarked audio file. The output is machine-readable, with each line starting with 'pattern' representing a decoded message. Results are sorted by relevance.

```bash
**$ audiowmark get out.wav**
  pattern  0:05 0123456789abcdef0011223344556677 1.358 0.059 A
  pattern  0:57 0123456789abcdef0011223344556677 1.426 0.050 B
  pattern  0:57 0123456789abcdef0011223344556677 1.392 0.055 AB
  pattern  1:49 0123456789abcdef0011223344556677 1.453 0.074 A
  pattern  2:40 0123456789abcdef0011223344556677 1.359 0.080 B
  pattern  2:40 0123456789abcdef0011223344556677 1.406 0.077 AB
  pattern   all 0123456789abcdef0011223344556677 1.399 0.035
  pattern  2:58 c6141f3d25720eb0dbd0e38ee2355ff4 0.185 0.382 B
  pattern  2:14 df659ac435f0569c67cdac1fb2e36cd8 0.178 0.391 B
  pattern  1:58 d7d7ed21e9d6da0a4ffdd5e55ffdb623 0.176 0.389 A
  pattern  2:59 1c13f1532eeb6c9aa719253736849d6e 0.167 0.389 A
```

--------------------------------

### Add and Get Short Payload Watermark

Source: https://uplex.de/audiowmark/README.html

Use the --short option for experimental short payloads (12, 16, or 20 bits). Error checking is performed after decoding to ensure validity. This is useful for shorter clips where fewer bits need to be sent.

```bash
audiowmark add --short 16 in.wav out.wav abcd
```

```bash
audiowmark get --short 16 out.wav
```

--------------------------------

### Build and Run Audiowmark with Docker

Source: https://uplex.de/audiowmark/README.html

Build a Docker image for audiowmark and run a container to display its usage message. Mount a local directory for data persistence.

```bash
docker build -t audiowmark .
docker run -v <local-data-directory>:/data --rm -i audiowmark -h
```

--------------------------------

### Build fftw3 with Float and SSE Support

Source: https://uplex.de/audiowmark/README.html

Configure and build the fftw3 library with single precision float and SSE optimizations. Ensure FFTW3_SOURCE is set to your source directory.

```bash
cd ${FFTW3_SOURCE}
./configure --enable-float --enable-sse && \
make && \
sudo make install
```

--------------------------------

### Basic Wav Pipe Processing

Source: https://uplex.de/audiowmark/README.html

This snippet demonstrates the basic command for piping audio through madplay and audiowmark for WAV output. It's used when the input stream length is unknown.

```bash
cat in.mp3 |
  madplay -o wave:- - |
  audiowmark add - out.wav f0
```

--------------------------------

### Build fftw3 from Git with Shared Libraries

Source: https://uplex.de/audiowmark/README.html

Build fftw3 from its git repository, enabling shared libraries, SSE, and float support. Ensure FFTW3_GIT is set to your git repository path.

```bash
cd ${FFTW3_GIT}
./bootstrap.sh --enable-shared --enable-sse --enable-float && \
make && \
sudo make install
```

--------------------------------

### Input and Output as Streams

Source: https://uplex.de/audiowmark/README.html

Processes audio by reading from stdin and writing to stdout. This is useful for chaining multiple stream-based audio tools.

```bash
cat in.wav | audiowmark add - - 0123456789abcdef0011223344556677 | play -
```

--------------------------------

### Wav Pipe Input and Output

Source: https://uplex.de/audiowmark/README.html

This snippet shows how to configure both input and output to use the 'wav-pipe' format for streaming audio processing when the length is not known in advance. The output is then piped to lame for MP3 encoding.

```bash
cat in.mp3 |
  madplay -o wave:- - |
  audiowmark add --input-format wav-pipe --output-format wav-pipe - - f0 |
  lame - > out.mp3
```

--------------------------------

### Prepare Audio Segments for HLS Watermarking

Source: https://uplex.de/audiowmark/README.html

This command processes prepared HLS audio segments for watermarking. It reads an audio playlist and outputs prepared segments to a new directory, ensuring sufficient audio context for accurate watermarking across segment boundaries.

```bash
audiowmark hls-prepare vs0 vs0prep out.m3u8 video.mp4
```

--------------------------------

### Shorthand for Wav Pipe Input and Output

Source: https://uplex.de/audiowmark/README.html

A more concise way to specify both 'wav-pipe' input and output formats. This is useful for simplifying commands when dealing with unknown stream lengths and piping to an encoder like lame.

```bash
cat in.mp3 |
  madplay -o wave:- - |
  audiowmark add --format wav-pipe - - f0 |
  lame - > out.mp3
```

--------------------------------

### Constructing Metadata String for Watermarking

Source: https://uplex.de/audiowmark/README.html

This string contains information about the song and user, which will be hashed to form the watermark. Ensure proper handling of special characters within fields.

```shell
Artist:Alice|Title:Dreams|User:John Smith
```

--------------------------------

### Wav Pipe Input with RF64 Output

Source: https://uplex.de/audiowmark/README.html

Use this command when you need to watermark an entire WAV pipe input and ensure compatibility with large output files (over 4GB) by using the RF64 format.

```bash
cat in.mp3 |
  madplay -o wave:- - |
  audiowmark add --input-format wav-pipe --output-format rf64 - out.wav f0
```

--------------------------------

### Prepare HLS Segments using FFmpeg

Source: https://uplex.de/audiowmark/README.html

This command splits a video file into HLS audio and video segments, transcoding audio to AAC. It's a prerequisite for watermarking HLS streams, ensuring segments are compatible with the target delivery format.

```bash
ffmpeg -i video.mp4 -f hls -master_pl_name replay.m3u8 -c:a aac -ab 192k \
  -var_stream_map "a:0,agroup:aud v:0,agroup:aud" \
  -hls_playlist_type vod -hls_list_size 0 -hls_time 10 vs%v/out.m3u8
```

--------------------------------

### Input from WAV Stream

Source: https://uplex.de/audiowmark/README.html

Reads a WAV file from stdin and watermarks it, writing the output to a file. This allows processing audio data as it becomes available.

```bash
cat in.wav | audiowmark add - out.wav 0123456789abcdef0011223344556677
```

--------------------------------

### Advanced Speed Detection with `--detect-speed-patient`

Source: https://uplex.de/audiowmark/README.html

Utilizes a more thorough and time-consuming algorithm for detecting speed differences, potentially yielding more accurate results. This is useful for challenging audio samples.

```bash
  **$ audiowmark get out1.wav --detect-speed-patient**
```

--------------------------------

### Add Watermark to Video File

Source: https://uplex.de/audiowmark/README.html

Use the videowmark tool to add a watermark to the audio track of video files. Specify the input and output files, and the watermark message. Optional parameters like audio codec, strength, key file, and more can be set.

```bash
  **$ videowmark add in.avi out.avi 0123456789abcdef0011223344556677**
  Audio Codec:  -c:a mp3 -ab 128000
  Input:        in.avi
  Output:       out.avi
  Message:      0123456789abcdef0011223344556677
  Strength:     10

  Time:         3:53
  Sample Rate:  44100
  Channels:     2
  Data Blocks:  4
```

--------------------------------

### Watermark HLS Segment via Stdin/Stdout

Source: https://uplex.de/audiowmark/README.html

For real-world use, pipe input segments via stdin and capture watermarked output to stdout using `audiowmark hls-add`. This is useful for integrating into streaming pipelines.

```bash
**$ [...] | audiowmark hls-add - - 0123456789abcdef0011223344556677 | [...]**
```

--------------------------------

### Embedding Watermark into Audio File

Source: https://uplex.de/audiowmark/README.html

Use the `audiowmark add` command to embed the generated 128-bit message into an audio file. Requires a key file and specifies input and output audio files.

```shell
$ audiowmark add --key my.key song.wav song.wm.wav $MSG
```

--------------------------------

### Generate Named Watermark Key

Source: https://uplex.de/audiowmark/README.html

Generates a watermark key and assigns it a name. The key name is reported during watermark detection.

```bash
audiowmark gen-key oct23.key --name "October 2023"
```

--------------------------------

### Watermark MP3 to stdout

Source: https://uplex.de/audiowmark/README.html

Watermarks an MP3 file and outputs the result to stdout. This showcases the flexibility of audiowmark with different audio encodings for streaming.

```bash
audiowmark add in.mp3 - 0123456789abcdef0011223344556677 | play -
```

--------------------------------

### Add Watermark with Increased Strength

Source: https://uplex.de/audiowmark/README.html

Adds a watermark to an audio file with a specified strength. Higher strength increases robustness against modifications but also makes the watermark more audible.

```bash
audiowmark add --strength 15 in.wav out.wav 0123456789abcdef0011223344556677
```

--------------------------------

### Add Watermark to Sound File

Source: https://uplex.de/audiowmark/README.html

Use this command to add a watermark to an audio file. Specify input and output file paths, and the 128-bit message as a hex string. The strength defaults to 10 if not specified.

```bash
**$ audiowmark add in.wav out.wav 0123456789abcdef0011223344556677**
  Input:        in.wav
  Output:       out.wav
  Message:      0123456789abcdef0011223344556677
  Strength:     10

  Time:         3:59
  Sample Rate:  48000
  Channels:     2
  Data Blocks:  4
```

--------------------------------

### Watermark WAV to stdout

Source: https://uplex.de/audiowmark/README.html

Watermarks a WAV file and outputs the result to stdout, allowing piping to other commands like 'play'. This enables real-time playback or processing of the watermarked stream.

```bash
audiowmark add in.wav - 0123456789abcdef0011223344556677 | play -
```

--------------------------------

### Detect Watermark With Speed Detection

Source: https://uplex.de/audiowmark/README.html

Detects a watermark in an audio file while automatically compensating for replay speed differences. This option is more robust against speed variations.

```bash
  **$ audiowmark get out1.wav --detect-speed**
```

--------------------------------

### Watermark FLAC to stdout

Source: https://uplex.de/audiowmark/README.html

Watermarks a FLAC file and outputs the result to stdout. This demonstrates audiowmark's support for various input formats when streaming.

```bash
audiowmark add in.flac - 0123456789abcdef0011223344556677 | play -
```

--------------------------------

### Detect Watermark from Stream

Source: https://uplex.de/audiowmark/README.html

Detects watermarks in an audio stream read from stdin. This is efficient for analyzing audio data without writing intermediate files.

```bash
cat in.wav | audiowmark get -
```

--------------------------------

### Add Watermark to Audio File

Source: https://uplex.de/audiowmark/README.html

Adds a watermark to an audio file. This is a prerequisite for subsequent detection operations.

```bash
  **$ audiowmark add in.wav out.wav 0123456789abcdef0011223344556677**
```

--------------------------------

### Generate Watermark Key

Source: https://uplex.de/audiowmark/README.html

Generates a 128-bit AES watermark key. This key controls the pseudo-random parameters of the watermarking algorithm.

```bash
audiowmark gen-key test.key
```

--------------------------------

### Watermark HLS Audio Segment

Source: https://uplex.de/audiowmark/README.html

Use `audiowmark hls-add` to watermark a specific HLS audio segment. The output provides details about the watermarking process, including message, strength, and timing.

```bash
**$ audiowmark hls-add vs0prep/out5.ts send5.ts 0123456789abcdef0011223344556677**
Message:      0123456789abcdef0011223344556677
Strength:     10

Time:         0:15
Sample Rate:  44100
Channels:     2
Data Blocks:  0
AAC Bitrate:  195641
```

--------------------------------

### Detect Watermark Without Speed Detection

Source: https://uplex.de/audiowmark/README.html

Attempts to detect a watermark in an audio file without considering speed variations. This may fail if the audio speed has been altered.

```bash
  **$ audiowmark get out1.wav**
```

--------------------------------

### Modify Audio Speed with Sox

Source: https://uplex.de/audiowmark/README.html

Adjusts the playback speed of an audio file using the 'sox' utility. This is used to simulate replay speed variations.

```bash
  **$ sox out.wav out1.wav speed 1.05**
```
Tokens:
Raw