Skip to content

Commit 4d4d35f

Browse files
mszym1mszym1
committed
Text updates.
1 parent ab44eba commit 4d4d35f

2 files changed

Lines changed: 37 additions & 33 deletions

File tree

‎plugins/code/hevc_dec/beamr/README.md‎

Lines changed: 16 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Beamr HEVC decoder plugin for Dolby Encoding Engine
22

3-
The provided source code was built and tested using Beamr5x-4.5.0.3.
3+
Provided source code was built and tested using Beamr5x-4.5.0.3.
44

55
## Build tools
66

@@ -9,34 +9,36 @@ The provided source code was built and tested using Beamr5x-4.5.0.3.
99

1010
## Prerequisites
1111

12-
To build Beamr SDK and environment variable BEAMR_SDK pointing to the kit folder.
13-
Typical structure of the kit folder is presented below. The build requires files in following folders:
14-
15-
- $BEAMR_SDK/common_primitives/include
16-
- $BEAMR_SDK/common_primitives/src
17-
- $BEAMR_SDK/inc
18-
- $BEAMR_SDK/lib
19-
- $BEAMR_SDK/lib64
12+
To build the plugin, Beamr5x SDK is required and environment variable `BEAMR_SDK` pointing to the kit folder.
13+
The typical structure of the kit folder is presented below.
2014

2115
```bash
2216
BEAMR_SDK
2317
├── Beamr_5_Installation_Notes.pdf
2418
├── bin
2519
├── common_primitives
26-
│   ├── include
27-
│   └── src
20+
│ ├── include
21+
│ └── src
2822
├── inc
2923
├── lib
3024
├── lib64
3125
├── license
3226
└── samples
3327
```
3428

29+
The build uses files in following folders:
30+
31+
- $BEAMR_SDK/common_primitives/include
32+
- $BEAMR_SDK/common_primitives/src
33+
- $BEAMR_SDK/inc
34+
- $BEAMR_SDK/lib
35+
- $BEAMR_SDK/lib64
36+
3537
## Build instructions (Linux)
3638

3739
Extract the kit folder from the archive.
3840

39-
Set environment variable BEAMR_SDK.
41+
Set environment variable `BEAMR_SDK`.
4042

4143
Build the plugin:
4244

@@ -45,7 +47,7 @@ cd make/linux_amd64_gnu
4547
make
4648
```
4749

48-
Copy `hevc_dec_beamr_release.so` to DEE installation folder. File can be renamed, but extension must be `.so`.
50+
Copy `hevc_dec_beamr_release.so` to DEE installation folder. The file can be renamed, but the extension must be `.so`.
4951

5052
## Build instructions (Windows)
5153

@@ -55,4 +57,4 @@ Set environment variable BEAMR_SDK.
5557

5658
Build the plugin using Visual Studio solution in `make\windows_amd64_msvs\hevc_dec_beamr_2015.sln`.
5759

58-
Copy `hevc_dec_beamr.dll` to DEE installation folder. File can be renamed, but extension must be `.dll`.
60+
Copy `hevc_dec_beamr.dll` to DEE installation folder. The file can be renamed, but the extension must be `.dll`.

‎plugins/code/hevc_enc/beamr/README.md‎

Lines changed: 21 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Beamr HEVC encoder plugin for Dolby Encoding Engine
22

3-
The provided source code was built and tested using Beamr5x-4.5.0.3.
3+
Provided source code was built and tested using Beamr5x-4.5.0.3.
44

55
## Build tools
66

@@ -9,34 +9,36 @@ The provided source code was built and tested using Beamr5x-4.5.0.3.
99

1010
## Prerequisites
1111

12-
To build Beamr SDK and environment variable BEAMR_SDK pointing to the kit folder.
13-
Typical structure of the kit folder is presented below. The build requires files in following folders:
14-
15-
- $BEAMR_SDK/common_primitives/include
16-
- $BEAMR_SDK/common_primitives/src
17-
- $BEAMR_SDK/inc
18-
- $BEAMR_SDK/lib
19-
- $BEAMR_SDK/lib64
12+
To build the plugin, Beamr5x SDK is required and environment variable `BEAMR_SDK` pointing to the kit folder.
13+
The typical structure of the kit folder is presented below.
2014

2115
```bash
2216
BEAMR_SDK
2317
├── Beamr_5_Installation_Notes.pdf
2418
├── bin
2519
├── common_primitives
26-
│   ├── include
27-
│   └── src
20+
│ ├── include
21+
│ └── src
2822
├── inc
2923
├── lib
3024
├── lib64
3125
├── license
3226
└── samples
3327
```
3428

29+
The build uses files in following folders:
30+
31+
- $BEAMR_SDK/common_primitives/include
32+
- $BEAMR_SDK/common_primitives/src
33+
- $BEAMR_SDK/inc
34+
- $BEAMR_SDK/lib
35+
- $BEAMR_SDK/lib64
36+
3537
## Build instructions (Linux)
3638

3739
Extract the kit folder from the archive.
3840

39-
Set environment variable BEAMR_SDK.
41+
Set environment variable `BEAMR_SDK`.
4042

4143
Build the plugin:
4244

@@ -45,9 +47,9 @@ cd make/linux_amd64_gnu
4547
make
4648
```
4749

48-
Copy `hevc_enc_beamr_release.so` to DEE installation folder. File can be renamed, but extension must be `.so`.
50+
Copy `hevc_enc_beamr_release.so` to DEE installation folder. The file can be renamed, but the extension must be `.so`.
4951

50-
Additionally, copy `$BEAMR_SDK/lib64/libtbb.so.2` to DEE installation folder. Name of that file cannot be changed.
52+
Additionally, copy `$BEAMR_SDK/lib64/libtbb.so.2` to DEE installation folder. The name of that file cannot be changed.
5153

5254
## Build instructions (Windows)
5355

@@ -57,23 +59,23 @@ Set environment variable BEAMR_SDK.
5759

5860
Build the plugin using Visual Studio solution in `make\windows_amd64_msvs\hevc_enc_beamr_2015.sln`.
5961

60-
Copy `hevc_enc_beamr.dll` to DEE installation folder. File can be renamed, but extension must be `.dll`.
62+
Copy `hevc_enc_beamr.dll` to DEE installation folder. The file can be renamed, but the extension must be `.dll`.
6163

62-
Additionally, copy `$BEAMR_SDK/bin/Intel_IPP_Win64/tbb.dll` to DEE installation folder. Name of that file cannot be changed.
64+
Additionally, copy `$BEAMR_SDK/bin/Intel_IPP_Win64/tbb.dll` to DEE installation folder. The name of that file cannot be changed.
6365

6466
## Tuning encoder settings
6567

6668
Provided XML examples present how Beamr plugin shall be used via DEE.
6769
Fine-tuning fo encoder configuration depends on processed content, thus it shall be consulted with Beamr Imaging.
6870

69-
Presented XML interface contains only basic encoder parameters. Other parameters can be set using following XML elements:
71+
The presented XML interface contains only basic encoder parameters. Other parameters can be set using following XML elements:
7072

7173
- `native_config_file`
7274
- `param`
7375

74-
These elements allow to configure encoder using native Beamr parameters, which can be found in Beamr SDK documentation and sample configs in `$BEAMR_SDK\samples\*.cfg`.
76+
These elements allow configuring encoder using native Beamr parameters, which can be found in Beamr SDK documentation and sample configs in `$BEAMR_SDK\samples\*.cfg`.
7577

7678
## Known issues
7779

7880
- When encoding Enhancement layer for Dolby Vision profile 7, encoder forces tier Main instead fo High.
79-
- This issue shall be fixed with next release of Beamr SDK.
81+
- This issue shall be fixed with the next release of Beamr SDK.

0 commit comments

Comments
 (0)