summaryrefslogtreecommitdiff
path: root/Documentation/media/uapi/v4l/vidioc-g-jpegcomp.rst
blob: f5bf8b7915edda5ed093307cd370fcc11962cc33 (plain)
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
.. -*- coding: utf-8; mode: rst -*-

.. _VIDIOC_G_JPEGCOMP:

******************************************
ioctl VIDIOC_G_JPEGCOMP, VIDIOC_S_JPEGCOMP
******************************************

Name
====

VIDIOC_G_JPEGCOMP - VIDIOC_S_JPEGCOMP


Synopsis
========

.. cpp:function:: int ioctl( int fd, int request, v4l2_jpegcompression *argp )

.. cpp:function:: int ioctl( int fd, int request, const v4l2_jpegcompression *argp )


Arguments
=========

``fd``
    File descriptor returned by :ref:`open() <func-open>`.

``request``
    VIDIOC_G_JPEGCOMP, VIDIOC_S_JPEGCOMP

``argp``


Description
===========

These ioctls are **deprecated**. New drivers and applications should use
:ref:`JPEG class controls <jpeg-controls>` for image quality and JPEG
markers control.

[to do]

Ronald Bultje elaborates:

APP is some application-specific information. The application can set it
itself, and it'll be stored in the JPEG-encoded fields (eg; interlacing
information for in an AVI or so). COM is the same, but it's comments,
like 'encoded by me' or so.

jpeg_markers describes whether the huffman tables, quantization tables
and the restart interval information (all JPEG-specific stuff) should be
stored in the JPEG-encoded fields. These define how the JPEG field is
encoded. If you omit them, applications assume you've used standard
encoding. You usually do want to add them.


.. _v4l2-jpegcompression:

.. flat-table:: struct v4l2_jpegcompression
    :header-rows:  0
    :stub-columns: 0
    :widths:       1 1 2


    -  .. row 1

       -  int

       -  ``quality``

       -  Deprecated. If
	  :ref:`V4L2_CID_JPEG_COMPRESSION_QUALITY <jpeg-quality-control>`
	  control is exposed by a driver applications should use it instead
	  and ignore this field.

    -  .. row 2

       -  int

       -  ``APPn``

       -

    -  .. row 3

       -  int

       -  ``APP_len``

       -

    -  .. row 4

       -  char

       -  ``APP_data``\ [60]

       -

    -  .. row 5

       -  int

       -  ``COM_len``

       -

    -  .. row 6

       -  char

       -  ``COM_data``\ [60]

       -

    -  .. row 7

       -  __u32

       -  ``jpeg_markers``

       -  See :ref:`jpeg-markers`. Deprecated. If
	  :ref:`V4L2_CID_JPEG_ACTIVE_MARKER <jpeg-active-marker-control>`
	  control is exposed by a driver applications should use it instead
	  and ignore this field.



.. _jpeg-markers:

.. flat-table:: JPEG Markers Flags
    :header-rows:  0
    :stub-columns: 0
    :widths:       3 1 4


    -  .. row 1

       -  ``V4L2_JPEG_MARKER_DHT``

       -  (1<<3)

       -  Define Huffman Tables

    -  .. row 2

       -  ``V4L2_JPEG_MARKER_DQT``

       -  (1<<4)

       -  Define Quantization Tables

    -  .. row 3

       -  ``V4L2_JPEG_MARKER_DRI``

       -  (1<<5)

       -  Define Restart Interval

    -  .. row 4

       -  ``V4L2_JPEG_MARKER_COM``

       -  (1<<6)

       -  Comment segment

    -  .. row 5

       -  ``V4L2_JPEG_MARKER_APP``

       -  (1<<7)

       -  App segment, driver will always use APP0


Return Value
============

On success 0 is returned, on error -1 and the ``errno`` variable is set
appropriately. The generic error codes are described at the
:ref:`Generic Error Codes <gen-errors>` chapter.