Skip to content

Commit d84000d

Browse files
committed
Simplify VMAF and VISQOL usage instructions in README
1 parent a507f25 commit d84000d

File tree

1 file changed

+22
-22
lines changed

1 file changed

+22
-22
lines changed

README.md

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -266,30 +266,30 @@ DEBUG_LEVEL=DEBUG:* yarn start \
266266
```
267267

268268
## Using the VMAF calculator
269-
1. Run a test adding the following options:
270-
```sh
271-
--script-params="{timestampWatermarkVideo:true,saveSendVideoTrack:'0',saveRecvVideoTrack:'1'}" \
272-
--server-port=5000 \
273-
--server-use-https=true \
274-
--server-data=/data \
275-
--vmaf-path /data
276-
```
277-
With `saveSendVideoTrack` and `saveRecvVideoTrack` you can specify the sessions that will be saved at sender and receiver side (in this example it will save all the video streams sent in the session with index `0` and received in session `1`).
278-
The sent/received videos will be saved in the `/data` directory.
279-
The tool will generate a `.vmaf.json` and a `.vmaf.png` files in the `data/vmaf` directory. Adding the `--vmaf-preview` option, a `.mp4` file containing the side-by-side video comparison will be generated.
269+
Run a test adding the following options:
270+
```sh
271+
--script-params="{timestampWatermarkVideo:true,saveSendVideoTrack:'0',saveRecvVideoTrack:'1'}" \
272+
--server-port=5000 \
273+
--server-use-https=true \
274+
--server-data=/data \
275+
--vmaf-path /data
276+
```
277+
With `saveSendVideoTrack` and `saveRecvVideoTrack` you can specify the sessions that will be saved at sender and receiver side (in this example it will save all the video streams sent in the session with index `0` and received in session `1`).
278+
The sent/received videos will be saved in the `/data` directory.
279+
The tool will generate a `.vmaf.json` and a `.vmaf.png` files in the `data/vmaf` directory. Adding the `--vmaf-preview` option, a `.mp4` file containing the side-by-side video comparison will be generated.
280280

281281
## Using the VISQOL calculator
282-
1. Run a test adding the following options:
283-
```sh
284-
--script-params="{saveSendAudioTrack:'0',saveRecvAudioTrack:'1'}" \
285-
--server-port=5000 \
286-
--server-use-https=true \
287-
--server-data=/data \
288-
--visqol-path /data
289-
```
290-
With `saveSendAudioTrack` and `saveRecvAudioTrack` you can specify the sessions that will be saved at sender and receiver side (in this example it will save all the audio streams sent in the session with index `0` and received in session `1`).
291-
The sent/received audio files will be saved in the `/data` directory.
292-
The tool will generate a `visqol.csv` file in the `data` directory.
282+
Run a test adding the following options:
283+
```sh
284+
--script-params="{saveSendAudioTrack:'0',saveRecvAudioTrack:'1'}" \
285+
--server-port=5000 \
286+
--server-use-https=true \
287+
--server-data=/data \
288+
--visqol-path /data
289+
```
290+
With `saveSendAudioTrack` and `saveRecvAudioTrack` you can specify the sessions that will be saved at sender and receiver side (in this example it will save all the audio streams sent in the session with index `0` and received in session `1`).
291+
The sent/received audio files will be saved in the `/data` directory.
292+
The tool will generate a `visqol.csv` file in the `data` directory.
293293

294294
## Authors
295295
- Vittorio Palmisano [[github](https://github.com/vpalmisano)]

0 commit comments

Comments
 (0)