File: mediasdk-tutorials-cmd-reference.md

package info (click to toggle)
intel-mediasdk 22.5.4-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 86,508 kB
  • sloc: cpp: 1,055,709; ansic: 25,847; asm: 17,754; python: 8,951; cs: 965; sh: 543; makefile: 528; lisp: 52
file content (414 lines) | stat: -rw-r--r-- 33,823 bytes parent folder | download | duplicates (2)
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
![](./pic/intel_logo.png)

# **Tutorials Command Line Reference**

<div style="page-break-before:always" />

**LEGAL DISCLAIMER**

INFORMATION IN THIS DOCUMENT IS PROVIDED IN CONNECTION WITH INTEL PRODUCTS. NO LICENSE, EXPRESS OR IMPLIED, BY ESTOPPEL OR OTHERWISE, TO ANY INTELLECTUAL PROPERTY RIGHTS IS GRANTED BY THIS DOCUMENT.  EXCEPT AS PROVIDED IN INTEL'S TERMS AND CONDITIONS OF SALE FOR SUCH PRODUCTS, INTEL ASSUMES NO LIABILITY WHATSOEVER AND INTEL DISCLAIMS ANY EXPRESS OR IMPLIED WARRANTY, RELATING TO SALE AND/OR USE OF INTEL PRODUCTS INCLUDING LIABILITY OR WARRANTIES RELATING TO FITNESS FOR A PARTICULAR PURPOSE, MERCHANTABILITY, OR INFRINGEMENT OF ANY PATENT, COPYRIGHT OR OTHER INTELLECTUAL PROPERTY RIGHT.

UNLESS OTHERWISE AGREED IN WRITING BY INTEL, THE INTEL PRODUCTS ARE NOT DESIGNED NOR INTENDED FOR ANY APPLICATION IN WHICH THE FAILURE OF THE INTEL PRODUCT COULD CREATE A SITUATION WHERE PERSONAL INJURY OR DEATH MAY OCCUR.

Intel may make changes to specifications and product descriptions at any time, without notice. Designers must not rely on the absence or characteristics of any features or instructions marked "reserved" or "undefined." Intel reserves these for future definition and shall have no responsibility whatsoever for conflicts or incompatibilities arising from future changes to them. The information here is subject to change without notice. Do not finalize a design with this information.

The products described in this document may contain design defects or errors known as errata which may cause the product to deviate from published specifications. Current characterized errata are available on request.

Contact your local Intel sales office or your distributor to obtain the latest specifications and before placing your product order.

Copies of documents which have an order number and are referenced in this document, or other Intel literature, may be obtained by calling 1-800-548-4725, or by visiting [Intel's Web Site](http://www.intel.com/).

MPEG is an international standard for video compression/decompression promoted by ISO. Implementations of MPEG CODECs, or MPEG enabled platforms may require licenses from various entities, including Intel Corporation.

Intel and the Intel logo are trademarks or registered trademarks of Intel Corporation or its subsidiaries in the United States and other countries.

\*Other names and brands may be claimed as the property of others.

Copyright © 2007-2020, Intel Corporation. All Rights reserved.
<div style="page-break-before:always" />

**Optimization Notice**

Intel's compilers may or may not optimize to the same degree for non-Intel microprocessors for optimizations that are not unique to Intel microprocessors. These optimizations include SSE2, SSE3, and SSSE3 instruction sets and other optimizations. Intel does not guarantee the availability, functionality, or effectiveness of any optimization on microprocessors not manufactured by Intel.

Microprocessor-dependent optimizations in this product are intended for use with Intel microprocessors. Certain optimizations not specific to Intel microarchitecture are reserved for Intel microprocessors. Please refer to the applicable product User and Reference Guides for more information regarding the specific instruction sets covered by this notice.

Notice revision #20110804

<div style="page-break-before:always" />

# Table of contents
- [General considerations](#general-considerations)
- [Basic tutorials](#basic-tutorials)
  - [simple_1_session](#simple-1-session)
  - [simple_7_codec](#simple_7_codec)
- [Decoding tutorials](#decoding-tutorials)
  - [simple_2_decode](#simple_2_decode)
  - [simple_2_decode_hevc10](#simple_2_decode_hevc10)
  - [simple_2_decode_vmem](#simple_2_decode_vmem)
  - [simple_6_decode_vpp_postproc](#simple_6_decode_vpp_postproc)
- [Encoding tutorials](#encoding-tutorials)
  - [simple_3_encode](#simple_3_encode)
  - [simple_3_encode_hevc10](#simple_3_encode_hevc10)
  - [simple_3_encode_vmem](#simple_3_encode_vmem)
  - [simple_3_encode_vmem_async](#simple_3_encode_vmem_async)
  - [simple_6_encode_vmem_lowlatency](simple_6_encode_vmem_lowlatency)
  - [simple_6_encode_vmem_vpp_preproc](#simple_6_encode_vmem_vpp_preproc)
- [Video PreProcessing (VPP) tutorials](#video-preprocessing-vpp-tutorials)
  - [simple_4_vpp_resize_denoise](#simple_4_vpp_resize_denoise)
  - [simple_4_vpp_resize_denoise_vmem](#simple_4_vpp_resize_denoise_vmem)
- [Transcoding tutorials](#transcoding-tutorials)
  - [simple_5_transcode](#simple_5_transcode)
  - [simple_5_transcode_vmem](#simple_5_transcode_vmem)
  - [simple_5_transcode_opaque](#simple_5_transcode_opaque)
  - [simple_5_transcode_opaque_async](#simple_5_transcode_opaque_async)
  - [simple_6_transcode_opaque_lowlatency](#simple_6_transcode_opaque_lowlatency)
  - [simple_5_transcode_opaque_async_vppresize](#simple_5_transcode_opaque_async_vppresize)


# General considerations
Intel Media SDK Tutorials package was designed in the simplistic manner. Each tutorial suites the purpose to demonstrate some technique of working with the Media SDK library. For the simplicity sample code supports only minimum required number of options without which it is impossible to variate input data and produce correct result. This command line reference is divided into few parts. Each part describes group of tutorials which have the same or similar list of command line options and arguments. The parts are:

-   **Basic tutorials**.
-   **Decoding tutorials**. The only configurable component in these tutorials is decoder (H.264).
Configuration parameters are input and output streams.
-   **Encoding tutorials**. The only configurable component is encoder (H.264). Configuration
parameters (besides input and output stream) - width, height, bitrate, framerate.
-   **VPP tutorials**. The only configurable component is VPP. Configuration parameters (besides
input and output stream) - input stream width and height.
-   **Transcoding tutorials**. Configurable components are decoder (H.264) and encoder (H.264).
Configuration parameters are: input/output streams, bitrate/framerate to encode.

# Basic tutorials
## simple_1_session
**simple_1_session *[-sw | -hw | -auto]***
Tutorial initializes Intel Media SDK session of a specified type. If *-auto* is specified (the default) Media SDK dispatcher will automatically select library implementation to use. If *-hw* is specified HW implementation will be used, *-sw* - SW one. Depending on Media SDK distribution different implementations may present. Options to adjust session type are applicable for all other tutorials described in this reference.

| Option | Description |
| ------:| -----------:|
| -sw | Loads SW Media SDK Library implementation |
| -hw | Loads HW Media SDK Library implementation |
| -auto | Automatically choses Media SDK library implementation |

## simple_7_codec
**simple_7_codec *[-sw | -hw | -auto]***
Tutorial showcases MSDK features via call Query functions. The tutorial can be run with the *-hw*, *-sw*, *-auto* or no options, it will report the capability for each codec. Since this tutorial checks all supported coded, it will configure a set of the video parameters for each codec by the predefined filling function. Each filling function will try the maximum resolutions, user might change the resolution based on his platform.

| Option | Description |
| ------:| -----------:|
| -sw | Loads SW Media SDK Library implementation |
| -hw | Loads HW Media SDK Library implementation |
| -auto | Automatically choses Media SDK library implementation |


# Decoding tutorials
## simple_2_decode
**simple_decode *[-sw | -hw | -auto] input-file [ output-file ]***
Tutorial demonstrates how to decode given raw video stream (input-file) of H.264 format. If output-file was specified, decoded YUV will be written into it. If the output-file is omitted, tutorial can be used to estimate constructed pipeline’s performance. Decoder is configured to produce decoded data in the system memory.

| Option | Description |
| ------:| -----------:|
| -sw | Loads SW Media SDK Library implementation |
| -hw | Loads HW Media SDK Library implementation |
| -auto | Automatically choses Media SDK library implementation |

| Argument | Description |
| ------:| -----------:|
| input-file | Mandatory argument. Sets incoming input bitstream to process. Input data should be in raw H.264 format. |
| output-file | Optional argument. Sets uncompressed video file to write output data. If file will not be specified, tutorial will work in the performance mode: it will process data, but will not produce any output. |
## simple_2_decode_hevc10
**simple_2_decode_hevc10 *[-sw | -hw | -auto] input-file [ output-file ]***
Tutorial demonstrates how to decode given raw video stream (input-file) of H.265 format. If output-file is specified, decoded YUV will be written into it. If the output-file is omitted, tutorial can be used to estimate constructed pipeline’s performance. Decoder is configured to produce decoded data in the system memory.

| Option | Description |
| ------:| -----------:|
| -sw | Loads SW Media SDK Library implementation |
| -hw | Loads HW Media SDK Library implementation |
| -auto | Automatically choses Media SDK library implementation |

| Argument | Description |
| ------:| -----------:|
| input-file | Mandatory argument. Sets incoming input bitstream to process. Input data should be in raw H.265 format. |
| output-file | Optional argument. Sets uncompressed video file to write output data. If file will not be specified, tutorial will work in the performance mode: it will process data, but will not produce any output. |

## simple_2_decode_vmem
**simple_decode_vmem *[-sw | -hw | -auto] input-file [ output-file ]***
Tutorial demonstrates how to decode given raw video stream (input-file) of H.264 format. If output-file was  specified, decoded YUV will be written into it. If the output-file is omitted, tutorial can be used to estimate  constructed pipeline’s performance. Decoder is configured to produce decoded data in the video memory.

| Option | Description |
| ------:| -----------:|
| -sw | Loads SW Media SDK Library implementation |
| -hw | Loads HW Media SDK Library implementation |
| -auto | Automatically choses Media SDK library implementation |

| Argument | Description |
| ------:| -----------:|
| input-file | Mandatory argument. Sets incoming input bitstream to process. Input data should be in raw H.264 format. |
| output-file | Optional argument. Sets uncompressed video file to write output data. If file will not be specified, tutorial will work in the performance mode: it will process data, but will not produce any output. |

## simple_6_decode_vpp_postproc
**simple_decode_vpp_pp *[-sw | -hw | -auto] input-file [ output-file ]***
Tutorial demonstrates how to decode given raw video stream (input-file) of H.264 format and perform some operation with the decoded frames thru the Video Post-Processing (VPP) component. If output-file was  specified, decoded YUV will be written into it. If the output-file is omitted, tutorial can be used to estimate  constructed pipeline’s performance. The performed VPP operation is x2 downscaling.

| Option | Description |
| ------:| -----------:|
| -sw | Loads SW Media SDK Library implementation |
| -hw | Loads HW Media SDK Library implementation |
| -auto | Automatically choses Media SDK library implementation |

| Argument | Description |
| ------:| -----------:|
| input-file | Mandatory argument. Sets incoming input bitstream to process. Input data should be in raw H.264 format. |
| output-file | Optional argument. Sets uncompressed video file to write output data. If file will not be specified, tutorial will work in the performance mode: it will process data, but will not produce any output. |

# Encoding tutorials
## simple_3_encode
**simple_encode *[-sw | -hw | -auto] -g WxH -b bitrate -f framerate [ input-file ] [ output-file ]***
Tutorial demonstrates how to encode given YUV video stream (input-file) in H.264 format. If output-file was specified, encoded bitstream will be written into it. If the input-file and output-file are omitted, tutorial can be used to estimate constructed pipeline’s performance (to some degree). Encoder is configured to receive input  data from system memory.

| Option | Description |
| ------:| -----------:|
| -sw | Loads SW Media SDK Library implementation |
| -hw | Loads HW Media SDK Library implementation |
| -auto | Automatically choses Media SDK library implementation |
| -g WxH | Mandatory option. Sets input video geometry, i.e. width and height. Example: -g 1920x1080. |
| -b bitrate | Mandatory option. Sets bitrate with which data should be encoded, in KBits-per-second. Example: -b 5000 to encode data at 5Mbit. |
| -f framerate | Mandatory option. Sets framerate with which data should be encoded in the form -f nominator/denominator. Example: -f 30/1. |

| Argument | Description |
| ------:| -----------:|
| input-file | Optional argument. Sets incoming input file containing uncompressed video. If file will not be specified, tutorial will work in the performance mode: input will be simulated by producing empty input frames filled with some color |
| output-file | Optional argument. Sets raw H.264 video file to write output data. If file will not be specified, tutorial will work in the performance mode: it will process data, but will not produce any output. |

## simple_3_encode_hevc10
**simple_3_encode_hevc10 *[-sw | -hw | -auto] -g WxH -b bitrate -f framerate [ input-file ] [ output-file ]***
Tutorial demonstrates how to encode given p010 YUV video stream (input-file) in H.265 format. If output-file is specified, encoded bitstream will be written into it. If the input-file and output-file are omitted, tutorial can be used to estimate constructed pipeline’s performance (to some degree). Encoder is configured to receive input  data from system memory.

| Option | Description |
| ------:| -----------:|
| -sw | Loads SW Media SDK Library implementation |
| -hw | Loads HW Media SDK Library implementation |
| -auto | Automatically choses Media SDK library implementation |
| -g WxH | Mandatory option. Sets input video geometry, i.e. width and height. Example: -g 1920x1080. |
| -b bitrate | Mandatory option. Sets bitrate with which data should be encoded, in KBits-per-second. Example: -b 5000 to encode data at 5Mbit. |
| -f framerate | Mandatory option. Sets framerate with which data should be encoded in the form -f nominator/denominator. Example: -f 30/1. |

| Argument | Description |
| ------:| -----------:|
| input-file | Optional argument. Sets incoming input file containing uncompressed video. If file is not be specified, tutorial will work in the performance mode: input will be simulated by producing empty input frames filled with some color |
| output-file | Optional argument. Sets raw H.265 video file to write output data. If file is not be specified, tutorial will work in the performance mode: it will process data, but will not produce any output. |

## simple_3_encode_vmem
**simple_encode_vmem *[-sw | -hw | -auto] -g WxHx10 -b bitrate -f framerate [ input-file ] [ output-file ]***
Tutorial demonstrates how to encode given YUV video stream (input-file) in H.264 format. If output-file was specified, encoded bitstream will be written into it. If the input-file and output-file are omitted, tutorial can be used to estimate constructed pipeline’s performance (to some degree). Encoder is configured to receive input data from video memory.

| Option | Description |
| ------:| -----------:|
| -sw | Loads SW Media SDK Library implementation |
| -hw | Loads HW Media SDK Library implementation |
| -auto | Automatically choses Media SDK library implementation |
| -g WxHx10 | Mandatory option. Sets input video geometry, i.e. width, height, bitdepth. Example: -g 1920x1080x10. |
| -b bitrate | Mandatory option. Sets bitrate with which data should be encoded, in KBits-per-second. Example: -b 5000 to encode data at 5Mbit. |
| -f framerate | Mandatory option. Sets framerate with which data should be encoded in the form -f nominator/denominator. Example: -f 30/1. |

| Argument | Description |
| ------:| -----------:|
| input-file | Optional argument. Sets incoming input file containing uncompressed video. If file will not be specified, tutorial will work in the performance mode: input will be simulated by producing empty input frames filled with some color. |
| output-file | Optional argument. Sets raw H.264 video file to write output data. If file will not be specified, tutorial will work in the performance mode: it will process data, but will not produce any output. |

## simple_3_encode_vmem_async
**simple_encode_vmem_async *[-sw | -hw | -auto] -g WxH -b bitrate -f framerate [ input-file ] [ output-file ]***

Tutorial demonstrates how to encode given YUV video stream (input-file) in H.264 format. If output-file was specified, encoded bitstream will be written into it. If the input-file and output-file are omitted, tutorial can be used to estimate constructed pipeline’s performance (to some degree). Encoder is configured to receive input data from system memory. Constructed pipeline is asynchronous and should be faster than pipelines in simple 3 encode and simple 3 encode vmem samples.

| Option | Description |
| ------:| -----------:|
| -sw | Loads SW Media SDK Library implementation |
| -hw | Loads HW Media SDK Library implementation |
| -auto | Automatically choses Media SDK library implementation |
| -g WxH | Mandatory option. Sets input video geometry, i.e. width and height. Example: -g 1920x1080. |
| -b bitrate | Mandatory option. Sets bitrate with which data should be encoded, in KBits-per-second. Example: -b 5000 to encode data at 5Mbit. |
| -f framerate | Mandatory option. Sets framerate with which data should be encoded in the form -f nominator/denominator. Example: -f 30/1. |

| Argument | Description |
| ------:| -----------:|
| input-file | Optional argument. Sets incoming input file containing uncompressed video. If file will not be specified, tutorial will work in the performance mode: input will be simulated by producing empty input frames filled with some color. |
| output-file | Optional argument. Sets raw H.264 video file to write output data. If file will not be specified, tutorial will work in the performance mode: it will process data, but will not produce any output. |

## simple_6_encode_vmem_lowlatency
**simple_encode_vmem_lowlat *[-sw | -hw | -auto] -g WxH -b bitrate -f framerate [–measure-latency | –no-measure-latency] [ input-file ] [ output-file ]***

Tutorial demonstrates how to encode given YUV video stream (input-file) in H.264 format. If output-file was specified, encoded bitstream will be written into it. If the input-file and output-file are omitted, tutorial can be used to estimate constructed pipeline’s performance (to some degree). Encoder is configured to work in low latency mode, producing encoded data as fast as possible.

| Option | Description |
| ------:| -----------:|
| -sw | Loads SW Media SDK Library implementation |
| -hw | Loads HW Media SDK Library implementation |
| -auto | Automatically choses Media SDK library implementation |
| -g WxH | Mandatory option. Sets input video geometry, i.e. width and height. Example: -g 1920x1080. |
| -b bitrate | Mandatory option. Sets bitrate with which data should be encoded, in KBits-per-second. Example: -b 5000 to encode data at 5Mbit. |
| -f framerate | Mandatory option. Sets framerate with which data should be encoded in the form -f nominator/denominator. Example: -f 30/1. |
| --measure-latency | Optional argument. With the option set tutorial calculates and prints latency statistics. This is the default. |
| --no-measure-latency | Optional argument. With the option set tutorial will not calculate and print latency statistics. |

| Argument | Description |
| ------:| -----------:|
| input-file | Optional argument. Sets incoming input file containing uncompressed video. If file will not be specified, tutorial will work in the performance mode: input will be simulated by producing empty input frames filled with some color. |
| output-file | Optional argument. Sets raw H.264 video file to write output data. If file will not be specified, tutorial will work in the perfromance mode: it will process data, but will not produce any output. |

## simple_6_encode_vmem vpp preproc
**simple_encode_vmem_preproc *[-sw | -hw | -auto] -g WxH -b bitrate -f framerate [ input-file ] [ output-file ]***

Tutorial demonstrates how to encode given RGB video stream (input-file) in H.264 format after applying some Video Pre-Processing (VPP) operation. If output-file was specified, encoded bitstream will be written into it. If  the input-file and output-file are omitted, tutorial can be used to estimate constructed pipeline’s performance (to some degree). The performed VPP operation is RGB to NV12 color space conversion.

| Option | Description |
| ------:| -----------:|
| -sw | Loads SW Media SDK Library implementation |
| -hw | Loads HW Media SDK Library implementation |
| -auto | Automatically choses Media SDK library implementation |
| -g WxH | Mandatory option. Sets input video geometry, i.e. width and height. Example: -g 1920x1080. |
| -b bitrate | Mandatory option. Sets bitrate with which data should be encoded, in KBits-per-second. Example: -b 5000 to encode data at 5Mbit. |
| -f framerate | Mandatory option. Sets framerate with which data should be encoded in the form -f nominator/denominator. Example: -f 30/1. |

| Argument | Description |
| ------:| -----------:|
| input-file | Optional argument. Sets incoming input file containing uncompressed video. If file will not be specified, tutorial will work in the performance mode: input will be simulated by producing empty input frames filled with some color. |
| output-file | Optional argument. Sets raw H.264 video file to write output data. If file will not be specified, tutorial will work in the performance mode: it will process data, but will not produce any output. |

# Video PreProcessing (VPP) tutorials
## simple_4_vpp_resize_denoise
**simple_vpp *[-sw | -hw | -auto] -g WxH [ input-file ] [ output-file ]***
Tutorial demonstrates how to run some Video Pre/Post-Processing (VPP) operation in the given input YUV stream (input-file). If output-file was specified, produced stream will be written into it. If the input-file and output-file are omitted, tutorial can be used to estimate constructed pipeline’s performance. Constructed pipeline is configured to work on system memory on the input and output. The performed VPP operation is x2 downscaling and noise reduction.

| Option | Description |
| ------:| -----------:|
| -sw | Loads SW Media SDK Library implementation |
| -hw | Loads HW Media SDK Library implementation |
| -auto | Automatically chooses Media SDK library implementation |
| -g WxH | Mandatory option. Sets input video geometry, i.e. width and height. Example: -g 1920x1080. |

| Argument | Description |
| ------:| -----------:|
| input-file | Optional argument. Sets incoming input file containing uncompressed video. If file will not be specified, tutorial will work in the performance mode: input will be simulated by producing empty input frames filled with some color. |
| output-file | Optional argument. Sets uncompressed video file to write output data. If file will not be specified, tutorial will work in the performance mode: it will process data, but will not produce any output. |

## simple_4_vpp_resize_denoise_vmem
**simple_vpp_vmem *[-sw | -hw | -auto] -g WxH [ input-file ] [ output-file ]***
Tutorial demonstrates how to run some Video Pre/Post-Processing (VPP) operation in the given input YUV stream (input-file). If output-file was specified, produced stream will be written into it. If the input-file and output-file are omitted, tutorial can be used to estimate constructed pipeline’s performance. Constructed pipeline is configured to work on video memory on the input and output. The performed VPP operation is x2 downscaling and noise reduction.

| Option | Description |
| ------:| -----------:|
| -sw | Loads SW Media SDK Library implementation |
| -hw | Loads HW Media SDK Library implementation |
| -auto | Automatically chooses Media SDK library implementation |
| -g WxH | Mandatory option. Sets input video geometry, i.e. width and height. Example: -g 1920x1080. |

| Argument | Description |
| ------:| -----------:|
| input-file | Optional argument. Sets incoming input file containing uncompressed video. If file will not be specified, tutorial will work in the performance mode: input will be simulated by producing empty input frames filled with some color. |
| output-file | Optional argument. Sets uncompressed video file to write output data. If file will not be specified, tutorial will work in the performance mode: it will process data, but will not produce any output. |

# Transcoding tutorials
## simple_5_transcode
**simple_transcode *[-sw | -hw | -auto] -b bitrate -f framerate input-file [ output-file ]***
[Command]
Tutorial demonstrates how to transcode given input raw H.264 video stream (input-file) into H.264 stream with different parameters. If output-file was specified, produced stream will be written into it. If output-file is omitted, tutorial can be used to estimate constructed pipeline’s performance. Constructed pipeline is configured to share system memory between decoder and encoder.

| Option | Description |
| ------:| -----------:|
| -sw | Loads SW Media SDK Library implementation |
| -hw | Loads HW Media SDK Library implementation |
| -auto | Automatically chooses Media SDK library implementation |
| -b bitrate | Mandatory option. Sets bitrate with which data should be encoded, in KBits-per-second. Example: -b 5000 to encode data at 5Mbit. |
| -f framerate | Mandatory option. Sets framerate with which data should be encoded in the form -f nominator/denominator. Example: -f 30/1. |

| Argument | Description |
| ------:| -----------:|
| input-file | Mandatory argument. Sets incoming input bitstream to process. Input data should be in raw H.264 format. |
| output-file | Optional argument. Sets raw H.264 video file to write output data. If file will not be specified, tutorial will work in the performance mode: it will process data, but will not produce any output |

## simple_5_transcode_vmem
**simple_transcode_vmem *[-sw | -hw | -auto] -b bitrate -f framerate input-file [ output-file ]***
Tutorial demonstrates how to transcode given input raw H.264 video stream (input-file) into H.264 stream with different parameters. If output-file was specified, produced stream will be written into it. If output-file is omitted, tutorial can be used to estimate constructed pipeline’s performance. Constructed pipeline is configured to share video memory between decoder and encoder.

| Option | Description |
| ------:| -----------:|
| -sw | Loads SW Media SDK Library implementation |
| -hw | Loads HW Media SDK Library implementation |
| -auto | Automatically chooses Media SDK library implementation |
| -b bitrate | Mandatory option. Sets bitrate with which data should be encoded, in KBits-per-second. Example: -b 5000 to encode data at 5Mbit. |
| -f framerate | Mandatory option. Sets framerate with which data should be encoded in the form -f nominator/denominator. Example: -f 30/1. |

| Argument | Description |
| ------:| -----------:|
| input-file | Mandatory argument. Sets incoming input bitstream to process. Input data should be in raw H.264 format. |
| output-file | Optional argument. Sets raw H.264 video file to write output data. If file will not be specified, tutorial will work in the performance mode: it will process data, but will not produce any output |

## simple_5_transcode_opaque
**simple_transcode_opaque *[-sw | -hw | -auto] -b bitrate -f framerate input-file [ output-file ]***
Tutorial demonstrates how to transcode given input raw H.264 video stream (input-file) into H.264 stream with different parameters. If output-file was specified, produced stream will be written into it. If output-file is omitted, tutorial can be used to estimate constructed pipeline’s performance. Constructed pipeline is configured to share opaque memory between decoder and encoder.

| Option | Description |
| ------:| -----------:|
| -sw | Loads SW Media SDK Library implementation |
| -hw | Loads HW Media SDK Library implementation |
| -auto | Automatically chooses Media SDK library implementation |
| -b bitrate | Mandatory option. Sets bitrate with which data should be encoded, in KBits-per-second. Example: -b 5000 to encode data at 5Mbit. |
| -f framerate | Mandatory option. Sets framerate with which data should be encoded in the form -f nominator/denominator. Example: -f 30/1. |

| Argument | Description |
| ------:| -----------:|
| input-file | Mandatory argument. Sets incoming input bitstream to process. Input data should be in raw H.264 format. |
| output-file | Optional argument. Sets raw H.264 video file to write output data. If file will not be specified, tutorial will work in the performance mode: it will process data, but will not produce any output |

## simple_5_transcode_opaque_async
**simple_transcode_opaque_async *[-sw | -hw | -auto] -b bitrate -f framerate input-file [ output-file ]***
Tutorial demonstrates how to transcode given input raw H.264 video stream (input-file) into H.264 stream with different parameters. If output-file was specified, produced stream will be written into it. If output-file is omitted, tutorial can be used to estimate constructed pipeline’s performance. Constructed pipeline is configured to share opaque memory between decoder and encoder and work in the asynchronous mode.

| Option | Description |
| ------:| -----------:|
| -sw | Loads SW Media SDK Library implementation |
| -hw | Loads HW Media SDK Library implementation |
| -auto | Automatically chooses Media SDK library implementation |
| -b bitrate | Mandatory option. Sets bitrate with which data should be encoded, in KBits-per-second. Example: -b 5000 to encode data at 5Mbit. |
| -f framerate | Mandatory option. Sets framerate with which data should be encoded in the form -f nominator/denominator. Example: -f 30/1. |

| Argument | Description |
| ------:| -----------:|
| input-file | Mandatory argument. Sets incoming input bitstream to process. Input data should be in raw H.264 format. |
| output-file | Optional argument. Sets raw H.264 video file to write output data. If file will not be specified, tutorial will work in the performance mode: it will process data, but will not produce any output |

## simple_6_transcode_opaque_lowlatency
**simple_transcode_opaque_lowlat *[-sw | -hw | -auto] -b bitrate -f framerate input-file [ output-file ]***
Tutorial demonstrates how to transcode given input raw H.264 video stream (input-file) into H.264 stream with different parameters. If output-file was specified, produced stream will be written into it. If output-file is omitted, tutorial can be used to estimate constructed pipeline’s performance. Constructed pipeline is configured to share opaque memory between decoder and encoder and work in the low latency mode, i.e. produce output as fast as possible.

| Option | Description |
| ------:| -----------:|
| -sw | Loads SW Media SDK Library implementation |
| -hw | Loads HW Media SDK Library implementation |
| -auto | Automatically chooses Media SDK library implementation |
| -b bitrate | Mandatory option. Sets bitrate with which data should be encoded, in KBits-per-second. Example: -b 5000 to encode data at 5Mbit. |
| -f framerate | Mandatory option. Sets framerate with which data should be encoded in the form -f nominator/denominator. Example: -f 30/1. |

| Argument | Description |
| ------:| -----------:|
| input-file | Mandatory argument. Sets incoming input bitstream to process. Input data should be in raw H.264 format. |
| output-file | Optional argument. Sets raw H.264 video file to write output data. If file will not be specified, tutorial will work in the performance mode: it will process data, but will not produce any output |

## simple_5_transcode_opaque_async_vppresize
**simple_transcode_opaque_async_vppresize *[-sw | -hw | -auto] -b bitrate -f framerate input-file [ output-file ]***
Tutorial demonstrates how to transcode given input raw H.264 video stream (input-file) into H.264 stream with different parameters. This tutorial adds VPP processing (x4 down-scaling) in the pipeline. If output-file was specified, produced stream will be written into it. If output-file is omitted, tutorial can be used to estimate constructed pipeline’s performance. Constructed pipeline is configured to share opaque memory between decoder and encoder and work in the asynchronous mode.

| Option | Description |
| ------:| -----------:|
| -sw | Loads SW Media SDK Library implementation |
| -hw | Loads HW Media SDK Library implementation |
| -auto | Automatically chooses Media SDK library implementation |
| -b bitrate | Mandatory option. Sets bitrate with which data should be encoded, in KBits-per-second. Example: -b 5000 to encode data at 5Mbit. |
| -f framerate | Mandatory option. Sets framerate with which data should be encoded in the form -f nominator/denominator. Example: -f 30/1. |

| Argument | Description |
| ------:| -----------:|
| input-file | Mandatory argument. Sets incoming input bitstream to process. Input data should be in raw H.264 format. |
| output-file | Optional argument. Sets raw H.264 video file to write output data. If file will not be specified, tutorial will work in the performance mode: it will process data, but will not produce any output |