summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTim-Philipp Müller <tim@centricular.com>2015-06-21 13:55:29 +0100
committerTim-Philipp Müller <tim@centricular.com>2015-06-21 13:55:29 +0100
commitd8963a015f51f872f8a05d50839370b7f52b9dbd (patch)
tree0aa523b7d7347aa11e048c074329fdb3748b4383
parente7512329cac59b60bf911639320c746d637f9f90 (diff)
docs: add new JPEG codecparser API to the docs
And sprinkle some more Since markers
-rw-r--r--docs/libs/gst-plugins-bad-libs-docs.sgml1
-rw-r--r--docs/libs/gst-plugins-bad-libs-sections.txt36
-rw-r--r--gst-libs/gst/codecparsers/gstjpegparser.c11
-rw-r--r--gst-libs/gst/codecparsers/gstjpegparser.h30
4 files changed, 78 insertions, 0 deletions
diff --git a/docs/libs/gst-plugins-bad-libs-docs.sgml b/docs/libs/gst-plugins-bad-libs-docs.sgml
index 0adc54ef1..76651b790 100644
--- a/docs/libs/gst-plugins-bad-libs-docs.sgml
+++ b/docs/libs/gst-plugins-bad-libs-docs.sgml
@@ -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" />
diff --git a/docs/libs/gst-plugins-bad-libs-sections.txt b/docs/libs/gst-plugins-bad-libs-sections.txt
index a1e346e2c..3b7cc0549 100644
--- a/docs/libs/gst-plugins-bad-libs-sections.txt
+++ b/docs/libs/gst-plugins-bad-libs-sections.txt
@@ -51,6 +51,42 @@ gst_h264_video_calculate_framerate
</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>
<INCLUDE>gst/codecparsers/gstvc1parser.h</INCLUDE>
diff --git a/gst-libs/gst/codecparsers/gstjpegparser.c b/gst-libs/gst/codecparsers/gstjpegparser.c
index ead0ad4b0..7235f836b 100644
--- a/gst-libs/gst/codecparsers/gstjpegparser.c
+++ b/gst-libs/gst/codecparsers/gstjpegparser.c
@@ -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>
diff --git a/gst-libs/gst/codecparsers/gstjpegparser.h b/gst-libs/gst/codecparsers/gstjpegparser.h
index 87f01875a..5ba5a358a 100644
--- a/gst-libs/gst/codecparsers/gstjpegparser.h
+++ b/gst-libs/gst/codecparsers/gstjpegparser.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
{