Mercurial > libavutil.hg
annotate pixdesc.h @ 961:64a8e85b50be libavutil
Improve GET_UTF{8,16} documentation
author | mru |
---|---|
date | Wed, 30 Jun 2010 20:09:48 +0000 |
parents | e34e8d654ded |
children | 8b14bef3cce2 |
rev | line source |
---|---|
781 | 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 typedef struct AVComponentDescriptor{ | |
28 uint16_t plane :2; ///< which of the 4 planes contains the component | |
29 | |
30 /** | |
31 * Number of elements between 2 horizontally consecutive pixels minus 1. | |
32 * Elements are bits for bitstream formats, bytes otherwise. | |
33 */ | |
34 uint16_t step_minus1 :3; | |
35 | |
36 /** | |
37 * Number of elements before the component of the first pixel plus 1. | |
38 * Elements are bits for bitstream formats, bytes otherwise. | |
39 */ | |
40 uint16_t offset_plus1 :3; | |
41 uint16_t shift :3; ///< number of least significant bits that must be shifted away to get the value | |
42 uint16_t depth_minus1 :4; ///< number of bits in the component minus 1 | |
43 }AVComponentDescriptor; | |
44 | |
45 /** | |
46 * Descriptor that unambiguously describes how the bits of a pixel are | |
47 * stored in the up to 4 data planes of an image. It also stores the | |
48 * subsampling factors and number of components. | |
49 * | |
50 * @note This is separate of the colorspace (RGB, YCbCr, YPbPr, JPEG-style YUV | |
51 * and all the YUV variants) AVPixFmtDescriptor just stores how values | |
52 * are stored not what these values represent. | |
53 */ | |
54 typedef struct AVPixFmtDescriptor{ | |
55 const char *name; | |
791
ecf67bd079fe
Rename AVPixFmtDescriptor.nb_channels to nb_components, the new name
stefano
parents:
781
diff
changeset
|
56 uint8_t nb_components; ///< The number of components each pixel has, (1-4) |
781 | 57 |
58 /** | |
59 * Amount to shift the luma width right to find the chroma width. | |
60 * For YV12 this is 1 for example. | |
61 * chroma_width = -((-luma_width) >> log2_chroma_w) | |
62 * The note above is needed to ensure rounding up. | |
793
9072135121e0
Clarify relations between log2_chroma_w, log2_chroma_h and comp.
stefano
parents:
791
diff
changeset
|
63 * This value only refers to the chroma components. |
781 | 64 */ |
65 uint8_t log2_chroma_w; ///< chroma_width = -((-luma_width )>>log2_chroma_w) | |
66 | |
67 /** | |
68 * Amount to shift the luma height right to find the chroma height. | |
69 * For YV12 this is 1 for example. | |
70 * chroma_height= -((-luma_height) >> log2_chroma_h) | |
71 * The note above is needed to ensure rounding up. | |
793
9072135121e0
Clarify relations between log2_chroma_w, log2_chroma_h and comp.
stefano
parents:
791
diff
changeset
|
72 * This value only refers to the chroma components. |
781 | 73 */ |
74 uint8_t log2_chroma_h; | |
75 uint8_t flags; | |
793
9072135121e0
Clarify relations between log2_chroma_w, log2_chroma_h and comp.
stefano
parents:
791
diff
changeset
|
76 |
9072135121e0
Clarify relations between log2_chroma_w, log2_chroma_h and comp.
stefano
parents:
791
diff
changeset
|
77 /** |
9072135121e0
Clarify relations between log2_chroma_w, log2_chroma_h and comp.
stefano
parents:
791
diff
changeset
|
78 * Parameters that describe how pixels are packed. If the format |
9072135121e0
Clarify relations between log2_chroma_w, log2_chroma_h and comp.
stefano
parents:
791
diff
changeset
|
79 * has chroma components, they must be stored in comp[1] and |
9072135121e0
Clarify relations between log2_chroma_w, log2_chroma_h and comp.
stefano
parents:
791
diff
changeset
|
80 * comp[2]. |
9072135121e0
Clarify relations between log2_chroma_w, log2_chroma_h and comp.
stefano
parents:
791
diff
changeset
|
81 */ |
9072135121e0
Clarify relations between log2_chroma_w, log2_chroma_h and comp.
stefano
parents:
791
diff
changeset
|
82 AVComponentDescriptor comp[4]; |
781 | 83 }AVPixFmtDescriptor; |
84 | |
794
7044a7c771b6
Clarify PIX_FMT_BE flag doxy. Increase consistency / pickiness.
stefano
parents:
793
diff
changeset
|
85 #define PIX_FMT_BE 1 ///< Pixel format is big-endian. |
781 | 86 #define PIX_FMT_PAL 2 ///< Pixel format has a palette in data[1], values are indexes in this palette. |
87 #define PIX_FMT_BITSTREAM 4 ///< All values of a component are bit-wise packed end to end. | |
88 #define PIX_FMT_HWACCEL 8 ///< Pixel format is an HW accelerated format. | |
89 | |
90 /** | |
91 * The array of all the pixel format descriptors. | |
92 */ | |
93 extern const AVPixFmtDescriptor av_pix_fmt_descriptors[]; | |
94 | |
95 /** | |
957 | 96 * Read a line from an image, and write the values of the |
829
bd84e0b5d422
Fix grammar: write to DST THING -> write THING to DST.
stefano
parents:
827
diff
changeset
|
97 * pixel format component c to dst. |
781 | 98 * |
99 * @param data the array containing the pointers to the planes of the image | |
100 * @param linesizes the array containing the linesizes of the image | |
101 * @param desc the pixel format descriptor for the image | |
102 * @param x the horizontal coordinate of the first pixel to read | |
103 * @param y the vertical coordinate of the first pixel to read | |
104 * @param w the width of the line to read, that is the number of | |
105 * values to write to dst | |
106 * @param read_pal_component if not zero and the format is a paletted | |
829
bd84e0b5d422
Fix grammar: write to DST THING -> write THING to DST.
stefano
parents:
827
diff
changeset
|
107 * format writes the values corresponding to the palette |
bd84e0b5d422
Fix grammar: write to DST THING -> write THING to DST.
stefano
parents:
827
diff
changeset
|
108 * component c in data[1] to dst, rather than the palette indexes in |
781 | 109 * data[0]. The behavior is undefined if the format is not paletted. |
110 */ | |
836
af688c6fa72f
Move read_line() and write_line() definition from pixdesc.h to
stefano
parents:
829
diff
changeset
|
111 void read_line(uint16_t *dst, const uint8_t *data[4], const int linesize[4], |
af688c6fa72f
Move read_line() and write_line() definition from pixdesc.h to
stefano
parents:
829
diff
changeset
|
112 const AVPixFmtDescriptor *desc, int x, int y, int c, int w, int read_pal_component); |
781 | 113 |
114 /** | |
957 | 115 * Write the values from src to the pixel format component c of an |
781 | 116 * image line. |
117 * | |
118 * @param src array containing the values to write | |
119 * @param data the array containing the pointers to the planes of the | |
120 * image to write into. It is supposed to be zeroed. | |
121 * @param linesizes the array containing the linesizes of the image | |
122 * @param desc the pixel format descriptor for the image | |
123 * @param x the horizontal coordinate of the first pixel to write | |
124 * @param y the vertical coordinate of the first pixel to write | |
125 * @param w the width of the line to write, that is the number of | |
126 * values to write to the image line | |
127 */ | |
836
af688c6fa72f
Move read_line() and write_line() definition from pixdesc.h to
stefano
parents:
829
diff
changeset
|
128 void write_line(const uint16_t *src, uint8_t *data[4], const int linesize[4], |
af688c6fa72f
Move read_line() and write_line() definition from pixdesc.h to
stefano
parents:
829
diff
changeset
|
129 const AVPixFmtDescriptor *desc, int x, int y, int c, int w); |
781 | 130 |
131 /** | |
957 | 132 * Return the pixel format corresponding to name. |
827
f01765adeb5c
Implement av_get_pix_fmt(), and deprecate avcodec_get_pix_fmt().
stefano
parents:
794
diff
changeset
|
133 * |
f01765adeb5c
Implement av_get_pix_fmt(), and deprecate avcodec_get_pix_fmt().
stefano
parents:
794
diff
changeset
|
134 * If there is no pixel format with name name, then looks for a |
f01765adeb5c
Implement av_get_pix_fmt(), and deprecate avcodec_get_pix_fmt().
stefano
parents:
794
diff
changeset
|
135 * pixel format with the name corresponding to the native endian |
f01765adeb5c
Implement av_get_pix_fmt(), and deprecate avcodec_get_pix_fmt().
stefano
parents:
794
diff
changeset
|
136 * format of name. |
f01765adeb5c
Implement av_get_pix_fmt(), and deprecate avcodec_get_pix_fmt().
stefano
parents:
794
diff
changeset
|
137 * For example in a little-endian system, first looks for "gray16", |
f01765adeb5c
Implement av_get_pix_fmt(), and deprecate avcodec_get_pix_fmt().
stefano
parents:
794
diff
changeset
|
138 * then for "gray16le". |
f01765adeb5c
Implement av_get_pix_fmt(), and deprecate avcodec_get_pix_fmt().
stefano
parents:
794
diff
changeset
|
139 * |
f01765adeb5c
Implement av_get_pix_fmt(), and deprecate avcodec_get_pix_fmt().
stefano
parents:
794
diff
changeset
|
140 * Finally if no pixel format has been found, returns PIX_FMT_NONE. |
f01765adeb5c
Implement av_get_pix_fmt(), and deprecate avcodec_get_pix_fmt().
stefano
parents:
794
diff
changeset
|
141 */ |
f01765adeb5c
Implement av_get_pix_fmt(), and deprecate avcodec_get_pix_fmt().
stefano
parents:
794
diff
changeset
|
142 enum PixelFormat av_get_pix_fmt(const char *name); |
f01765adeb5c
Implement av_get_pix_fmt(), and deprecate avcodec_get_pix_fmt().
stefano
parents:
794
diff
changeset
|
143 |
f01765adeb5c
Implement av_get_pix_fmt(), and deprecate avcodec_get_pix_fmt().
stefano
parents:
794
diff
changeset
|
144 /** |
957 | 145 * Return the number of bits per pixel used by the pixel format |
781 | 146 * described by pixdesc. |
147 * | |
148 * The returned number of bits refers to the number of bits actually | |
149 * used for storing the pixel information, that is padding bits are | |
150 * not counted. | |
151 */ | |
152 int av_get_bits_per_pixel(const AVPixFmtDescriptor *pixdesc); | |
153 | |
154 #endif /* AVUTIL_PIXDESC_H */ |