lavc/htmlsubtitles: handle colors starting with many '#'
[ffmpeg.git] / libavcodec / mpegutils.h
1 /*
2  * Mpeg video formats-related defines and utility functions
3  *
4  * This file is part of FFmpeg.
5  *
6  * FFmpeg is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Lesser General Public
8  * License as published by the Free Software Foundation; either
9  * version 2.1 of the License, or (at your option) any later version.
10  *
11  * FFmpeg is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14  * Lesser General Public License for more details.
15  *
16  * You should have received a copy of the GNU Lesser General Public
17  * License along with FFmpeg; if not, write to the Free Software
18  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19  */
20
21 #ifndef AVCODEC_MPEGUTILS_H
22 #define AVCODEC_MPEGUTILS_H
23
24 #include <stdint.h>
25
26 #include "libavutil/frame.h"
27
28 #include "avcodec.h"
29 #include "version.h"
30
31 /**
32  * Return value for header parsers if frame is not coded.
33  * */
34 #define FRAME_SKIPPED 100
35
36 /* picture type */
37 #define PICT_TOP_FIELD     1
38 #define PICT_BOTTOM_FIELD  2
39 #define PICT_FRAME         3
40
41 /**
42  * Value of Picture.reference when Picture is not a reference picture, but
43  * is held for delayed output.
44  */
45 #define DELAYED_PIC_REF 4
46
47 #define MAX_MB_BYTES    (30 * 16 * 16 * 3 / 8 + 120)
48 #define MAX_FCODE        7
49
50 /* MB types */
51 #if !FF_API_MB_TYPE
52 #define MB_TYPE_INTRA4x4   (1 <<  0)
53 #define MB_TYPE_INTRA16x16 (1 <<  1) // FIXME H.264-specific
54 #define MB_TYPE_INTRA_PCM  (1 <<  2) // FIXME H.264-specific
55 #define MB_TYPE_16x16      (1 <<  3)
56 #define MB_TYPE_16x8       (1 <<  4)
57 #define MB_TYPE_8x16       (1 <<  5)
58 #define MB_TYPE_8x8        (1 <<  6)
59 #define MB_TYPE_INTERLACED (1 <<  7)
60 #define MB_TYPE_DIRECT2    (1 <<  8) // FIXME
61 #define MB_TYPE_ACPRED     (1 <<  9)
62 #define MB_TYPE_GMC        (1 << 10)
63 #define MB_TYPE_SKIP       (1 << 11)
64 #define MB_TYPE_P0L0       (1 << 12)
65 #define MB_TYPE_P1L0       (1 << 13)
66 #define MB_TYPE_P0L1       (1 << 14)
67 #define MB_TYPE_P1L1       (1 << 15)
68 #define MB_TYPE_L0         (MB_TYPE_P0L0 | MB_TYPE_P1L0)
69 #define MB_TYPE_L1         (MB_TYPE_P0L1 | MB_TYPE_P1L1)
70 #define MB_TYPE_L0L1       (MB_TYPE_L0   | MB_TYPE_L1)
71 #define MB_TYPE_QUANT      (1 << 16)
72 #define MB_TYPE_CBP        (1 << 17)
73 #endif
74
75 #define MB_TYPE_INTRA    MB_TYPE_INTRA4x4 // default mb_type if there is just one type
76
77 #define IS_INTRA4x4(a)   ((a) & MB_TYPE_INTRA4x4)
78 #define IS_INTRA16x16(a) ((a) & MB_TYPE_INTRA16x16)
79 #define IS_PCM(a)        ((a) & MB_TYPE_INTRA_PCM)
80 #define IS_INTRA(a)      ((a) & 7)
81 #define IS_INTER(a)      ((a) & (MB_TYPE_16x16 | MB_TYPE_16x8 | \
82                                  MB_TYPE_8x16  | MB_TYPE_8x8))
83 #define IS_SKIP(a)       ((a) & MB_TYPE_SKIP)
84 #define IS_INTRA_PCM(a)  ((a) & MB_TYPE_INTRA_PCM)
85 #define IS_INTERLACED(a) ((a) & MB_TYPE_INTERLACED)
86 #define IS_DIRECT(a)     ((a) & MB_TYPE_DIRECT2)
87 #define IS_GMC(a)        ((a) & MB_TYPE_GMC)
88 #define IS_16X16(a)      ((a) & MB_TYPE_16x16)
89 #define IS_16X8(a)       ((a) & MB_TYPE_16x8)
90 #define IS_8X16(a)       ((a) & MB_TYPE_8x16)
91 #define IS_8X8(a)        ((a) & MB_TYPE_8x8)
92 #define IS_SUB_8X8(a)    ((a) & MB_TYPE_16x16) // note reused
93 #define IS_SUB_8X4(a)    ((a) & MB_TYPE_16x8)  // note reused
94 #define IS_SUB_4X8(a)    ((a) & MB_TYPE_8x16)  // note reused
95 #define IS_SUB_4X4(a)    ((a) & MB_TYPE_8x8)   // note reused
96 #define IS_ACPRED(a)     ((a) & MB_TYPE_ACPRED)
97 #define IS_QUANT(a)      ((a) & MB_TYPE_QUANT)
98 #define IS_DIR(a, part, list) ((a) & (MB_TYPE_P0L0 << ((part) + 2 * (list))))
99
100 // does this mb use listX, note does not work if subMBs
101 #define USES_LIST(a, list) ((a) & ((MB_TYPE_P0L0 | MB_TYPE_P1L0) << (2 * (list))))
102
103 #define HAS_CBP(a)       ((a) & MB_TYPE_CBP)
104
105 /* MB types for encoding */
106 #define CANDIDATE_MB_TYPE_INTRA      (1 <<  0)
107 #define CANDIDATE_MB_TYPE_INTER      (1 <<  1)
108 #define CANDIDATE_MB_TYPE_INTER4V    (1 <<  2)
109 #define CANDIDATE_MB_TYPE_SKIPPED    (1 <<  3)
110
111 #define CANDIDATE_MB_TYPE_DIRECT     (1 <<  4)
112 #define CANDIDATE_MB_TYPE_FORWARD    (1 <<  5)
113 #define CANDIDATE_MB_TYPE_BACKWARD   (1 <<  6)
114 #define CANDIDATE_MB_TYPE_BIDIR      (1 <<  7)
115
116 #define CANDIDATE_MB_TYPE_INTER_I    (1 <<  8)
117 #define CANDIDATE_MB_TYPE_FORWARD_I  (1 <<  9)
118 #define CANDIDATE_MB_TYPE_BACKWARD_I (1 << 10)
119 #define CANDIDATE_MB_TYPE_BIDIR_I    (1 << 11)
120
121 #define CANDIDATE_MB_TYPE_DIRECT0    (1 << 12)
122
123 #define INPLACE_OFFSET 16
124
125 enum OutputFormat {
126     FMT_MPEG1,
127     FMT_H261,
128     FMT_H263,
129     FMT_MJPEG,
130 };
131
132
133 /**
134  * Draw a horizontal band if supported.
135  *
136  * @param h is the normal height, this will be reduced automatically if needed
137  */
138 void ff_draw_horiz_band(AVCodecContext *avctx, AVFrame *cur, AVFrame *last,
139                         int y, int h, int picture_structure, int first_field,
140                         int low_delay);
141
142 #endif /* AVCODEC_MPEGUTILS_H */