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