vf_mp: remove boxblur wrapper
[ffmpeg.git] / libavfilter / libmpcodecs / mp_image.h
1 /*
2  * This file is part of MPlayer.
3  *
4  * MPlayer is free software; you can redistribute it and/or modify
5  * it under the terms of the GNU General Public License as published by
6  * the Free Software Foundation; either version 2 of the License, or
7  * (at your option) any later version.
8  *
9  * MPlayer is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License along
15  * with MPlayer; if not, write to the Free Software Foundation, Inc.,
16  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
17  */
18
19 #ifndef MPLAYER_MP_IMAGE_H
20 #define MPLAYER_MP_IMAGE_H
21
22 #include <stdio.h>
23 #include <stdlib.h>
24 #include <string.h>
25 #undef printf //FIXME
26 #undef fprintf //FIXME
27 #include "mp_msg.h"
28 #include "libavutil/avutil.h"
29 #include "libavutil/avassert.h"
30 #undef realloc
31 #undef malloc
32 #undef free
33 #undef rand
34 #undef srand
35 #undef printf
36 #undef strncpy
37 #define ASMALIGN(ZEROBITS) ".p2align " #ZEROBITS "\n\t"
38
39
40 //--------- codec's requirements (filled by the codec/vf) ---------
41
42 //--- buffer content restrictions:
43 // set if buffer content shouldn't be modified:
44 #define MP_IMGFLAG_PRESERVE 0x01
45 // set if buffer content will be READ for next frame's MC: (I/P mpeg frames)
46 #define MP_IMGFLAG_READABLE 0x02
47
48 //--- buffer width/stride/plane restrictions: (used for direct rendering)
49 // stride _have_to_ be aligned to MB boundary:  [for DR restrictions]
50 #define MP_IMGFLAG_ACCEPT_ALIGNED_STRIDE 0x4
51 // stride should be aligned to MB boundary:     [for buffer allocation]
52 #define MP_IMGFLAG_PREFER_ALIGNED_STRIDE 0x8
53 // codec accept any stride (>=width):
54 #define MP_IMGFLAG_ACCEPT_STRIDE 0x10
55 // codec accept any width (width*bpp=stride -> stride%bpp==0) (>=width):
56 #define MP_IMGFLAG_ACCEPT_WIDTH 0x20
57 //--- for planar formats only:
58 // uses only stride[0], and stride[1]=stride[2]=stride[0]>>mpi->chroma_x_shift
59 #define MP_IMGFLAG_COMMON_STRIDE 0x40
60 // uses only planes[0], and calculates planes[1,2] from width,height,imgfmt
61 #define MP_IMGFLAG_COMMON_PLANE 0x80
62
63 #define MP_IMGFLAGMASK_RESTRICTIONS 0xFF
64
65 //--------- color info (filled by mp_image_setfmt() ) -----------
66 // set if number of planes > 1
67 #define MP_IMGFLAG_PLANAR 0x100
68 // set if it's YUV colorspace
69 #define MP_IMGFLAG_YUV 0x200
70 // set if it's swapped (BGR or YVU) plane/byteorder
71 #define MP_IMGFLAG_SWAPPED 0x400
72 // set if you want memory for palette allocated and managed by vf_get_image etc.
73 #define MP_IMGFLAG_RGB_PALETTE 0x800
74
75 #define MP_IMGFLAGMASK_COLORS 0xF00
76
77 // codec uses drawing/rendering callbacks (draw_slice()-like thing, DR method 2)
78 // [the codec will set this flag if it supports callbacks, and the vo _may_
79 //  clear it in get_image() if draw_slice() not implemented]
80 #define MP_IMGFLAG_DRAW_CALLBACK 0x1000
81 // set if it's in video buffer/memory: [set by vo/vf's get_image() !!!]
82 #define MP_IMGFLAG_DIRECT 0x2000
83 // set if buffer is allocated (used in destination images):
84 #define MP_IMGFLAG_ALLOCATED 0x4000
85
86 // buffer type was printed (do NOT set this flag - it's for INTERNAL USE!!!)
87 #define MP_IMGFLAG_TYPE_DISPLAYED 0x8000
88
89 // codec doesn't support any form of direct rendering - it has own buffer
90 // allocation. so we just export its buffer pointers:
91 #define MP_IMGTYPE_EXPORT 0
92 // codec requires a static WO buffer, but it does only partial updates later:
93 #define MP_IMGTYPE_STATIC 1
94 // codec just needs some WO memory, where it writes/copies the whole frame to:
95 #define MP_IMGTYPE_TEMP 2
96 // I+P type, requires 2+ independent static R/W buffers
97 #define MP_IMGTYPE_IP 3
98 // I+P+B type, requires 2+ independent static R/W and 1+ temp WO buffers
99 #define MP_IMGTYPE_IPB 4
100 // Upper 16 bits give desired buffer number, -1 means get next available
101 #define MP_IMGTYPE_NUMBERED 5
102 // Doesn't need any buffer, incomplete image (probably a first field only)
103 // we need this type to be able to differentiate between half frames and
104 // all other cases
105 #define MP_IMGTYPE_INCOMPLETE 6
106
107 #define MP_MAX_PLANES 4
108
109 #define MP_IMGFIELD_ORDERED 0x01
110 #define MP_IMGFIELD_TOP_FIRST 0x02
111 #define MP_IMGFIELD_REPEAT_FIRST 0x04
112 #define MP_IMGFIELD_TOP 0x08
113 #define MP_IMGFIELD_BOTTOM 0x10
114 #define MP_IMGFIELD_INTERLACED 0x20
115
116 typedef struct mp_image {
117     unsigned int flags;
118     unsigned char type;
119     int number;
120     unsigned char bpp;  // bits/pixel. NOT depth! for RGB it will be n*8
121     unsigned int imgfmt;
122     int width,height;  // stored dimensions
123     int x,y,w,h;  // visible dimensions
124     unsigned char* planes[MP_MAX_PLANES];
125     int stride[MP_MAX_PLANES];
126     char * qscale;
127     int qstride;
128     int pict_type; // 0->unknown, 1->I, 2->P, 3->B
129     int fields;
130     int qscale_type; // 0->mpeg1/4/h263, 1->mpeg2
131     int num_planes;
132     /* these are only used by planar formats Y,U(Cb),V(Cr) */
133     int chroma_width;
134     int chroma_height;
135     int chroma_x_shift; // horizontal
136     int chroma_y_shift; // vertical
137     int usage_count;
138     /* for private use by filter or vo driver (to store buffer id or dmpi) */
139     void* priv;
140 } mp_image_t;
141
142 void mp_image_setfmt(mp_image_t* mpi,unsigned int out_fmt);
143 mp_image_t* new_mp_image(int w,int h);
144 void free_mp_image(mp_image_t* mpi);
145
146 mp_image_t* alloc_mpi(int w, int h, unsigned long int fmt);
147 void mp_image_alloc_planes(mp_image_t *mpi);
148 void copy_mpi(mp_image_t *dmpi, mp_image_t *mpi);
149
150 #endif /* MPLAYER_MP_IMAGE_H */