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 Libav.
   6  *
   7  * Libav 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  * Libav 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 Libav; 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
  30 typedef struct AVComponentDescriptor {
  31     /**
  32      * Which of the 4 planes contains the component.
  33      */
  34     uint16_t plane        : 2;
  35
  36     /**
  37      * Number of elements between 2 horizontally consecutive pixels minus 1.
  38      * Elements are bits for bitstream formats, bytes otherwise.
  39      */
  40     uint16_t step_minus1  : 3;
  41
  42     /**
  43      * Number of elements before the component of the first pixel plus 1.
  44      * Elements are bits for bitstream formats, bytes otherwise.
  45      */
  46     uint16_t offset_plus1 : 3;
  47
  48     /**
  49      * Number of least significant bits that must be shifted away
  50      * to get the value.
  51      */
  52     uint16_t shift        : 3;
  53
  54     /**
  55      * Number of bits in the component minus 1.
  56      */
  57     uint16_t depth_minus1 : 4;
  58 } AVComponentDescriptor;
  59
  60 /**
  61  * Descriptor that unambiguously describes how the bits of a pixel are
  62  * stored in the up to 4 data planes of an image. It also stores the
  63  * subsampling factors and number of components.
  64  *
  65  * @note This is separate of the colorspace (RGB, YCbCr, YPbPr, JPEG-style YUV
  66  *       and all the YUV variants) AVPixFmtDescriptor just stores how values
  67  *       are stored not what these values represent.
  68  */
  69 typedef struct AVPixFmtDescriptor {
  70     const char *name;
  71     uint8_t nb_components;  ///< The number of components each pixel has, (1-4)
  72
  73     /**
  74      * Amount to shift the luma width right to find the chroma width.
  75      * For YV12 this is 1 for example.
  76      * chroma_width = -((-luma_width) >> log2_chroma_w)
  77      * The note above is needed to ensure rounding up.
  78      * This value only refers to the chroma components.
  79      */
  80     uint8_t log2_chroma_w;  ///< chroma_width = -((-luma_width )>>log2_chroma_w)
  81
  82     /**
  83      * Amount to shift the luma height right to find the chroma height.
  84      * For YV12 this is 1 for example.
  85      * chroma_height= -((-luma_height) >> log2_chroma_h)
  86      * The note above is needed to ensure rounding up.
  87      * This value only refers to the chroma components.
  88      */
  89     uint8_t log2_chroma_h;
  90     uint8_t flags;
  91
  92     /**
  93      * Parameters that describe how pixels are packed. If the format
  94      * has chroma components, they must be stored in comp[1] and
  95      * comp[2].
  96      */
  97     AVComponentDescriptor comp[4];
  98 } AVPixFmtDescriptor;
  99
 100 /**
 101  * Pixel format is big-endian.
 102  */
 103 #define AV_PIX_FMT_FLAG_BE           (1 << 0)
 104 /**
 105  * Pixel format has a palette in data[1], values are indexes in this palette.
 106  */
 107 #define AV_PIX_FMT_FLAG_PAL          (1 << 1)
 108 /**
 109  * All values of a component are bit-wise packed end to end.
 110  */
 111 #define AV_PIX_FMT_FLAG_BITSTREAM    (1 << 2)
 112 /**
 113  * Pixel format is an HW accelerated format.
 114  */
 115 #define AV_PIX_FMT_FLAG_HWACCEL      (1 << 3)
 116 /**
 117  * At least one pixel component is not in the first data plane.
 118  */
 119 #define AV_PIX_FMT_FLAG_PLANAR       (1 << 4)
 120 /**
 121  * The pixel format contains RGB-like data (as opposed to YUV/grayscale).
 122  */
 123 #define AV_PIX_FMT_FLAG_RGB          (1 << 5)
 124 /**
 125  * The pixel format is "pseudo-paletted". This means that Libav treats it as
 126  * paletted internally, but the palette is generated by the decoder and is not
 127  * stored in the file.
 128  */
 129 #define AV_PIX_FMT_FLAG_PSEUDOPAL    (1 << 6)
 130 /**
 131  * The pixel format has an alpha channel.
 132  */
 133 #define AV_PIX_FMT_FLAG_ALPHA        (1 << 7)
 134
 135 #if FF_API_PIX_FMT
 136 /**
 137  * @deprecated use the AV_PIX_FMT_FLAG_* flags
 138  */
 139 #define PIX_FMT_BE        AV_PIX_FMT_FLAG_BE
 140 #define PIX_FMT_PAL       AV_PIX_FMT_FLAG_PAL
 141 #define PIX_FMT_BITSTREAM AV_PIX_FMT_FLAG_BITSTREAM
 142 #define PIX_FMT_HWACCEL   AV_PIX_FMT_FLAG_HWACCEL
 143 #define PIX_FMT_PLANAR    AV_PIX_FMT_FLAG_PLANAR
 144 #define PIX_FMT_RGB       AV_PIX_FMT_FLAG_RGB
 145 #define PIX_FMT_PSEUDOPAL AV_PIX_FMT_FLAG_PSEUDOPAL
 146 #define PIX_FMT_ALPHA     AV_PIX_FMT_FLAG_ALPHA
 147 #endif
 148
 149 #if FF_API_PIX_FMT_DESC
 150 /**
 151  * The array of all the pixel format descriptors.
 152  */
 153 extern attribute_deprecated const AVPixFmtDescriptor av_pix_fmt_descriptors[];
 154 #endif
 155
 156 /**
 157  * Read a line from an image, and write the values of the
 158  * pixel format component c to dst.
 159  *
 160  * @param data the array containing the pointers to the planes of the image
 161  * @param linesize the array containing the linesizes of the image
 162  * @param desc the pixel format descriptor for the image
 163  * @param x the horizontal coordinate of the first pixel to read
 164  * @param y the vertical coordinate of the first pixel to read
 165  * @param w the width of the line to read, that is the number of
 166  * values to write to dst
 167  * @param read_pal_component if not zero and the format is a paletted
 168  * format writes the values corresponding to the palette
 169  * component c in data[1] to dst, rather than the palette indexes in
 170  * data[0]. The behavior is undefined if the format is not paletted.
 171  */
 172 void av_read_image_line(uint16_t *dst, const uint8_t *data[4],
 173                         const int linesize[4], const AVPixFmtDescriptor *desc,
 174                         int x, int y, int c, int w, int read_pal_component);
 175
 176 /**
 177  * Write the values from src to the pixel format component c of an
 178  * image line.
 179  *
 180  * @param src array containing the values to write
 181  * @param data the array containing the pointers to the planes of the
 182  * image to write into. It is supposed to be zeroed.
 183  * @param linesize the array containing the linesizes of the image
 184  * @param desc the pixel format descriptor for the image
 185  * @param x the horizontal coordinate of the first pixel to write
 186  * @param y the vertical coordinate of the first pixel to write
 187  * @param w the width of the line to write, that is the number of
 188  * values to write to the image line
 189  */
 190 void av_write_image_line(const uint16_t *src, uint8_t *data[4],
 191                          const int linesize[4], const AVPixFmtDescriptor *desc,
 192                          int x, int y, int c, int w);
 193
 194 /**
 195  * Return the pixel format corresponding to name.
 196  *
 197  * If there is no pixel format with name name, then looks for a
 198  * pixel format with the name corresponding to the native endian
 199  * format of name.
 200  * For example in a little-endian system, first looks for "gray16",
 201  * then for "gray16le".
 202  *
 203  * Finally if no pixel format has been found, returns PIX_FMT_NONE.
 204  */
 205 enum AVPixelFormat av_get_pix_fmt(const char *name);
 206
 207 /**
 208  * Return the short name for a pixel format, NULL in case pix_fmt is
 209  * unknown.
 210  *
 211  * @see av_get_pix_fmt(), av_get_pix_fmt_string()
 212  */
 213 const char *av_get_pix_fmt_name(enum AVPixelFormat pix_fmt);
 214
 215 /**
 216  * Print in buf the string corresponding to the pixel format with
 217  * number pix_fmt, or an header if pix_fmt is negative.
 218  *
 219  * @param buf the buffer where to write the string
 220  * @param buf_size the size of buf
 221  * @param pix_fmt the number of the pixel format to print the
 222  * corresponding info string, or a negative value to print the
 223  * corresponding header.
 224  */
 225 char *av_get_pix_fmt_string(char *buf, int buf_size,
 226                             enum AVPixelFormat pix_fmt);
 227
 228 /**
 229  * Return the number of bits per pixel used by the pixel format
 230  * described by pixdesc. Note that this is not the same as the number
 231  * of bits per sample.
 232  *
 233  * The returned number of bits refers to the number of bits actually
 234  * used for storing the pixel information, that is padding bits are
 235  * not counted.
 236  */
 237 int av_get_bits_per_pixel(const AVPixFmtDescriptor *pixdesc);
 238
 239 /**
 240  * @return a pixel format descriptor for provided pixel format or NULL if
 241  * this pixel format is unknown.
 242  */
 243 const AVPixFmtDescriptor *av_pix_fmt_desc_get(enum AVPixelFormat pix_fmt);
 244
 245 /**
 246  * Iterate over all pixel format descriptors known to libavutil.
 247  *
 248  * @param prev previous descriptor. NULL to get the first descriptor.
 249  *
 250  * @return next descriptor or NULL after the last descriptor
 251  */
 252 const AVPixFmtDescriptor *av_pix_fmt_desc_next(const AVPixFmtDescriptor *prev);
 253
 254 /**
 255  * @return an AVPixelFormat id described by desc, or AV_PIX_FMT_NONE if desc
 256  * is not a valid pointer to a pixel format descriptor.
 257  */
 258 enum AVPixelFormat av_pix_fmt_desc_get_id(const AVPixFmtDescriptor *desc);
 259
 260 /**
 261  * Utility function to access log2_chroma_w log2_chroma_h from
 262  * the pixel format AVPixFmtDescriptor.
 263  *
 264  * @param[in]  pix_fmt the pixel format
 265  * @param[out] h_shift store log2_chroma_h
 266  * @param[out] v_shift store log2_chroma_w
 267  *
 268  * @return 0 on success, AVERROR(ENOSYS) on invalid or unknown pixel format
 269  */
 270 int av_pix_fmt_get_chroma_sub_sample(enum AVPixelFormat pix_fmt,
 271                                      int *h_shift, int *v_shift);
 272
 273 /**
 274  * @return number of planes in pix_fmt, a negative AVERROR if pix_fmt is not a
 275  * valid pixel format.
 276  */
 277 int av_pix_fmt_count_planes(enum AVPixelFormat pix_fmt);
 278
 279 /**
 280  * Utility function to swap the endianness of a pixel format.
 281  *
 282  * @param[in]  pix_fmt the pixel format
 283  *
 284  * @return pixel format with swapped endianness if it exists,
 285  * otherwise AV_PIX_FMT_NONE
 286  */
 287 enum AVPixelFormat av_pix_fmt_swap_endianness(enum AVPixelFormat pix_fmt);
 288
 289 #endif /* AVUTIL_PIXDESC_H */