Debian Codegraph @

doc/spec/source/architecture/index.rst

raw
1 .. SPDX-FileCopyrightText: 2019-2020 Intel Corporation
2 ..
3 .. SPDX-License-Identifier: CC-BY-4.0
4 ..
5 Intel(r) Video Processing Library (Intel(r) VPL)
6
7 ============
8 Architecture
9 ============
10
11 |vpl_short_name| functions fall into the following categories:
12
13 .. glossary::
14
15 DECODE
16 Functions that decode compressed video streams into raw video frames
17
18 ENCODE
19 Functions that encode raw video frames into compressed bitstreams
20
21 VPP
22 Functions that perform video processing on raw video frames
23
24 DECODE_VPP
25 Functions that perform combined operations of decoding and video processing
26
27 CORE
28 Auxiliary functions for synchronization
29
30 Misc
31 Global auxiliary functions
32
33 With the exception of the global auxiliary functions, |vpl_short_name| functions are named
34 after their functioning domain and category. |vpl_short_name| exposes video domain
35 functions.
36
37 .. figure:: ../images/sdk_function_naming_convention.png
38
39 |vpl_short_name| function name notation
40
41 Applications use |vpl_short_name| functions by linking with the |vpl_short_name| dispatcher library.
42
43 .. graphviz::
44 :caption: |vpl_short_name| dispatching mechanism
45
46 digraph {
47 rankdir=TB;
48 Application [shape=record label="Application" ];
49 Sdk [shape=record label="Intel® VPL dispatcher library"];
50 Lib1 [shape=record label="Intel® VPL library 1 (CPU)"];
51 Lib2 [shape=record label="Intel® VPL library 2 (platform 1)"];
52 Lib3 [shape=record label="Intel® VPL library 3 (platform 2)"];
53 Application->Sdk;
54 Sdk->Lib1;
55 Sdk->Lib2;
56 Sdk->Lib3;
57 }
58
59
60 The dispatcher library identifies the hardware acceleration device on the
61 running platform, determines the most suitable platform library for the
62 identified hardware acceleration, and then redirects function calls accordingly.
63
64
65 .. toctree::
66 :hidden:
67
68 VPL_decoding
69 VPL_encoding
70 VPL_processing
71 VPL_decoding_vpp