Gitiles
Code Review Sign In
review.shift-gmbh.com / SHIFTPHONES / mainline / linux / 3cc31fa65d85610574c0f6a474e89f4c419923d5 / . / Documentation / media / uapi / dvb / video-set-format.rst
blob: 4239a4e365bb2b2818435aa3616231c4d79ebdec [file] [log] [blame]
Mauro Carvalho Chehab47d23e32016-07-05 10:37:31 -0300[diff] [blame]1.. -*- coding: utf-8; mode: rst -*-
2
3.. _VIDEO_SET_FORMAT:
4
Mauro Carvalho Chehab586027c2016-07-05 07:58:48 -0300[diff] [blame]5================
Mauro Carvalho Chehab47d23e32016-07-05 10:37:31 -0300[diff] [blame]6VIDEO_SET_FORMAT
7================
8
Mauro Carvalho Chehab15e7d612016-07-05 15:14:35 -0300[diff] [blame]9Name
Mauro Carvalho Chehab586027c2016-07-05 07:58:48 -0300[diff] [blame]10----
Mauro Carvalho Chehab47d23e32016-07-05 10:37:31 -0300[diff] [blame]11
Mauro Carvalho Chehab586027c2016-07-05 07:58:48 -0300[diff] [blame]12VIDEO_SET_FORMAT
Mauro Carvalho Chehab47d23e32016-07-05 10:37:31 -0300[diff] [blame]13
Mauro Carvalho Chehabcf8076c2016-08-19 16:56:15 -0300[diff] [blame]14.. attention:: This ioctl is deprecated.
Mauro Carvalho Chehab15e7d612016-07-05 15:14:35 -0300[diff] [blame]15
16Synopsis
Mauro Carvalho Chehab47d23e32016-07-05 10:37:31 -0300[diff] [blame]17--------
18
Mauro Carvalho Chehabcf8076c2016-08-19 16:56:15 -0300[diff] [blame]19.. c:function:: int ioctl(fd, VIDEO_SET_FORMAT, video_format_t format)
20 :name: VIDEO_SET_FORMAT
Mauro Carvalho Chehab47d23e32016-07-05 10:37:31 -0300[diff] [blame]21
Mauro Carvalho Chehab47d23e32016-07-05 10:37:31 -0300[diff] [blame]22
Mauro Carvalho Chehab15e7d612016-07-05 15:14:35 -0300[diff] [blame]23Arguments
Mauro Carvalho Chehab586027c2016-07-05 07:58:48 -0300[diff] [blame]24---------
Mauro Carvalho Chehab47d23e32016-07-05 10:37:31 -0300[diff] [blame]25
26.. flat-table::
27 :header-rows: 0
28 :stub-columns: 0
29
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
49
Mauro Carvalho Chehab15e7d612016-07-05 15:14:35 -0300[diff] [blame]50Description
Mauro Carvalho Chehab586027c2016-07-05 07:58:48 -0300[diff] [blame]51-----------
52
53This ioctl sets the screen format (aspect ratio) of the connected output
54device (TV) so that the output of the decoder can be adjusted
55accordingly.
56
Mauro Carvalho Chehab848d10312016-08-31 16:34:07 -0300[diff] [blame]57.. c:type:: video_format_t
58
59.. code-block:: c
60
61 typedef enum {
62 VIDEO_FORMAT_4_3, /* Select 4:3 format */
63 VIDEO_FORMAT_16_9, /* Select 16:9 format. */
64 VIDEO_FORMAT_221_1 /* 2.21:1 */
65 } video_format_t;
Mauro Carvalho Chehab586027c2016-07-05 07:58:48 -0300[diff] [blame]66
Mauro Carvalho Chehab15e7d612016-07-05 15:14:35 -0300[diff] [blame]67Return Value
Mauro Carvalho Chehab47d23e32016-07-05 10:37:31 -0300[diff] [blame]68------------
69
70On success 0 is returned, on error -1 and the ``errno`` variable is set
71appropriately. The generic error codes are described at the
72:ref:`Generic Error Codes <gen-errors>` chapter.
73
74
75
76.. flat-table::
77 :header-rows: 0
78 :stub-columns: 0
79
80
81 - .. row 1
82
83 - ``EINVAL``
84
85 - format is not a valid video format.