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_PAN_SCAN_RECT          = 2,   ///< pan-scan rectangle
  31     H264_SEI_TYPE_FILLER_PAYLOAD         = 3,   ///< filler data
  32     H264_SEI_TYPE_USER_DATA_REGISTERED   = 4,   ///< registered user data as specified by Rec. ITU-T T.35
  33     H264_SEI_TYPE_USER_DATA_UNREGISTERED = 5,   ///< unregistered user data
  34     H264_SEI_TYPE_RECOVERY_POINT         = 6,   ///< recovery point (frame # to decoder sync)
  35     H264_SEI_TYPE_FRAME_PACKING          = 45,  ///< frame packing arrangement
  36     H264_SEI_TYPE_DISPLAY_ORIENTATION    = 47,  ///< display orientation
  37     H264_SEI_TYPE_GREEN_METADATA         = 56,  ///< GreenMPEG information
  38     H264_SEI_TYPE_MASTERING_DISPLAY_COLOUR_VOLUME = 137,  ///< mastering display properties
  39     H264_SEI_TYPE_ALTERNATIVE_TRANSFER   = 147, ///< alternative transfer
  40 } H264_SEI_Type;
  41
  42 /**
  43  * pic_struct in picture timing SEI message
  44  */
  45 typedef enum {
  46     H264_SEI_PIC_STRUCT_FRAME             = 0, ///<  0: %frame
  47     H264_SEI_PIC_STRUCT_TOP_FIELD         = 1, ///<  1: top field
  48     H264_SEI_PIC_STRUCT_BOTTOM_FIELD      = 2, ///<  2: bottom field
  49     H264_SEI_PIC_STRUCT_TOP_BOTTOM        = 3, ///<  3: top field, bottom field, in that order
  50     H264_SEI_PIC_STRUCT_BOTTOM_TOP        = 4, ///<  4: bottom field, top field, in that order
  51     H264_SEI_PIC_STRUCT_TOP_BOTTOM_TOP    = 5, ///<  5: top field, bottom field, top field repeated, in that order
  52     H264_SEI_PIC_STRUCT_BOTTOM_TOP_BOTTOM = 6, ///<  6: bottom field, top field, bottom field repeated, in that order
  53     H264_SEI_PIC_STRUCT_FRAME_DOUBLING    = 7, ///<  7: %frame doubling
  54     H264_SEI_PIC_STRUCT_FRAME_TRIPLING    = 8  ///<  8: %frame tripling
  55 } H264_SEI_PicStructType;
  56
  57 /**
  58  * frame_packing_arrangement types
  59  */
  60 typedef enum {
  61     H264_SEI_FPA_TYPE_CHECKERBOARD        = 0,
  62     H264_SEI_FPA_TYPE_INTERLEAVE_COLUMN   = 1,
  63     H264_SEI_FPA_TYPE_INTERLEAVE_ROW      = 2,
  64     H264_SEI_FPA_TYPE_SIDE_BY_SIDE        = 3,
  65     H264_SEI_FPA_TYPE_TOP_BOTTOM          = 4,
  66     H264_SEI_FPA_TYPE_INTERLEAVE_TEMPORAL = 5,
  67     H264_SEI_FPA_TYPE_2D                  = 6,
  68 } H264_SEI_FpaType;
  69
  70 typedef struct H264SEITimeCode {
  71     /* When not continuously receiving full timecodes, we have to reference
  72        the previous timecode received */
  73     int full;
  74     int frame;
  75     int seconds;
  76     int minutes;
  77     int hours;
  78     int dropframe;
  79 } H264SEITimeCode;
  80
  81 typedef struct H264SEIPictureTiming {
  82     int present;
  83     H264_SEI_PicStructType pic_struct;
  84
  85     /**
  86      * Bit set of clock types for fields/frames in picture timing SEI message.
  87      * For each found ct_type, appropriate bit is set (e.g., bit 1 for
  88      * interlaced).
  89      */
  90     int ct_type;
  91
  92     /**
  93      * dpb_output_delay in picture timing SEI message, see H.264 C.2.2
  94      */
  95     int dpb_output_delay;
  96
  97     /**
  98      * cpb_removal_delay in picture timing SEI message, see H.264 C.1.2
  99      */
 100     int cpb_removal_delay;
 101
 102     /**
 103      * Maximum three timecodes in a pic_timing SEI.
 104      */
 105     H264SEITimeCode timecode[3];
 106
 107     /**
 108      * Number of timecode in use
 109      */
 110     int timecode_cnt;
 111 } H264SEIPictureTiming;
 112
 113 typedef struct H264SEIAFD {
 114     int present;
 115     uint8_t active_format_description;
 116 } H264SEIAFD;
 117
 118 typedef struct H264SEIA53Caption {
 119     AVBufferRef *buf_ref;
 120 } H264SEIA53Caption;
 121
 122 typedef struct H264SEIUnregistered {
 123     int x264_build;
 124 } H264SEIUnregistered;
 125
 126 typedef struct H264SEIRecoveryPoint {
 127     /**
 128      * recovery_frame_cnt
 129      *
 130      * Set to -1 if no recovery point SEI message found or to number of frames
 131      * before playback synchronizes. Frames having recovery point are key
 132      * frames.
 133      */
 134     int recovery_frame_cnt;
 135 } H264SEIRecoveryPoint;
 136
 137 typedef struct H264SEIBufferingPeriod {
 138     int present;   ///< Buffering period SEI flag
 139     int initial_cpb_removal_delay[32];  ///< Initial timestamps for CPBs
 140 } H264SEIBufferingPeriod;
 141
 142 typedef struct H264SEIFramePacking {
 143     int present;
 144     int arrangement_id;
 145     int arrangement_cancel_flag;  ///< is previous arrangement canceled, -1 if never received
 146     H264_SEI_FpaType arrangement_type;
 147     int arrangement_repetition_period;
 148     int content_interpretation_type;
 149     int quincunx_sampling_flag;
 150     int current_frame_is_frame0_flag;
 151 } H264SEIFramePacking;
 152
 153 typedef struct H264SEIDisplayOrientation {
 154     int present;
 155     int anticlockwise_rotation;
 156     int hflip, vflip;
 157 } H264SEIDisplayOrientation;
 158
 159 typedef struct H264SEIGreenMetaData {
 160     uint8_t green_metadata_type;
 161     uint8_t period_type;
 162     uint16_t num_seconds;
 163     uint16_t num_pictures;
 164     uint8_t percent_non_zero_macroblocks;
 165     uint8_t percent_intra_coded_macroblocks;
 166     uint8_t percent_six_tap_filtering;
 167     uint8_t percent_alpha_point_deblocking_instance;
 168     uint8_t xsd_metric_type;
 169     uint16_t xsd_metric_value;
 170 } H264SEIGreenMetaData;
 171
 172 typedef struct H264SEIAlternativeTransfer {
 173     int present;
 174     int preferred_transfer_characteristics;
 175 } H264SEIAlternativeTransfer;
 176
 177 typedef struct H264SEIContext {
 178     H264SEIPictureTiming picture_timing;
 179     H264SEIAFD afd;
 180     H264SEIA53Caption a53_caption;
 181     H264SEIUnregistered unregistered;
 182     H264SEIRecoveryPoint recovery_point;
 183     H264SEIBufferingPeriod buffering_period;
 184     H264SEIFramePacking frame_packing;
 185     H264SEIDisplayOrientation display_orientation;
 186     H264SEIGreenMetaData green_metadata;
 187     H264SEIAlternativeTransfer alternative_transfer;
 188 } H264SEIContext;
 189
 190 struct H264ParamSets;
 191
 192 int ff_h264_sei_decode(H264SEIContext *h, GetBitContext *gb,
 193                        const struct H264ParamSets *ps, void *logctx);
 194
 195 /**
 196  * Reset SEI values at the beginning of the frame.
 197  */
 198 void ff_h264_sei_uninit(H264SEIContext *h);
 199
 200 /**
 201  * Get stereo_mode string from the h264 frame_packing_arrangement
 202  */
 203 const char *ff_h264_sei_stereo_mode(const H264SEIFramePacking *h);
 204
 205 #endif /* AVCODEC_H264_SEI_H */