Fix planarCopy to ignore the GRAY8 "pseudo"-palette, fixes libavtest regression test.
[mplayer/glamo.git] / libmpcodecs / mp_image.h
blobddf52c71c59fe5cb9a6e13a3359461798e24e16c
1 #ifndef MPLAYER_MP_IMAGE_H
2 #define MPLAYER_MP_IMAGE_H
4 #include <stdio.h>
5 #include <stdlib.h>
6 #include <string.h>
7 #include "mp_msg.h"
9 //--------- codec's requirements (filled by the codec/vf) ---------
11 //--- buffer content restrictions:
12 // set if buffer content shouldn't be modified:
13 #define MP_IMGFLAG_PRESERVE 0x01
14 // set if buffer content will be READ for next frame's MC: (I/P mpeg frames)
15 #define MP_IMGFLAG_READABLE 0x02
17 //--- buffer width/stride/plane restrictions: (used for direct rendering)
18 // stride _have_to_ be aligned to MB boundary: [for DR restrictions]
19 #define MP_IMGFLAG_ACCEPT_ALIGNED_STRIDE 0x4
20 // stride should be aligned to MB boundary: [for buffer allocation]
21 #define MP_IMGFLAG_PREFER_ALIGNED_STRIDE 0x8
22 // codec accept any stride (>=width):
23 #define MP_IMGFLAG_ACCEPT_STRIDE 0x10
24 // codec accept any width (width*bpp=stride -> stride%bpp==0) (>=width):
25 #define MP_IMGFLAG_ACCEPT_WIDTH 0x20
26 //--- for planar formats only:
27 // uses only stride[0], and stride[1]=stride[2]=stride[0]>>mpi->chroma_x_shift
28 #define MP_IMGFLAG_COMMON_STRIDE 0x40
29 // uses only planes[0], and calculates planes[1,2] from width,height,imgfmt
30 #define MP_IMGFLAG_COMMON_PLANE 0x80
32 #define MP_IMGFLAGMASK_RESTRICTIONS 0xFF
34 //--------- color info (filled by mp_image_setfmt() ) -----------
35 // set if number of planes > 1
36 #define MP_IMGFLAG_PLANAR 0x100
37 // set if it's YUV colorspace
38 #define MP_IMGFLAG_YUV 0x200
39 // set if it's swapped (BGR or YVU) plane/byteorder
40 #define MP_IMGFLAG_SWAPPED 0x400
41 // using palette for RGB data
42 #define MP_IMGFLAG_RGB_PALETTE 0x800
44 #define MP_IMGFLAGMASK_COLORS 0xF00
46 // codec uses drawing/rendering callbacks (draw_slice()-like thing, DR method 2)
47 // [the codec will set this flag if it supports callbacks, and the vo _may_
48 // clear it in get_image() if draw_slice() not implemented]
49 #define MP_IMGFLAG_DRAW_CALLBACK 0x1000
50 // set if it's in video buffer/memory: [set by vo/vf's get_image() !!!]
51 #define MP_IMGFLAG_DIRECT 0x2000
52 // set if buffer is allocated (used in destination images):
53 #define MP_IMGFLAG_ALLOCATED 0x4000
55 // buffer type was printed (do NOT set this flag - it's for INTERNAL USE!!!)
56 #define MP_IMGFLAG_TYPE_DISPLAYED 0x8000
58 // codec doesn't support any form of direct rendering - it has own buffer
59 // allocation. so we just export its buffer pointers:
60 #define MP_IMGTYPE_EXPORT 0
61 // codec requires a static WO buffer, but it does only partial updates later:
62 #define MP_IMGTYPE_STATIC 1
63 // codec just needs some WO memory, where it writes/copies the whole frame to:
64 #define MP_IMGTYPE_TEMP 2
65 // I+P type, requires 2+ independent static R/W buffers
66 #define MP_IMGTYPE_IP 3
67 // I+P+B type, requires 2+ independent static R/W and 1+ temp WO buffers
68 #define MP_IMGTYPE_IPB 4
69 // Upper 16 bits give desired buffer number, -1 means get next available
70 #define MP_IMGTYPE_NUMBERED 5
72 #define MP_MAX_PLANES 4
74 #define MP_IMGFIELD_ORDERED 0x01
75 #define MP_IMGFIELD_TOP_FIRST 0x02
76 #define MP_IMGFIELD_REPEAT_FIRST 0x04
77 #define MP_IMGFIELD_TOP 0x08
78 #define MP_IMGFIELD_BOTTOM 0x10
79 #define MP_IMGFIELD_INTERLACED 0x20
81 typedef struct mp_image_s {
82 unsigned int flags;
83 unsigned char type;
84 int number;
85 unsigned char bpp; // bits/pixel. NOT depth! for RGB it will be n*8
86 unsigned int imgfmt;
87 int width,height; // stored dimensions
88 int x,y,w,h; // visible dimensions
89 unsigned char* planes[MP_MAX_PLANES];
90 int stride[MP_MAX_PLANES];
91 char * qscale;
92 int qstride;
93 int pict_type; // 0->unknown, 1->I, 2->P, 3->B
94 int fields;
95 int qscale_type; // 0->mpeg1/4/h263, 1->mpeg2
96 int num_planes;
97 /* these are only used by planar formats Y,U(Cb),V(Cr) */
98 int chroma_width;
99 int chroma_height;
100 int chroma_x_shift; // horizontal
101 int chroma_y_shift; // vertical
102 int usage_count;
103 /* for private use by filter or vo driver (to store buffer id or dmpi) */
104 void* priv;
105 } mp_image_t;
107 #ifdef IMGFMT_YUY2
108 static inline void mp_image_setfmt(mp_image_t* mpi,unsigned int out_fmt){
109 mpi->flags&=~(MP_IMGFLAG_PLANAR|MP_IMGFLAG_YUV|MP_IMGFLAG_SWAPPED);
110 mpi->imgfmt=out_fmt;
111 // compressed formats
112 if(out_fmt == IMGFMT_MPEGPES ||
113 out_fmt == IMGFMT_ZRMJPEGNI || out_fmt == IMGFMT_ZRMJPEGIT || out_fmt == IMGFMT_ZRMJPEGIB ||
114 IMGFMT_IS_VDPAU(out_fmt) || IMGFMT_IS_XVMC(out_fmt)){
115 mpi->bpp=0;
116 return;
118 mpi->num_planes=1;
119 if (IMGFMT_IS_RGB(out_fmt)) {
120 if (IMGFMT_RGB_DEPTH(out_fmt) < 8 && !(out_fmt&128))
121 mpi->bpp = IMGFMT_RGB_DEPTH(out_fmt);
122 else
123 mpi->bpp=(IMGFMT_RGB_DEPTH(out_fmt)+7)&(~7);
124 return;
126 if (IMGFMT_IS_BGR(out_fmt)) {
127 if (IMGFMT_BGR_DEPTH(out_fmt) < 8 && !(out_fmt&128))
128 mpi->bpp = IMGFMT_BGR_DEPTH(out_fmt);
129 else
130 mpi->bpp=(IMGFMT_BGR_DEPTH(out_fmt)+7)&(~7);
131 mpi->flags|=MP_IMGFLAG_SWAPPED;
132 return;
134 mpi->flags|=MP_IMGFLAG_YUV;
135 mpi->num_planes=3;
136 switch(out_fmt){
137 case IMGFMT_I420:
138 case IMGFMT_IYUV:
139 mpi->flags|=MP_IMGFLAG_SWAPPED;
140 case IMGFMT_YV12:
141 mpi->flags|=MP_IMGFLAG_PLANAR;
142 mpi->bpp=12;
143 mpi->chroma_width=(mpi->width>>1);
144 mpi->chroma_height=(mpi->height>>1);
145 mpi->chroma_x_shift=1;
146 mpi->chroma_y_shift=1;
147 return;
148 case IMGFMT_IF09:
149 mpi->num_planes=4;
150 case IMGFMT_YVU9:
151 mpi->flags|=MP_IMGFLAG_PLANAR;
152 mpi->bpp=9;
153 mpi->chroma_width=(mpi->width>>2);
154 mpi->chroma_height=(mpi->height>>2);
155 mpi->chroma_x_shift=2;
156 mpi->chroma_y_shift=2;
157 return;
158 case IMGFMT_444P:
159 mpi->flags|=MP_IMGFLAG_PLANAR;
160 mpi->bpp=24;
161 mpi->chroma_width=(mpi->width);
162 mpi->chroma_height=(mpi->height);
163 mpi->chroma_x_shift=0;
164 mpi->chroma_y_shift=0;
165 return;
166 case IMGFMT_422P:
167 mpi->flags|=MP_IMGFLAG_PLANAR;
168 mpi->bpp=16;
169 mpi->chroma_width=(mpi->width>>1);
170 mpi->chroma_height=(mpi->height);
171 mpi->chroma_x_shift=1;
172 mpi->chroma_y_shift=0;
173 return;
174 case IMGFMT_411P:
175 mpi->flags|=MP_IMGFLAG_PLANAR;
176 mpi->bpp=12;
177 mpi->chroma_width=(mpi->width>>2);
178 mpi->chroma_height=(mpi->height);
179 mpi->chroma_x_shift=2;
180 mpi->chroma_y_shift=0;
181 return;
182 case IMGFMT_Y800:
183 case IMGFMT_Y8:
184 /* they're planar ones, but for easier handling use them as packed */
185 // mpi->flags|=MP_IMGFLAG_PLANAR;
186 mpi->bpp=8;
187 mpi->num_planes=1;
188 return;
189 case IMGFMT_UYVY:
190 mpi->flags|=MP_IMGFLAG_SWAPPED;
191 case IMGFMT_YUY2:
192 mpi->bpp=16;
193 mpi->num_planes=1;
194 return;
195 case IMGFMT_NV12:
196 mpi->flags|=MP_IMGFLAG_SWAPPED;
197 case IMGFMT_NV21:
198 mpi->flags|=MP_IMGFLAG_PLANAR;
199 mpi->bpp=12;
200 mpi->num_planes=2;
201 mpi->chroma_width=(mpi->width>>0);
202 mpi->chroma_height=(mpi->height>>1);
203 mpi->chroma_x_shift=0;
204 mpi->chroma_y_shift=1;
205 return;
207 mp_msg(MSGT_DECVIDEO,MSGL_WARN,"mp_image: unknown out_fmt: 0x%X\n",out_fmt);
208 mpi->bpp=0;
210 #endif
212 static inline mp_image_t* new_mp_image(int w,int h){
213 mp_image_t* mpi=(mp_image_t*)malloc(sizeof(mp_image_t));
214 if(!mpi) return NULL; // error!
215 memset(mpi,0,sizeof(mp_image_t));
216 mpi->width=mpi->w=w;
217 mpi->height=mpi->h=h;
218 return mpi;
221 static inline void free_mp_image(mp_image_t* mpi){
222 if(!mpi) return;
223 if(mpi->flags&MP_IMGFLAG_ALLOCATED){
224 /* becouse we allocate the whole image in once */
225 if(mpi->planes[0]) free(mpi->planes[0]);
227 free(mpi);
230 mp_image_t* alloc_mpi(int w, int h, unsigned long int fmt);
231 void copy_mpi(mp_image_t *dmpi, mp_image_t *mpi);
233 #endif /* MPLAYER_MP_IMAGE_H */