File.CL command-line

File.CL command-line

SOUND4 Helpdesk
SOUND4 Helpdesk

File.CL command-line

Compatible Linux and Windows on x86_64 platforms

SOUND4 FILE.CL is an audio file processing and transcoding application.

Installing

For Windows, the command-line tool is installed with the installer in C:\Program Files\SOUND4\File.CL\SOUND4 File.CL Cmd.exe, and the processing libraries are already in the same folder.

For Linux, you will need to create a folder, put the program sound4file.cl in it, and put the processing libraries in the same folder, or in ../lib if the program is in a folder named bin.

You can get the libraries from here (libsound4.x1.cloud.so, libsound4.impact.cl.so, libsound4.bigvoice.cl.so...).

Parameters

Parameters always needed

You will need to configure the software to use a license and a storage directory. The storage directory will hold the settings and preset to use.

Some parameters can be set from environment variables.

Use sound4file.cl -h to get all help up to date.

Process selection

Depending on the installed processing libraries, you will have to choose which process to use. This is mandatory if multiple processes are installed.

  • -x1 : select X1.CL processor
  • -impact : select IMPACT.CL processor
  • -bigvoice : select BIG VOICE.CL processor

Storage

  • s, -storage=dir : Storage directory for configuration (env:S4STORE_PATH)

This selects the processing configuration. You should not reuse a folder for a different processor.

License

  • a, -key=mykey : License access key (env:ACCESS_KEY_ID)
  • l, -login=mylogin : License login key (env:S4LOGINKEY)
  • r, -radioname=myradio : License radio name (env:RADIO_NAME)
  • x, -secret=mysecret : License access secret (env:ACCESS_KEY_SECRET)

Setup

To configure the process, use:

  • -setup : Setup mode: web access to set up the process (no file processing)
  • w, -webport=port : Web port in setup mode (0:auto)

If no web port is given, one will be automatically chosen and displayed in output logs.

Use a web browser to the local port for setup.

Processing

To process files (ie without --setup), you need to give 2 parameters:

  1. Input file
  2. Output file

If the input and output file extensions are the same, the default is to re-encode the output as close as possible as was the input.

Otherwise, the encoding may be guessed from the output file extension.

Encoding change

You can force the encoding of output with

  • -aac : Select AAC encoder
  • -flac : Select FLAC encoder
  • -heaac : Select He-AAC encoder
  • -heaacv2 : Select He-AAC v2 encoder
  • -mp2 : Select MPEG-1 Layer 2 encoder
  • -mp3 : Select MPEG-1 Layer 3 encoder
  • -opus : Select Opus encoder
  • -vorbis : Select Vorbis encoder
  • -wav : Select WAV encoder

You can also adjust some parameters, depending on the codec:

  • -bitrate=bps : Set encoder bit-rate
  • -samplerate=hz : Set encoder sample-rate
  • -samplebits=bits : Set encoder bit per sample

Output/Progress options

  • b, -batch : Batch mode: progress is reported on stdout by lines like 35.2%
  • q, -quiet : Quiet: do not report progress, reduce log level
  • v, -verbose : Be more verbose

Advanced options

  • p, -param=key=value : Set parameter in library (see individual library documention)

KANTAR Watermarking specific

If you use the KANTAR watermarking, you need to give more information to be able to watermark the file.

This can be done either by command-line arguments, or by using an XML file with the same name and path as input file, with .xml extension added.

  • u, -contentid=uid : Watermarking unique content id
  • -wmlog=directory : Watermark logs directory (env:WMLOG_PATH)
  • f, -metadata=file : Watermarking metadata filename (default: inputfile.xml)
  • -bbis=YYYY-MM-DDThh:mm:ssZ : Watermarking BBis
  • -channel=channel : Watermarking channel name
  • -license=license : Watermarking license name
  • -liclogin=login_name : Kantar license login (for online license)
  • -licpwd=password : Kantar license password (for online license)

The parameters can also be with --setup, except for the contentid which is unique per file.

To get help on the XML format, use sound4file.cl --help-meta.

Help and version

  • h, -help : Show full help
  • -help-meta : Show help on metadata file
  • -list-encoders : List possible encoders
  • -list-processors : List possible processors (depends on library installed)
  • V, -version : Print software version