Cloud Containerization - Revision history

Camille: /* General information */

2024-07-24T08:04:18Z

General information

Camille at 15:49, 1 March 2024

2024-03-01T15:49:34Z

Camille: /* General information */

2024-02-21T16:11:24Z

General information

Camille: Added example of separated process/server. Added BigVoice example.

2024-02-21T13:51:09Z

Added example of separated process/server. Added BigVoice example.

Show changes

Camille at 16:32, 7 February 2024

2024-02-07T16:32:32Z

Camille: Created

2024-02-07T16:14:11Z

Created

New page

The SOUND4 .CL processing can be containerized.

=== General information ===
To provide the audio to the container, the easier is to use RTP to send and retrieve audio.

You can use the <code>sound4.''xxx''-proc</code> program contained in the archive to create the process using the dynamic library.

For X1.CL and IMPACT.CL, you can add extensions (Kantar.CL and Stream.CL) in the container to have them available.

The libraries for Linux have very little dependencies :

* kernel >= 3.13
* GlibC >= 2.19

So, using Debian>=8 or Ubuntu>=14.04 will work.

=== Special care ===
The distribution should have recent ca-certificates to be able to access HTTPS on the Internet, for licenses or metadata pulling.

The configuration storage should be in a volume to keep presets and configuration upon upgrades.

You need to pass license information when starting the container. This can be done with environment variables or process parameters.

You can check all available options by running the <code>sound4.''xxx''-proc</code> with <code>-h</code> to get help.

=== Example for X1.CL ===
Files used in image should be extracted from the matching process library archives.

==== Dockerfile ====
<syntaxhighlight lang="dockerfile">
FROM debian:bookworm-slim
# install ca-certificates to access HTTPS for licenses
RUN apt update \
&& apt install -yq --no-install-recommends \
ca-certificates \
&& rm -rf /var/lib/apt/lists/*
RUN mkdir -p /usr/share/sound4proc
WORKDIR /
# copy processing library
COPY lib/libsound4.x1.cloud.so /usr/local/lib
# copy processing helper executable
COPY bin/sound4.x1.cloud-proc /usr/local/bin

# OPTIONAL: Kantar.CL
COPY lib/libsound4.kantar.so /usr/local/lib
COPY lib/libsnapliveaudioembedder.so /usr/local/lib

# OPTIONAL: Stream.CL
COPY lib/libsound4.stream.so /usr/local/lib
# OPTIONAL: Stream.CL scripts in share/sound4/SOUND4\ Stream.CL\ Metaparsers/
COPY share/ /usr/local/share/

# force libs locate
RUN ldconfig
# rtp needs a logname
ENV LOGNAME=sound4
CMD /usr/local/bin/sound4.x1.cloud-proc

</syntaxhighlight>

==== Docker-compose File ====
<syntaxhighlight lang="yaml">
version: '3.4'
services:
process:
build: .
restart: unless-stopped
ports:
- "${RTP_SRC_PORT:-5004}:${RTP_SRC_PORT:-5004}/udp"
- "${HTTP_PORT:-80}:${HTTP_PORT:-80}"
volumes:
- process_storage:/usr/share/sound4proc
command: [
"/usr/local/bin/sound4.x1.cloud-proc"
# You can get the full command line options by running the program with -h

# For Kantar, disable usage of offline licenses in cloud solutions
, "-a", "KANTAR_OfflineLicense=0"
# , "-a", "KANTAR_LicPath=/usr/share/sound4lic"
# For Kantar, you may force KANTAR_Login, KANTAR_Password, KANTAR_LicenseName and KANTAR_ChannelName
# For stream, known metadata parsers
, "-a", "Metadata_provided_path=/usr/local/share/sound4/SOUND4 Stream.CL Metaparsers"
# For stream, if you want no metadata management in UI, set to 1
, "-a", "Metadata_no_ui=0"
]
environment:
# where to save, internally
- STATE_DIR=/usr/share/sound4proc
# RTP/UDP listening specific IP (use for broadcast) or Livewire channel in
# use 0 to receive directly RTP (no Livewire)
- RTP_SRC_IP=${RTP_SRC_IP:-0}
- RTP_SRC_PORT=${RTP_SRC_PORT:-5004}
# Send back to this IP or Livewire channel
- RTP_DEST_IP=${RTP_DEST_IP:-x.x.x.x}
- RTP_DEST_PORT=${RTP_DEST_PORT:-5004}
- PROC_VERB=${PROC_VERB:-}
# Choose sample format in S16_LE, S16_BE, S24_LE, S24_BE, S32_LE, S32_BE, F32_LE, F32_BE
- RTP_SAMPLE_FORMAT=${RTP_SAMPLE_FORMAT:-S16_BE}
# receive/send RTP payload. NOTE: payload 97 allows to receive payload 96 or 97, to ease compatibility.
- RTP_PAYLOAD=${RTP_PAYLOAD:-97}
# Audio frames Per Output Packet
- RTP_FRAMES=${RTP_FRAMES:-64}
# Port for HTTP
- HTTP_PORT=${HTTP_PORT:-80}
# Setup/Admin user: see doc
- SETUP_USER=${SETUP_USER:-}
- SETUP_SECRET=${SETUP_SECRET:-}
- ADMIN_USER=${ADMIN_USER:-}
- ADMIN_SECRET=${ADMIN_SECRET:-}
# IDs for the licence SOUND4 gave you
- S4LOGINKEY=${S4LOGINKEY:-xxxxxxxx}
- RADIO_NAME=${RADIO_NAME:-}
- S4_AWS_ACCESS_KEY_ID=${S4_AWS_ACCESS_KEY_ID:-}
- S4_AWS_SECRET_ACCESS_KEY=${S4_AWS_SECRET_ACCESS_KEY:-}
volumes:
process_storage:

</syntaxhighlight><br />

@@ Line 12: / Line 12: @@
 The libraries for Linux have very little dependencies :
-*kernel >= 3.13
+*kernel >= 5.4
-*GlibC >= 2.19
+*GlibC >= 2.31
-So, using Debian>=8 or Ubuntu>=14.04 will work.
+So, using Debian>=11 or Ubuntu>=20.04 will work.
 If you need, you can separate the process and the user interface server, but this is not required

@@ Line 1: / Line 1: @@
 The SOUND4 .CL processing can be containerized.
 ===General information===
@@ Line 29: / Line 31: @@
 Files used in image should be extracted from the matching process library archives.
-==== Files ====
+====Files====
 You need to get the processing libraries, and optionally the plugins' library, and extract them in the same folder as the Dockerfile, so Docker can use them.

@@ Line 28: / Line 28: @@
 ===Example for X1.CL===
 Files used in image should be extracted from the matching process library archives.
 ====Dockerfile====
@@ Line 120: / Line 125: @@
 </syntaxhighlight>
-=== Example for X1.CL with separated server ===
+===Example for X1.CL with separated server===
 Files used in image should be extracted from the matching process library archives.
 ====Dockerfile-process====
@@ Line 250: / Line 257: @@
 </syntaxhighlight>
-=== Impact.CL ===
+===Impact.CL===
 This exactly the same as X1.CL, replacing <code>sound4.x1.cloud</code> by <code>sound4.impact.cl</code>.
-=== Bigvoice.CL ===
+See [[Cloud Containerization#Example for X1.CL|Example for X1.CL]]  for details.
 This exactly the same as X1.CL, replacing <code>sound4.x1.cloud</code> by <code>sound4.bigvoice.cl</code>. You can remove all Kantar and Stream extension's specific, as they are not used in BigVoice.CL.
 ====Dockerfile====
@@ Line 324: / Line 335: @@
 </syntaxhighlight>
 [[Category:Cloud]]

@@ Line 1: / Line 1: @@
 The SOUND4 .CL processing can be containerized.
-=== General information ===
+===General information===
 To provide the audio to the container, the easier is to use RTP to send and retrieve audio.
@@ Line 10: / Line 10: @@
 The libraries for Linux have very little dependencies :
-* kernel >= 3.13
+*kernel >= 3.13
-* GlibC >= 2.19
+*GlibC >= 2.19
 So, using Debian>=8 or Ubuntu>=14.04 will work.
-=== Special care ===
+===Special care===
 The distribution should have recent ca-certificates to be able to access HTTPS on the Internet, for licenses or metadata pulling.
@@ Line 24: / Line 24: @@
 You can check all available options by running the <code>sound4.''xxx''-proc</code> with <code>-h</code> to get help.
-=== Example for X1.CL ===
+===Example for X1.CL===
 Files used in image should be extracted from the matching process library archives.
-==== Dockerfile ====
+====Dockerfile====
 <syntaxhighlight lang="dockerfile">
 FROM debian:bookworm-slim
@@ Line 59: / Line 59: @@
 </syntaxhighlight>
-==== Docker-compose File ====
+====Docker-compose File====
 <syntaxhighlight lang="yaml">
 version: '3.4'
@@ Line 117: / Line 117: @@
 </syntaxhighlight><br />