git.sesse.net Git - ffmpeg/blob - 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     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_GREEN_METADATA         = 56,  ///< GreenMPEG information
  37     H264_SEI_TYPE_ALTERNATIVE_TRANSFER   = 147, ///< alternative transfer
  38 } H264_SEI_Type;
  39
  40 /**
  41  * pic_struct in picture timing SEI message
  42  */
  43 typedef enum {
  44     H264_SEI_PIC_STRUCT_FRAME             = 0, ///<  0: %frame
  45     H264_SEI_PIC_STRUCT_TOP_FIELD         = 1, ///<  1: top field
  46     H264_SEI_PIC_STRUCT_BOTTOM_FIELD      = 2, ///<  2: bottom field
  47     H264_SEI_PIC_STRUCT_TOP_BOTTOM        = 3, ///<  3: top field, bottom field, in that order
  48     H264_SEI_PIC_STRUCT_BOTTOM_TOP        = 4, ///<  4: bottom field, top field, in that order
  49     H264_SEI_PIC_STRUCT_TOP_BOTTOM_TOP    = 5, ///<  5: top field, bottom field, top field repeated, in that order
  50     H264_SEI_PIC_STRUCT_BOTTOM_TOP_BOTTOM = 6, ///<  6: bottom field, top field, bottom field repeated, in that order
  51     H264_SEI_PIC_STRUCT_FRAME_DOUBLING    = 7, ///<  7: %frame doubling
  52     H264_SEI_PIC_STRUCT_FRAME_TRIPLING    = 8  ///<  8: %frame tripling
  53 } H264_SEI_PicStructType;
  54
  55 /**
  56  * frame_packing_arrangement types
  57  */
  58 typedef enum {
  59     H264_SEI_FPA_TYPE_CHECKERBOARD        = 0,
  60     H264_SEI_FPA_TYPE_INTERLEAVE_COLUMN   = 1,
  61     H264_SEI_FPA_TYPE_INTERLEAVE_ROW      = 2,
  62     H264_SEI_FPA_TYPE_SIDE_BY_SIDE        = 3,
  63     H264_SEI_FPA_TYPE_TOP_BOTTOM          = 4,
  64     H264_SEI_FPA_TYPE_INTERLEAVE_TEMPORAL = 5,
  65     H264_SEI_FPA_TYPE_2D                  = 6,
  66 } H264_SEI_FpaType;
  67
  68 typedef struct H264SEIPictureTiming {
  69     int present;
  70     H264_SEI_PicStructType pic_struct;
  71
  72     /**
  73      * Bit set of clock types for fields/frames in picture timing SEI message.
  74      * For each found ct_type, appropriate bit is set (e.g., bit 1 for
  75      * interlaced).
  76      */
  77     int ct_type;
  78
  79     /**
  80      * dpb_output_delay in picture timing SEI message, see H.264 C.2.2
  81      */
  82     int dpb_output_delay;
  83
  84     /**
  85      * cpb_removal_delay in picture timing SEI message, see H.264 C.1.2
  86      */
  87     int cpb_removal_delay;
  88 } H264SEIPictureTiming;
  89
  90 typedef struct H264SEIAFD {
  91     int present;
  92     uint8_t active_format_description;
  93 } H264SEIAFD;
  94
  95 typedef struct H264SEIA53Caption {
  96     int a53_caption_size;
  97     uint8_t *a53_caption;
  98 } H264SEIA53Caption;
  99
 100 typedef struct H264SEIUnregistered {
 101     int x264_build;
 102 } H264SEIUnregistered;
 103
 104 typedef struct H264SEIRecoveryPoint {
 105     /**
 106      * recovery_frame_cnt
 107      *
 108      * Set to -1 if no recovery point SEI message found or to number of frames
 109      * before playback synchronizes. Frames having recovery point are key
 110      * frames.
 111      */
 112     int recovery_frame_cnt;
 113 } H264SEIRecoveryPoint;
 114
 115 typedef struct H264SEIBufferingPeriod {
 116     int present;   ///< Buffering period SEI flag
 117     int initial_cpb_removal_delay[32];  ///< Initial timestamps for CPBs
 118 } H264SEIBufferingPeriod;
 119
 120 typedef struct H264SEIFramePacking {
 121     int present;
 122     int frame_packing_arrangement_id;
 123     int frame_packing_arrangement_cancel_flag;  ///< is previous arrangement canceled, -1 if never received
 124     H264_SEI_FpaType frame_packing_arrangement_type;
 125     int frame_packing_arrangement_repetition_period;
 126     int content_interpretation_type;
 127     int quincunx_sampling_flag;
 128 } H264SEIFramePacking;
 129
 130 typedef struct H264SEIDisplayOrientation {
 131     int present;
 132     int anticlockwise_rotation;
 133     int hflip, vflip;
 134 } H264SEIDisplayOrientation;
 135
 136 typedef struct H264SEIGreenMetaData {
 137     uint8_t green_metadata_type;
 138     uint8_t period_type;
 139     uint16_t num_seconds;
 140     uint16_t num_pictures;
 141     uint8_t percent_non_zero_macroblocks;
 142     uint8_t percent_intra_coded_macroblocks;
 143     uint8_t percent_six_tap_filtering;
 144     uint8_t percent_alpha_point_deblocking_instance;
 145     uint8_t xsd_metric_type;
 146     uint16_t xsd_metric_value;
 147 } H264SEIGreenMetaData;
 148
 149 typedef struct H264SEIAlternativeTransfer {
 150     int present;
 151     int preferred_transfer_characteristics;
 152 } H264SEIAlternativeTransfer;
 153
 154 typedef struct H264SEIContext {
 155     H264SEIPictureTiming picture_timing;
 156     H264SEIAFD afd;
 157     H264SEIA53Caption a53_caption;
 158     H264SEIUnregistered unregistered;
 159     H264SEIRecoveryPoint recovery_point;
 160     H264SEIBufferingPeriod buffering_period;
 161     H264SEIFramePacking frame_packing;
 162     H264SEIDisplayOrientation display_orientation;
 163     H264SEIGreenMetaData green_metadata;
 164     H264SEIAlternativeTransfer alternative_transfer;
 165 } H264SEIContext;
 166
 167 struct H264ParamSets;
 168
 169 int ff_h264_sei_decode(H264SEIContext *h, GetBitContext *gb,
 170                        const struct H264ParamSets *ps, void *logctx);
 171
 172 /**
 173  * Reset SEI values at the beginning of the frame.
 174  */
 175 void ff_h264_sei_uninit(H264SEIContext *h);
 176
 177 /**
 178  * Get stereo_mode string from the h264 frame_packing_arrangement
 179  */
 180 const char *ff_h264_sei_stereo_mode(const H264SEIFramePacking *h);
 181
 182 #endif /* AVCODEC_H264_SEI_H */