/*
- * gstjpegparser.h - JPEG parser for baseline
+ * gstjpegparser.h - JPEG parser
*
* Copyright (C) 2011 Intel Corporation
*
G_BEGIN_DECLS
-#define GST_JPEG_MAX_COMPONENTS 4
-#define GST_JPEG_QUANT_ELEMENTS_SIZE 64
+/**
+ * GST_JPEG_MAX_FRAME_COMPONENTS:
+ *
+ * Maximum number of image components in a frame (Nf).
+ */
+#define GST_JPEG_MAX_FRAME_COMPONENTS 256
+
+/**
+ * GST_JPEG_MAX_SCAN_COMPONENTS:
+ *
+ * Maximum number of image components in a scan (Ns).
+ */
+#define GST_JPEG_MAX_SCAN_COMPONENTS 4
+
+/**
+ * GST_JPEG_MAX_QUANT_ELEMENTS:
+ *
+ * Number of elements in the quantization table.
+ */
+#define GST_JPEG_MAX_QUANT_ELEMENTS 64
typedef struct _GstJpegQuantTable GstJpegQuantTable;
typedef struct _GstJpegHuffmanTable GstJpegHuffmanTable;
-typedef struct _GstJpegScan GstJpegScan;
-typedef struct _GstJpegImage GstJpegImage;
+typedef struct _GstJpegScanComponent GstJpegScanComponent;
+typedef struct _GstJpegScanHdr GstJpegScanHdr;
+typedef struct _GstJpegFrameComponent GstJpegFrameComponent;
+typedef struct _GstJpegFrameHdr GstJpegFrameHdr;
+typedef struct _GstJpegTypeOffsetSize GstJpegTypeOffsetSize;
+/**
+ * GstJpegParserResult:
+ * @GST_JPEG_PARSER_OK: The parsing succeeded
+ * @GST_JPEG_PARSER_BROKEN_DATA: The data to parse is broken
+ * @GST_JPEG_PARSER_NO_SCAN_FOUND: No scan found during the parsing
+ * @GST_JPEG_PARSER_ERROR: An error occured while parsing
+ *
+ * The result of parsing JPEG data.
+ */
typedef enum
{
GST_JPEG_PARSER_OK,
- GST_JPEG_PARSER_UNSUPPORTED_PROFILE,
- GST_JPEG_PARSER_NOT_JPEG,
GST_JPEG_PARSER_BROKEN_DATA,
GST_JPEG_PARSER_NO_SCAN_FOUND,
- GST_JPEG_PARSER_FRAME_ERROR,
- GST_JPEG_PARSER_SCAN_ERROR,
- GST_JPEG_PARSER_HUFFMAN_ERROR,
- GST_JPEG_PARSER_QUANT_ERROR,
- GST_JPEG_PARSER_DRI_ERROR,
+ GST_JPEG_PARSER_ERROR,
} GstJpegParserResult;
+/**
+ * GstJpegMarkerCode:
+ * @GST_JPEG_MARKER_SOF_MIN: Start of frame min marker code
+ * @GST_JPEG_MARKER_SOF_MAX: Start of frame max marker code
+ * @GST_JPEG_MARKER_DHT: Huffman tabler marker code
+ * @GST_JPEG_MARKER_DAC: Arithmetic coding marker code
+ * @GST_JPEG_MARKER_RST_MIN: Restart interval min marker code
+ * @GST_JPEG_MARKER_RST_MAX: Restart interval max marker code
+ * @GST_JPEG_MARKER_SOI: Start of image marker code
+ * @GST_JPEG_MARKER_EOI: End of image marker code
+ * @GST_JPEG_MARKER_SOS: Start of scan marker code
+ * @GST_JPEG_MARKER_DQT: Define quantization table marker code
+ * @GST_JPEG_MARKER_DNL: Define number of lines marker code
+ * @GST_JPEG_MARKER_DRI: Define restart interval marker code
+ * @GST_JPEG_MARKER_APP_MIN: Application segment min marker code
+ * @GST_JPEG_MARKER_APP_MAX: Application segment max marker code
+ * @GST_JPEG_MARKER_COM: Comment marker code
+ *
+ * Indicates the type of JPEG segment.
+ */
+typedef enum {
+ GST_JPEG_MARKER_SOF_MIN = 0xC0,
+ GST_JPEG_MARKER_SOF_MAX = 0xCF,
+ GST_JPEG_MARKER_DHT = 0xC4,
+ GST_JPEG_MARKER_DAC = 0xCC,
+ GST_JPEG_MARKER_RST_MIN = 0xD0,
+ GST_JPEG_MARKER_RST_MAX = 0xD7,
+ GST_JPEG_MARKER_SOI = 0xD8,
+ GST_JPEG_MARKER_EOI = 0xD9,
+ GST_JPEG_MARKER_SOS = 0xDA,
+ GST_JPEG_MARKER_DQT = 0xDB,
+ GST_JPEG_MARKER_DNL = 0xDC,
+ GST_JPEG_MARKER_DRI = 0xDD,
+ GST_JPEG_MARKER_APP_MIN = 0xE0,
+ GST_JPEG_MARKER_APP_MAX = 0xEF,
+ GST_JPEG_MARKER_COM = 0xFE,
+} GstJpegMarkerCode;
+
+/**
+ * GstJpegProfile:
+ * @GST_JPEG_PROFILE_BASELINE: Baseline DCT
+ * @GST_JPEG_PROFILE_EXTENDED: Extended sequential DCT
+ * @GST_JPEG_PROFILE_PROGRESSIVE: Progressive DCT
+ * @GST_JPEG_PROFILE_LOSSLESS: Lossless (sequential)
+ * @GST_JPEG_PROFILE_ARITHMETIC: Flag for arithmetic coding
+ *
+ * JPEG encoding processes.
+ */
+typedef enum {
+ GST_JPEG_PROFILE_BASELINE = 0x00,
+ GST_JPEG_PROFILE_EXTENDED = 0x01,
+ GST_JPEG_PROFILE_PROGRESSIVE = 0x02,
+ GST_JPEG_PROFILE_LOSSLESS = 0x03,
+ GST_JPEG_PROFILE_ARITHMETIC = 0x80
+} GstJpegProfile;
+
+/**
+ * GstJpegQuantTable:
+ * @quant_precision: Quantization table element precision (Pq)
+ * @quant_table: Quantization table elements (Qk)
+ *
+ * Quantization table.
+ */
struct _GstJpegQuantTable
{
- guint8 quant_precision; /* 4 bits; Value 0 indicates 8bit Q values; value 1 indicates 16bit Q values */
- guint8 quant_table[GST_JPEG_QUANT_ELEMENTS_SIZE * 2]; /* 64*8(or 64*16) bits, zigzag mode */
+ guint8 quant_precision;
+ guint16 quant_table[GST_JPEG_MAX_QUANT_ELEMENTS];
};
+/**
+ * GstJpegHuffmanTable:
+ * @huf_bits: Number of Huffman codes of length i + 1 (Li)
+ * @huf_vales: Value associated with each Huffman code (Vij)
+ *
+ * Huffman table.
+ */
struct _GstJpegHuffmanTable
{
guint8 huf_bits[16];
guint8 huf_values[256];
};
-struct _GstJpegScan
+/**
+ * GstJpegScanComponent:
+ * @component_selector: Scan component selector (Csj)
+ * @dc_selector: DC entropy coding table destination selector (Tdj)
+ * @ac_selector: AC entropy coding table destination selector (Taj)
+
+ * Component-specification parameters.
+ */
+struct _GstJpegScanComponent
{
- guint8 num_components; /* 8 bits */
- struct
- {
- guint8 component_selector; /* 8 bits */
- guint8 dc_selector; /* 4 bits */
- guint8 ac_selector; /* 4 bits */
- } components[GST_JPEG_MAX_COMPONENTS];
+ guint8 component_selector; /* 0 .. 255 */
+ guint8 dc_selector; /* 0 .. 3 */
+ guint8 ac_selector; /* 0 .. 3 */
};
-struct _GstJpegImage
+/**
+ * GstJpegScanHdr:
+ * @num_components: Number of image components in scan (Ns)
+ * @components: Image components
+ *
+ * Scan header.
+ */
+struct _GstJpegScanHdr
{
- guint32 frame_type;
- guint8 sample_precision; /* 8 bits */
- guint16 height; /* 16 bits */
- guint16 width; /* 16 bits */
- guint8 num_components; /* 8 bits */
- struct
- {
- guint8 identifier; /* 8 bits */
- guint8 horizontal_factor; /* 4 bits */
- guint8 vertical_factor; /* 4 bits */
- guint8 quant_table_selector; /* 8 bits */
- } components[GST_JPEG_MAX_COMPONENTS];
-
- GstJpegQuantTable quant_tables[GST_JPEG_MAX_COMPONENTS];
- GstJpegHuffmanTable dc_huf_tables[GST_JPEG_MAX_COMPONENTS];
- GstJpegHuffmanTable ac_huf_tables[GST_JPEG_MAX_COMPONENTS];
- guint32 restart_interval; /* DRI */
-
- GstJpegScan current_scan;
-
- const guint8 *jpeg_pos;
- const guint8 *jpeg_begin;
- const guint8 *jpeg_end;
+ guint8 num_components; /* 1 .. 4 */
+ GstJpegScanComponent components[GST_JPEG_MAX_SCAN_COMPONENTS];
};
-/* parse to first scan and stop there */
-GstJpegParserResult gst_jpeg_parse_image (GstJpegImage * image,
- const guint8 * buf,
- guint32 size);
+/**
+ * GstJpegFrameComponent:
+ * @identifier: Component identifier (Ci)
+ * @horizontal_factor: Horizontal sampling factor (Hi)
+ * @vertical_factor: Vertical sampling factor (Vi)
+ * @quant_table_selector: Quantization table destination selector (Tqi)
+ *
+ * Component-specification parameters.
+ */
+struct _GstJpegFrameComponent
+{
+ guint8 identifier; /* 0 .. 255 */
+ guint8 horizontal_factor; /* 1 .. 4 */
+ guint8 vertical_factor; /* 1 .. 4 */
+ guint8 quant_table_selector; /* 0 .. 3 */
+};
-GstJpegParserResult gst_jpeg_parse_next_scan (GstJpegImage * image);
+/**
+ * GstJpegFrameHdr:
+ * @profile: JPEG encoding process (see #GstJpegProfile)
+ * @sample_precision: Sample precision (P)
+ * @height: Number of lines (Y)
+ * @width: Number of samples per line (X)
+ * @num_components: Number of image components in frame (Nf)
+ * @components: Image components
+ * @restart_interval: Number of MCU in the restart interval (Ri)
+ *
+ * Frame header.
+ */
+struct _GstJpegFrameHdr
+{
+ guint8 profile;
+ guint8 sample_precision; /* 2 .. 16 */
+ guint16 width; /* 1 .. 65535 */
+ guint16 height; /* 0 .. 65535 */
+ guint8 num_components; /* 1 .. 255 */
+ GstJpegFrameComponent components[GST_JPEG_MAX_FRAME_COMPONENTS];
+};
+
+/**
+ * GstJpegTypeOffsetSize:
+ * @type: The type of the segment that starts at @offset
+ * @offset: The offset to the segment start in bytes
+ * @size: The size in bytes of the segment, or -1 if the end was not found
+ *
+ * A structure that contains the type of a segment, its offset and its size.
+ */
+struct _GstJpegTypeOffsetSize
+{
+ guint8 type;
+ guint offset;
+ gint size;
+};
+
+/**
+ * gst_jpeg_parse:
+ * @data: The data to parse
+ * @size: The size of @data
+ * @offset: The offset from which to start parsing
+ *
+ * Parses the JPEG bitstream contained in @data, and returns the detected
+ * segments as a newly-allocated list of #GstJpegTypeOffsetSize elements.
+ * The caller is responsible for destroying the list when no longer needed.
+ *
+ * Returns: a #GList of #GstJpegTypeOffsetSize.
+ */
+GList *gst_jpeg_parse (const guint8 * data,
+ gsize size,
+ guint offset);
+
+/**
+ * gst_jpeg_parse_frame_hdr:
+ * @hdr: (out): The #GstJpegFrameHdr structure to fill in
+ * @data: The data from which to parse the frame header
+ * @size: The size of @data
+ * @offset: The offset in bytes from which to start parsing @data
+ *
+ * Parses the @hdr JPEG frame header structure members from @data.
+ *
+ * Returns: a #GstJpegParserResult
+ */
+GstJpegParserResult gst_jpeg_parse_frame_hdr (GstJpegFrameHdr * hdr,
+ const guint8 * data,
+ gsize size,
+ guint offset);
+
+/**
+ * gst_jpeg_parse_scan_hdr:
+ * @hdr: (out): The #GstJpegScanHdr structure to fill in
+ * @data: The data from which to parse the scan header
+ * @size: The size of @data
+ * @offset: The offset in bytes from which to start parsing @data
+ *
+ * Parses the @hdr JPEG scan header structure members from @data.
+ *
+ * Returns: a #GstJpegParserResult
+ */
+GstJpegParserResult gst_jpeg_parse_scan_hdr (GstJpegScanHdr * hdr,
+ const guint8 * data,
+ gsize size,
+ guint offset);
+
+/**
+ * gst_jpeg_parse_quantization_table:
+ * @quant_tables: (out): The #GstJpegQuantizationTable structure to fill in
+ * @num_quant_tables: The number of allocated quantization tables in @quant_tables
+ * @data: The data from which to parse the quantization table
+ * @size: The size of @data
+ * @offset: The offset in bytes from which to start parsing @data
+ *
+ * Parses the JPEG quantization table structure members from @data.
+ *
+ * Note: @quant_tables represents the user-allocated quantization
+ * tables based on the number of scan components. That is, the parser
+ * writes the output quantization table at the index specified by the
+ * quantization table destination identifier (Tq). So, the array of
+ * quantization tables shall be large enough to hold the table for the
+ * last component.
+ *
+ * Returns: a #GstJpegParserResult
+ */
+GstJpegParserResult gst_jpeg_parse_quant_table (GstJpegQuantTable *quant_tables,
+ guint num_quant_tables,
+ const guint8 * data,
+ gsize size,
+ guint offset);
-/* return skip bytes length */
-guint32 gst_jpeg_skip_to_scan_end (GstJpegImage * image);
-const guint8 * gst_jpeg_get_position (GstJpegImage * image);
-guint32 gst_jpeg_get_left_size (GstJpegImage * image);
+/**
+ * gst_jpeg_parse_huffman_table:
+ * @huf_tables: (out): The #GstJpegHuffmanTable structure to fill in
+ * @num_huf_tables: The number of allocated Huffman tables in @huf_tables
+ * @data: The data from which to parse the Huffman table
+ * @size: The size of @data
+ * @offset: The offset in bytes from which to start parsing @data
+ *
+ * Parses the JPEG Huffman table structure members from @data.
+ *
+ * Note: @huf_tables represents the user-allocated Huffman tables
+ * based on the number of scan components. That is, the parser writes
+ * the output Huffman table at the index specified by the Huffman
+ * table destination identifier (Th). So, the array of Huffman tables
+ * shall be large enough to hold the table for the last component.
+ *
+ * Returns: a #GstJpegParserResult
+ */
+GstJpegParserResult gst_jpeg_parse_huffman_table (GstJpegHuffmanTable *huf_tables,
+ guint num_huf_tables,
+ const guint8 * data,
+ gsize size,
+ guint offset);
+
+/**
+ * gst_jpeg_parse_restart_interval:
+ * @interval: (out): The parsed restart interval value
+ * @data: The data from which to parse the restart interval specification
+ * @size: The size of @data
+ * @offset: The offset in bytes from which to start parsing @data
+ *
+ * Returns: a #GstJpegParserResult
+ */
+GstJpegParserResult gst_jpeg_parse_restart_interval (guint * interval,
+ const guint8 * data,
+ gsize size,
+ guint offset);
G_END_DECLS
projects / platform / upstream / gstreamer-vaapi.git / commitdiff