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