gst-libs/gst/video/video-format.h

   1 /* GStreamer
   2  * Copyright (C) <2011> Wim Taymans <wim.taymans@gmail.com>
   3  *
   4  * This library is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU Library General Public
   6  * License as published by the Free Software Foundation; either
   7  * version 2 of the License, or (at your option) any later version.
   8  *
   9  * This library is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * Library General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Library General Public
  15  * License along with this library; if not, write to the
  16  * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
  17  * Boston, MA 02110-1301, USA.
  18  */
  19
  20 #ifndef __GST_VIDEO_FORMAT_H__
  21 #define __GST_VIDEO_FORMAT_H__
  22
  23 #include <gst/gst.h>
  24
  25 G_BEGIN_DECLS
  26
  27 #include <gst/video/video-enumtypes.h>
  28 #include <gst/video/video-tile.h>
  29
  30 /**
  31  * GstVideoFormat:
  32  * @GST_VIDEO_FORMAT_UNKNOWN: Unknown or unset video format id
  33  * @GST_VIDEO_FORMAT_ENCODED: Encoded video format. Only ever use that in caps for
  34  *                            special video formats in combination with non-system
  35  *                            memory GstCapsFeatures where it does not make sense
  36  *                            to specify a real video format.
  37  * @GST_VIDEO_FORMAT_I420: planar 4:2:0 YUV
  38  * @GST_VIDEO_FORMAT_YV12: planar 4:2:0 YVU (like I420 but UV planes swapped)
  39  * @GST_VIDEO_FORMAT_YUY2: packed 4:2:2 YUV (Y0-U0-Y1-V0 Y2-U2-Y3-V2 Y4 ...)
  40  * @GST_VIDEO_FORMAT_UYVY: packed 4:2:2 YUV (U0-Y0-V0-Y1 U2-Y2-V2-Y3 U4 ...)
  41  * @GST_VIDEO_FORMAT_VYUY: packed 4:2:2 YUV (V0-Y0-U0-Y1 V2-Y2-U2-Y3 V4 ...)
  42  * @GST_VIDEO_FORMAT_AYUV: packed 4:4:4 YUV with alpha channel (A0-Y0-U0-V0 ...)
  43  * @GST_VIDEO_FORMAT_RGBx: sparse rgb packed into 32 bit, space last
  44  * @GST_VIDEO_FORMAT_BGRx: sparse reverse rgb packed into 32 bit, space last
  45  * @GST_VIDEO_FORMAT_xRGB: sparse rgb packed into 32 bit, space first
  46  * @GST_VIDEO_FORMAT_xBGR: sparse reverse rgb packed into 32 bit, space first
  47  * @GST_VIDEO_FORMAT_RGBA: rgb with alpha channel last
  48  * @GST_VIDEO_FORMAT_BGRA: reverse rgb with alpha channel last
  49  * @GST_VIDEO_FORMAT_ARGB: rgb with alpha channel first
  50  * @GST_VIDEO_FORMAT_ABGR: reverse rgb with alpha channel first
  51  * @GST_VIDEO_FORMAT_RGB: RGB packed into 24 bits without padding (`R-G-B-R-G-B`)
  52  * @GST_VIDEO_FORMAT_BGR: reverse RGB packed into 24 bits without padding (`B-G-R-B-G-R`)
  53  * @GST_VIDEO_FORMAT_Y41B: planar 4:1:1 YUV
  54  * @GST_VIDEO_FORMAT_Y42B: planar 4:2:2 YUV
  55  * @GST_VIDEO_FORMAT_YVYU: packed 4:2:2 YUV (Y0-V0-Y1-U0 Y2-V2-Y3-U2 Y4 ...)
  56  * @GST_VIDEO_FORMAT_Y444: planar 4:4:4 YUV
  57  * @GST_VIDEO_FORMAT_v210: packed 4:2:2 10-bit YUV, complex format
  58  * @GST_VIDEO_FORMAT_v216: packed 4:2:2 16-bit YUV, Y0-U0-Y1-V1 order
  59  * @GST_VIDEO_FORMAT_NV12: planar 4:2:0 YUV with interleaved UV plane
  60  * @GST_VIDEO_FORMAT_NV21: planar 4:2:0 YUV with interleaved VU plane
  61  * @GST_VIDEO_FORMAT_NV12_10LE32: 10-bit variant of @GST_VIDEO_FORMAT_NV12, packed into 32bit words (MSB 2 bits padding) (Since: 1.14)
  62  * @GST_VIDEO_FORMAT_GRAY8: 8-bit grayscale
  63  * @GST_VIDEO_FORMAT_GRAY10_LE32: 10-bit grayscale, packed into 32bit words (2 bits padding) (Since: 1.14)
  64  * @GST_VIDEO_FORMAT_GRAY16_BE: 16-bit grayscale, most significant byte first
  65  * @GST_VIDEO_FORMAT_GRAY16_LE: 16-bit grayscale, least significant byte first
  66  * @GST_VIDEO_FORMAT_v308: packed 4:4:4 YUV (Y-U-V ...)
  67  * @GST_VIDEO_FORMAT_IYU2: packed 4:4:4 YUV (U-Y-V ...) (Since: 1.10)
  68  * @GST_VIDEO_FORMAT_RGB16: rgb 5-6-5 bits per component
  69  * @GST_VIDEO_FORMAT_BGR16: reverse rgb 5-6-5 bits per component
  70  * @GST_VIDEO_FORMAT_RGB15: rgb 5-5-5 bits per component
  71  * @GST_VIDEO_FORMAT_BGR15: reverse rgb 5-5-5 bits per component
  72  * @GST_VIDEO_FORMAT_UYVP: packed 10-bit 4:2:2 YUV (U0-Y0-V0-Y1 U2-Y2-V2-Y3 U4 ...)
  73  * @GST_VIDEO_FORMAT_A420: planar 4:4:2:0 AYUV
  74  * @GST_VIDEO_FORMAT_RGB8P: 8-bit paletted RGB
  75  * @GST_VIDEO_FORMAT_YUV9: planar 4:1:0 YUV
  76  * @GST_VIDEO_FORMAT_YVU9: planar 4:1:0 YUV (like YUV9 but UV planes swapped)
  77  * @GST_VIDEO_FORMAT_IYU1: packed 4:1:1 YUV (Cb-Y0-Y1-Cr-Y2-Y3 ...)
  78  * @GST_VIDEO_FORMAT_ARGB64: rgb with alpha channel first, 16 bits per channel
  79  * @GST_VIDEO_FORMAT_AYUV64: packed 4:4:4 YUV with alpha channel, 16 bits per channel (A0-Y0-U0-V0 ...)
  80  * @GST_VIDEO_FORMAT_r210: packed 4:4:4 RGB, 10 bits per channel
  81  * @GST_VIDEO_FORMAT_I420_10BE: planar 4:2:0 YUV, 10 bits per channel
  82  * @GST_VIDEO_FORMAT_I420_10LE: planar 4:2:0 YUV, 10 bits per channel
  83  * @GST_VIDEO_FORMAT_I422_10BE: planar 4:2:2 YUV, 10 bits per channel
  84  * @GST_VIDEO_FORMAT_I422_10LE: planar 4:2:2 YUV, 10 bits per channel
  85  * @GST_VIDEO_FORMAT_Y444_10BE: planar 4:4:4 YUV, 10 bits per channel (Since: 1.2)
  86  * @GST_VIDEO_FORMAT_Y444_10LE: planar 4:4:4 YUV, 10 bits per channel (Since: 1.2)
  87  * @GST_VIDEO_FORMAT_GBR: planar 4:4:4 RGB, 8 bits per channel (Since: 1.2)
  88  * @GST_VIDEO_FORMAT_GBR_10BE: planar 4:4:4 RGB, 10 bits per channel (Since: 1.2)
  89  * @GST_VIDEO_FORMAT_GBR_10LE: planar 4:4:4 RGB, 10 bits per channel (Since: 1.2)
  90  * @GST_VIDEO_FORMAT_NV16: planar 4:2:2 YUV with interleaved UV plane (Since: 1.2)
  91  * @GST_VIDEO_FORMAT_NV16_10LE32: 10-bit variant of @GST_VIDEO_FORMAT_NV16, packed into 32bit words (MSB 2 bits padding) (Since: 1.14)
  92  * @GST_VIDEO_FORMAT_NV24: planar 4:4:4 YUV with interleaved UV plane (Since: 1.2)
  93  * @GST_VIDEO_FORMAT_NV12_64Z32: NV12 with 64x32 tiling in zigzag pattern (Since: 1.4)
  94  * @GST_VIDEO_FORMAT_A420_10BE: planar 4:4:2:0 YUV, 10 bits per channel (Since: 1.6)
  95  * @GST_VIDEO_FORMAT_A420_10LE: planar 4:4:2:0 YUV, 10 bits per channel (Since: 1.6)
  96  * @GST_VIDEO_FORMAT_A422_10BE: planar 4:4:2:2 YUV, 10 bits per channel (Since: 1.6)
  97  * @GST_VIDEO_FORMAT_A422_10LE: planar 4:4:2:2 YUV, 10 bits per channel (Since: 1.6)
  98  * @GST_VIDEO_FORMAT_A444_10BE: planar 4:4:4:4 YUV, 10 bits per channel (Since: 1.6)
  99  * @GST_VIDEO_FORMAT_A444_10LE: planar 4:4:4:4 YUV, 10 bits per channel (Since: 1.6)
 100  * @GST_VIDEO_FORMAT_NV61: planar 4:2:2 YUV with interleaved VU plane (Since: 1.6)
 101  * @GST_VIDEO_FORMAT_P010_10BE: planar 4:2:0 YUV with interleaved UV plane, 10 bits per channel (Since: 1.10)
 102  * @GST_VIDEO_FORMAT_P010_10LE: planar 4:2:0 YUV with interleaved UV plane, 10 bits per channel (Since: 1.10)
 103  * @GST_VIDEO_FORMAT_GBRA: planar 4:4:4:4 ARGB, 8 bits per channel (Since: 1.12)
 104  * @GST_VIDEO_FORMAT_GBRA_10BE: planar 4:4:4:4 ARGB, 10 bits per channel (Since: 1.12)
 105  * @GST_VIDEO_FORMAT_GBRA_10LE: planar 4:4:4:4 ARGB, 10 bits per channel (Since: 1.12)
 106  * @GST_VIDEO_FORMAT_GBR_12BE: planar 4:4:4 RGB, 12 bits per channel (Since: 1.12)
 107  * @GST_VIDEO_FORMAT_GBR_12LE: planar 4:4:4 RGB, 12 bits per channel (Since: 1.12)
 108  * @GST_VIDEO_FORMAT_GBRA_12BE: planar 4:4:4:4 ARGB, 12 bits per channel (Since: 1.12)
 109  * @GST_VIDEO_FORMAT_GBRA_12LE: planar 4:4:4:4 ARGB, 12 bits per channel (Since: 1.12)
 110  * @GST_VIDEO_FORMAT_I420_12BE: planar 4:2:0 YUV, 12 bits per channel (Since: 1.12)
 111  * @GST_VIDEO_FORMAT_I420_12LE: planar 4:2:0 YUV, 12 bits per channel (Since: 1.12)
 112  * @GST_VIDEO_FORMAT_I422_12BE: planar 4:2:2 YUV, 12 bits per channel (Since: 1.12)
 113  * @GST_VIDEO_FORMAT_I422_12LE: planar 4:2:2 YUV, 12 bits per channel (Since: 1.12)
 114  * @GST_VIDEO_FORMAT_Y444_12BE: planar 4:4:4 YUV, 12 bits per channel (Since: 1.12)
 115  * @GST_VIDEO_FORMAT_Y444_12LE: planar 4:4:4 YUV, 12 bits per channel (Since: 1.12)
 116  * @GST_VIDEO_FORMAT_NV12_10LE40: Fully packed variant of NV12_10LE32 (Since: 1.16)
 117  * @GST_VIDEO_FORMAT_Y210: packed 4:2:2 YUV, 10 bits per channel (Since: 1.16)
 118  * @GST_VIDEO_FORMAT_Y410: packed 4:4:4 YUV, 10 bits per channel(A-V-Y-U...) (Since: 1.16)
 119  * @GST_VIDEO_FORMAT_VUYA: packed 4:4:4 YUV with alpha channel (V0-U0-Y0-A0...) (Since: 1.16)
 120  * @GST_VIDEO_FORMAT_BGR10A2_LE: packed 4:4:4 RGB with alpha channel(B-G-R-A), 10 bits for R/G/B channel and MSB 2 bits for alpha channel (Since: 1.16)
 121  * @GST_VIDEO_FORMAT_RGB10A2_LE: packed 4:4:4 RGB with alpha channel(R-G-B-A), 10 bits for R/G/B channel and MSB 2 bits for alpha channel (Since: 1.18)
 122  *
 123  * Enum value describing the most common video formats.
 124  *
 125  * See the [GStreamer raw video format design document](https://gstreamer.freedesktop.org/documentation/design/mediatype-video-raw.html#formats)
 126  * for details about the layout and packing of these formats in memory.
 127  */
 128 typedef enum {
 129   GST_VIDEO_FORMAT_UNKNOWN,
 130   GST_VIDEO_FORMAT_ENCODED,
 131   GST_VIDEO_FORMAT_I420,
 132   GST_VIDEO_FORMAT_YV12,
 133   GST_VIDEO_FORMAT_YUY2,
 134   GST_VIDEO_FORMAT_UYVY,
 135   GST_VIDEO_FORMAT_AYUV,
 136   GST_VIDEO_FORMAT_RGBx,
 137   GST_VIDEO_FORMAT_BGRx,
 138   GST_VIDEO_FORMAT_xRGB,
 139   GST_VIDEO_FORMAT_xBGR,
 140   GST_VIDEO_FORMAT_RGBA,
 141   GST_VIDEO_FORMAT_BGRA,
 142   GST_VIDEO_FORMAT_ARGB,
 143   GST_VIDEO_FORMAT_ABGR,
 144   GST_VIDEO_FORMAT_RGB,
 145   GST_VIDEO_FORMAT_BGR,
 146   GST_VIDEO_FORMAT_Y41B,
 147   GST_VIDEO_FORMAT_Y42B,
 148   GST_VIDEO_FORMAT_YVYU,
 149   GST_VIDEO_FORMAT_Y444,
 150   GST_VIDEO_FORMAT_v210,
 151   GST_VIDEO_FORMAT_v216,
 152   GST_VIDEO_FORMAT_NV12,
 153   GST_VIDEO_FORMAT_NV21,
 154   GST_VIDEO_FORMAT_GRAY8,
 155   GST_VIDEO_FORMAT_GRAY16_BE,
 156   GST_VIDEO_FORMAT_GRAY16_LE,
 157   GST_VIDEO_FORMAT_v308,
 158   GST_VIDEO_FORMAT_RGB16,
 159   GST_VIDEO_FORMAT_BGR16,
 160   GST_VIDEO_FORMAT_RGB15,
 161   GST_VIDEO_FORMAT_BGR15,
 162   GST_VIDEO_FORMAT_UYVP,
 163   GST_VIDEO_FORMAT_A420,
 164   GST_VIDEO_FORMAT_RGB8P,
 165   GST_VIDEO_FORMAT_YUV9,
 166   GST_VIDEO_FORMAT_YVU9,
 167   GST_VIDEO_FORMAT_IYU1,
 168   GST_VIDEO_FORMAT_ARGB64,
 169   GST_VIDEO_FORMAT_AYUV64,
 170   GST_VIDEO_FORMAT_r210,
 171   GST_VIDEO_FORMAT_I420_10BE,
 172   GST_VIDEO_FORMAT_I420_10LE,
 173   GST_VIDEO_FORMAT_I422_10BE,
 174   GST_VIDEO_FORMAT_I422_10LE,
 175   GST_VIDEO_FORMAT_Y444_10BE,
 176   GST_VIDEO_FORMAT_Y444_10LE,
 177   GST_VIDEO_FORMAT_GBR,
 178   GST_VIDEO_FORMAT_GBR_10BE,
 179   GST_VIDEO_FORMAT_GBR_10LE,
 180   GST_VIDEO_FORMAT_NV16,
 181   GST_VIDEO_FORMAT_NV24,
 182   GST_VIDEO_FORMAT_NV12_64Z32,
 183   GST_VIDEO_FORMAT_A420_10BE,
 184   GST_VIDEO_FORMAT_A420_10LE,
 185   GST_VIDEO_FORMAT_A422_10BE,
 186   GST_VIDEO_FORMAT_A422_10LE,
 187   GST_VIDEO_FORMAT_A444_10BE,
 188   GST_VIDEO_FORMAT_A444_10LE,
 189   GST_VIDEO_FORMAT_NV61,
 190   GST_VIDEO_FORMAT_P010_10BE,
 191   GST_VIDEO_FORMAT_P010_10LE,
 192   GST_VIDEO_FORMAT_IYU2,
 193   GST_VIDEO_FORMAT_VYUY,
 194   GST_VIDEO_FORMAT_GBRA,
 195   GST_VIDEO_FORMAT_GBRA_10BE,
 196   GST_VIDEO_FORMAT_GBRA_10LE,
 197   GST_VIDEO_FORMAT_GBR_12BE,
 198   GST_VIDEO_FORMAT_GBR_12LE,
 199   GST_VIDEO_FORMAT_GBRA_12BE,
 200   GST_VIDEO_FORMAT_GBRA_12LE,
 201   GST_VIDEO_FORMAT_I420_12BE,
 202   GST_VIDEO_FORMAT_I420_12LE,
 203   GST_VIDEO_FORMAT_I422_12BE,
 204   GST_VIDEO_FORMAT_I422_12LE,
 205   GST_VIDEO_FORMAT_Y444_12BE,
 206   GST_VIDEO_FORMAT_Y444_12LE,
 207   GST_VIDEO_FORMAT_GRAY10_LE32,
 208   GST_VIDEO_FORMAT_NV12_10LE32,
 209   GST_VIDEO_FORMAT_NV16_10LE32,
 210   GST_VIDEO_FORMAT_NV12_10LE40,
 211   GST_VIDEO_FORMAT_Y210,
 212   GST_VIDEO_FORMAT_Y410,
 213   GST_VIDEO_FORMAT_VUYA,
 214   GST_VIDEO_FORMAT_BGR10A2_LE,
 215   GST_VIDEO_FORMAT_RGB10A2_LE,
 216 } GstVideoFormat;
 217
 218 #define GST_VIDEO_MAX_PLANES 4
 219 #define GST_VIDEO_MAX_COMPONENTS 4
 220
 221 typedef struct _GstVideoFormatInfo GstVideoFormatInfo;
 222
 223 /**
 224  * GstVideoFormatFlags:
 225  * @GST_VIDEO_FORMAT_FLAG_YUV: The video format is YUV, components are numbered
 226  *   0=Y, 1=U, 2=V.
 227  * @GST_VIDEO_FORMAT_FLAG_RGB: The video format is RGB, components are numbered
 228  *   0=R, 1=G, 2=B.
 229  * @GST_VIDEO_FORMAT_FLAG_GRAY: The video is gray, there is one gray component
 230  *   with index 0.
 231  * @GST_VIDEO_FORMAT_FLAG_ALPHA: The video format has an alpha components with
 232  *   the number 3.
 233  * @GST_VIDEO_FORMAT_FLAG_LE: The video format has data stored in little
 234  *   endianness.
 235  * @GST_VIDEO_FORMAT_FLAG_PALETTE: The video format has a palette. The palette
 236  *   is stored in the second plane and indexes are stored in the first plane.
 237  * @GST_VIDEO_FORMAT_FLAG_COMPLEX: The video format has a complex layout that
 238  *   can't be described with the usual information in the #GstVideoFormatInfo.
 239  * @GST_VIDEO_FORMAT_FLAG_UNPACK: This format can be used in a
 240  *   #GstVideoFormatUnpack and #GstVideoFormatPack function.
 241  * @GST_VIDEO_FORMAT_FLAG_TILED: The format is tiled, there is tiling information
 242  *   in the last plane.
 243  *
 244  * The different video flags that a format info can have.
 245  */
 246 typedef enum
 247 {
 248   GST_VIDEO_FORMAT_FLAG_YUV      = (1 << 0),
 249   GST_VIDEO_FORMAT_FLAG_RGB      = (1 << 1),
 250   GST_VIDEO_FORMAT_FLAG_GRAY     = (1 << 2),
 251   GST_VIDEO_FORMAT_FLAG_ALPHA    = (1 << 3),
 252   GST_VIDEO_FORMAT_FLAG_LE       = (1 << 4),
 253   GST_VIDEO_FORMAT_FLAG_PALETTE  = (1 << 5),
 254   GST_VIDEO_FORMAT_FLAG_COMPLEX  = (1 << 6),
 255   GST_VIDEO_FORMAT_FLAG_UNPACK   = (1 << 7),
 256   GST_VIDEO_FORMAT_FLAG_TILED    = (1 << 8)
 257 } GstVideoFormatFlags;
 258
 259 /* YUV components */
 260 #define GST_VIDEO_COMP_Y  0
 261 #define GST_VIDEO_COMP_U  1
 262 #define GST_VIDEO_COMP_V  2
 263
 264 /* RGB components */
 265 #define GST_VIDEO_COMP_R  0
 266 #define GST_VIDEO_COMP_G  1
 267 #define GST_VIDEO_COMP_B  2
 268
 269 /* alpha component */
 270 #define GST_VIDEO_COMP_A  3
 271
 272 /* palette components */
 273 #define GST_VIDEO_COMP_INDEX    0
 274 #define GST_VIDEO_COMP_PALETTE  1
 275
 276 #include <gst/video/video-chroma.h>
 277
 278 /**
 279  * GstVideoPackFlags:
 280  * @GST_VIDEO_PACK_FLAG_NONE: No flag
 281  * @GST_VIDEO_PACK_FLAG_TRUNCATE_RANGE: When the source has a smaller depth
 282  *   than the target format, set the least significant bits of the target
 283  *   to 0. This is likely sightly faster but less accurate. When this flag
 284  *   is not specified, the most significant bits of the source are duplicated
 285  *   in the least significant bits of the destination.
 286  * @GST_VIDEO_PACK_FLAG_INTERLACED: The source is interlaced. The unpacked
 287  *   format will be interlaced as well with each line containing
 288  *   information from alternating fields. (Since: 1.2)
 289  *
 290  * The different flags that can be used when packing and unpacking.
 291  */
 292 typedef enum
 293 {
 294   GST_VIDEO_PACK_FLAG_NONE           = 0,
 295   GST_VIDEO_PACK_FLAG_TRUNCATE_RANGE = (1 << 0),
 296   GST_VIDEO_PACK_FLAG_INTERLACED     = (1 << 1)
 297 } GstVideoPackFlags;
 298
 299 /**
 300  * GstVideoFormatUnpack:
 301  * @info: a #GstVideoFormatInfo
 302  * @flags: flags to control the unpacking
 303  * @dest: a destination array
 304  * @data: pointers to the data planes
 305  * @stride: strides of the planes
 306  * @x: the x position in the image to start from
 307  * @y: the y position in the image to start from
 308  * @width: the amount of pixels to unpack.
 309  *
 310  * Unpacks @width pixels from the given planes and strides containing data of
 311  * format @info. The pixels will be unpacked into @dest with each component
 312  * interleaved as per @info's unpack_format, which will usually be one of
 313  * #GST_VIDEO_FORMAT_ARGB, #GST_VIDEO_FORMAT_AYUV, #GST_VIDEO_FORMAT_ARGB64 or
 314  * #GST_VIDEO_FORMAT_AYUV64 depending on the format to unpack.
 315  * @dest should at least be big enough to hold @width * bytes_per_pixel bytes
 316  * where bytes_per_pixel relates to the unpack format and will usually be
 317  * either 4 or 8 depending on the unpack format. bytes_per_pixel will be
 318  * the same as the pixel stride for plane 0 for the above formats.
 319  *
 320  * For subsampled formats, the components will be duplicated in the destination
 321  * array. Reconstruction of the missing components can be performed in a
 322  * separate step after unpacking.
 323  */
 324 typedef void (*GstVideoFormatUnpack)         (const GstVideoFormatInfo *info,
 325                                               GstVideoPackFlags flags, gpointer dest,
 326                                               const gpointer data[GST_VIDEO_MAX_PLANES],
 327                                               const gint stride[GST_VIDEO_MAX_PLANES],
 328                                               gint x, gint y, gint width);
 329 /**
 330  * GstVideoFormatPack:
 331  * @info: a #GstVideoFormatInfo
 332  * @flags: flags to control the packing
 333  * @src: a source array
 334  * @sstride: the source array stride
 335  * @data: pointers to the destination data planes
 336  * @stride: strides of the destination planes
 337  * @chroma_site: the chroma siting of the target when subsampled (not used)
 338  * @y: the y position in the image to pack to
 339  * @width: the amount of pixels to pack.
 340  *
 341  * Packs @width pixels from @src to the given planes and strides in the
 342  * format @info. The pixels from source have each component interleaved
 343  * and will be packed into the planes in @data.
 344  *
 345  * This function operates on pack_lines lines, meaning that @src should
 346  * contain at least pack_lines lines with a stride of @sstride and @y
 347  * should be a multiple of pack_lines.
 348  *
 349  * Subsampled formats will use the horizontally and vertically cosited
 350  * component from the source. Subsampling should be performed before
 351  * packing.
 352  *
 353  * Because this function does not have a x coordinate, it is not possible to
 354  * pack pixels starting from an unaligned position. For tiled images this
 355  * means that packing should start from a tile coordinate. For subsampled
 356  * formats this means that a complete pixel needs to be packed.
 357  */
 358 /* FIXME(2.0): remove the chroma_site, it is unused and is not relevant for
 359  * packing, chroma subsampling based on chroma-site should be done in a separate
 360  * step before packing*/
 361 typedef void (*GstVideoFormatPack)           (const GstVideoFormatInfo *info,
 362                                               GstVideoPackFlags flags,
 363                                               const gpointer src, gint sstride,
 364                                               gpointer data[GST_VIDEO_MAX_PLANES],
 365                                               const gint stride[GST_VIDEO_MAX_PLANES],
 366                                               GstVideoChromaSite chroma_site,
 367                                               gint y, gint width);
 368
 369 /**
 370  * GstVideoFormatInfo:
 371  * @format: #GstVideoFormat
 372  * @name: string representation of the format
 373  * @description: use readable description of the format
 374  * @flags: #GstVideoFormatFlags
 375  * @bits: The number of bits used to pack data items. This can be less than 8
 376  *    when multiple pixels are stored in a byte. for values > 8 multiple bytes
 377  *    should be read according to the endianness flag before applying the shift
 378  *    and mask.
 379  * @n_components: the number of components in the video format.
 380  * @shift: the number of bits to shift away to get the component data
 381  * @depth: the depth in bits for each component
 382  * @pixel_stride: the pixel stride of each component. This is the amount of
 383  *    bytes to the pixel immediately to the right. When bits < 8, the stride is
 384  *    expressed in bits. For 24-bit RGB, this would be 3 bytes, for example,
 385  *    while it would be 4 bytes for RGBx or ARGB.
 386  * @n_planes: the number of planes for this format. The number of planes can be
 387  *    less than the amount of components when multiple components are packed into
 388  *    one plane.
 389  * @plane: the plane number where a component can be found
 390  * @poffset: the offset in the plane where the first pixel of the components
 391  *    can be found.
 392  * @w_sub: subsampling factor of the width for the component. Use
 393  *     GST_VIDEO_SUB_SCALE to scale a width.
 394  * @h_sub: subsampling factor of the height for the component. Use
 395  *     GST_VIDEO_SUB_SCALE to scale a height.
 396  * @unpack_format: the format of the unpacked pixels. This format must have the
 397  *     #GST_VIDEO_FORMAT_FLAG_UNPACK flag set.
 398  * @unpack_func: an unpack function for this format
 399  * @pack_lines: the amount of lines that will be packed
 400  * @pack_func: an pack function for this format
 401  * @tile_mode: The tiling mode
 402  * @tile_ws: The width of a tile, in bytes, represented as a shift
 403  * @tile_hs: The height of a tile, in bytes, represented as a shift
 404  *
 405  * Information for a video format.
 406  */
 407 struct _GstVideoFormatInfo {
 408   GstVideoFormat format;
 409   const gchar *name;
 410   const gchar *description;
 411   GstVideoFormatFlags flags;
 412   guint bits;
 413   guint n_components;
 414   guint shift[GST_VIDEO_MAX_COMPONENTS];
 415   guint depth[GST_VIDEO_MAX_COMPONENTS];
 416   gint  pixel_stride[GST_VIDEO_MAX_COMPONENTS];
 417   guint n_planes;
 418   guint plane[GST_VIDEO_MAX_COMPONENTS];
 419   guint poffset[GST_VIDEO_MAX_COMPONENTS];
 420   guint w_sub[GST_VIDEO_MAX_COMPONENTS];
 421   guint h_sub[GST_VIDEO_MAX_COMPONENTS];
 422
 423   GstVideoFormat unpack_format;
 424   GstVideoFormatUnpack unpack_func;
 425   gint pack_lines;
 426   GstVideoFormatPack pack_func;
 427
 428   GstVideoTileMode tile_mode;
 429   guint tile_ws;
 430   guint tile_hs;
 431
 432   /*< private >*/
 433   gpointer _gst_reserved[GST_PADDING];
 434 };
 435
 436 #define GST_VIDEO_FORMAT_INFO_FORMAT(info)       ((info)->format)
 437 #define GST_VIDEO_FORMAT_INFO_NAME(info)         ((info)->name)
 438 #define GST_VIDEO_FORMAT_INFO_FLAGS(info)        ((info)->flags)
 439
 440 #define GST_VIDEO_FORMAT_INFO_IS_YUV(info)       ((info)->flags & GST_VIDEO_FORMAT_FLAG_YUV)
 441 #define GST_VIDEO_FORMAT_INFO_IS_RGB(info)       ((info)->flags & GST_VIDEO_FORMAT_FLAG_RGB)
 442 #define GST_VIDEO_FORMAT_INFO_IS_GRAY(info)      ((info)->flags & GST_VIDEO_FORMAT_FLAG_GRAY)
 443 #define GST_VIDEO_FORMAT_INFO_HAS_ALPHA(info)    ((info)->flags & GST_VIDEO_FORMAT_FLAG_ALPHA)
 444 #define GST_VIDEO_FORMAT_INFO_IS_LE(info)        ((info)->flags & GST_VIDEO_FORMAT_FLAG_LE)
 445 #define GST_VIDEO_FORMAT_INFO_HAS_PALETTE(info)  ((info)->flags & GST_VIDEO_FORMAT_FLAG_PALETTE)
 446 #define GST_VIDEO_FORMAT_INFO_IS_COMPLEX(info)   ((info)->flags & GST_VIDEO_FORMAT_FLAG_COMPLEX)
 447 #define GST_VIDEO_FORMAT_INFO_IS_TILED(info)     ((info)->flags & GST_VIDEO_FORMAT_FLAG_TILED)
 448
 449 #define GST_VIDEO_FORMAT_INFO_BITS(info)         ((info)->bits)
 450 #define GST_VIDEO_FORMAT_INFO_N_COMPONENTS(info) ((info)->n_components)
 451 #define GST_VIDEO_FORMAT_INFO_SHIFT(info,c)      ((info)->shift[c])
 452 #define GST_VIDEO_FORMAT_INFO_DEPTH(info,c)      ((info)->depth[c])
 453 /**
 454  * GST_VIDEO_FORMAT_INFO_PSTRIDE:
 455  * @info: a #GstVideoFormatInfo
 456  * @c: the component index
 457  *
 458  * pixel stride for the given component. This is the amount of bytes to the
 459  * pixel immediately to the right, so basically bytes from one pixel to the
 460  * next. When bits < 8, the stride is expressed in bits.
 461  *
 462  * Examples: for 24-bit RGB, the pixel stride would be 3 bytes, while it
 463  * would be 4 bytes for RGBx or ARGB, and 8 bytes for ARGB64 or AYUV64.
 464  * For planar formats such as I420 the pixel stride is usually 1. For
 465  * YUY2 it would be 2 bytes.
 466  */
 467 #define GST_VIDEO_FORMAT_INFO_PSTRIDE(info,c)    ((info)->pixel_stride[c])
 468 /**
 469  * GST_VIDEO_FORMAT_INFO_N_PLANES:
 470  * @info: a #GstVideoFormatInfo
 471  *
 472  * Number of planes. This is the number of planes the pixel layout is
 473  * organized in in memory. The number of planes can be less than the
 474  * number of components (e.g. Y,U,V,A or R, G, B, A) when multiple
 475  * components are packed into one plane.
 476  *
 477  * Examples: RGB/RGBx/RGBA: 1 plane, 3/3/4 components;
 478  * I420: 3 planes, 3 components; NV21/NV12: 2 planes, 3 components.
 479  */
 480 #define GST_VIDEO_FORMAT_INFO_N_PLANES(info)     ((info)->n_planes)
 481 /**
 482  * GST_VIDEO_FORMAT_INFO_PLANE:
 483  * @info: a #GstVideoFormatInfo
 484  * @c: the component index
 485  *
 486  * Plane number where the given component can be found. A plane may
 487  * contain data for multiple components.
 488  */
 489 #define GST_VIDEO_FORMAT_INFO_PLANE(info,c)      ((info)->plane[c])
 490 #define GST_VIDEO_FORMAT_INFO_POFFSET(info,c)    ((info)->poffset[c])
 491 #define GST_VIDEO_FORMAT_INFO_W_SUB(info,c)      ((info)->w_sub[c])
 492 #define GST_VIDEO_FORMAT_INFO_H_SUB(info,c)      ((info)->h_sub[c])
 493
 494 /* rounds up */
 495 #define GST_VIDEO_SUB_SCALE(scale,val)   (-((-((gint)(val)))>>(scale)))
 496
 497 #define GST_VIDEO_FORMAT_INFO_SCALE_WIDTH(info,c,w)  GST_VIDEO_SUB_SCALE ((info)->w_sub[c],(w))
 498 #define GST_VIDEO_FORMAT_INFO_SCALE_HEIGHT(info,c,h) GST_VIDEO_SUB_SCALE ((info)->h_sub[c],(h))
 499
 500 #define GST_VIDEO_FORMAT_INFO_DATA(info,planes,comp) \
 501   (((guint8*)(planes)[(info)->plane[comp]]) + (info)->poffset[comp])
 502 /**
 503  * GST_VIDEO_FORMAT_INFO_STRIDE:
 504  * @info: a #GstVideoFormatInfo
 505  * @strides: an array of strides
 506  * @comp: the component index
 507  *
 508  * Row stride in bytes, that is number of bytes from the first pixel component
 509  * of a row to the first pixel component in the next row. This might include
 510  * some row padding (memory not actually used for anything, to make sure the
 511  * beginning of the next row is aligned in a particular way).
 512  */
 513 #define GST_VIDEO_FORMAT_INFO_STRIDE(info,strides,comp) ((strides)[(info)->plane[comp]])
 514 #define GST_VIDEO_FORMAT_INFO_OFFSET(info,offsets,comp) \
 515   (((offsets)[(info)->plane[comp]]) + (info)->poffset[comp])
 516
 517 #define GST_VIDEO_FORMAT_INFO_TILE_MODE(info) ((info)->tile_mode)
 518 #define GST_VIDEO_FORMAT_INFO_TILE_WS(info) ((info)->tile_ws)
 519 #define GST_VIDEO_FORMAT_INFO_TILE_HS(info) ((info)->tile_hs)
 520
 521 GST_VIDEO_API
 522 void gst_video_format_info_component                  (const GstVideoFormatInfo *info, guint plane, gint components[GST_VIDEO_MAX_COMPONENTS]);
 523
 524 /* format properties */
 525
 526 GST_VIDEO_API
 527 GstVideoFormat gst_video_format_from_masks           (gint depth, gint bpp, gint endianness,
 528                                                       guint red_mask, guint green_mask,
 529                                                       guint blue_mask, guint alpha_mask) G_GNUC_CONST;
 530
 531 GST_VIDEO_API
 532 GstVideoFormat gst_video_format_from_fourcc          (guint32 fourcc) G_GNUC_CONST;
 533
 534 GST_VIDEO_API
 535 GstVideoFormat gst_video_format_from_string          (const gchar *format) G_GNUC_CONST;
 536
 537 GST_VIDEO_API
 538 guint32        gst_video_format_to_fourcc            (GstVideoFormat format) G_GNUC_CONST;
 539
 540 GST_VIDEO_API
 541 const gchar *  gst_video_format_to_string            (GstVideoFormat format) G_GNUC_CONST;
 542
 543 GST_VIDEO_API
 544 const GstVideoFormatInfo *
 545                gst_video_format_get_info             (GstVideoFormat format) G_GNUC_CONST;
 546
 547 GST_VIDEO_API
 548 gconstpointer  gst_video_format_get_palette          (GstVideoFormat format, gsize *size);
 549
 550 #define GST_VIDEO_SIZE_RANGE "(int) [ 1, max ]"
 551 #define GST_VIDEO_FPS_RANGE "(fraction) [ 0, max ]"
 552
 553 #if G_BYTE_ORDER == G_LITTLE_ENDIAN
 554 # define GST_VIDEO_NE(s) G_STRINGIFY(s)"_LE"
 555 # define GST_VIDEO_OE(s) G_STRINGIFY(s)"_BE"
 556 #else
 557 # define GST_VIDEO_NE(s) G_STRINGIFY(s)"_BE"
 558 # define GST_VIDEO_OE(s) G_STRINGIFY(s)"_LE"
 559 #endif
 560
 561 #define GST_VIDEO_FORMATS_ALL "{ I420, YV12, YUY2, UYVY, AYUV, VUYA, RGBx, "  \
 562   "BGRx, xRGB, xBGR, RGBA, BGRA, ARGB, ABGR, RGB, BGR, Y41B, Y42B, YVYU, " \
 563   "Y444, v210, v216, Y210, Y410, NV12, NV21, GRAY8, GRAY16_BE, GRAY16_LE, v308, RGB16, " \
 564   "BGR16, RGB15, BGR15, UYVP, A420, RGB8P, YUV9, YVU9, IYU1, ARGB64, " \
 565   "AYUV64, r210, I420_10BE, I420_10LE, I422_10BE, I422_10LE, Y444_10BE, " \
 566   "Y444_10LE, GBR, GBR_10BE, GBR_10LE, NV16, NV24, NV12_64Z32, A420_10BE, " \
 567   "A420_10LE, A422_10BE, A422_10LE, A444_10BE, A444_10LE, NV61, P010_10BE, " \
 568   "P010_10LE, IYU2, VYUY, GBRA, GBRA_10BE, GBRA_10LE, BGR10A2_LE, RGB10A2_LE, GBR_12BE, GBR_12LE, " \
 569   "GBRA_12BE, GBRA_12LE, I420_12BE, I420_12LE, I422_12BE, I422_12LE, " \
 570   "Y444_12BE, Y444_12LE, GRAY10_LE32, NV12_10LE32, NV16_10LE32, NV12_10LE40 }"
 571
 572 /**
 573  * GST_VIDEO_CAPS_MAKE:
 574  * @format: string format that describes the pixel layout, as string
 575  *     (e.g. "I420", "RGB", "YV12", "YUY2", "AYUV", etc.)
 576  *
 577  * Generic caps string for video, for use in pad templates.
 578  */
 579 #define GST_VIDEO_CAPS_MAKE(format)                                     \
 580     "video/x-raw, "                                                     \
 581     "format = (string) " format ", "                                    \
 582     "width = " GST_VIDEO_SIZE_RANGE ", "                                \
 583     "height = " GST_VIDEO_SIZE_RANGE ", "                               \
 584     "framerate = " GST_VIDEO_FPS_RANGE
 585
 586 /**
 587  * GST_VIDEO_CAPS_MAKE_WITH_FEATURES:
 588  * @format: string format that describes the pixel layout, as string
 589  *     (e.g. "I420", "RGB", "YV12", "YUY2", "AYUV", etc.)
 590  * @features: Requires caps features as a string, e.g.
 591  *     "memory:SystemMemory".
 592  *
 593  * Generic caps string for video, for use in pad templates.
 594  *
 595  * Since: 1.2
 596  */
 597 #define GST_VIDEO_CAPS_MAKE_WITH_FEATURES(features,format)              \
 598     "video/x-raw(" features "), "                                       \
 599     "format = (string) " format ", "                                    \
 600     "width = " GST_VIDEO_SIZE_RANGE ", "                                \
 601     "height = " GST_VIDEO_SIZE_RANGE ", "                               \
 602     "framerate = " GST_VIDEO_FPS_RANGE
 603
 604 G_END_DECLS
 605
 606 #endif /* __GST_VIDEO_FORMAT_H__ */