text: /* GStreamer
   * Copyright (C) <2018> Edward Hervey <edward@centricular.com>
   *
   * This library is free software; you can redistribute it and/or
   * modify it under the terms of the GNU Library General Public
   * License as published by the Free Software Foundation; either
   * version 2 of the License, or (at your option) any later version.
   *
   * This library is distributed in the hope that it will be useful,
   * but WITHOUT ANY WARRANTY; without even the implied warranty of
   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
   * Library General Public License for more details.
   *
   * You should have received a copy of the GNU Library General Public
   * License along with this library; if not, write to the
   * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
   * Boston, MA 02110-1301, USA.
   */
  
  #ifndef __GST_VIDEO_ANC_H__
  #define __GST_VIDEO_ANC_H__
  
  #include <gst/gst.h>
  #include <gst/video/video-format.h>
  #include <gst/video/video-info.h>
  
  G_BEGIN_DECLS
  
  typedef struct _GstVideoAncillary GstVideoAncillary;
  
  /**
   * GstVideoAncillary:
   * @DID: The Data Identifier
   * @SDID_block_number: The Secondary Data Identifier (if type 2) or the Data
   *                     Block Number (if type 1)
   * @data_count: The amount of data (in bytes) in @data (max 255 bytes)
   * @data: (array length=data_count): The user data content of the Ancillary packet.
   *    Does not contain the ADF, DID, SDID nor CS.
   *
   * Video Ancillary data, according to SMPTE-291M specification.
   *
   * Note that the contents of the data are always stored as 8bit data (i.e. do not contain
   * the parity check bits).
   *
   * Since: 1.16
   */
  struct _GstVideoAncillary {
    guint8 DID;
    guint8 SDID_block_number;
    guint8 data_count;
    guint8 data[256];
  
    /*< private >*/
    /* Padding for future extension */
    gpointer _gst_reserved[GST_PADDING];
  };
  
  /**
   * GstVideoAncillaryDID:
   *
   * Since: 1.16
   */
  typedef enum {
    GST_VIDEO_ANCILLARY_DID_UNDEFINED = 0x00,
    GST_VIDEO_ANCILLARY_DID_DELETION  = 0x80,
    GST_VIDEO_ANCILLARY_DID_HANC_3G_AUDIO_DATA_FIRST = 0xa0,
    GST_VIDEO_ANCILLARY_DID_HANC_3G_AUDIO_DATA_LAST = 0xa7,
    GST_VIDEO_ANCILLARY_DID_HANC_HDTV_AUDIO_DATA_FIRST = 0xe0,
    GST_VIDEO_ANCILLARY_DID_HANC_HDTV_AUDIO_DATA_LAST = 0xe7,
    GST_VIDEO_ANCILLARY_DID_HANC_SDTV_AUDIO_DATA_1_FIRST = 0xec,
    GST_VIDEO_ANCILLARY_DID_HANC_SDTV_AUDIO_DATA_1_LAST = 0xef,
    GST_VIDEO_ANCILLARY_DID_CAMERA_POSITION = 0xf0,
    GST_VIDEO_ANCILLARY_DID_HANC_ERROR_DETECTION = 0xf4,
    GST_VIDEO_ANCILLARY_DID_HANC_SDTV_AUDIO_DATA_2_FIRST = 0xf8,
    GST_VIDEO_ANCILLARY_DID_HANC_SDTV_AUDIO_DATA_2_LAST = 0xff,
  } GstVideoAncillaryDID;
  
  /**
   * GST_VIDEO_ANCILLARY_DID16:
   * @anc: a #GstVideoAncillary
   *
   * Returns the #GstVideoAncillaryDID16 of the ancillary data.
   *
   * Since: 1.16
   *
   * Returns: a #GstVideoAncillaryDID16 identifier
   */
  #define GST_VIDEO_ANCILLARY_DID16(anc) ((guint16)((anc)->DID) << 8 | (guint16)((anc)->SDID_block_number))
  
  /**
   * GstVideoAncillaryDID16:
   * @GST_VIDEO_ANCILLARY_DID16_S334_EIA_708: CEA 708 Ancillary data according to SMPTE 334
   * @GST_VIDEO_ANCILLARY_DID16_S334_EIA_608: CEA 608 Ancillary data according to SMPTE 334
   * @GST_VIDEO_ANCILLARY_DID16_S2016_3_AFD_BAR: AFD/Bar Ancillary data according to SMPTE 2016-3 (Since: 1.18)
   *
   * Some know types of Ancillary Data identifiers.
   *
   * Since: 1.16
   */
  typedef enum {
    GST_VIDEO_ANCILLARY_DID16_S334_EIA_708	= 0x6101,
    GST_VIDEO_ANCILLARY_DID16_S334_EIA_608	= 0x6102,
    GST_VIDEO_ANCILLARY_DID16_S2016_3_AFD_BAR	= 0x4105,
  } GstVideoAncillaryDID16;
  
  /**
   * GstVideoAFDValue:
   * @GST_VIDEO_AFD_UNAVAILABLE: Unavailable (see note 0 below).
   * @GST_VIDEO_AFD_16_9_TOP_ALIGNED: For 4:3 coded frame, letterbox 16:9 image,
   *      at top of the coded frame. For 16:9 coded frame, full frame 16:9 image,
   *      the same as the coded frame.
   * @GST_VIDEO_AFD_14_9_TOP_ALIGNED: For 4:3 coded frame, letterbox 14:9 image,
   *      at top of the coded frame. For 16:9 coded frame, pillarbox 14:9 image,
   *      horizontally centered in the coded frame.
   * @GST_VIDEO_AFD_GREATER_THAN_16_9: For 4:3 coded frame, letterbox image with an aspect ratio
   *      greater than 16:9, vertically centered in the coded frame. For 16:9 coded frame,
   *      letterbox image with an aspect ratio greater than 16:9.
   * @GST_VIDEO_AFD_4_3_FULL_16_9_FULL: For 4:3 coded frame, full frame 4:3 image,
   *      the same as the coded frame. For 16:9 coded frame, full frame 16:9 image, the same as
   *      the coded frame.
   * @GST_VIDEO_AFD_4_3_FULL_4_3_PILLAR: For 4:3 coded frame, full frame 4:3 image, the same as
   *      the coded frame. For 16:9 coded frame, pillarbox 4:3 image, horizontally centered in the
   *      coded frame.
   * @GST_VIDEO_AFD_16_9_LETTER_16_9_FULL: For 4:3 coded frame, letterbox 16:9 image, vertically centered in
   *      the coded frame with all image areas protected. For 16:9 coded frame, full frame 16:9 image,
   *      with all image areas protected.
   * @GST_VIDEO_AFD_14_9_LETTER_14_9_PILLAR: For 4:3 coded frame, letterbox 14:9 image, vertically centered in
   *      the coded frame. For 16:9 coded frame, pillarbox 14:9 image, horizontally centered in the
   *      coded frame.
   * @GST_VIDEO_AFD_4_3_FULL_14_9_CENTER: For 4:3 coded frame, full frame 4:3 image, with alternative 14:9
   *      center. For 16:9 coded frame, pillarbox 4:3 image, with alternative 14:9 center.
   * @GST_VIDEO_AFD_16_9_LETTER_14_9_CENTER: For 4:3 coded frame, letterbox 16:9 image, with alternative 14:9
   *      center. For 16:9 coded frame, full frame 16:9 image, with alternative 14:9 center.
   * @GST_VIDEO_AFD_16_9_LETTER_4_3_CENTER: For 4:3 coded frame, letterbox 16:9 image, with alternative 4:3
   *      center. For 16:9 coded frame, full frame 16:9 image, with alternative 4:3 center.
   *
   * Enumeration of the various values for Active Format Description (AFD)
   *
   * AFD should be included in video user data whenever the rectangular
   * picture area containing useful information does not extend to the full height or width of the coded
   * frame. AFD data may also be included in user data when the rectangular picture area containing
   * useful information extends to the full height and width of the coded frame.
   *
   * For details, see Table 6.14 Active Format in:
   *
   * ATSC Digital Television Standard:
   * Part 4 – MPEG-2 Video System Characteristics
   *
   * https://www.atsc.org/wp-content/uploads/2015/03/a_53-Part-4-2009.pdf
   *
   * and Active Format Description in Complete list of AFD codes
   *
   * https://en.wikipedia.org/wiki/Active_Format_Description#Complete_list_of_AFD_codes
   *
   * and SMPTE ST2016-1
   *
   * Notes:
   *
   * 1) AFD 0 is undefined for ATSC and SMPTE ST2016-1, indicating that AFD data is not available:
   * If Bar Data is not present, AFD '0000' indicates that exact information
   * is not available and the active image should be assumed to be the same as the coded frame. AFD '0000'.
   * AFD '0000' accompanied by Bar Data signals that the active image’s aspect ratio is narrower than 16:9,
   * but is not 4:3 or 14:9. As the exact aspect ratio cannot be conveyed by AFD alone, wherever possible,
   * AFD ‘0000’ should be accompanied by Bar Data to define the exact vertical or horizontal extent
   * of the active image.
   * 2) AFD 0 is reserved for DVB/ETSI
   * 3) values 1, 5, 6, 7, and 12 are reserved for both ATSC and DVB/ETSI
   * 4) values 2 and 3 are not recommended for ATSC, but are valid for DVB/ETSI
   *
   * Since: 1.18
   */
  typedef enum {
    GST_VIDEO_AFD_UNAVAILABLE = 0,
    GST_VIDEO_AFD_16_9_TOP_ALIGNED = 2,
    GST_VIDEO_AFD_14_9_TOP_ALIGNED = 3,
    GST_VIDEO_AFD_GREATER_THAN_16_9 = 4,
    GST_VIDEO_AFD_4_3_FULL_16_9_FULL = 8,
    GST_VIDEO_AFD_4_3_FULL_4_3_PILLAR = 9,
    GST_VIDEO_AFD_16_9_LETTER_16_9_FULL = 10,
    GST_VIDEO_AFD_14_9_LETTER_14_9_PILLAR = 11,
    GST_VIDEO_AFD_4_3_FULL_14_9_CENTER = 13,
    GST_VIDEO_AFD_16_9_LETTER_14_9_CENTER = 14,
    GST_VIDEO_AFD_16_9_LETTER_4_3_CENTER = 15
  } GstVideoAFDValue;
  
  /**
   * GstVideoAFDSpec:
   * @GST_VIDEO_AFD_SPEC_DVB_ETSI: AFD value is from DVB/ETSI standard
   * @GST_VIDEO_AFD_SPEC_ATSC_A53: AFD value is from ATSC A/53 standard
   * @GST_VIDEO_AFD_SPEC_SMPT_ST2016_1 : AFD value is from SMPTE ST2016-1 standard
   *
   * Enumeration of the different standards that may apply to AFD data:
   *
   * 0) ETSI/DVB:
   * https://www.etsi.org/deliver/etsi_ts/101100_101199/101154/02.01.01_60/ts_101154v020101p.pdf
   *
   * 1) ATSC A/53:
   * https://www.atsc.org/wp-content/uploads/2015/03/a_53-Part-4-2009.pdf
   *
   * 2) SMPTE ST2016-1:
   *
   * Since: 1.18
   */
  typedef enum {
    GST_VIDEO_AFD_SPEC_DVB_ETSI,
    GST_VIDEO_AFD_SPEC_ATSC_A53,
    GST_VIDEO_AFD_SPEC_SMPTE_ST2016_1
  } GstVideoAFDSpec;
  
  /**
   * GstVideoAFDMeta:
   * @meta: parent #GstMeta
   * @field: 0 for progressive or field 1 and 1 for field 2
   * @spec: #GstVideoAFDSpec that applies to @afd
   * @afd: #GstVideoAFDValue AFD value
   *
   * Active Format Description (AFD)
   *
   * For details, see Table 6.14 Active Format in:
   *
   * ATSC Digital Television Standard:
   * Part 4 – MPEG-2 Video System Characteristics
   *
   * https://www.atsc.org/wp-content/uploads/2015/03/a_53-Part-4-2009.pdf
   *
   * and Active Format Description in Complete list of AFD codes
   *
   * https://en.wikipedia.org/wiki/Active_Format_Description#Complete_list_of_AFD_codes
   *
   * and SMPTE ST2016-1
   *
   * Since: 1.18
   */
  typedef struct {
    GstMeta meta;
  
    guint8 field;
    GstVideoAFDSpec spec;
    GstVideoAFDValue afd;
  } GstVideoAFDMeta;
  
  GST_VIDEO_API GType gst_video_afd_meta_api_get_type (void);
  #define GST_VIDEO_AFD_META_API_TYPE (gst_video_afd_meta_api_get_type())
  
  GST_VIDEO_API const GstMetaInfo *gst_video_afd_meta_get_info (void);
  #define GST_VIDEO_AFD_META_INFO (gst_video_afd_meta_get_info())
  
  /**
   * gst_buffer_get_video_afd_meta:
   * @b: A #GstBuffer
   * @field: 0 for progressive or field 1 and 1 for field 2
   * @spec: #GstVideoAFDSpec that applies to @afd
   * @afd: #GstVideoAFDValue AFD value
   *
   * Gets the #GstVideoAFDMeta that might be present on @b.
   * Note: there may be two #GstVideoAFDMeta structs for interlaced video.
   *
   * Since: 1.18
   *
   * Returns: The first #GstVideoAFDMeta present on @b, or %NULL if
   * no #GstVideoAFDMeta are present
   */
  #define gst_buffer_get_video_afd_meta(b) \
          ((GstVideoAFDMeta*)gst_buffer_get_meta((b)))
  
  GST_VIDEO_API
  GstVideoAFDMeta *gst_buffer_add_video_afd_meta (GstBuffer * buffer, guint8 field,
  						GstVideoAFDSpec spec,
  						GstVideoAFDValue afd);
  /**
   * GstVideoBarMeta:
   * @meta: parent #GstMeta
   * @field: 0 for progressive or field 1 and 1 for field 2
   * @is_letterbox: if true then bar data specifies letterbox, otherwise pillarbox
   * @bar_data1: If @is_letterbox is true, then the value specifies the
   *      last line of a horizontal letterbox bar area at top of reconstructed frame.
   *      Otherwise, it specifies the last horizontal luminance sample of a vertical pillarbox
   *      bar area at the left side of the reconstructed frame
   * @bar_data2: If @is_letterbox is true, then the value specifies the
   *      first line of a horizontal letterbox bar area at bottom of reconstructed frame.
   *      Otherwise, it specifies the first horizontal
   *      luminance sample of a vertical pillarbox bar area at the right side of the reconstructed frame.
   *
   * Bar data should be included in video user data
   * whenever the rectangular picture area containing useful information
   * does not extend to the full height or width of the coded frame
   * and AFD alone is insufficient to describe the extent of the image.
   *
   * Note: either vertical or horizontal bars are specified, but not both.
   *
   * For more details, see:
   *
   * https://www.atsc.org/wp-content/uploads/2015/03/a_53-Part-4-2009.pdf
   *
   * and SMPTE ST2016-1
   *
   * Since: 1.18
   */
  typedef struct {
    GstMeta meta;
  
    guint8 field;
    gboolean is_letterbox;
    guint bar_data1;
    guint bar_data2;
  } GstVideoBarMeta;
  
  GST_VIDEO_API GType gst_video_bar_meta_api_get_type (void);
  #define GST_VIDEO_BAR_META_API_TYPE (gst_video_bar_meta_api_get_type())
  
  GST_VIDEO_API const GstMetaInfo *gst_video_bar_meta_get_info (void);
  #define GST_VIDEO_BAR_META_INFO (gst_video_bar_meta_get_info())
  
  #define gst_buffer_get_video_bar_meta(b) \
          ((GstVideoBarMeta*)gst_buffer_get_meta((b)))
  
  /**
   * gst_buffer_get_video_bar_meta:
   * @b: A #GstBuffer
   * @field: 0 for progressive or field 1 and 1 for field 2
   * @is_letterbox: if true then bar data specifies letterbox, otherwise pillarbox
   * @bar_data1: If @is_letterbox is true, then the value specifies the
   *      last line of a horizontal letterbox bar area at top of reconstructed frame.
   *      Otherwise, it specifies the last horizontal luminance sample of a vertical pillarbox
   *      bar area at the left side of the reconstructed frame
   * @bar_data2: If @is_letterbox is true, then the value specifies the
   *      first line of a horizontal letterbox bar area at bottom of reconstructed frame.
   *      Otherwise, it specifies the first horizontal
   *      luminance sample of a vertical pillarbox bar area at the right side of the reconstructed frame.
   * Gets the #GstVideoBarMeta that might be present on @b.
   *
   * Since: 1.18
   *
   * Returns: The first #GstVideoBarMeta present on @b, or %NULL if
   * no #GstVideoBarMeta are present
   */
  GST_VIDEO_API
  GstVideoBarMeta *gst_buffer_add_video_bar_meta (GstBuffer * buffer, guint8 field,
      gboolean is_letterbox, guint bar_data1, guint bar_data2);
  
  /* Closed Caption support */
  /**
   * GstVideoCaptionType:
   * @GST_VIDEO_CAPTION_TYPE_UNKNOWN: Unknown type of CC
   * @GST_VIDEO_CAPTION_TYPE_CEA608_RAW: CEA-608 as byte pairs. Note that
   *      this format is not recommended since is does not specify to
   *      which field the caption comes from and therefore assumes
   *      it comes from the first field (and that there is no information
   *      on the second field). Use @GST_VIDEO_CAPTION_TYPE_CEA708_RAW
   *      if you wish to store CEA-608 from two fields and prefix each byte pair
   *      with 0xFC for the first field and 0xFD for the second field.
   * @GST_VIDEO_CAPTION_TYPE_CEA608_S334_1A: CEA-608 as byte triplets as defined
   *      in SMPTE S334-1 Annex A. The second and third byte of the byte triplet
   *      is the raw CEA608 data, the first byte is a bitfield: The top/7th bit is
   *      0 for the second field, 1 for the first field, bit 6 and 5 are 0 and
   *      bits 4 to 0 are a 5 bit unsigned integer that represents the line
   *      offset relative to the base-line of the original image format (line 9
   *      for 525-line field 1, line 272 for 525-line field 2, line 5 for
   *      625-line field 1 and line 318 for 625-line field 2).
   * @GST_VIDEO_CAPTION_TYPE_CEA708_RAW: CEA-708 as cc_data byte triplets. They
   *      can also contain 608-in-708 and the first byte of each triplet has to
   *      be inspected for detecting the type.
   * @GST_VIDEO_CAPTION_TYPE_CEA708_CDP: CEA-708 (and optionally CEA-608) in
   *      a CDP (Caption Distribution Packet) defined by SMPTE S-334-2.
   *      Contains the whole CDP (starting with 0x9669).
   *
   * The various known types of Closed Caption (CC).
   *
   * Since: 1.16
   */
  typedef enum {
    GST_VIDEO_CAPTION_TYPE_UNKNOWN                = 0,
    GST_VIDEO_CAPTION_TYPE_CEA608_RAW		= 1,
    GST_VIDEO_CAPTION_TYPE_CEA608_S334_1A		= 2,
    GST_VIDEO_CAPTION_TYPE_CEA708_RAW		= 3,
    GST_VIDEO_CAPTION_TYPE_CEA708_CDP		= 4
  } GstVideoCaptionType;
  
  GST_VIDEO_API
  GstVideoCaptionType
  gst_video_caption_type_from_caps (const GstCaps *caps);
  
  GST_VIDEO_API
  GstCaps *
  gst_video_caption_type_to_caps (GstVideoCaptionType type);
  
  /**
   * GstVideoCaptionMeta:
   * @meta: parent #GstMeta
   * @caption_type: The type of Closed Caption contained in the meta.
   * @data: (array length=size): The Closed Caption data.
   * @size: The size in bytes of @data
   *
   * Extra buffer metadata providing Closed Caption.
   *
   * Since: 1.16
   */
  typedef struct {
    GstMeta meta;
  
    GstVideoCaptionType caption_type;
    guint8 *data;
    gsize size;
  } GstVideoCaptionMeta;
  
  GST_VIDEO_API
  GType	gst_video_caption_meta_api_get_type (void);
  #define GST_VIDEO_CAPTION_META_API_TYPE (gst_video_caption_meta_api_get_type())
  
  GST_VIDEO_API
  const GstMetaInfo *gst_video_caption_meta_get_info (void);
  #define GST_VIDEO_CAPTION_META_INFO (gst_video_caption_meta_get_info())
  
  /**
   * gst_buffer_get_video_caption_meta:
   * @b: A #GstBuffer
   *
   * Gets the #GstVideoCaptionMeta that might be present on @b.
   *
   * Since: 1.16
   *
   * Returns: The first #GstVideoCaptionMeta present on @b, or %NULL if
   * no #GstVideoCaptionMeta are present
   */
  #define gst_buffer_get_video_caption_meta(b) \
          ((GstVideoCaptionMeta*)gst_buffer_get_meta((b),GST_VIDEO_CAPTION_META_API_TYPE))
  
  GST_VIDEO_API
  GstVideoCaptionMeta *gst_buffer_add_video_caption_meta    (GstBuffer   * buffer,
  							   GstVideoCaptionType caption_type,
  							   const guint8 *data,
  							   gsize size);
  
  /**
   * GstVideoVBIParser:
   *
   * A parser for detecting and extracting @GstVideoAncillary data from
   * Vertical Blanking Interval lines of component signals.
   *
   * Since: 1.16
   */
  
  typedef struct _GstVideoVBIParser GstVideoVBIParser;
  
  GST_VIDEO_API
  GType gst_video_vbi_parser_get_type (void);
  
  /**
   * GstVideoVBIParserResult:
   * @GST_VIDEO_VBI_PARSER_RESULT_DONE: No line were provided, or no more Ancillary data was found.
   * @GST_VIDEO_VBI_PARSER_RESULT_OK: A #GstVideoAncillary was found.
   * @GST_VIDEO_VBI_PARSER_RESULT_ERROR: An error occurred
   *
   * Return values for #GstVideoVBIParser
   *
   * Since: 1.16
   */
  typedef enum {
    GST_VIDEO_VBI_PARSER_RESULT_DONE  = 0,
    GST_VIDEO_VBI_PARSER_RESULT_OK    = 1,
    GST_VIDEO_VBI_PARSER_RESULT_ERROR = 2
  } GstVideoVBIParserResult;
  
  GST_VIDEO_API
  GstVideoVBIParserResult gst_video_vbi_parser_get_ancillary(GstVideoVBIParser *parser,
  							   GstVideoAncillary *anc);
  
  GST_VIDEO_API
  GstVideoVBIParser *gst_video_vbi_parser_new (GstVideoFormat format, guint32 pixel_width);
  
  GST_VIDEO_API
  GstVideoVBIParser *gst_video_vbi_parser_copy (const GstVideoVBIParser *parser);
  
  GST_VIDEO_API
  void               gst_video_vbi_parser_free (GstVideoVBIParser *parser);
  
  GST_VIDEO_API
  void		   gst_video_vbi_parser_add_line (GstVideoVBIParser *parser, const guint8 *data);
  
  /**
   * GstVideoVBIEncoder:
   *
   * An encoder for writing ancillary data to the
   * Vertical Blanking Interval lines of component signals.
   *
   * Since: 1.16
   */
  
  typedef struct _GstVideoVBIEncoder GstVideoVBIEncoder;
  
  GST_VIDEO_API
  GType gst_video_vbi_encoder_get_type (void);
  
  GST_VIDEO_API
  GstVideoVBIEncoder *gst_video_vbi_encoder_new  (GstVideoFormat format, guint32 pixel_width);
  
  GST_VIDEO_API
  GstVideoVBIEncoder *gst_video_vbi_encoder_copy (const GstVideoVBIEncoder *encoder);
  
  GST_VIDEO_API
  void               gst_video_vbi_encoder_free  (GstVideoVBIEncoder *encoder);
  
  GST_VIDEO_API
  gboolean gst_video_vbi_encoder_add_ancillary   (GstVideoVBIEncoder *encoder,
                                                  gboolean            composite,
                                                  guint8              DID,
                                                  guint8              SDID_block_number,
                                                  const guint8       *data,
                                                  guint               data_count);
  
  GST_VIDEO_API
  void gst_video_vbi_encoder_write_line (GstVideoVBIEncoder *encoder, guint8 *data);
  
  G_END_DECLS
  
  #endif /* __GST_VIDEO_ANC_H__ */
  