git.sesse.net Git - ffmpeg/blob - libavutil/pixdesc.h

   1 /*
   2  * pixel format descriptor
   3  * Copyright (c) 2009 Michael Niedermayer <michaelni@gmx.at>
   4  *
   5  * This file is part of FFmpeg.
   6  *
   7  * FFmpeg is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU Lesser General Public
   9  * License as published by the Free Software Foundation; either
  10  * version 2.1 of the License, or (at your option) any later version.
  11  *
  12  * FFmpeg is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * Lesser General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Lesser General Public
  18  * License along with FFmpeg; if not, write to the Free Software
  19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  20  */
  21
  22 #ifndef AVUTIL_PIXDESC_H
  23 #define AVUTIL_PIXDESC_H
  24
  25 #include <inttypes.h>
  26
  27 #include "attributes.h"
  28 #include "pixfmt.h"
  29 #include "version.h"
  30
  31 typedef struct AVComponentDescriptor {
  32     /**
  33      * Which of the 4 planes contains the component.
  34      */
  35     int plane;
  36
  37     /**
  38      * Number of elements between 2 horizontally consecutive pixels.
  39      * Elements are bits for bitstream formats, bytes otherwise.
  40      */
  41     int step;
  42
  43     /**
  44      * Number of elements before the component of the first pixel.
  45      * Elements are bits for bitstream formats, bytes otherwise.
  46      */
  47     int offset;
  48
  49     /**
  50      * Number of least significant bits that must be shifted away
  51      * to get the value.
  52      */
  53     int shift;
  54
  55     /**
  56      * Number of bits in the component.
  57      */
  58     int depth;
  59
  60 #if FF_API_PLUS1_MINUS1
  61     /** deprecated, use step instead */
  62     attribute_deprecated int step_minus1;
  63
  64     /** deprecated, use depth instead */
  65     attribute_deprecated int depth_minus1;
  66
  67     /** deprecated, use offset instead */
  68     attribute_deprecated int offset_plus1;
  69 #endif
  70 } AVComponentDescriptor;
  71
  72 /**
  73  * Descriptor that unambiguously describes how the bits of a pixel are
  74  * stored in the up to 4 data planes of an image. It also stores the
  75  * subsampling factors and number of components.
  76  *
  77  * @note This is separate of the colorspace (RGB, YCbCr, YPbPr, JPEG-style YUV
  78  *       and all the YUV variants) AVPixFmtDescriptor just stores how values
  79  *       are stored not what these values represent.
  80  */
  81 typedef struct AVPixFmtDescriptor {
  82     const char *name;
  83     uint8_t nb_components;  ///< The number of components each pixel has, (1-4)
  84
  85     /**
  86      * Amount to shift the luma width right to find the chroma width.
  87      * For YV12 this is 1 for example.
  88      * chroma_width = -((-luma_width) >> log2_chroma_w)
  89      * The note above is needed to ensure rounding up.
  90      * This value only refers to the chroma components.
  91      */
  92     uint8_t log2_chroma_w;  ///< chroma_width = -((-luma_width )>>log2_chroma_w)
  93
  94     /**
  95      * Amount to shift the luma height right to find the chroma height.
  96      * For YV12 this is 1 for example.
  97      * chroma_height= -((-luma_height) >> log2_chroma_h)
  98      * The note above is needed to ensure rounding up.
  99      * This value only refers to the chroma components.
 100      */
 101     uint8_t log2_chroma_h;
 102
 103     /**
 104      * Combination of AV_PIX_FMT_FLAG_... flags.
 105      */
 106     uint64_t flags;
 107
 108     /**
 109      * Parameters that describe how pixels are packed.
 110      * If the format has 2 or 4 components, then alpha is last.
 111      * If the format has 1 or 2 components, then luma is 0.
 112      * If the format has 3 or 4 components:
 113      *   if the RGB flag is set then 0 is red, 1 is green and 2 is blue;
 114      *   otherwise 0 is luma, 1 is chroma-U and 2 is chroma-V.
 115      */
 116     AVComponentDescriptor comp[4];
 117
 118     /**
 119      * Alternative comma-separated names.
 120      */
 121     const char *alias;
 122 } AVPixFmtDescriptor;
 123
 124 /**
 125  * Pixel format is big-endian.
 126  */
 127 #define AV_PIX_FMT_FLAG_BE           (1 << 0)
 128 /**
 129  * Pixel format has a palette in data[1], values are indexes in this palette.
 130  */
 131 #define AV_PIX_FMT_FLAG_PAL          (1 << 1)
 132 /**
 133  * All values of a component are bit-wise packed end to end.
 134  */
 135 #define AV_PIX_FMT_FLAG_BITSTREAM    (1 << 2)
 136 /**
 137  * Pixel format is an HW accelerated format.
 138  */
 139 #define AV_PIX_FMT_FLAG_HWACCEL      (1 << 3)
 140 /**
 141  * At least one pixel component is not in the first data plane.
 142  */
 143 #define AV_PIX_FMT_FLAG_PLANAR       (1 << 4)
 144 /**
 145  * The pixel format contains RGB-like data (as opposed to YUV/grayscale).
 146  */
 147 #define AV_PIX_FMT_FLAG_RGB          (1 << 5)
 148
 149 /**
 150  * The pixel format is "pseudo-paletted". This means that it contains a
 151  * fixed palette in the 2nd plane but the palette is fixed/constant for each
 152  * PIX_FMT. This allows interpreting the data as if it was PAL8, which can
 153  * in some cases be simpler. Or the data can be interpreted purely based on
 154  * the pixel format without using the palette.
 155  * An example of a pseudo-paletted format is AV_PIX_FMT_GRAY8
 156  */
 157 #define AV_PIX_FMT_FLAG_PSEUDOPAL    (1 << 6)
 158
 159 /**
 160  * The pixel format has an alpha channel. This is set on all formats that
 161  * support alpha in some way. The exception is AV_PIX_FMT_PAL8, which can
 162  * carry alpha as part of the palette. Details are explained in the
 163  * AVPixelFormat enum, and are also encoded in the corresponding
 164  * AVPixFmtDescriptor.
 165  *
 166  * The alpha is always straight, never pre-multiplied.
 167  *
 168  * If a codec or a filter does not support alpha, it should set all alpha to
 169  * opaque, or use the equivalent pixel formats without alpha component, e.g.
 170  * AV_PIX_FMT_RGB0 (or AV_PIX_FMT_RGB24 etc.) instead of AV_PIX_FMT_RGBA.
 171  */
 172 #define AV_PIX_FMT_FLAG_ALPHA        (1 << 7)
 173
 174 /**
 175  * Read a line from an image, and write the values of the
 176  * pixel format component c to dst.
 177  *
 178  * @param data the array containing the pointers to the planes of the image
 179  * @param linesize the array containing the linesizes of the image
 180  * @param desc the pixel format descriptor for the image
 181  * @param x the horizontal coordinate of the first pixel to read
 182  * @param y the vertical coordinate of the first pixel to read
 183  * @param w the width of the line to read, that is the number of
 184  * values to write to dst
 185  * @param read_pal_component if not zero and the format is a paletted
 186  * format writes the values corresponding to the palette
 187  * component c in data[1] to dst, rather than the palette indexes in
 188  * data[0]. The behavior is undefined if the format is not paletted.
 189  */
 190 void av_read_image_line(uint16_t *dst, const uint8_t *data[4],
 191                         const int linesize[4], const AVPixFmtDescriptor *desc,
 192                         int x, int y, int c, int w, int read_pal_component);
 193
 194 /**
 195  * Write the values from src to the pixel format component c of an
 196  * image line.
 197  *
 198  * @param src array containing the values to write
 199  * @param data the array containing the pointers to the planes of the
 200  * image to write into. It is supposed to be zeroed.
 201  * @param linesize the array containing the linesizes of the image
 202  * @param desc the pixel format descriptor for the image
 203  * @param x the horizontal coordinate of the first pixel to write
 204  * @param y the vertical coordinate of the first pixel to write
 205  * @param w the width of the line to write, that is the number of
 206  * values to write to the image line
 207  */
 208 void av_write_image_line(const uint16_t *src, uint8_t *data[4],
 209                          const int linesize[4], const AVPixFmtDescriptor *desc,
 210                          int x, int y, int c, int w);
 211
 212 /**
 213  * Return the pixel format corresponding to name.
 214  *
 215  * If there is no pixel format with name name, then looks for a
 216  * pixel format with the name corresponding to the native endian
 217  * format of name.
 218  * For example in a little-endian system, first looks for "gray16",
 219  * then for "gray16le".
 220  *
 221  * Finally if no pixel format has been found, returns AV_PIX_FMT_NONE.
 222  */
 223 enum AVPixelFormat av_get_pix_fmt(const char *name);
 224
 225 /**
 226  * Return the short name for a pixel format, NULL in case pix_fmt is
 227  * unknown.
 228  *
 229  * @see av_get_pix_fmt(), av_get_pix_fmt_string()
 230  */
 231 const char *av_get_pix_fmt_name(enum AVPixelFormat pix_fmt);
 232
 233 /**
 234  * Print in buf the string corresponding to the pixel format with
 235  * number pix_fmt, or a header if pix_fmt is negative.
 236  *
 237  * @param buf the buffer where to write the string
 238  * @param buf_size the size of buf
 239  * @param pix_fmt the number of the pixel format to print the
 240  * corresponding info string, or a negative value to print the
 241  * corresponding header.
 242  */
 243 char *av_get_pix_fmt_string(char *buf, int buf_size,
 244                             enum AVPixelFormat pix_fmt);
 245
 246 /**
 247  * Return the number of bits per pixel used by the pixel format
 248  * described by pixdesc. Note that this is not the same as the number
 249  * of bits per sample.
 250  *
 251  * The returned number of bits refers to the number of bits actually
 252  * used for storing the pixel information, that is padding bits are
 253  * not counted.
 254  */
 255 int av_get_bits_per_pixel(const AVPixFmtDescriptor *pixdesc);
 256
 257 /**
 258  * Return the number of bits per pixel for the pixel format
 259  * described by pixdesc, including any padding or unused bits.
 260  */
 261 int av_get_padded_bits_per_pixel(const AVPixFmtDescriptor *pixdesc);
 262
 263 /**
 264  * @return a pixel format descriptor for provided pixel format or NULL if
 265  * this pixel format is unknown.
 266  */
 267 const AVPixFmtDescriptor *av_pix_fmt_desc_get(enum AVPixelFormat pix_fmt);
 268
 269 /**
 270  * Iterate over all pixel format descriptors known to libavutil.
 271  *
 272  * @param prev previous descriptor. NULL to get the first descriptor.
 273  *
 274  * @return next descriptor or NULL after the last descriptor
 275  */
 276 const AVPixFmtDescriptor *av_pix_fmt_desc_next(const AVPixFmtDescriptor *prev);
 277
 278 /**
 279  * @return an AVPixelFormat id described by desc, or AV_PIX_FMT_NONE if desc
 280  * is not a valid pointer to a pixel format descriptor.
 281  */
 282 enum AVPixelFormat av_pix_fmt_desc_get_id(const AVPixFmtDescriptor *desc);
 283
 284 /**
 285  * Utility function to access log2_chroma_w log2_chroma_h from
 286  * the pixel format AVPixFmtDescriptor.
 287  *
 288  * See av_get_chroma_sub_sample() for a function that asserts a
 289  * valid pixel format instead of returning an error code.
 290  * Its recommended that you use avcodec_get_chroma_sub_sample unless
 291  * you do check the return code!
 292  *
 293  * @param[in]  pix_fmt the pixel format
 294  * @param[out] h_shift store log2_chroma_w
 295  * @param[out] v_shift store log2_chroma_h
 296  *
 297  * @return 0 on success, AVERROR(ENOSYS) on invalid or unknown pixel format
 298  */
 299 int av_pix_fmt_get_chroma_sub_sample(enum AVPixelFormat pix_fmt,
 300                                      int *h_shift, int *v_shift);
 301
 302 /**
 303  * @return number of planes in pix_fmt, a negative AVERROR if pix_fmt is not a
 304  * valid pixel format.
 305  */
 306 int av_pix_fmt_count_planes(enum AVPixelFormat pix_fmt);
 307
 308 /**
 309  * Utility function to swap the endianness of a pixel format.
 310  *
 311  * @param[in]  pix_fmt the pixel format
 312  *
 313  * @return pixel format with swapped endianness if it exists,
 314  * otherwise AV_PIX_FMT_NONE
 315  */
 316 enum AVPixelFormat av_pix_fmt_swap_endianness(enum AVPixelFormat pix_fmt);
 317
 318 #define FF_LOSS_RESOLUTION  0x0001 /**< loss due to resolution change */
 319 #define FF_LOSS_DEPTH       0x0002 /**< loss due to color depth change */
 320 #define FF_LOSS_COLORSPACE  0x0004 /**< loss due to color space conversion */
 321 #define FF_LOSS_ALPHA       0x0008 /**< loss of alpha bits */
 322 #define FF_LOSS_COLORQUANT  0x0010 /**< loss due to color quantization */
 323 #define FF_LOSS_CHROMA      0x0020 /**< loss of chroma (e.g. RGB to gray conversion) */
 324
 325 /**
 326  * Compute what kind of losses will occur when converting from one specific
 327  * pixel format to another.
 328  * When converting from one pixel format to another, information loss may occur.
 329  * For example, when converting from RGB24 to GRAY, the color information will
 330  * be lost. Similarly, other losses occur when converting from some formats to
 331  * other formats. These losses can involve loss of chroma, but also loss of
 332  * resolution, loss of color depth, loss due to the color space conversion, loss
 333  * of the alpha bits or loss due to color quantization.
 334  * av_get_fix_fmt_loss() informs you about the various types of losses
 335  * which will occur when converting from one pixel format to another.
 336  *
 337  * @param[in] dst_pix_fmt destination pixel format
 338  * @param[in] src_pix_fmt source pixel format
 339  * @param[in] has_alpha Whether the source pixel format alpha channel is used.
 340  * @return Combination of flags informing you what kind of losses will occur
 341  * (maximum loss for an invalid dst_pix_fmt).
 342  */
 343 int av_get_pix_fmt_loss(enum AVPixelFormat dst_pix_fmt,
 344                         enum AVPixelFormat src_pix_fmt,
 345                         int has_alpha);
 346
 347 /**
 348  * Compute what kind of losses will occur when converting from one specific
 349  * pixel format to another.
 350  * When converting from one pixel format to another, information loss may occur.
 351  * For example, when converting from RGB24 to GRAY, the color information will
 352  * be lost. Similarly, other losses occur when converting from some formats to
 353  * other formats. These losses can involve loss of chroma, but also loss of
 354  * resolution, loss of color depth, loss due to the color space conversion, loss
 355  * of the alpha bits or loss due to color quantization.
 356  * av_get_fix_fmt_loss() informs you about the various types of losses
 357  * which will occur when converting from one pixel format to another.
 358  *
 359  * @param[in] dst_pix_fmt destination pixel format
 360  * @param[in] src_pix_fmt source pixel format
 361  * @param[in] has_alpha Whether the source pixel format alpha channel is used.
 362  * @return Combination of flags informing you what kind of losses will occur
 363  * (maximum loss for an invalid dst_pix_fmt).
 364  */
 365 enum AVPixelFormat av_find_best_pix_fmt_of_2(enum AVPixelFormat dst_pix_fmt1, enum AVPixelFormat dst_pix_fmt2,
 366                                              enum AVPixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
 367
 368 /**
 369  * @return the name for provided color range or NULL if unknown.
 370  */
 371 const char *av_color_range_name(enum AVColorRange range);
 372
 373 /**
 374  * @return the name for provided color primaries or NULL if unknown.
 375  */
 376 const char *av_color_primaries_name(enum AVColorPrimaries primaries);
 377
 378 /**
 379  * @return the name for provided color transfer or NULL if unknown.
 380  */
 381 const char *av_color_transfer_name(enum AVColorTransferCharacteristic transfer);
 382
 383 /**
 384  * @return the name for provided color space or NULL if unknown.
 385  */
 386 const char *av_color_space_name(enum AVColorSpace space);
 387
 388 /**
 389  * @return the name for provided chroma location or NULL if unknown.
 390  */
 391 const char *av_chroma_location_name(enum AVChromaLocation location);
 392
 393 #endif /* AVUTIL_PIXDESC_H */