h264_sei: Add namespace prefix to all SEI values
[libav.git] / libavcodec / h264_sei.h
CommitLineData
728d90a0
AK
1/*
2 * This file is part of Libav.
3 *
4 * Libav 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 * Libav 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 Libav; 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 */
27typedef enum {
6ea220cb
MT
28 H264_SEI_TYPE_BUFFERING_PERIOD = 0, ///< buffering period (H.264, D.1.1)
29 H264_SEI_TYPE_PIC_TIMING = 1, ///< picture timing
30 H264_SEI_TYPE_FILLER_PAYLOAD = 3, ///< filler data
31 H264_SEI_TYPE_USER_DATA_REGISTERED = 4, ///< registered user data as specified by Rec. ITU-T T.35
32 H264_SEI_TYPE_USER_DATA_UNREGISTERED = 5, ///< unregistered user data
33 H264_SEI_TYPE_RECOVERY_POINT = 6, ///< recovery point (frame # to decoder sync)
34 H264_SEI_TYPE_FRAME_PACKING = 45, ///< frame packing arrangement
35 H264_SEI_TYPE_DISPLAY_ORIENTATION = 47, ///< display orientation
36} H264_SEI_Type;
728d90a0
AK
37
38/**
39 * pic_struct in picture timing SEI message
40 */
41typedef enum {
6ea220cb
MT
42 H264_SEI_PIC_STRUCT_FRAME = 0, ///< 0: %frame
43 H264_SEI_PIC_STRUCT_TOP_FIELD = 1, ///< 1: top field
44 H264_SEI_PIC_STRUCT_BOTTOM_FIELD = 2, ///< 2: bottom field
45 H264_SEI_PIC_STRUCT_TOP_BOTTOM = 3, ///< 3: top field, bottom field, in that order
46 H264_SEI_PIC_STRUCT_BOTTOM_TOP = 4, ///< 4: bottom field, top field, in that order
47 H264_SEI_PIC_STRUCT_TOP_BOTTOM_TOP = 5, ///< 5: top field, bottom field, top field repeated, in that order
48 H264_SEI_PIC_STRUCT_BOTTOM_TOP_BOTTOM = 6, ///< 6: bottom field, top field, bottom field repeated, in that order
49 H264_SEI_PIC_STRUCT_FRAME_DOUBLING = 7, ///< 7: %frame doubling
50 H264_SEI_PIC_STRUCT_FRAME_TRIPLING = 8 ///< 8: %frame tripling
51} H264_SEI_PicStructType;
728d90a0
AK
52
53typedef struct H264SEIPictureTiming {
d7b2bb53 54 int present;
6ea220cb 55 H264_SEI_PicStructType pic_struct;
728d90a0
AK
56
57 /**
58 * Bit set of clock types for fields/frames in picture timing SEI message.
59 * For each found ct_type, appropriate bit is set (e.g., bit 1 for
60 * interlaced).
61 */
62 int ct_type;
63
64 /**
65 * dpb_output_delay in picture timing SEI message, see H.264 C.2.2
66 */
67 int dpb_output_delay;
68
69 /**
70 * cpb_removal_delay in picture timing SEI message, see H.264 C.1.2
71 */
72 int cpb_removal_delay;
73} H264SEIPictureTiming;
74
75typedef struct H264SEIAFD {
76 int present;
77 uint8_t active_format_description;
78} H264SEIAFD;
79
80typedef struct H264SEIA53Caption {
81 int a53_caption_size;
82 uint8_t *a53_caption;
83} H264SEIA53Caption;
84
85typedef struct H264SEIUnregistered {
86 int x264_build;
87} H264SEIUnregistered;
88
89typedef struct H264SEIRecoveryPoint {
90 /**
91 * recovery_frame_cnt
92 *
93 * Set to -1 if no recovery point SEI message found or to number of frames
94 * before playback synchronizes. Frames having recovery point are key
95 * frames.
96 */
97 int recovery_frame_cnt;
98} H264SEIRecoveryPoint;
99
100typedef struct H264SEIBufferingPeriod {
101 int present; ///< Buffering period SEI flag
102 int initial_cpb_removal_delay[32]; ///< Initial timestamps for CPBs
103} H264SEIBufferingPeriod;
104
105typedef struct H264SEIFramePacking {
106 int present;
107 int arrangement_type;
108 int content_interpretation_type;
109 int quincunx_subsampling;
110} H264SEIFramePacking;
111
112typedef struct H264SEIDisplayOrientation {
113 int present;
114 int anticlockwise_rotation;
115 int hflip, vflip;
116} H264SEIDisplayOrientation;
117
118typedef struct H264SEIContext {
119 H264SEIPictureTiming picture_timing;
120 H264SEIAFD afd;
121 H264SEIA53Caption a53_caption;
122 H264SEIUnregistered unregistered;
123 H264SEIRecoveryPoint recovery_point;
124 H264SEIBufferingPeriod buffering_period;
125 H264SEIFramePacking frame_packing;
126 H264SEIDisplayOrientation display_orientation;
127} H264SEIContext;
128
129struct H264ParamSets;
130
131int ff_h264_sei_decode(H264SEIContext *h, GetBitContext *gb,
132 const struct H264ParamSets *ps, void *logctx);
133
134/**
135 * Reset SEI values at the beginning of the frame.
136 */
137void ff_h264_sei_uninit(H264SEIContext *h);
138
139#endif /* AVCODEC_H264_SEI_H */