diff options
Diffstat (limited to 'Documentation/media/uapi/v4l/vidioc-enum-framesizes.rst')
| -rw-r--r-- | Documentation/media/uapi/v4l/vidioc-enum-framesizes.rst | 243 |
1 files changed, 80 insertions, 163 deletions
diff --git a/Documentation/media/uapi/v4l/vidioc-enum-framesizes.rst b/Documentation/media/uapi/v4l/vidioc-enum-framesizes.rst index 8b268354d442..628f1aa66338 100644 --- a/Documentation/media/uapi/v4l/vidioc-enum-framesizes.rst +++ b/Documentation/media/uapi/v4l/vidioc-enum-framesizes.rst | |||
| @@ -15,7 +15,8 @@ VIDIOC_ENUM_FRAMESIZES - Enumerate frame sizes | |||
| 15 | Synopsis | 15 | Synopsis |
| 16 | ======== | 16 | ======== |
| 17 | 17 | ||
| 18 | .. cpp:function:: int ioctl( int fd, int request, struct v4l2_frmsizeenum *argp ) | 18 | .. c:function:: int ioctl( int fd, VIDIOC_ENUM_FRAMESIZES, struct v4l2_frmsizeenum *argp ) |
| 19 | :name: VIDIOC_ENUM_FRAMESIZES | ||
| 19 | 20 | ||
| 20 | 21 | ||
| 21 | Arguments | 22 | Arguments |
| @@ -24,11 +25,8 @@ Arguments | |||
| 24 | ``fd`` | 25 | ``fd`` |
| 25 | File descriptor returned by :ref:`open() <func-open>`. | 26 | File descriptor returned by :ref:`open() <func-open>`. |
| 26 | 27 | ||
| 27 | ``request`` | ||
| 28 | VIDIOC_ENUM_FRAMESIZES | ||
| 29 | |||
| 30 | ``argp`` | 28 | ``argp`` |
| 31 | Pointer to a struct :ref:`v4l2_frmsizeenum <v4l2-frmsizeenum>` | 29 | Pointer to a struct :c:type:`v4l2_frmsizeenum` |
| 32 | that contains an index and pixel format and receives a frame width | 30 | that contains an index and pixel format and receives a frame width |
| 33 | and height. | 31 | and height. |
| 34 | 32 | ||
| @@ -72,7 +70,9 @@ the ``type`` field to determine the type of frame size enumeration the | |||
| 72 | device supports. Only for the ``V4L2_FRMSIZE_TYPE_DISCRETE`` type does | 70 | device supports. Only for the ``V4L2_FRMSIZE_TYPE_DISCRETE`` type does |
| 73 | it make sense to increase the index value to receive more frame sizes. | 71 | it make sense to increase the index value to receive more frame sizes. |
| 74 | 72 | ||
| 75 | .. note:: The order in which the frame sizes are returned has no special | 73 | .. note:: |
| 74 | |||
| 75 | The order in which the frame sizes are returned has no special | ||
| 76 | meaning. In particular does it not say anything about potential default | 76 | meaning. In particular does it not say anything about potential default |
| 77 | format sizes. | 77 | format sizes. |
| 78 | 78 | ||
| @@ -90,159 +90,89 @@ the application, *OUT* denotes values that the driver fills in. The | |||
| 90 | application should zero out all members except for the *IN* fields. | 90 | application should zero out all members except for the *IN* fields. |
| 91 | 91 | ||
| 92 | 92 | ||
| 93 | .. _v4l2-frmsize-discrete: | 93 | .. c:type:: v4l2_frmsize_discrete |
| 94 | |||
| 95 | .. tabularcolumns:: |p{4.4cm}|p{4.4cm}|p{8.7cm}| | ||
| 94 | 96 | ||
| 95 | .. flat-table:: struct v4l2_frmsize_discrete | 97 | .. flat-table:: struct v4l2_frmsize_discrete |
| 96 | :header-rows: 0 | 98 | :header-rows: 0 |
| 97 | :stub-columns: 0 | 99 | :stub-columns: 0 |
| 98 | :widths: 1 1 2 | 100 | :widths: 1 1 2 |
| 99 | 101 | ||
| 102 | * - __u32 | ||
| 103 | - ``width`` | ||
| 104 | - Width of the frame [pixel]. | ||
| 105 | * - __u32 | ||
| 106 | - ``height`` | ||
| 107 | - Height of the frame [pixel]. | ||
| 100 | 108 | ||
| 101 | - .. row 1 | ||
| 102 | |||
| 103 | - __u32 | ||
| 104 | |||
| 105 | - ``width`` | ||
| 106 | |||
| 107 | - Width of the frame [pixel]. | ||
| 108 | |||
| 109 | - .. row 2 | ||
| 110 | |||
| 111 | - __u32 | ||
| 112 | |||
| 113 | - ``height`` | ||
| 114 | |||
| 115 | - Height of the frame [pixel]. | ||
| 116 | 109 | ||
| 117 | 110 | ||
| 111 | .. c:type:: v4l2_frmsize_stepwise | ||
| 118 | 112 | ||
| 119 | .. _v4l2-frmsize-stepwise: | 113 | .. tabularcolumns:: |p{4.4cm}|p{4.4cm}|p{8.7cm}| |
| 120 | 114 | ||
| 121 | .. flat-table:: struct v4l2_frmsize_stepwise | 115 | .. flat-table:: struct v4l2_frmsize_stepwise |
| 122 | :header-rows: 0 | 116 | :header-rows: 0 |
| 123 | :stub-columns: 0 | 117 | :stub-columns: 0 |
| 124 | :widths: 1 1 2 | 118 | :widths: 1 1 2 |
| 125 | 119 | ||
| 126 | 120 | * - __u32 | |
| 127 | - .. row 1 | 121 | - ``min_width`` |
| 128 | 122 | - Minimum frame width [pixel]. | |
| 129 | - __u32 | 123 | * - __u32 |
| 130 | 124 | - ``max_width`` | |
| 131 | - ``min_width`` | 125 | - Maximum frame width [pixel]. |
| 132 | 126 | * - __u32 | |
| 133 | - Minimum frame width [pixel]. | 127 | - ``step_width`` |
| 134 | 128 | - Frame width step size [pixel]. | |
| 135 | - .. row 2 | 129 | * - __u32 |
| 136 | 130 | - ``min_height`` | |
| 137 | - __u32 | 131 | - Minimum frame height [pixel]. |
| 138 | 132 | * - __u32 | |
| 139 | - ``max_width`` | 133 | - ``max_height`` |
| 140 | 134 | - Maximum frame height [pixel]. | |
| 141 | - Maximum frame width [pixel]. | 135 | * - __u32 |
| 142 | 136 | - ``step_height`` | |
| 143 | - .. row 3 | 137 | - Frame height step size [pixel]. |
| 144 | 138 | ||
| 145 | - __u32 | 139 | |
| 146 | 140 | ||
| 147 | - ``step_width`` | 141 | .. c:type:: v4l2_frmsizeenum |
| 148 | |||
| 149 | - Frame width step size [pixel]. | ||
| 150 | |||
| 151 | - .. row 4 | ||
| 152 | |||
| 153 | - __u32 | ||
| 154 | |||
| 155 | - ``min_height`` | ||
| 156 | |||
| 157 | - Minimum frame height [pixel]. | ||
| 158 | |||
| 159 | - .. row 5 | ||
| 160 | |||
| 161 | - __u32 | ||
| 162 | |||
| 163 | - ``max_height`` | ||
| 164 | |||
| 165 | - Maximum frame height [pixel]. | ||
| 166 | |||
| 167 | - .. row 6 | ||
| 168 | |||
| 169 | - __u32 | ||
| 170 | |||
| 171 | - ``step_height`` | ||
| 172 | |||
| 173 | - Frame height step size [pixel]. | ||
| 174 | |||
| 175 | |||
| 176 | |||
| 177 | .. _v4l2-frmsizeenum: | ||
| 178 | 142 | ||
| 179 | .. flat-table:: struct v4l2_frmsizeenum | 143 | .. flat-table:: struct v4l2_frmsizeenum |
| 180 | :header-rows: 0 | 144 | :header-rows: 0 |
| 181 | :stub-columns: 0 | 145 | :stub-columns: 0 |
| 182 | 146 | ||
| 183 | 147 | * - __u32 | |
| 184 | - .. row 1 | 148 | - ``index`` |
| 185 | 149 | - | |
| 186 | - __u32 | 150 | - IN: Index of the given frame size in the enumeration. |
| 187 | 151 | * - __u32 | |
| 188 | - ``index`` | 152 | - ``pixel_format`` |
| 189 | 153 | - | |
| 190 | - | 154 | - IN: Pixel format for which the frame sizes are enumerated. |
| 191 | - IN: Index of the given frame size in the enumeration. | 155 | * - __u32 |
| 192 | 156 | - ``type`` | |
| 193 | - .. row 2 | 157 | - |
| 194 | 158 | - OUT: Frame size type the device supports. | |
| 195 | - __u32 | 159 | * - union |
| 196 | 160 | - | |
| 197 | - ``pixel_format`` | 161 | - |
| 198 | 162 | - OUT: Frame size with the given index. | |
| 199 | - | 163 | * - |
| 200 | - IN: Pixel format for which the frame sizes are enumerated. | 164 | - struct :c:type:`v4l2_frmsize_discrete` |
| 201 | 165 | - ``discrete`` | |
| 202 | - .. row 3 | 166 | - |
| 203 | 167 | * - | |
| 204 | - __u32 | 168 | - struct :c:type:`v4l2_frmsize_stepwise` |
| 205 | 169 | - ``stepwise`` | |
| 206 | - ``type`` | 170 | - |
| 207 | 171 | * - __u32 | |
| 208 | - | 172 | - ``reserved[2]`` |
| 209 | - OUT: Frame size type the device supports. | 173 | - |
| 210 | 174 | - Reserved space for future use. Must be zeroed by drivers and | |
| 211 | - .. row 4 | 175 | applications. |
| 212 | |||
| 213 | - union | ||
| 214 | |||
| 215 | - | ||
| 216 | - | ||
| 217 | - OUT: Frame size with the given index. | ||
| 218 | |||
| 219 | - .. row 5 | ||
| 220 | |||
| 221 | - | ||
| 222 | - struct :ref:`v4l2_frmsize_discrete <v4l2-frmsize-discrete>` | ||
| 223 | |||
| 224 | - ``discrete`` | ||
| 225 | |||
| 226 | - | ||
| 227 | |||
| 228 | - .. row 6 | ||
| 229 | |||
| 230 | - | ||
| 231 | - struct :ref:`v4l2_frmsize_stepwise <v4l2-frmsize-stepwise>` | ||
| 232 | |||
| 233 | - ``stepwise`` | ||
| 234 | |||
| 235 | - | ||
| 236 | |||
| 237 | - .. row 7 | ||
| 238 | |||
| 239 | - __u32 | ||
| 240 | |||
| 241 | - ``reserved[2]`` | ||
| 242 | |||
| 243 | - | ||
| 244 | - Reserved space for future use. Must be zeroed by drivers and | ||
| 245 | applications. | ||
| 246 | 176 | ||
| 247 | 177 | ||
| 248 | 178 | ||
| @@ -250,37 +180,24 @@ Enums | |||
| 250 | ===== | 180 | ===== |
| 251 | 181 | ||
| 252 | 182 | ||
| 253 | .. _v4l2-frmsizetypes: | 183 | .. c:type:: v4l2_frmsizetypes |
| 184 | |||
| 185 | .. tabularcolumns:: |p{6.6cm}|p{2.2cm}|p{8.7cm}| | ||
| 254 | 186 | ||
| 255 | .. flat-table:: enum v4l2_frmsizetypes | 187 | .. flat-table:: enum v4l2_frmsizetypes |
| 256 | :header-rows: 0 | 188 | :header-rows: 0 |
| 257 | :stub-columns: 0 | 189 | :stub-columns: 0 |
| 258 | :widths: 3 1 4 | 190 | :widths: 3 1 4 |
| 259 | 191 | ||
| 260 | 192 | * - ``V4L2_FRMSIZE_TYPE_DISCRETE`` | |
| 261 | - .. row 1 | 193 | - 1 |
| 262 | 194 | - Discrete frame size. | |
| 263 | - ``V4L2_FRMSIZE_TYPE_DISCRETE`` | 195 | * - ``V4L2_FRMSIZE_TYPE_CONTINUOUS`` |
| 264 | 196 | - 2 | |
| 265 | - 1 | 197 | - Continuous frame size. |
| 266 | 198 | * - ``V4L2_FRMSIZE_TYPE_STEPWISE`` | |
| 267 | - Discrete frame size. | 199 | - 3 |
| 268 | 200 | - Step-wise defined frame size. | |
| 269 | - .. row 2 | ||
| 270 | |||
| 271 | - ``V4L2_FRMSIZE_TYPE_CONTINUOUS`` | ||
| 272 | |||
| 273 | - 2 | ||
| 274 | |||
| 275 | - Continuous frame size. | ||
| 276 | |||
| 277 | - .. row 3 | ||
| 278 | |||
| 279 | - ``V4L2_FRMSIZE_TYPE_STEPWISE`` | ||
| 280 | |||
| 281 | - 3 | ||
| 282 | |||
| 283 | - Step-wise defined frame size. | ||
| 284 | 201 | ||
| 285 | 202 | ||
| 286 | Return Value | 203 | Return Value |
