5f5d895e8984781b353e7299bf3a073d8f83542f
[ffmpeg.git] / libavcodec / h264_sei.h
1 /*
2  * This file is part of FFmpeg.
3  *
4  * FFmpeg is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU Lesser General Public
6  * License as published by the Free Software Foundation; either
7  * version 2.1 of the License, or (at your option) any later version.
8  *
9  * FFmpeg 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 GNU
12  * Lesser General Public License for more details.
13  *
14  * You should have received a copy of the GNU Lesser General Public
15  * License along with FFmpeg; if not, write to the Free Software
16  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17  */
18
19 #ifndef AVCODEC_H264_SEI_H
20 #define AVCODEC_H264_SEI_H
21
22 #include "get_bits.h"
23
24 /**
25  * SEI message types
26  */
27 typedef enum {
28     SEI_TYPE_BUFFERING_PERIOD       = 0,   ///< buffering period (H.264, D.1.1)
29     SEI_TYPE_PIC_TIMING             = 1,   ///< picture timing
30     SEI_TYPE_USER_DATA_REGISTERED   = 4,   ///< registered user data as specified by Rec. ITU-T T.35
31     SEI_TYPE_USER_DATA_UNREGISTERED = 5,   ///< unregistered user data
32     SEI_TYPE_RECOVERY_POINT         = 6,   ///< recovery point (frame # to decoder sync)
33     SEI_TYPE_FRAME_PACKING          = 45,  ///< frame packing arrangement
34     SEI_TYPE_DISPLAY_ORIENTATION    = 47,  ///< display orientation
35     SEI_TYPE_GREEN_METADATA         = 56,  ///< GreenMPEG information
36     SEI_TYPE_ALTERNATIVE_TRANSFER   = 147, ///< alternative transfer
37 } SEI_Type;
38
39 /**
40  * pic_struct in picture timing SEI message
41  */
42 typedef enum {
43     SEI_PIC_STRUCT_FRAME             = 0, ///<  0: %frame
44     SEI_PIC_STRUCT_TOP_FIELD         = 1, ///<  1: top field
45     SEI_PIC_STRUCT_BOTTOM_FIELD      = 2, ///<  2: bottom field
46     SEI_PIC_STRUCT_TOP_BOTTOM        = 3, ///<  3: top field, bottom field, in that order
47     SEI_PIC_STRUCT_BOTTOM_TOP        = 4, ///<  4: bottom field, top field, in that order
48     SEI_PIC_STRUCT_TOP_BOTTOM_TOP    = 5, ///<  5: top field, bottom field, top field repeated, in that order
49     SEI_PIC_STRUCT_BOTTOM_TOP_BOTTOM = 6, ///<  6: bottom field, top field, bottom field repeated, in that order
50     SEI_PIC_STRUCT_FRAME_DOUBLING    = 7, ///<  7: %frame doubling
51     SEI_PIC_STRUCT_FRAME_TRIPLING    = 8  ///<  8: %frame tripling
52 } SEI_PicStructType;
53
54 /**
55  * frame_packing_arrangement types
56  */
57 typedef enum {
58     SEI_FPA_TYPE_CHECKERBOARD        = 0,
59     SEI_FPA_TYPE_INTERLEAVE_COLUMN   = 1,
60     SEI_FPA_TYPE_INTERLEAVE_ROW      = 2,
61     SEI_FPA_TYPE_SIDE_BY_SIDE        = 3,
62     SEI_FPA_TYPE_TOP_BOTTOM          = 4,
63     SEI_FPA_TYPE_INTERLEAVE_TEMPORAL = 5,
64     SEI_FPA_TYPE_2D                  = 6,
65 } SEI_FpaType;
66
67 typedef struct H264SEIPictureTiming {
68     int present;
69     SEI_PicStructType pic_struct;
70
71     /**
72      * Bit set of clock types for fields/frames in picture timing SEI message.
73      * For each found ct_type, appropriate bit is set (e.g., bit 1 for
74      * interlaced).
75      */
76     int ct_type;
77
78     /**
79      * dpb_output_delay in picture timing SEI message, see H.264 C.2.2
80      */
81     int dpb_output_delay;
82
83     /**
84      * cpb_removal_delay in picture timing SEI message, see H.264 C.1.2
85      */
86     int cpb_removal_delay;
87 } H264SEIPictureTiming;
88
89 typedef struct H264SEIAFD {
90     int present;
91     uint8_t active_format_description;
92 } H264SEIAFD;
93
94 typedef struct H264SEIA53Caption {
95     int a53_caption_size;
96     uint8_t *a53_caption;
97 } H264SEIA53Caption;
98
99 typedef struct H264SEIUnregistered {
100     int x264_build;
101 } H264SEIUnregistered;
102
103 typedef struct H264SEIRecoveryPoint {
104     /**
105      * recovery_frame_cnt
106      *
107      * Set to -1 if no recovery point SEI message found or to number of frames
108      * before playback synchronizes. Frames having recovery point are key
109      * frames.
110      */
111     int recovery_frame_cnt;
112 } H264SEIRecoveryPoint;
113
114 typedef struct H264SEIBufferingPeriod {
115     int present;   ///< Buffering period SEI flag
116     int initial_cpb_removal_delay[32];  ///< Initial timestamps for CPBs
117 } H264SEIBufferingPeriod;
118
119 typedef struct H264SEIFramePacking {
120     int present;
121     int frame_packing_arrangement_id;
122     int frame_packing_arrangement_cancel_flag;  ///< is previous arrangement canceled, -1 if never received
123     SEI_FpaType frame_packing_arrangement_type;
124     int frame_packing_arrangement_repetition_period;
125     int content_interpretation_type;
126     int quincunx_sampling_flag;
127 } H264SEIFramePacking;
128
129 typedef struct H264SEIDisplayOrientation {
130     int present;
131     int anticlockwise_rotation;
132     int hflip, vflip;
133 } H264SEIDisplayOrientation;
134
135 typedef struct H264SEIGreenMetaData {
136     uint8_t green_metadata_type;
137     uint8_t period_type;
138     uint16_t num_seconds;
139     uint16_t num_pictures;
140     uint8_t percent_non_zero_macroblocks;
141     uint8_t percent_intra_coded_macroblocks;
142     uint8_t percent_six_tap_filtering;
143     uint8_t percent_alpha_point_deblocking_instance;
144     uint8_t xsd_metric_type;
145     uint16_t xsd_metric_value;
146 } H264SEIGreenMetaData;
147
148 typedef struct H264SEIAlternativeTransfer {
149     int present;
150     int preferred_transfer_characteristics;
151 } H264SEIAlternativeTransfer;
152
153 typedef struct H264SEIContext {
154     H264SEIPictureTiming picture_timing;
155     H264SEIAFD afd;
156     H264SEIA53Caption a53_caption;
157     H264SEIUnregistered unregistered;
158     H264SEIRecoveryPoint recovery_point;
159     H264SEIBufferingPeriod buffering_period;
160     H264SEIFramePacking frame_packing;
161     H264SEIDisplayOrientation display_orientation;
162     H264SEIGreenMetaData green_metadata;
163     H264SEIAlternativeTransfer alternative_transfer;
164 } H264SEIContext;
165
166 struct H264ParamSets;
167
168 int ff_h264_sei_decode(H264SEIContext *h, GetBitContext *gb,
169                        const struct H264ParamSets *ps, void *logctx);
170
171 /**
172  * Reset SEI values at the beginning of the frame.
173  */
174 void ff_h264_sei_uninit(H264SEIContext *h);
175
176 /**
177  * Get stereo_mode string from the h264 frame_packing_arrangement
178  */
179 const char *ff_h264_sei_stereo_mode(const H264SEIFramePacking *h);
180
181 #endif /* AVCODEC_H264_SEI_H */