Skip to content

Commit b45993d

Browse files
authored
Merge the docs folder into readme (#259)
* Merge the docs folder into readme Signed-off-by: KP Choi <kp5.choi@samsung.com> * Drop the profile numbering convention description Signed-off-by: KP Choi <kp5.choi@samsung.com> --------- Signed-off-by: KP Choi <kp5.choi@samsung.com>
1 parent 459df85 commit b45993d

3 files changed

Lines changed: 3 additions & 16 deletions

File tree

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ The OpenAPV supports the following features:
1414
- RGB content coding with the 444 profiles through color description signalling
1515
- Constant QP (CQP) and average bitrate (ABR) rate control algorithms
1616
- [APV Family](/readme/apv_family.md) configurations for typical target bitrate setting of encoder
17-
- [APV Profile Extensions](/docs/profile_ext.md) defined by the OpenAPV project on top of the RFC 9924 profiles
17+
- [APV Profile Extensions](/readme/profile_ext.md) defined by the OpenAPV project on top of the RFC 9924 profiles
1818

1919

2020
## APV codec
@@ -106,7 +106,7 @@ Encoding:
106106
oapv_app_enc -i input_1920x1080_yuv422_10bit.yuv -w 1920 -h 1080 -d 10 -z 30 --input-csp 2 -o encoded.apv
107107
oapv_app_enc -i input.y4m -o encoded.apv
108108

109-
Encoding RGB content (G/B/R planar order, coded as 444 with the identity matrix signalled in the color description; see the [Programmer's Guide](/docs/programmers_guide.md) for details):
109+
Encoding RGB content (G/B/R planar order, coded as 444 with the identity matrix signalled in the color description; see the [Programmer's Guide](/readme/programmers_guide.md) for details):
110110

111111
oapv_app_enc -i input_rgb_gbr_planar_10bit.yuv -w 1920 -h 1080 -d 10 -z 30 --input-csp 3 --profile 444-10 --color-primaries 1 --color-transfer 13 --color-matrix 0 --color-range 1 -o encoded.apv
112112

@@ -124,7 +124,7 @@ Decoding:
124124

125125
## Programmer's guide
126126

127-
See the [Programmer's Guide](/docs/programmers_guide.md) for how to write
127+
See the [Programmer's Guide](/readme/programmers_guide.md) for how to write
128128
encoding and decoding code with the library, including PBU-based decoding,
129129
tile-based partial decoding, runtime configuration, RGB content encoding,
130130
and the custom memory allocator interface.
Lines changed: 0 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -10,16 +10,6 @@ only be decoded by implementations that support the corresponding extension.
1010
For the profiles defined by RFC 9924 (422-10, 422-12, 444-10, 444-12,
1111
4444-10, 4444-12, and 400-10), see [Section 9.3 of the RFC](https://www.rfc-editor.org/rfc/rfc9924.html#section-9.3).
1212

13-
## Numbering convention
14-
15-
A profile which extends an RFC 9924 profile uses a `profile_idc` value one
16-
less than the next RFC 9924 profile, counting downward if more extensions of
17-
the same profile are added later. For example, the first extension of the
18-
422-10 profile (`profile_idc` 33) uses `profile_idc` 43, one less than the
19-
422-12 profile (`profile_idc` 44). Since the 400-10 profile (`profile_idc`
20-
99) is the last profile of RFC 9924, its extensions count down from 109, one
21-
less than 110, the next value in the RFC 9924 numbering pattern.
22-
2313
## Defined extension profiles
2414

2515
| Profile | profile_idc | chroma_format_idc | bit_depth_minus8 | Description |
@@ -34,9 +24,6 @@ less than 110, the next value in the RFC 9924 numbering pattern.
3424
| 444-16C12 | 140 | 3 | 4 | 16-bit source companded to 12-bit |
3525
| 4444-16C12 | 144 | 3 or 4 | 4 | 16-bit source companded to 12-bit |
3626

37-
Note: 444-16C12 and 4444-16C12 predate the numbering convention above and
38-
keep their original `profile_idc` values.
39-
4027
## UNCONST profiles
4128

4229
The UNCONST profiles relax conformance constraints of the corresponding
File renamed without changes.

0 commit comments

Comments
 (0)