mpegvideo: move mpegvideo formats-related defines to mpegutils.h
[ffmpeg.git] / libavcodec / mpegutils.h
1 /*
2  * Mpeg video formats-related defines and utility functions
3  *
4  * This file is part of Libav.
5  *
6  * Libav 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  * Libav 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 Libav; 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 "version.h"
25
26 /* picture type */
27 #define PICT_TOP_FIELD     1
28 #define PICT_BOTTOM_FIELD  2
29 #define PICT_FRAME         3
30
31 /**
32  * Value of Picture.reference when Picture is not a reference picture, but
33  * is held for delayed output.
34  */
35 #define DELAYED_PIC_REF 4
36
37
38 /* MB types */
39 #if !FF_API_MB_TYPE
40 #define MB_TYPE_INTRA4x4   (1 <<  0)
41 #define MB_TYPE_INTRA16x16 (1 <<  1) // FIXME H.264-specific
42 #define MB_TYPE_INTRA_PCM  (1 <<  2) // FIXME H.264-specific
43 #define MB_TYPE_16x16      (1 <<  3)
44 #define MB_TYPE_16x8       (1 <<  4)
45 #define MB_TYPE_8x16       (1 <<  5)
46 #define MB_TYPE_8x8        (1 <<  6)
47 #define MB_TYPE_INTERLACED (1 <<  7)
48 #define MB_TYPE_DIRECT2    (1 <<  8) // FIXME
49 #define MB_TYPE_ACPRED     (1 <<  9)
50 #define MB_TYPE_GMC        (1 << 10)
51 #define MB_TYPE_SKIP       (1 << 11)
52 #define MB_TYPE_P0L0       (1 << 12)
53 #define MB_TYPE_P1L0       (1 << 13)
54 #define MB_TYPE_P0L1       (1 << 14)
55 #define MB_TYPE_P1L1       (1 << 15)
56 #define MB_TYPE_L0         (MB_TYPE_P0L0 | MB_TYPE_P1L0)
57 #define MB_TYPE_L1         (MB_TYPE_P0L1 | MB_TYPE_P1L1)
58 #define MB_TYPE_L0L1       (MB_TYPE_L0   | MB_TYPE_L1)
59 #define MB_TYPE_QUANT      (1 << 16)
60 #define MB_TYPE_CBP        (1 << 17)
61 #endif
62
63 #define MB_TYPE_INTRA    MB_TYPE_INTRA4x4 // default mb_type if there is just one type
64
65 #define IS_INTRA4x4(a)   ((a) & MB_TYPE_INTRA4x4)
66 #define IS_INTRA16x16(a) ((a) & MB_TYPE_INTRA16x16)
67 #define IS_PCM(a)        ((a) & MB_TYPE_INTRA_PCM)
68 #define IS_INTRA(a)      ((a) & 7)
69 #define IS_INTER(a)      ((a) & (MB_TYPE_16x16 | MB_TYPE_16x8 | \
70                                  MB_TYPE_8x16  | MB_TYPE_8x8))
71 #define IS_SKIP(a)       ((a) & MB_TYPE_SKIP)
72 #define IS_INTRA_PCM(a)  ((a) & MB_TYPE_INTRA_PCM)
73 #define IS_INTERLACED(a) ((a) & MB_TYPE_INTERLACED)
74 #define IS_DIRECT(a)     ((a) & MB_TYPE_DIRECT2)
75 #define IS_GMC(a)        ((a) & MB_TYPE_GMC)
76 #define IS_16X16(a)      ((a) & MB_TYPE_16x16)
77 #define IS_16X8(a)       ((a) & MB_TYPE_16x8)
78 #define IS_8X16(a)       ((a) & MB_TYPE_8x16)
79 #define IS_8X8(a)        ((a) & MB_TYPE_8x8)
80 #define IS_SUB_8X8(a)    ((a) & MB_TYPE_16x16) // note reused
81 #define IS_SUB_8X4(a)    ((a) & MB_TYPE_16x8)  // note reused
82 #define IS_SUB_4X8(a)    ((a) & MB_TYPE_8x16)  // note reused
83 #define IS_SUB_4X4(a)    ((a) & MB_TYPE_8x8)   // note reused
84 #define IS_ACPRED(a)     ((a) & MB_TYPE_ACPRED)
85 #define IS_QUANT(a)      ((a) & MB_TYPE_QUANT)
86 #define IS_DIR(a, part, list) ((a) & (MB_TYPE_P0L0 << ((part) + 2 * (list))))
87
88 // does this mb use listX, note does not work if subMBs
89 #define USES_LIST(a, list) ((a) & ((MB_TYPE_P0L0 | MB_TYPE_P1L0) << (2 * (list))))
90
91 #define HAS_CBP(a)       ((a) & MB_TYPE_CBP)
92
93 /* MB types for encoding */
94 #define CANDIDATE_MB_TYPE_INTRA      (1 <<  0)
95 #define CANDIDATE_MB_TYPE_INTER      (1 <<  1)
96 #define CANDIDATE_MB_TYPE_INTER4V    (1 <<  2)
97 #define CANDIDATE_MB_TYPE_SKIPPED    (1 <<  3)
98
99 #define CANDIDATE_MB_TYPE_DIRECT     (1 <<  4)
100 #define CANDIDATE_MB_TYPE_FORWARD    (1 <<  5)
101 #define CANDIDATE_MB_TYPE_BACKWARD   (1 <<  6)
102 #define CANDIDATE_MB_TYPE_BIDIR      (1 <<  7)
103
104 #define CANDIDATE_MB_TYPE_INTER_I    (1 <<  8)
105 #define CANDIDATE_MB_TYPE_FORWARD_I  (1 <<  9)
106 #define CANDIDATE_MB_TYPE_BACKWARD_I (1 << 10)
107 #define CANDIDATE_MB_TYPE_BIDIR_I    (1 << 11)
108
109 #define CANDIDATE_MB_TYPE_DIRECT0    (1 << 12)
110
111 #endif /* AVCODEC_PICTTYPE_H */