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