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