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 
26 //--------- codec's requirements (filled by the codec/vf) ---------
27 
28 //--- buffer content restrictions:
29 // set if buffer content shouldn't be modified:
30 #define MP_IMGFLAG_PRESERVE 0x01
31 // set if buffer content will be READ.
32 // This can be e.g. for next frame's MC: (I/P mpeg frames) -
33 // then in combination with MP_IMGFLAG_PRESERVE - or it
34 // can be because a video filter or codec will read a significant
35 // amount of data while processing that frame (e.g. blending something
36 // onto the frame, MV based intra prediction).
37 // A frame marked like this should not be placed in to uncachable
38 // video RAM for example.
39 #define MP_IMGFLAG_READABLE 0x02
40 
41 //--- buffer width/stride/plane restrictions: (used for direct rendering)
42 // stride _have_to_ be aligned to MB boundary:  [for DR restrictions]
43 #define MP_IMGFLAG_ACCEPT_ALIGNED_STRIDE 0x4
44 // stride should be aligned to MB boundary:     [for buffer allocation]
45 #define MP_IMGFLAG_PREFER_ALIGNED_STRIDE 0x8
46 // codec accept any stride (>=width):
47 #define MP_IMGFLAG_ACCEPT_STRIDE 0x10
48 // codec accept any width (width*bpp=stride -> stride%bpp==0) (>=width):
49 #define MP_IMGFLAG_ACCEPT_WIDTH 0x20
50 //--- for planar formats only:
51 // uses only stride[0], and stride[1]=stride[2]=stride[0]>>mpi->chroma_x_shift
52 #define MP_IMGFLAG_COMMON_STRIDE 0x40
53 // uses only planes[0], and calculates planes[1,2] from width,height,imgfmt
54 #define MP_IMGFLAG_COMMON_PLANE 0x80
55 
56 #define MP_IMGFLAGMASK_RESTRICTIONS 0xFF
57 
58 //--------- color info (filled by mp_image_setfmt() ) -----------
59 // set if number of planes > 1
60 #define MP_IMGFLAG_PLANAR 0x100
61 // set if it's YUV colorspace
62 #define MP_IMGFLAG_YUV 0x200
63 // set if it's swapped (BGR or YVU) plane/byteorder
64 #define MP_IMGFLAG_SWAPPED 0x400
65 // set if you want memory for palette allocated and managed by vf_get_image etc.
66 #define MP_IMGFLAG_RGB_PALETTE 0x800
67 
68 #define MP_IMGFLAGMASK_COLORS 0xF00
69 
70 // codec uses drawing/rendering callbacks (draw_slice()-like thing, DR method 2)
71 // [the codec will set this flag if it supports callbacks, and the vo _may_
72 //  clear it in get_image() if draw_slice() not implemented]
73 #define MP_IMGFLAG_DRAW_CALLBACK 0x1000
74 // set if it's in video buffer/memory: [set by vo/vf's get_image() !!!]
75 #define MP_IMGFLAG_DIRECT 0x2000
76 // set if buffer is allocated (used in destination images):
77 #define MP_IMGFLAG_ALLOCATED 0x4000
78 
79 // buffer type was printed (do NOT set this flag - it's for INTERNAL USE!!!)
80 #define MP_IMGFLAG_TYPE_DISPLAYED 0x8000
81 
82 // codec doesn't support any form of direct rendering - it has own buffer
83 // allocation. so we just export its buffer pointers:
84 #define MP_IMGTYPE_EXPORT 0
85 // codec requires a static WO buffer, but it does only partial updates later:
86 #define MP_IMGTYPE_STATIC 1
87 // codec just needs some WO memory, where it writes/copies the whole frame to:
88 #define MP_IMGTYPE_TEMP 2
89 // I+P type, requires 2+ independent static R/W buffers
90 #define MP_IMGTYPE_IP 3
91 // I+P+B type, requires 2+ independent static R/W and 1+ temp WO buffers
92 #define MP_IMGTYPE_IPB 4
93 // Upper 16 bits give desired buffer number, -1 means get next available
94 #define MP_IMGTYPE_NUMBERED 5
95 // Doesn't need any buffer, incomplete image (probably a first field only)
96 // we need this type to be able to differentiate between half frames and
97 // all other cases
98 #define MP_IMGTYPE_INCOMPLETE 6
99 
100 #define MP_MAX_PLANES 4
101 
102 #define MP_IMGFIELD_ORDERED 0x01
103 #define MP_IMGFIELD_TOP_FIRST 0x02
104 #define MP_IMGFIELD_REPEAT_FIRST 0x04
105 #define MP_IMGFIELD_TOP 0x08
106 #define MP_IMGFIELD_BOTTOM 0x10
107 #define MP_IMGFIELD_INTERLACED 0x20
108 
109 typedef struct mp_image {
110     unsigned int flags;
111     unsigned char type;
112     int number;
113     unsigned char bpp;  // bits/pixel. NOT depth! for RGB it will be n*8
114     unsigned int imgfmt;
115     int width,height;  // stored dimensions
116     int x,y,w,h;  // visible dimensions
117     unsigned char* planes[MP_MAX_PLANES];
118     int stride[MP_MAX_PLANES];
119     char * qscale;
120     int qstride;
121     int pict_type; // 0->unknown, 1->I, 2->P, 3->B
122     int fields;
123     int qscale_type; // 0->mpeg1/4/h263, 1->mpeg2
124     int num_planes;
125     /* these are only used by planar formats Y,U(Cb),V(Cr) */
126     int chroma_width;
127     int chroma_height;
128     int chroma_x_shift; // horizontal
129     int chroma_y_shift; // vertical
130     int usage_count;
131     /* for private use by filter or vo driver (to store buffer id or dmpi) */
132     void* priv;
133 } mp_image_t;
134 
135 void mp_image_setfmt(mp_image_t* mpi,unsigned int out_fmt);
136 mp_image_t* new_mp_image(int w,int h);
137 void free_mp_image(mp_image_t* mpi);
138 
139 mp_image_t* alloc_mpi(int w, int h, unsigned long int fmt);
140 void mp_image_alloc_planes(mp_image_t *mpi);
141 void copy_mpi(mp_image_t *dmpi, mp_image_t *mpi);
142 
143 #endif /* MPLAYER_MP_IMAGE_H */
144