Difference between revisions of "File.CL command-line"
From SOUND4wiki
(Created) |
m (→Processing) |
||
| Line 3: | Line 3: | ||
It can be used to process files directly. | It can be used to process files directly. | ||
| − | === Installing === | + | ===Installing=== |
For Windows, the command-line tool is installed with the installer in <code>C:\Program Files\SOUND4\File.CL\SOUND4 File.CL Cmd.exe</code>, and the processing libraries are already in the same folder. | For Windows, the command-line tool is installed with the installer in <code>C:\Program Files\SOUND4\File.CL\SOUND4 File.CL Cmd.exe</code>, and the processing libraries are already in the same folder. | ||
| Line 10: | Line 10: | ||
You can get the libraries from http://download.sound4.biz (libsound4.x1.cloud.so, libsound4.impact.cl.so, libsound4.bigvoice.cl.so...). | You can get the libraries from http://download.sound4.biz (libsound4.x1.cloud.so, libsound4.impact.cl.so, libsound4.bigvoice.cl.so...). | ||
| − | === Parameters === | + | ===Parameters=== |
| − | ==== Parameters always needed ==== | + | ====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. | 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. | ||
| Line 19: | Line 19: | ||
Use <code>sound4file.cl -h</code> to get all help up to date. | Use <code>sound4file.cl -h</code> to get all help up to date. | ||
| − | ===== Process selection ===== | + | =====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. | Depending on the installed processing libraries, you will have to choose which process to use. This is mandatory if multiple processes are installed. | ||
| − | * <code>--x1</code> : select X1.CL processor | + | *<code>--x1</code> : select X1.CL processor |
| − | * <code>--impact</code> : select IMPACT.CL processor | + | *<code>--impact</code> : select IMPACT.CL processor |
| − | * <code>--bigvoice</code> : select BIG VOICE.CL processor | + | *<code>--bigvoice</code> : select BIG VOICE.CL processor |
| − | ===== Storage ===== | + | =====Storage===== |
| − | * <code>-s</code>, <code>--storage=''dir''</code> : Storage directory for configuration (env:<code>S4STORE_PATH</code>) | + | *<code>-s</code>, <code>--storage=''dir''</code> : Storage directory for configuration (env:<code>S4STORE_PATH</code>) |
This selects the processing configuration. You should not reuse a folder for a different processor. | This selects the processing configuration. You should not reuse a folder for a different processor. | ||
| − | ===== License ===== | + | =====License===== |
| − | * <code>-a</code>, <code>--key=''mykey''</code> : License access key (env:<code>ACCESS_KEY_ID</code>) | + | *<code>-a</code>, <code>--key=''mykey''</code> : License access key (env:<code>ACCESS_KEY_ID</code>) |
| − | * <code>-l</code>, <code>--login=''mylogin''</code> : License login key (env:<code>S4LOGINKEY</code>) | + | *<code>-l</code>, <code>--login=''mylogin''</code> : License login key (env:<code>S4LOGINKEY</code>) |
| − | * <code>-r</code>, <code>--radioname=''myradio''</code> : License radio name (env:<code>RADIO_NAME</code>) | + | *<code>-r</code>, <code>--radioname=''myradio''</code> : License radio name (env:<code>RADIO_NAME</code>) |
| − | * <code>-x</code>, <code>--secret=''mysecret''</code> : License access secret (env:<code>ACCESS_KEY_SECRET</code>) | + | *<code>-x</code>, <code>--secret=''mysecret''</code> : License access secret (env:<code>ACCESS_KEY_SECRET</code>) |
| − | ==== Setup ==== | + | ====Setup==== |
To configure the process, use: | To configure the process, use: | ||
| − | * <code>--setup</code> : Setup mode: web access to set up the process (no file processing) | + | *<code>--setup</code> : Setup mode: web access to set up the process (no file processing) |
| − | * <code>-w</code>, <code>--webport=''port''</code> : Web port in setup mode (0:auto) | + | *<code>-w</code>, <code>--webport=''port''</code> : Web port in setup mode (0:auto) |
If no web port is given, one will be automatically chosen and displayed in output logs. | If no web port is given, one will be automatically chosen and displayed in output logs. | ||
| Line 49: | Line 49: | ||
Use a web browser to the local port for setup. | Use a web browser to the local port for setup. | ||
| − | ==== Processing ==== | + | ====Processing==== |
To process files (ie without --setup), you need to give 2 parameters: | To process files (ie without --setup), you need to give 2 parameters: | ||
| − | # Input file | + | #Input file |
| − | # Output file | + | #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. | 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. | ||
| − | ===== Encoding change ===== | + | Otherwise, the encoding may be guessed from the output file extension. |
| + | |||
| + | =====Encoding change===== | ||
You can force the encoding of output with | You can force the encoding of output with | ||
| − | * <code>--aac</code> : Select AAC encoder | + | *<code>--aac</code> : Select AAC encoder |
| − | * <code>--flac</code> : Select FLAC encoder | + | *<code>--flac</code> : Select FLAC encoder |
| − | * <code>--heaac</code> : Select He-AAC encoder | + | *<code>--heaac</code> : Select He-AAC encoder |
| − | * <code>--heaacv2</code> : Select He-AAC v2 encoder | + | *<code>--heaacv2</code> : Select He-AAC v2 encoder |
| − | * <code>--mp2</code> : Select MPEG-1 Layer 2 encoder | + | *<code>--mp2</code> : Select MPEG-1 Layer 2 encoder |
| − | * <code>--mp3</code> : Select MPEG-1 Layer 3 encoder | + | *<code>--mp3</code> : Select MPEG-1 Layer 3 encoder |
| − | * <code>--opus</code> : Select Opus encoder | + | *<code>--opus</code> : Select Opus encoder |
| − | * <code>--vorbis</code> : Select Vorbis encoder | + | *<code>--vorbis</code> : Select Vorbis encoder |
| − | * <code>--wav</code> : Select WAV encoder | + | *<code>--wav</code> : Select WAV encoder |
You can also adjust some parameters, depending on the codec: | You can also adjust some parameters, depending on the codec: | ||
| − | * <code>--bitrate=''bps''</code> : Set encoder bit-rate | + | *<code>--bitrate=''bps''</code> : Set encoder bit-rate |
| − | * <code>--samplerate=''hz''</code> : Set encoder sample-rate | + | *<code>--samplerate=''hz''</code> : Set encoder sample-rate |
| − | * <code>--samplebits=''bits''</code> : Set encoder bit per sample | + | *<code>--samplebits=''bits''</code> : Set encoder bit per sample |
| − | ===== Output/Progress options ===== | + | =====Output/Progress options===== |
| − | * <code>-b</code>, <code>--batch</code> : Batch mode: progress is reported on stdout by lines like 35.2% | + | *<code>-b</code>, <code>--batch</code> : Batch mode: progress is reported on stdout by lines like 35.2% |
| − | * <code>-q</code>, <code>--quiet</code> : Quiet: do not report progress, reduce log level | + | *<code>-q</code>, <code>--quiet</code> : Quiet: do not report progress, reduce log level |
| − | * <code>-v</code>, <code>--verbose</code> : Be more verbose | + | *<code>-v</code>, <code>--verbose</code> : Be more verbose |
| − | ===== Advanced options ===== | + | =====Advanced options===== |
| − | * <code>-p</code>, <code>--param=''key=value''</code> : Set parameter in library (see individual library documention) | + | *<code>-p</code>, <code>--param=''key=value''</code> : Set parameter in library (see individual library documention) |
| − | ===== KANTAR Watermarking specific ===== | + | =====KANTAR Watermarking specific===== |
If you use the KANTAR watermarking, you need to give more information to be able to watermark the file. | 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. | 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. | ||
| − | * <code>-u</code>, <code>--contentid=''uid''</code> : Watermarking unique content id | + | *<code>-u</code>, <code>--contentid=''uid''</code> : Watermarking unique content id |
| − | * <code>--wmlog=''directory''</code> : Watermark logs directory (env:<code>WMLOG_PATH</code>) | + | *<code>--wmlog=''directory''</code> : Watermark logs directory (env:<code>WMLOG_PATH</code>) |
| − | * <code>-f</code>, <code>--metadata=''file''</code> : Watermarking metadata filename (default: inputfile.xml) | + | *<code>-f</code>, <code>--metadata=''file''</code> : Watermarking metadata filename (default: inputfile.xml) |
| − | * <code>--bbis=''YYYY-MM-DDThh:mm:ssZ''</code> : Watermarking BBis | + | *<code>--bbis=''YYYY-MM-DDThh:mm:ssZ''</code> : Watermarking BBis |
| − | * <code>--channel=''channel''</code> : Watermarking channel name | + | *<code>--channel=''channel''</code> : Watermarking channel name |
| − | * <code>--license=''license''</code> : Watermarking license name | + | *<code>--license=''license''</code> : Watermarking license name |
| − | * <code>--liclogin=''login_name''</code> : Kantar license login (for online license) | + | *<code>--liclogin=''login_name''</code> : Kantar license login (for online license) |
| − | * <code>--licpwd=''password''</code> : Kantar license password (for online license) | + | *<code>--licpwd=''password''</code> : Kantar license password (for online license) |
The parameters can also be with --setup, except for the contentid which is unique per file. | The parameters can also be with --setup, except for the contentid which is unique per file. | ||
| Line 105: | Line 107: | ||
To get help on the XML format, use <code>sound4file.cl --help-meta</code>. | To get help on the XML format, use <code>sound4file.cl --help-meta</code>. | ||
| − | ==== Help and version ==== | + | ====Help and version==== |
| − | * <code>-h</code>, <code>--help</code> : Show full help | + | *<code>-h</code>, <code>--help</code> : Show full help |
| − | * <code>--help-meta</code> : Show help on metadata file | + | *<code>--help-meta</code> : Show help on metadata file |
| − | * <code>--list-encoders</code> : List possible encoders | + | *<code>--list-encoders</code> : List possible encoders |
| − | * <code>--list-processors</code> : List possible processors (depends on library installed) | + | *<code>--list-processors</code> : List possible processors (depends on library installed) |
| − | * <code>-V</code>, <code>--version</code> : Print software version | + | *<code>-V</code>, <code>--version</code> : Print software version |
<br /> | <br /> | ||
[[Category:Cloud]] | [[Category:Cloud]] | ||
Latest revision as of 14:12, 13 March 2024
The File.CL software provides a command-line tool for Linux and Windows on x86_64.
It can be used to process files directly.
Contents
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 http://download.sound4.biz (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:
- Input file
- 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
