.CL Command-line tools - Revision history

Camille: sound4.any.cl-proc: added Kubernetes Leader Election

2024-06-07T14:33:28Z

sound4.any.cl-proc: added Kubernetes Leader Election

← Older revision		Revision as of 14:33, 7 June 2024
Line 106:		Line 106:

	For parameters and metadata, see libraries documentation.		For parameters and metadata, see libraries documentation.

			==== Kubernetes Leader Election ====
			Linux only, with environment variables:

			* <code>LEADERELECTION_LEASENAME</code> : lease name
			* <code>LEADERELECTION_NAMESPACE</code> : lease namespace
			* Optional:
			** <code>LEADERELECTION_IFACE_IP</code> : define ID with this interface IP instead of hostname
			** <code>LEADERELECTION_WAITFORCREATE</code> : block before creating instance instead of after
			** <code>LEADERELECTION_LEASEDURATION</code> : lease duration
			** <code>LEADERELECTION_RENEWDEADLINE</code> : lease renew deadline
			** <code>LEADERELECTION_RETRYPERIOD</code> : lease retry period

			When both <code>LEADERELECTION_LEASENAME</code> and <code>LEADERELECTION_NAMESPACE</code> are set and working, only one pod will process.

			Duration are Go duration strings, like 3s, 100ms, ...

			The pod needs access to apiGroups 'coordination.k8s.io' resources 'leases' for 'get', 'update', 'list' (and 'create' if not pre-created).

	====Advanced access====		====Advanced access====

Camille: Added PipeWire

2024-06-07T14:27:56Z

Added PipeWire

← Older revision		Revision as of 14:27, 7 June 2024
Line 145:		Line 145:

	===sound4.''any''.cl-jack===		===sound4.''any''.cl-jack===
	[https://jackaudio.org/ JACK Audio Connection Kit] support.		Linux [https://jackaudio.org/ JACK Audio Connection Kit] support.

	Parameters :		Parameters :
Line 151:		Line 151:
	*<code>-C ''jack_name''</code> : JACK client name		*<code>-C ''jack_name''</code> : JACK client name
	*<code>-S ''jack_session''</code> : JACK session name		*<code>-S ''jack_session''</code> : JACK session name

			See also [[#Web interface\|Web interface]], [[#Storage\|Storage]] and [[#Advanced access\|Advanced access]].
			===sound4.''any''.cl-pipewire===
			Linux [https://pipewire.org/ PipeWire] support.

			Parameters :

			*<code>-C ''name''</code> : client name

	See also [[#Web interface\|Web interface]], [[#Storage\|Storage]] and [[#Advanced access\|Advanced access]].		See also [[#Web interface\|Web interface]], [[#Storage\|Storage]] and [[#Advanced access\|Advanced access]].
	[[Category:Cloud]]		[[Category:Cloud]]

Camille: STATE_FILENAME, STATE_ONAIR, STORAGE_RO are parameters, not env variables

2024-03-21T07:35:47Z

STATE_FILENAME, STATE_ONAIR, STORAGE_RO are parameters, not env variables

← Older revision		Revision as of 07:35, 21 March 2024
Line 44:		Line 44:
	But in this case, you should give each a different statename, so each has its own settings and onair preset.		But in this case, you should give each a different statename, so each has its own settings and onair preset.

	*<code>-N ''statename''</code> : Storage state filename, if sharing storepath between instances ~~(default: <code>STATE_FILENAME</code>)~~		*<code>-N ''statename''</code> : Storage state filename, if sharing storepath between instances

	Also, if you want instances to follow the onair preset, you can set them the same onairname : changing preset on one instance will change for all at the same time.		Also, if you want instances to follow the onair preset, you can set them the same onairname : changing preset on one instance will change for all at the same time.

	*<code>-O ''onairname''</code> : Storage onair filename, if sharing storepath between instances ~~(default: <code>STATE_ONAIR</code>)~~		*<code>-O ''onairname''</code> : Storage onair filename, if sharing storepath between instances

	See also [[Cloud Process Configuration Storage]]		See also [[Cloud Process Configuration Storage]]
Line 54:		Line 54:
	Special storage information :		Special storage information :

	*<code>-R</code> : Storage is read-only ~~(default: <code>STORAGE_RO</code>)~~		*<code>-R</code> : Storage is read-only
	*<code>-S</code> : Storage state is read-only ~~(default: <code>STATE_RO</code>)~~		*<code>-S</code> : Storage state is read-only

	====Audio I/O====		====Audio I/O====

Camille: /* Storage */

2024-02-26T09:28:32Z

Storage

← Older revision		Revision as of 09:28, 26 February 2024
Line 44:		Line 44:
	But in this case, you should give each a different statename, so each has its own settings and onair preset.		But in this case, you should give each a different statename, so each has its own settings and onair preset.

	*<code>-N ''statename''</code> : Storage state filename, if sharing storepath between instances		*<code>-N ''statename''</code> : Storage state filename, if sharing storepath between instances (default: <code>STATE_FILENAME</code>)

	Also, if you want instances to follow the onair preset, you can set them the same onairname : changing preset on one instance will change for all at the same time.		Also, if you want instances to follow the onair preset, you can set them the same onairname : changing preset on one instance will change for all at the same time.

	*<code>-O ''onairname''</code> : Storage onair filename, if sharing storepath between instances		*<code>-O ''onairname''</code> : Storage onair filename, if sharing storepath between instances (default: <code>STATE_ONAIR</code>)

	See also [[Cloud Process Configuration Storage]]		See also [[Cloud Process Configuration Storage]]
Line 54:		Line 54:
	Special storage information :		Special storage information :

	*<code>-R</code> : Storage is read-only		*<code>-R</code> : Storage is read-only (default: <code>STORAGE_RO</code>)
	*<code>-S</code> : Storage state is read-only		*<code>-S</code> : Storage state is read-only (default: <code>STATE_RO</code>)

	====Audio I/O====		====Audio I/O====

Camille: RTP_FRAMES

2024-02-22T13:15:51Z

RTP_FRAMES

Camille: Web access authentication

2024-02-22T12:59:31Z

Web access authentication

@@ Line 56: / Line 56: @@
 *<code>-R</code> : Storage is read-only
 *<code>-S</code> : Storage state is read-only
 ====Audio I/O====
@@ Line 114: / Line 112: @@
 This starts a server for the [[Cloud JSON Protocol]]. It can be used to have a separate interface web server
 ===sound4.''any''.cl-server===

Camille at 12:51, 22 February 2024

2024-02-22T12:51:59Z

← Older revision		Revision as of 12:51, 22 February 2024
Line 68:		Line 68:
	*<code>-B ''ip''</code> : IP to bind for input. Uses source IP if not given (default <code>RTP_BIND_IP</code>=0.0.0.0)		*<code>-B ''ip''</code> : IP to bind for input. Uses source IP if not given (default <code>RTP_BIND_IP</code>=0.0.0.0)
	*<code>-G ''ip''</code> : IP to bind for output (default: <code>RTP_OUT_BIND_IP</code>=0.0.0.0)		*<code>-G ''ip''</code> : IP to bind for output (default: <code>RTP_OUT_BIND_IP</code>=0.0.0.0)
	*<code>-t ''pt''</code> : Rcv/Send Payload Type (default: <code>RTP_PAYLOAD</code>=96)		*<code>-t ''pt''</code> : Rcv/Send Payload Type (default: <code>RTP_PAYLOAD</code>=96). ''NOTE: payload 97 allows receiving payload 96 or 97, to ease compatibility''
	*<code>-F ''format''</code> : Sample format (default: <code>RTP_SAMPLE_FORMAT</code>=S16_BE) (S16_LE, S16_BE, S24_LE, S24_BE, S32_LE, S32_BE, F32_LE, F32_BE)		*<code>-F ''format''</code> : Sample format (default: <code>RTP_SAMPLE_FORMAT</code>=S16_BE) (S16_LE, S16_BE, S24_LE, S24_BE, S32_LE, S32_BE, F32_LE, F32_BE)
	*<code>-f ''frames''</code> : Frames Per Output Packet (default: same as received)		*<code>-f ''frames''</code> : Frames Per Output Packet (default: same as received)

Camille: /* Storage */

2024-02-14T10:44:15Z

Storage

← Older revision		Revision as of 10:44, 14 February 2024
Line 49:		Line 49:

	*<code>-O ''onairname''</code> : Storage onair filename, if sharing storepath between instances		*<code>-O ''onairname''</code> : Storage onair filename, if sharing storepath between instances

			See also [[Cloud Process Configuration Storage]]

	Special storage information :		Special storage information :

Camille at 10:14, 14 February 2024

2024-02-14T10:14:19Z

Show changes

Camille: Created

2024-02-14T10:07:56Z

Created

New page

Each .CL library offers some command-line programs.

They can be used to provide input/output audio to the processing library.

Each tool support <code>-h</code> parameter to get help.

=== sound4.''any''.cl-proc ===
This is the generic processor, which can be used for RTP or raw audio.

It is the preferred way to use it in a container (see [[Cloud Containerization]]).

Some parameters can be passed via environment variable. In this case, the help shows those variable.

==== License ====
You need to provide license information to the instance.

* <code>-u ''loginkey''</code> : User ID for License (''default from env'' <code>S4LOGINKEY</code>)
* <code>-n ''radioname''</code> : Radioname for License (''default from env'' <code>RADIO_NAME)</code>
* ''env only'' <code>S4_AWS_ACCESS_KEY_ID</code> : the license key ID
* ''env only'' <code>S4_AWS_SECRET_ACCESS_KEY</code> : the license key secret

==== Web interface ====
Start a web browser to setup this instance.

Parameters:

* <code>-w ''http_port''</code> : port to listen for HTTP (current:0)
* <code>-s ''https_port''</code>: port to listen for HTTPS (current:0)

HTTPS needs a certificate, which information is in env variables:

* <code>SSL_CERTIFICATE_PATH</code> : the certificate
* <code>SSL_PRIVATE_PATH</code> : the certificate private key

==== Storage ====
The instance needs to have a storage directory to save its state and its presets.

Parameters:

* <code>-D ''storepath''</code> : Storage path (default: <code>STATE_DIR</code>)

You can have multiple instances using the same storage folder, so they can share their presets.

But in this case, you should give each a different statename, so each has its own settings and onair preset.

* <code>-N ''statename''</code> : Storage state filename, if sharing storepath between instances

Also, if you want instances to follow the onair preset, you can set them the same onairname : changing preset on one instance will change for all at the same time.

* <code>-O ''onairname''</code> : Storage onair filename, if sharing storepath between instances

Special storage information :

* <code>-R</code> : Storage is read-only
* <code>-S</code> : Storage state is read-only

<br />

==== Audio I/O ====
Parameters:

* <code>-i ''ip|lwr''</code> : Livewire channel in or UDP listening specific IP (use for broadcast) (default <code>RTP_SRC_IP</code>)
* <code>-p ''port''</code> : UDP listening port (default: <code>RTP_SRC_PORT</code>=5000)
* <code>-I ''dstip|lwr''</code> : Livewire channel out or Send back to this IP if zero (default <code>RTP_DEST_IP</code>=0.0.0.0)
* <code>-P ''dstport''</code> : Send back to this port (default: <code>RTP_DEST_PORT</code>=5004)
* <code>-B ''ip''</code> : IP to bind for input. Uses source IP if not given (default <code>RTP_BIND_IP</code>=0.0.0.0)
* <code>-G ''ip''</code> : IP to bind for output (default: <code>RTP_OUT_BIND_IP</code>=0.0.0.0)
* <code>-t ''pt''</code> : Rcv/Send Payload Type (default: <code>RTP_PAYLOAD</code>=96)
* <code>-F ''format''</code> : Sample format (default: <code>RTP_SAMPLE_FORMAT</code>=S16_BE) (S16_LE, S16_BE, S24_LE, S24_BE, S32_LE, S32_BE, F32_LE, F32_BE)
* <code>-f ''frames''</code> : Frames Per Output Packet (default: same as received)
* <code>-c ''channels''</code> : Channels in RTP stream (default: <code>RTP_CHANNELS</code>=2)
* <code>-r</code> : RAW mode, get audio from stdin in float32 native 48000Hz stereo, send it to stdout.

===== RTP Input/Output =====
Example: process locally received audio on port 5004, send the processed to 10.3.1.25 port 5004

<code>sound4.impact.cl-proc -i 127.0.0.1 -p 5004 -I 10.3.1.25 -P 5004 -F S16_BE -w 8080</code>

===== AES67 Input/Output =====
Example: receive from 239.4.27.1, send to 239.4.83.1

<code>sound4.impact.cl-proc -i 239.4.27.1 -p 5004 -I 239.4.83.1 -P 5004 -F S24_BE -w 8080</code>

Note: there is no advertising

===== Livewire Input/Output =====
Example: receive from channel 1001, send to 2001

<code>sound4.impact.cl-proc -i 1001 -I 2001 -w 8080</code>

Note: there is no advertising

===== Raw audio =====
This uses stdin and stdout for audio, so you can use another program to provide and to play audio.

Example: process RTP stream received on port 5000 and play it

<code>ffmpeg -i rtp://127.0.0.1:5000 -ar 48000 -ac 2 -f f32le - | sound4.impact.cl-proc -r -w 8080 | ffplay -f f32le -ar 48000 -ac 2 -i -</code>

For this sample, audio can be sent with <code>ffmpeg -re -i myfile.mp3 -map a:0 -acodec libmp3lame -f rtp udp://127.0.0.1:5000</code>

==== Advanced parameters ====

* <code>-a ''key=value''</code> : Add parameter
* <code>-m ''key=value''</code> : Add metadata

For parameters and metadata, see libraries documentation.

==== Advanced access ====

* <code>-j ''json_port''</code> : port for TCP JSON (default: <code>PROC_PORT</code>=0)

This starts a server for the [[Cloud JSON Protocol]]. It can be used to have a separate interface web server

=== sound4.''any''.cl-server ===
Separate interface web server, which can be used if you want a different container for processing and interface.

* <code>-i ''process_ip''</code> : IP address of the process to connect to (env <code>PROC_IP</code>)
* <code>-p ''process_port''</code> : port of the process to connect to (env <code>PROC_PORT</code>)

For other parameters, see [[#Web interface|Web interface]] :

* <code>-w ''http_port''</code> : port to listen for HTTP (env <code>HTTP_PORT</code>)
* <code>-s ''https_port''</code> : port to listen for HTTPS (env <code>HTTPS_PORT</code>)

=== sound4.''any''.cl-jack ===
[https://jackaudio.org/ JACK Audio Connection Kit] support.

Parameters :

* <code>-C ''jack_name''</code> : JACK client name
* <code>-S ''jack_session''</code> : JACK session name

See also [[#Web interface|Web interface]], [[#Storage|Storage]] and [[#Advanced access|Advanced access]].

← Older revision		Revision as of 13:15, 22 February 2024
Line 68:		Line 68:
	*<code>-t ''pt''</code> : Rcv/Send Payload Type (default: <code>RTP_PAYLOAD</code>=96). ''NOTE: payload 97 allows receiving payload 96 or 97, to ease compatibility''		*<code>-t ''pt''</code> : Rcv/Send Payload Type (default: <code>RTP_PAYLOAD</code>=96). ''NOTE: payload 97 allows receiving payload 96 or 97, to ease compatibility''
	*<code>-F ''format''</code> : Sample format (default: <code>RTP_SAMPLE_FORMAT</code>=S16_BE) (S16_LE, S16_BE, S24_LE, S24_BE, S32_LE, S32_BE, F32_LE, F32_BE)		*<code>-F ''format''</code> : Sample format (default: <code>RTP_SAMPLE_FORMAT</code>=S16_BE) (S16_LE, S16_BE, S24_LE, S24_BE, S32_LE, S32_BE, F32_LE, F32_BE)
	*<code>-f ''frames''</code> : Frames Per Output Packet (default: ~~same as received~~)		*<code>-f ''frames''</code> : Frames Per Output Packet. Same as input if zero (default: <code>RTP_FRAMES</code>=0)
	*<code>-c ''channels''</code> : Channels in RTP stream (default: <code>RTP_CHANNELS</code>=2)		*<code>-c ''channels''</code> : Channels in RTP stream (default: <code>RTP_CHANNELS</code>=2)
	*<code>-r</code> : RAW mode, get audio from stdin in float32 native 48000Hz stereo, send it to stdout.		*<code>-r</code> : RAW mode, get audio from stdin in float32 native 48000Hz stereo, send it to stdout.
Line 115:		Line 115:
	Warning: there is no authentication protection on this socket, even if the web interface has some set up.		Warning: there is no authentication protection on this socket, even if the web interface has some set up.

	==== Web access authentication ====		====Web access authentication====
	Details are in the process library documentation.		Details are in the process library documentation.

Line 122:		Line 122:
	There are 2 modes:		There are 2 modes:

	* Setup mode: you define a setup account, which can then create an administrator account. The setup account always keeps the access and can delete the administrator.		*Setup mode: you define a setup account, which can then create an administrator account. The setup account always keeps the access and can delete the administrator.
	* Admin mode: you define the administrator, which will be the single administrator.		*Admin mode: you define the administrator, which will be the single administrator.

	To select the mode, you have to put in the parameters		To select the mode, you have to put in the parameters

	* SETUP_USER (and optionally SETUP_SECRET) to select Setup mode		*SETUP_USER (and optionally SETUP_SECRET) to select Setup mode
	* ADMIN_USER (and optionally ADMIN_SECRET) to select Admin mode		*ADMIN_USER (and optionally ADMIN_SECRET) to select Admin mode
	* none: the web access is opened, no login will be asked		*none: the web access is opened, no login will be asked

	If you do not set the xxx_SECRET, then the setup password will be randomly generated and print in logs (at info severity).		If you do not set the xxx_SECRET, then the setup password will be randomly generated and print in logs (at info severity).