tjh.dev
Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel
os
linux
1.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
2.. c:namespace:: DTV.video
3
4.. _VIDEO_SET_FORMAT:
5
6================
7VIDEO_SET_FORMAT
8================
9
10Name
11----
12
13VIDEO_SET_FORMAT
14
15.. attention:: This ioctl is deprecated.
16
17Synopsis
18--------
19
20.. c:macro:: VIDEO_SET_FORMAT
21
22``int ioctl(fd, VIDEO_SET_FORMAT, video_format_t format)``
23
24Arguments
25---------
26
27.. flat-table::
28 :header-rows: 0
29 :stub-columns: 0
30
31 - .. row 1
32
33 - int fd
34
35 - File descriptor returned by a previous call to open().
36
37 - .. row 2
38
39 - int request
40
41 - Equals VIDEO_SET_FORMAT for this command.
42
43 - .. row 3
44
45 - video_format_t format
46
47 - video format of TV as defined in section ??.
48
49Description
50-----------
51
52This ioctl sets the screen format (aspect ratio) of the connected output
53device (TV) so that the output of the decoder can be adjusted
54accordingly.
55
56.. c:type:: video_format_t
57
58.. code-block:: c
59
60 typedef enum {
61 VIDEO_FORMAT_4_3, /* Select 4:3 format */
62 VIDEO_FORMAT_16_9, /* Select 16:9 format. */
63 VIDEO_FORMAT_221_1 /* 2.21:1 */
64 } video_format_t;
65
66Return Value
67------------
68
69On success 0 is returned, on error -1 and the ``errno`` variable is set
70appropriately. The generic error codes are described at the
71:ref:`Generic Error Codes <gen-errors>` chapter.
72
73
74.. flat-table::
75 :header-rows: 0
76 :stub-columns: 0
77
78 - .. row 1
79
80 - ``EINVAL``
81
82 - format is not a valid video format.