Skip to content

Commit 3b5c0f5

Browse files
committed
Refine the README file
Signed-off-by: Xiaoxia Liang <xiaoxia.liang@intel.com>
1 parent 114e6f8 commit 3b5c0f5

1 file changed

Lines changed: 16 additions & 11 deletions

File tree

README.md

Lines changed: 16 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -7,30 +7,29 @@ To build this project you will need:
77
- [Docker](https://www.docker.com/)
88
- Intel Xeon hardware which supports Intel AVX512 (Skylake generation or later)
99
- Compiler (clang++, g++)
10-
- Cmake version 3.12 or later
10+
- Cmake version 3.14 or later
1111
- Intel® Integrated Performance Primitives (Intel® IPP) (Stand-Alone Version is the minimum requirement)
1212
- (optional) libx264, libx265, zlib1g-dev
1313

1414
## Install Intel IPP
1515
Standalone version of IPP (minimum requirement): https://www.intel.com/content/www/us/en/developer/articles/tool/oneapi-standalone-components.html#ipp \
1616
Alternatively, install IPP as part of oneAPI Base Toolkit: https://www.intel.com/content/www/us/en/developer/tools/oneapi/base-toolkit-download.html \
17-
Add below lines to `~/.bash_profile` which sets IPP env. \
17+
Add below line to `~/.bash_profile` which sets IPP env. \
1818
`source /opt/intel/oneapi/ipp/latest/env/vars.sh` \
19-
`. ~/.bashrc` \
2019
Then `source ~/.bash_profile`
2120

2221
# Use FFmpeg RAISR plugin
2322

2423
## Build and install the Intel® Library for VSR with Docker
2524
In the top level directory of the repository, run
2625
```
27-
./build.sh
26+
sudo -E ./build.sh
2827
```
2928
The library and docker image will automatically be built within 'build.sh'.
3029

3130
If the user is not root and does not have sudo permission, it is assumed that the user has been added to the Docker cgroup and the user must provide the path to the install directory when building.
3231
```
33-
./build.sh -DCMAKE_INSTALL_PREFIX="/path/to/install"
32+
./build.sh -DCMAKE_INSTALL_PREFIX="$PWD/install"
3433
```
3534

3635
This simple command will run the image in a docker container:
@@ -46,8 +45,8 @@ docker run -ti --rm -v $PWD/input_files:/input_files -v $PWD/output_files:/outpu
4645

4746
If the user would prefer not to use Docker, these instructions may be utilized to setup the Intel Library for VSR.
4847

49-
To build the library without building the docker image, run
50-
`./build.sh no_docker -DCMAKE_INSTALL_PREFIX="/path/to/install"`
48+
To build the library without building the docker image, run \
49+
`./build.sh no_docker -DCMAKE_INSTALL_PREFIX="$PWD/install"`
5150

5251
### Clone FFmpeg
5352
`git clone https://github.com/FFmpeg/FFmpeg ffmpeg` \
@@ -57,21 +56,27 @@ To build the library without building the docker image, run
5756
`git checkout release/4.4`
5857

5958
### Copy vf_raisr.c to ffmpeg libavfilter folder
60-
`cp ../ilvsr-library/ffmpeg/vf_raisr.c libavfilter/`
59+
`cp ../Video-Super-Resolution-Library/ffmpeg/vf_raisr.c libavfilter/`
6160

6261
### Apply patch
63-
`git am ../ilvsr-library/ffmpeg/0001-ffmpeg-raisr-filter.patch`
62+
`git am ../Video-Super-Resolution-Library/ffmpeg/0001-ffmpeg-raisr-filter.patch`
6463

6564
### Configure FFmpeg
65+
When `DCMAKE_INSTALL_PREFIX` isn't used, the ffmpeg configure command is as: \
6666
`./configure --enable-libipp --extra-cflags="-fopenmp" --extra-ldflags=-fopenmp --extra-libs='-lraisr -lstdc++ -lippcore -lippvm -lipps -lippi' --enable-cross-compile`
6767

68+
When `DCMAKE_INSTALL_PREFIX` is used, please add the below line to the ffmpeg configure command: \
69+
`--extra-cflags=="-fopenmp -I../Video-Super-Resolution-Library/install/include/" --extra-ldflags="-fopenmp -L../Video-Super-Resolution-Library/install/lib/"` \
70+
The ffmmpeg confiure command is as: \
71+
`./configure --enable-libipp --extra-cflags="-fopenmp -I../Video-Super-Resolution-Library/install/include/" --extra-ldflags="-fopenmp -L../Video-Super-Resolution-Library/install/lib/" --extra-libs='-lraisr -lstdc++ -lippcore -lippvm -lipps -lippi' --enable-cross-compile`
72+
6873
### Build FFmpeg
6974
`make clean` \
7075
`make -j $(nproc)`
7176

7277
### Copy RAISR filter folder to FFmpeg folder
7378
The folder contains filterbin_partialCV2, Qfactor_cohbin_partialCV2, and Qfactor_strbin_partialCV2 \
74-
`cp -r ../ilvsr-library/filters* .`
79+
`cp -r ../Video-Super-Resolution-Library/filters* .`
7580

7681
## Running the Intel Library for VSR
7782
One should be able to test with video files:
@@ -193,4 +198,4 @@ The Intel Library for VSR is licensed under the BSD 3-Clause "New" or "Revised"
193198
## How to Report Bugs and Provide Feedback
194199
Use the Issues tab on Github.
195200

196-
Intel, the Intel logo and Xeon are trademarks of Intel Corporation or its subsidiaries.
201+
Intel, the Intel logo and Xeon are trademarks of Intel Corporation or its subsidiaries.

0 commit comments

Comments
 (0)