File: specification.yml

package info (click to toggle)
libvpl 1%3A2.16.0-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 21,580 kB
  • sloc: cpp: 92,604; ansic: 6,176; python: 4,312; sh: 323; makefile: 7
file content (499 lines) | stat: -rw-r--r-- 16,183 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
---
name: Specification

permissions: read-all

on:
  # Run on pull requests
  pull_request:
    # Trigger only when spec files have changed
    paths:
      - .github/workflows/**
      - api/**
      - doc/spec/**
  push:
    branches:
      - 'main'
      - 'specification/*'
  # Run on user request
  workflow_dispatch:
    inputs:
      docker_opts:
        description: 'extra options for docker build'
        required: false
        type: string

jobs:
  linux_check_structure_pack:
    name: Linux Check Structure Pack
    runs-on: [self-hosted, linux]
    steps:
      - name: Cleanup workspace (Linux)
        if: always() && runner.os == 'Linux'
        run: sudo rm -rf ..?* .[!.]* *
      - name: Checkout source
        uses: actions/checkout@v3
      - name: Run check
        run: python3 ./api/tests/abi/check_pack.py -i ./api/vpl

  linux_missed_tests:
    name: Linux Missed tests
    runs-on: [self-hosted, linux]
    steps:
      - name: Cleanup workspace (Linux)
        if: always() && runner.os == 'Linux'
        run: sudo rm -rf ..?* .[!.]* *
      - name: Checkout source
        uses: actions/checkout@v3
      - name: Docker build
        run: >
          docker build ${{ inputs.docker_opts }}
          -f ./api/tests/docker/Dockerfile.clang
          -t clang_img .
      - name: Docker run
        run: >
          docker run --rm
          --volume=$(pwd):/data
          --user $(id -u):$(id -g)
          clang_img python3 api/tests/abi/check_missing_structs.py
          -i api/vpl
          -t api/tests/abi/mfx_static_assert_structs.cpp

  linux_compile_c:
    name: Linux Compile C
    runs-on: [self-hosted, linux]
    steps:
      - name: Cleanup workspace (Linux)
        if: always() && runner.os == 'Linux'
        run: sudo rm -rf ..?* .[!.]* *
      - name: Checkout source
        uses: actions/checkout@v3
      - name: Run ls
        run: ls
      - name: Docker build
        run: >
          docker build ${{ inputs.docker_opts }}
          -f ./api/tests/docker/Dockerfile.gcc
          -t gcc_img .
      - name: Docker run
        run: >
          docker run --rm
          --volume=$(pwd):/data
          --user $(id -u):$(id -g)
          gcc_img gcc -I./api/vpl ./api/tests/compile_headers/test.c

  linux_compile_c_exp:
    name: Linux Compile C Experimental
    runs-on: [self-hosted, linux]
    steps:
      - name: Cleanup workspace (Linux)
        if: always() && runner.os == 'Linux'
        run: sudo rm -rf ..?* .[!.]* *
      - name: Checkout source
        uses: actions/checkout@v3
      - name: Run ls
        run: ls
      - name: Docker build
        run: >
          docker build ${{ inputs.docker_opts }}
          -f ./api/tests/docker/Dockerfile.gcc
          -t gcc_img .
      - name: Docker run
        run: >
          docker run --rm
          --volume=$(pwd):/data
          --user $(id -u):$(id -g)
          gcc_img gcc -I./api/vpl -DONEVPL_EXPERIMENTAL
          ./api/tests/compile_headers/test.c
          -o ./api/tests/abi/abi_test

  linux_compile_cpp:
    name: Linux Compile C++
    runs-on: [self-hosted, linux]
    steps:
      - name: Cleanup workspace (Linux)
        if: always() && runner.os == 'Linux'
        run: sudo rm -rf ..?* .[!.]* *
      - name: Checkout source
        uses: actions/checkout@v3
      - name: Run ls
        run: ls
      - name: Docker build
        run: >
          docker build ${{ inputs.docker_opts }}
          -f ./api/tests/docker/Dockerfile.gcc
          -t gcc_img .
      - name: Docker run
        run: >
          docker run --rm
          --volume=$(pwd):/data
          --user $(id -u):$(id -g)
          gcc_img gcc -I./api/vpl ./api/tests/compile_headers/test.cpp

  linux_compile_cpp_exp:
    name: Linux Compile C++ Experimental
    runs-on: [self-hosted, linux]
    steps:
      - name: Cleanup workspace (Linux)
        if: always() && runner.os == 'Linux'
        run: sudo rm -rf ..?* .[!.]* *
      - name: Checkout source
        uses: actions/checkout@v3
      - name: Run ls
        run: ls
      - name: Docker build
        run: >
          docker build ${{ inputs.docker_opts }}
          -f ./api/tests/docker/Dockerfile.gcc
          -t gcc_img .
      - name: Docker run
        run: >
          docker run --rm
          --volume=$(pwd):/data
          --user $(id -u):$(id -g)
          gcc_img gcc -I./api/vpl -DONEVPL_EXPERIMENTAL
          ./api/tests/compile_headers/test.cpp

  linux_compile_abi_64:
    name: Linux Static Assert Test
    runs-on: [self-hosted, linux]
    steps:
      - name: Cleanup workspace (Linux)
        if: always() && runner.os == 'Linux'
        run: sudo rm -rf ..?* .[!.]* *
      - name: Checkout source
        uses: actions/checkout@v3
      - name: Docker build
        run: >
          docker build ${{ inputs.docker_opts }}
          -f ./api/tests/docker/Dockerfile.gcc
          -t gcc_img .
      - name: Docker run
        run: >
          docker run --rm
          --volume=$(pwd):/data
          --user $(id -u):$(id -g)
          gcc_img gcc -D _x86_64 -m64 -I./api/vpl
          ./api/tests/abi/mfx_static_assert_structs.cpp
      - name: Execute
        run: ./a.out

  linux_compile_abi_64_exp:
    name: Linux Static Assert Test Experimental
    runs-on: [self-hosted, linux]
    steps:
      - name: Cleanup workspace (Linux)
        if: always() && runner.os == 'Linux'
        run: sudo rm -rf ..?* .[!.]* *
      - name: Checkout source
        uses: actions/checkout@v3
      - name: Docker build
        run: >
          docker build ${{ inputs.docker_opts }}
          -f ./api/tests/docker/Dockerfile.gcc
          -t gcc_img .
      - name: Docker run
        run: >
          docker run --rm
          --volume=$(pwd):/data
          --user $(id -u):$(id -g)
          gcc_img gcc -D _x86_64 -m64 -I./api/vpl -DONEVPL_EXPERIMENTAL
          ./api/tests/abi/mfx_static_assert_structs.cpp
      - name: Execute
        run: ./a.out

  linux_compile_snippets_c:
    name: Linux Compile Snippets C
    runs-on: [self-hosted, linux]
    steps:
      - name: Cleanup workspace (Linux)
        if: always() && runner.os == 'Linux'
        run: sudo rm -rf ..?* .[!.]* *
      - name: Checkout source
        uses: actions/checkout@v3
      - name: Docker build
        run: >
          docker build ${{ inputs.docker_opts }}
          -f ./api/tests/docker/Dockerfile.gcc
          -t gcc_img .
      - name: Docker run
        run: >
          docker run --rm
          --volume=$(pwd):/data
          --user $(id -u):$(id -g)
          gcc_img gcc -Wall  -Wextra -Wno-unused-function -Werror -I./api/vpl
          -DONEVPL_EXPERIMENTAL
          ./api/tests/doc_examples/dummy_impl.c
          ./doc/spec/source/snippets/appnd_b.c
          ./doc/spec/source/snippets/prg_decoding.c
          ./doc/spec/source/snippets/prg_encoding.c
          ./doc/spec/source/snippets/prg_err.c
          ./doc/spec/source/snippets/prg_mem.c
          ./doc/spec/source/snippets/prg_transcoding.c
          ./doc/spec/source/snippets/prg_vpp.c
          ./doc/spec/source/snippets/appnd_e.c
          ./api/tests/doc_examples/main.c
          ./doc/spec/source/snippets/prg_decoding_vpp.c
          ./doc/spec/source/snippets/prg_disp.c
          -ldl -lva -lva-drm

  linux_compile_snippets_cpp:
    name: Linux Compile Snippets C++
    runs-on: [self-hosted, linux]
    steps:
      - name: Cleanup workspace (Linux)
        if: always() && runner.os == 'Linux'
        run: sudo rm -rf ..?* .[!.]* *
      - name: Checkout source
        uses: actions/checkout@v3
      - name: Docker build
        run: >
          docker build ${{ inputs.docker_opts }}
          -f ./api/tests/docker/Dockerfile.gcc
          -t gcc_img .
      - name: Docker run
        run: >
          docker run --rm
          --volume=$(pwd):/data
          --user $(id -u):$(id -g)
          gcc_img g++ -Wall -Wextra -Wno-unused-function -Werror -I./api/vpl
          -DONEVPL_EXPERIMENTAL -DMFX_DEPRECATED_OFF
          ./api/tests/doc_examples/dummy_impl.c
          ./doc/spec/source/snippets/prg_hw.cpp
          ./doc/spec/source/snippets/prg_session.cpp
          ./doc/spec/source/snippets/prg_surface_sharing.cpp
          ./doc/spec/source/snippets/prg_config.cpp
          ./api/tests/doc_examples/main.c

  windows_compile_c:
    name: Windows Compile C
    runs-on: [self-hosted, windows]
    steps:
      - name: Cleanup workspace (Windows)
        if: always() && runner.os == 'Windows'
        run: Remove-Item -Recurse -Force .\*
      - name: Checkout source code
        uses: actions/checkout@v1
      - name: Setup VisualStudio build enviroment
        uses: intel-innersource/frameworks.actions.thirdparty.msvc-dev-cmd@v1
      - name: Build with VisualStudio
        run: >
          cl.exe /EHsc /I .\api\vpl
          /D ONEVPL_EXPERIMENTAL
          .\api\tests\compile_headers\test.c

  windows_compile_cpp:
    name: Windows Compile CPP
    runs-on: [self-hosted, windows]
    steps:
      - name: Cleanup workspace (Windows)
        if: always() && runner.os == 'Windows'
        run: Remove-Item -Recurse -Force .\*
      - name: Checkout source code
        uses: actions/checkout@v1
      - name: Setup VisualStudio build enviroment
        uses: intel-innersource/frameworks.actions.thirdparty.msvc-dev-cmd@v1
      - name: Build with VisualStudio
        run: >
          cl.exe /EHsc /I .\api\vpl
          /D ONEVPL_EXPERIMENTAL
          .\api\tests\compile_headers\test.cpp

  windows_compile_abi_64:
    name: Windows Static Assert Test (64-bit)
    runs-on: [self-hosted, windows]
    steps:
      - name: Cleanup workspace (Windows)
        if: always() && runner.os == 'Windows'
        run: Remove-Item -Recurse -Force .\*
      - name: Checkout source code
        uses: actions/checkout@v1
      - name: Setup VisualStudio build enviroment
        uses: intel-innersource/frameworks.actions.thirdparty.msvc-dev-cmd@v1
      - name: Build with experimental (x64)
        run: >
          cl.exe /EHsc /I .\api\vpl
          /D ONEVPL_EXPERIMENTAL /D _x86_64
          .\api\tests\abi\mfx_static_assert_structs.cpp
      - name: Execute
        run: .\mfx_static_assert_structs.exe
      - name: Build without experimental (x64)
        run: >
          cl.exe /EHsc /I .\api\vpl
          /D _x86_64
          .\api\tests\abi\mfx_static_assert_structs.cpp
      - name: Execute
        run: .\mfx_static_assert_structs.exe

  windows_compile_abi_32:
    name: Windows Static Assert Test (32-bit)
    runs-on: [self-hosted, windows]
    steps:
      - name: Cleanup workspace (Windows)
        if: always() && runner.os == 'Windows'
        run: Remove-Item -Recurse -Force .\*
      - name: Checkout source code
        uses: actions/checkout@v1
      - name: Setup VisualStudio build enviroment
        uses: intel-innersource/frameworks.actions.thirdparty.msvc-dev-cmd@v1
        with:
          arch: x86
      - name: Build with experimental (x86)
        run: >
          cl.exe /EHsc /I .\api\vpl /D _x86
          /D ONEVPL_EXPERIMENTAL
          .\api\tests\abi\mfx_static_assert_structs.cpp
      - name: Execute
        run: .\mfx_static_assert_structs.exe
      - name: Build without experimental (x86)
        run: >
          cl.exe /EHsc /I .\api\vpl /D _x86
          .\api\tests\abi\mfx_static_assert_structs.cpp
      - name: Execute
        run: .\mfx_static_assert_structs.exe

  required_checks:
    name: Verify Required Checks
    needs:
      - linux_check_structure_pack
      - linux_missed_tests
      - linux_compile_c
      - linux_compile_c_exp
      - linux_compile_cpp
      - linux_compile_cpp_exp
      - linux_compile_abi_64
      - linux_compile_abi_64_exp
      - linux_compile_snippets_c
      - linux_compile_snippets_cpp
      - windows_compile_abi_64
      - windows_compile_abi_32
      - windows_compile_c
      - windows_compile_cpp
    runs-on: [self-hosted]
    steps:
      - name: Required Checks
        run: echo Done

  html:
    name: HTML
    needs:
      - required_checks
    runs-on: [self-hosted, linux]
    steps:
      - name: Cleanup workspace (Linux)
        if: always() && runner.os == 'Linux'
        run: sudo rm -rf ..?* .[!.]* *
      - name: Checkout source
        uses: actions/checkout@v3
      - name: Docker build
        run: python3 ./doc/spec/build-spec.py dockerbuild
      - name: Build spec - HTML
        run: >
          docker run --rm
          --volume=$(pwd):/build
          --workdir=/build
          --user $(id -u):$(id -g)
          vpl-spec
          python3 ./doc/spec/build-spec.py -W html ./doc/spec
      - name: Archive HTML
        uses: actions/upload-artifact@v4
        with:
          name: HTML
          path: ./doc/spec/build/html/
          retention-days: 28

  pdf:
    name: PDF
    needs:
      - required_checks
    runs-on: [self-hosted, linux]
    steps:
      - name: Cleanup workspace (Linux)
        if: always() && runner.os == 'Linux'
        run: sudo rm -rf ..?* .[!.]* *
      - name: Checkout source
        uses: actions/checkout@v3
      - name: Docker build
        run: python3 ./doc/spec/build-spec.py dockerbuild
      - name: Build spec - PDF
        run: >
          docker run --rm
          --volume=$(pwd):/build
          --workdir=/build
          --user $(id -u):$(id -g)
          vpl-spec
          python3 ./doc/spec/build-spec.py -W latexpdf ./doc/spec
      - name: Archive pdf
        uses: actions/upload-artifact@v4
        with:
          name: pdf
          path: ./doc/spec/build/latex/
          retention-days: 28

  # if branch name is in the format "specification/vX.Y" then use the basename
  #   (vX.Y) as the github pages subdirectory to publish into
  get_branch_basename:
    name: Get branch basename
    runs-on: [self-hosted, linux]
    outputs:
      branch_name: ${{ steps.get_branch_name.outputs.branch_name }}
      is_spec_branch: ${{ steps.get_branch_name.outputs.is_spec_branch}}
    steps:
      - name: Parse name
        id: get_branch_name
        run: |
          if [[ ${{ github.ref }} \
          =~ ^refs/heads/specification/v[0-9]+\.[0-9]+$ ]]; then
              echo "Specification branch matched"
              echo "${GITHUB_REF#refs/heads/specification/*}"
              base_name="${GITHUB_REF#refs/heads/specification/*}"
              echo "branch_name=$base_name" >> $GITHUB_OUTPUT
              echo "is_spec_branch=true" >> $GITHUB_OUTPUT
          else
              echo "Specification branch not matched"
              echo "${GITHUB_REF#refs/heads/*}"
              base_name="${GITHUB_REF#refs/heads/*}"
              echo "branch_name=$base_name" >> $GITHUB_OUTPUT
              echo "is_spec_branch=false" >> $GITHUB_OUTPUT
          fi

  pages:
    name: Deploy HTML
    permissions:
      contents: write
      pages: write
    needs:
      - html
      - get_branch_basename
    if: >
      github.ref == 'refs/heads/main'
      || needs.get_branch_basename.outputs.is_spec_branch == 'true'
    runs-on: [self-hosted, linux]
    steps:
      - name: Download HTML
        uses: actions/download-artifact@v4
        with:
          name: HTML
          path: ./html_files
      - name: Move html files to public
        run: mv ./html_files ./public
      - name: Deploy to latest
        if: (github.ref == 'refs/heads/main')
        uses:
          intel-innersource/frameworks.actions.thirdparty.actions-gh-pages@v3
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          publish_dir: ./public
          destination_dir: latest
          user_name: 'github-actions[bot]'
          user_email: 'github-actions[bot]@users.noreply.github.com'
      - name: Deploy to version subdirectory
        if: (needs.get_branch_basename.outputs.is_spec_branch == 'true')
        uses:
          intel-innersource/frameworks.actions.thirdparty.actions-gh-pages@v3
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          publish_dir: ./public
          destination_dir: ${{needs.get_branch_basename.outputs.branch_name}}
          user_name: 'github-actions[bot]'
          user_email: 'github-actions[bot]@users.noreply.github.com'