18c2ecf20Sopenharmony_ci.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
28c2ecf20Sopenharmony_ci.. c:namespace:: DTV.video
38c2ecf20Sopenharmony_ci
48c2ecf20Sopenharmony_ci.. _VIDEO_SET_FORMAT:
58c2ecf20Sopenharmony_ci
68c2ecf20Sopenharmony_ci================
78c2ecf20Sopenharmony_ciVIDEO_SET_FORMAT
88c2ecf20Sopenharmony_ci================
98c2ecf20Sopenharmony_ci
108c2ecf20Sopenharmony_ciName
118c2ecf20Sopenharmony_ci----
128c2ecf20Sopenharmony_ci
138c2ecf20Sopenharmony_ciVIDEO_SET_FORMAT
148c2ecf20Sopenharmony_ci
158c2ecf20Sopenharmony_ci.. attention:: This ioctl is deprecated.
168c2ecf20Sopenharmony_ci
178c2ecf20Sopenharmony_ciSynopsis
188c2ecf20Sopenharmony_ci--------
198c2ecf20Sopenharmony_ci
208c2ecf20Sopenharmony_ci.. c:macro:: VIDEO_SET_FORMAT
218c2ecf20Sopenharmony_ci
228c2ecf20Sopenharmony_ci``int ioctl(fd, VIDEO_SET_FORMAT, video_format_t format)``
238c2ecf20Sopenharmony_ci
248c2ecf20Sopenharmony_ciArguments
258c2ecf20Sopenharmony_ci---------
268c2ecf20Sopenharmony_ci
278c2ecf20Sopenharmony_ci.. flat-table::
288c2ecf20Sopenharmony_ci    :header-rows:  0
298c2ecf20Sopenharmony_ci    :stub-columns: 0
308c2ecf20Sopenharmony_ci
318c2ecf20Sopenharmony_ci    -  .. row 1
328c2ecf20Sopenharmony_ci
338c2ecf20Sopenharmony_ci       -  int fd
348c2ecf20Sopenharmony_ci
358c2ecf20Sopenharmony_ci       -  File descriptor returned by a previous call to open().
368c2ecf20Sopenharmony_ci
378c2ecf20Sopenharmony_ci    -  .. row 2
388c2ecf20Sopenharmony_ci
398c2ecf20Sopenharmony_ci       -  int request
408c2ecf20Sopenharmony_ci
418c2ecf20Sopenharmony_ci       -  Equals VIDEO_SET_FORMAT for this command.
428c2ecf20Sopenharmony_ci
438c2ecf20Sopenharmony_ci    -  .. row 3
448c2ecf20Sopenharmony_ci
458c2ecf20Sopenharmony_ci       -  video_format_t format
468c2ecf20Sopenharmony_ci
478c2ecf20Sopenharmony_ci       -  video format of TV as defined in section ??.
488c2ecf20Sopenharmony_ci
498c2ecf20Sopenharmony_ciDescription
508c2ecf20Sopenharmony_ci-----------
518c2ecf20Sopenharmony_ci
528c2ecf20Sopenharmony_ciThis ioctl sets the screen format (aspect ratio) of the connected output
538c2ecf20Sopenharmony_cidevice (TV) so that the output of the decoder can be adjusted
548c2ecf20Sopenharmony_ciaccordingly.
558c2ecf20Sopenharmony_ci
568c2ecf20Sopenharmony_ci.. c:type:: video_format_t
578c2ecf20Sopenharmony_ci
588c2ecf20Sopenharmony_ci.. code-block:: c
598c2ecf20Sopenharmony_ci
608c2ecf20Sopenharmony_ci	typedef enum {
618c2ecf20Sopenharmony_ci		VIDEO_FORMAT_4_3,     /* Select 4:3 format */
628c2ecf20Sopenharmony_ci		VIDEO_FORMAT_16_9,    /* Select 16:9 format. */
638c2ecf20Sopenharmony_ci		VIDEO_FORMAT_221_1    /* 2.21:1 */
648c2ecf20Sopenharmony_ci	} video_format_t;
658c2ecf20Sopenharmony_ci
668c2ecf20Sopenharmony_ciReturn Value
678c2ecf20Sopenharmony_ci------------
688c2ecf20Sopenharmony_ci
698c2ecf20Sopenharmony_ciOn success 0 is returned, on error -1 and the ``errno`` variable is set
708c2ecf20Sopenharmony_ciappropriately. The generic error codes are described at the
718c2ecf20Sopenharmony_ci:ref:`Generic Error Codes <gen-errors>` chapter.
728c2ecf20Sopenharmony_ci
738c2ecf20Sopenharmony_ci
748c2ecf20Sopenharmony_ci.. flat-table::
758c2ecf20Sopenharmony_ci    :header-rows:  0
768c2ecf20Sopenharmony_ci    :stub-columns: 0
778c2ecf20Sopenharmony_ci
788c2ecf20Sopenharmony_ci    -  .. row 1
798c2ecf20Sopenharmony_ci
808c2ecf20Sopenharmony_ci       -  ``EINVAL``
818c2ecf20Sopenharmony_ci
828c2ecf20Sopenharmony_ci       -  format is not a valid video format.
83