mirror of
https://gitlab.freedesktop.org/gstreamer/gstreamer.git
synced 2024-11-27 12:11:13 +00:00
docs: add new JPEG codecparser API to the docs
And sprinkle some more Since markers
This commit is contained in:
parent
e7512329ca
commit
d8963a015f
4 changed files with 78 additions and 0 deletions
|
@ -29,6 +29,7 @@
|
|||
<filename>-lgstcodeparsers-&GST_API_VERSION;</filename> to the library flags.
|
||||
</para>
|
||||
<xi:include href="xml/gsth264parser.xml" />
|
||||
<xi:include href="xml/gstjpegparser.xml" />
|
||||
<xi:include href="xml/gstmpegvideoparser.xml" />
|
||||
<xi:include href="xml/gstmpeg4parser.xml" />
|
||||
<xi:include href="xml/gstvc1parser.xml" />
|
||||
|
|
|
@ -50,6 +50,42 @@ gst_h264_video_calculate_framerate
|
|||
<SUBSECTION Private>
|
||||
</SECTION>
|
||||
|
||||
<SECTION>
|
||||
<FILE>gstjpegparser</FILE>
|
||||
<TITLE>jpegparser</TITLE>
|
||||
<INCLUDE>gst/codecparsers/gstjpegparser.h</INCLUDE>
|
||||
GST_JPEG_MAX_FRAME_COMPONENTS
|
||||
GST_JPEG_MAX_SCAN_COMPONENTS
|
||||
GST_JPEG_MAX_QUANT_ELEMENTS
|
||||
GstJpegMarker;
|
||||
GST_JPEG_MARKER_SOF_MIN
|
||||
GST_JPEG_MARKER_SOF_MAX
|
||||
GST_JPEG_MARKER_APP_MIN
|
||||
GST_JPEG_MARKER_APP_MAX
|
||||
GST_JPEG_MARKER_RST_MIN
|
||||
GST_JPEG_MARKER_RST_MAX
|
||||
GstJpegEntropyCodingMode
|
||||
GstJpegProfile
|
||||
GstJpegSegment
|
||||
gst_jpeg_parse
|
||||
GstJpegFrameHdr
|
||||
GstJpegFrameComponent
|
||||
gst_jpeg_segment_parse_frame_header
|
||||
GstJpegScanHdr
|
||||
GstJpegScanComponent
|
||||
gst_jpeg_segment_parse_scan_header
|
||||
GstJpegHuffmanTables
|
||||
GstJpegHuffmanTable
|
||||
gst_jpeg_segment_parse_huffman_table
|
||||
GstJpegQuantTable
|
||||
gst_jpeg_segment_parse_quantization_table
|
||||
gst_jpeg_segment_parse_restart_interval
|
||||
gst_jpeg_get_default_quantization_tables
|
||||
gst_jpeg_get_default_huffman_tables
|
||||
<SUBSECTION Standard>
|
||||
<SUBSECTION Private>
|
||||
</SECTION>
|
||||
|
||||
<SECTION>
|
||||
<FILE>gstvc1parser</FILE>
|
||||
<TITLE>vc1parser</TITLE>
|
||||
|
|
|
@ -18,6 +18,17 @@
|
|||
* Boston, MA 02110-1301 USA
|
||||
*/
|
||||
|
||||
/**
|
||||
* SECTION:gstjpegparser
|
||||
* @short_description: Convenience library for JPEG bitstream parsing.
|
||||
*
|
||||
* <refsect2>
|
||||
* <para>
|
||||
* Provides useful functions for parsing JPEG images
|
||||
* </para>
|
||||
* </refsect2>
|
||||
*/
|
||||
|
||||
#include <string.h>
|
||||
#include <stdlib.h>
|
||||
#include <gst/base/gstbytereader.h>
|
||||
|
|
|
@ -34,6 +34,8 @@ G_BEGIN_DECLS
|
|||
* GST_JPEG_MAX_FRAME_COMPONENTS:
|
||||
*
|
||||
* Maximum number of image components in a frame (Nf).
|
||||
*
|
||||
* Since: 1.6
|
||||
*/
|
||||
#define GST_JPEG_MAX_FRAME_COMPONENTS 256
|
||||
|
||||
|
@ -41,6 +43,8 @@ G_BEGIN_DECLS
|
|||
* GST_JPEG_MAX_SCAN_COMPONENTS:
|
||||
*
|
||||
* Maximum number of image components in a scan (Ns).
|
||||
*
|
||||
* Since: 1.6
|
||||
*/
|
||||
#define GST_JPEG_MAX_SCAN_COMPONENTS 4
|
||||
|
||||
|
@ -48,6 +52,8 @@ G_BEGIN_DECLS
|
|||
* GST_JPEG_MAX_QUANT_ELEMENTS:
|
||||
*
|
||||
* Number of elements in the quantization table.
|
||||
*
|
||||
* Since: 1.6
|
||||
*/
|
||||
#define GST_JPEG_MAX_QUANT_ELEMENTS 64
|
||||
|
||||
|
@ -105,6 +111,8 @@ typedef struct _GstJpegSegment GstJpegSegment;
|
|||
* @GST_JPEG_MARKER_COM: Comment marker code
|
||||
*
|
||||
* Indicates the type of JPEG segment.
|
||||
*
|
||||
* Since: 1.6
|
||||
*/
|
||||
typedef enum {
|
||||
GST_JPEG_MARKER_SOF0 = 0xC0,
|
||||
|
@ -175,6 +183,8 @@ typedef enum {
|
|||
* @GST_JPEG_PROFILE_LOSSLESS: Lossless (sequential)
|
||||
*
|
||||
* JPEG encoding processes.
|
||||
*
|
||||
* Since: 1.6
|
||||
*/
|
||||
typedef enum {
|
||||
GST_JPEG_PROFILE_BASELINE = 0x00,
|
||||
|
@ -189,6 +199,8 @@ typedef enum {
|
|||
* @GST_JPEG_ENTROPY_CODING_ARITHMETIC: arithmetic coding
|
||||
*
|
||||
* JPEG entropy coding mode.
|
||||
*
|
||||
* Since: 1.6
|
||||
*/
|
||||
typedef enum {
|
||||
GST_JPEG_ENTROPY_CODING_HUFFMAN = 0x00,
|
||||
|
@ -203,6 +215,8 @@ typedef enum {
|
|||
* already been parsed
|
||||
*
|
||||
* Quantization table.
|
||||
*
|
||||
* Since: 1.6
|
||||
*/
|
||||
struct _GstJpegQuantTable
|
||||
{
|
||||
|
@ -217,6 +231,8 @@ struct _GstJpegQuantTable
|
|||
*
|
||||
* Helper data structure that holds all quantization tables used to
|
||||
* decode an image.
|
||||
*
|
||||
* Since: 1.6
|
||||
*/
|
||||
struct _GstJpegQuantTables
|
||||
{
|
||||
|
@ -231,6 +247,8 @@ struct _GstJpegQuantTables
|
|||
* been parsed
|
||||
*
|
||||
* Huffman table.
|
||||
*
|
||||
* Since: 1.6
|
||||
*/
|
||||
struct _GstJpegHuffmanTable
|
||||
{
|
||||
|
@ -246,6 +264,8 @@ struct _GstJpegHuffmanTable
|
|||
*
|
||||
* Helper data structure that holds all AC/DC Huffman tables used to
|
||||
* decode an image.
|
||||
*
|
||||
* Since: 1.6
|
||||
*/
|
||||
struct _GstJpegHuffmanTables
|
||||
{
|
||||
|
@ -260,6 +280,8 @@ struct _GstJpegHuffmanTables
|
|||
* @ac_selector: AC entropy coding table destination selector (Taj)
|
||||
|
||||
* Component-specification parameters.
|
||||
*
|
||||
* Since: 1.6
|
||||
*/
|
||||
struct _GstJpegScanComponent
|
||||
{
|
||||
|
@ -274,6 +296,8 @@ struct _GstJpegScanComponent
|
|||
* @components: Image components
|
||||
*
|
||||
* Scan header.
|
||||
*
|
||||
* Since: 1.6
|
||||
*/
|
||||
struct _GstJpegScanHdr
|
||||
{
|
||||
|
@ -289,6 +313,8 @@ struct _GstJpegScanHdr
|
|||
* @quant_table_selector: Quantization table destination selector (Tqi)
|
||||
*
|
||||
* Component-specification parameters.
|
||||
*
|
||||
* Since: 1.6
|
||||
*/
|
||||
struct _GstJpegFrameComponent
|
||||
{
|
||||
|
@ -308,6 +334,8 @@ struct _GstJpegFrameComponent
|
|||
* @restart_interval: Number of MCU in the restart interval (Ri)
|
||||
*
|
||||
* Frame header.
|
||||
*
|
||||
* Since: 1.6
|
||||
*/
|
||||
struct _GstJpegFrameHdr
|
||||
{
|
||||
|
@ -329,6 +357,8 @@ struct _GstJpegFrameHdr
|
|||
* marker code but including any length bytes.
|
||||
*
|
||||
* A structure that contains the type of a segment, its offset and its size.
|
||||
*
|
||||
* Since: 1.6
|
||||
*/
|
||||
struct _GstJpegSegment
|
||||
{
|
||||
|
|
Loading…
Reference in a new issue