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 "pixfmt.h"
  26 #include <inttypes.h>
  27 #include "pixfmt.h"
  28
  29 typedef struct AVComponentDescriptor{
  30     uint16_t plane        :2;            ///< which of the 4 planes contains the component
  31
  32     /**
  33      * Number of elements between 2 horizontally consecutive pixels minus 1.
  34      * Elements are bits for bitstream formats, bytes otherwise.
  35      */
  36     uint16_t step_minus1  :3;
  37
  38     /**
  39      * Number of elements before the component of the first pixel plus 1.
  40      * Elements are bits for bitstream formats, bytes otherwise.
  41      */
  42     uint16_t offset_plus1 :3;
  43     uint16_t shift        :3;            ///< number of least significant bits that must be shifted away to get the value
  44     uint16_t depth_minus1 :4;            ///< number of bits in the component minus 1
  45 }AVComponentDescriptor;
  46
  47 /**
  48  * Descriptor that unambiguously describes how the bits of a pixel are
  49  * stored in the up to 4 data planes of an image. It also stores the
  50  * subsampling factors and number of components.
  51  *
  52  * @note This is separate of the colorspace (RGB, YCbCr, YPbPr, JPEG-style YUV
  53  *       and all the YUV variants) AVPixFmtDescriptor just stores how values
  54  *       are stored not what these values represent.
  55  */
  56 typedef struct AVPixFmtDescriptor{
  57     const char *name;
  58     uint8_t nb_components;      ///< The number of components each pixel has, (1-4)
  59
  60     /**
  61      * Amount to shift the luma width right to find the chroma width.
  62      * For YV12 this is 1 for example.
  63      * chroma_width = -((-luma_width) >> log2_chroma_w)
  64      * The note above is needed to ensure rounding up.
  65      * This value only refers to the chroma components.
  66      */
  67     uint8_t log2_chroma_w;      ///< chroma_width = -((-luma_width )>>log2_chroma_w)
  68
  69     /**
  70      * Amount to shift the luma height right to find the chroma height.
  71      * For YV12 this is 1 for example.
  72      * chroma_height= -((-luma_height) >> log2_chroma_h)
  73      * The note above is needed to ensure rounding up.
  74      * This value only refers to the chroma components.
  75      */
  76     uint8_t log2_chroma_h;
  77     uint8_t flags;
  78
  79     /**
  80      * Parameters that describe how pixels are packed. If the format
  81      * has chroma components, they must be stored in comp[1] and
  82      * comp[2].
  83      */
  84     AVComponentDescriptor comp[4];
  85 }AVPixFmtDescriptor;
  86
  87 #define PIX_FMT_BE        1 ///< Pixel format is big-endian.
  88 #define PIX_FMT_PAL       2 ///< Pixel format has a palette in data[1], values are indexes in this palette.
  89 #define PIX_FMT_BITSTREAM 4 ///< All values of a component are bit-wise packed end to end.
  90 #define PIX_FMT_HWACCEL   8 ///< Pixel format is an HW accelerated format.
  91
  92 /**
  93  * The array of all the pixel format descriptors.
  94  */
  95 extern const AVPixFmtDescriptor av_pix_fmt_descriptors[];
  96
  97 /**
  98  * Read a line from an image, and write the values of the
  99  * pixel format component c to dst.
 100  *
 101  * @param data the array containing the pointers to the planes of the image
 102  * @param linesize the array containing the linesizes of the image
 103  * @param desc the pixel format descriptor for the image
 104  * @param x the horizontal coordinate of the first pixel to read
 105  * @param y the vertical coordinate of the first pixel to read
 106  * @param w the width of the line to read, that is the number of
 107  * values to write to dst
 108  * @param read_pal_component if not zero and the format is a paletted
 109  * format writes the values corresponding to the palette
 110  * component c in data[1] to dst, rather than the palette indexes in
 111  * data[0]. The behavior is undefined if the format is not paletted.
 112  */
 113 void av_read_image_line(uint16_t *dst, const uint8_t *data[4], const int linesize[4],
 114                         const AVPixFmtDescriptor *desc, int x, int y, int c, int w, int read_pal_component);
 115
 116 /**
 117  * Write the values from src to the pixel format component c of an
 118  * image line.
 119  *
 120  * @param src array containing the values to write
 121  * @param data the array containing the pointers to the planes of the
 122  * image to write into. It is supposed to be zeroed.
 123  * @param linesize the array containing the linesizes of the image
 124  * @param desc the pixel format descriptor for the image
 125  * @param x the horizontal coordinate of the first pixel to write
 126  * @param y the vertical coordinate of the first pixel to write
 127  * @param w the width of the line to write, that is the number of
 128  * values to write to the image line
 129  */
 130 void av_write_image_line(const uint16_t *src, uint8_t *data[4], const int linesize[4],
 131                          const AVPixFmtDescriptor *desc, int x, int y, int c, int w);
 132
 133 /**
 134  * Return the pixel format corresponding to name.
 135  *
 136  * If there is no pixel format with name name, then looks for a
 137  * pixel format with the name corresponding to the native endian
 138  * format of name.
 139  * For example in a little-endian system, first looks for "gray16",
 140  * then for "gray16le".
 141  *
 142  * Finally if no pixel format has been found, returns PIX_FMT_NONE.
 143  */
 144 enum PixelFormat av_get_pix_fmt(const char *name);
 145
 146 /**
 147  * Return the short name for a pixel format, NULL in case pix_fmt is
 148  * unknown.
 149  *
 150  * @see av_get_pix_fmt(), av_get_pix_fmt_string()
 151  */
 152 const char *av_get_pix_fmt_name(enum PixelFormat pix_fmt);
 153
 154 /**
 155  * Print in buf the string corresponding to the pixel format with
 156  * number pix_fmt, or an header if pix_fmt is negative.
 157  *
 158  * @param buf the buffer where to write the string
 159  * @param buf_size the size of buf
 160  * @param pix_fmt the number of the pixel format to print the
 161  * corresponding info string, or a negative value to print the
 162  * corresponding header.
 163  */
 164 char *av_get_pix_fmt_string (char *buf, int buf_size, enum PixelFormat pix_fmt);
 165
 166 /**
 167  * Return the number of bits per pixel used by the pixel format
 168  * described by pixdesc.
 169  *
 170  * The returned number of bits refers to the number of bits actually
 171  * used for storing the pixel information, that is padding bits are
 172  * not counted.
 173  */
 174 int av_get_bits_per_pixel(const AVPixFmtDescriptor *pixdesc);
 175
 176 #endif /* AVUTIL_PIXDESC_H */