mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2025-02-19 20:46:22 +00:00
Code Issues 1 Projects Releases Wiki Activity

encoding-profile: Fix documentation and port to gtk markdown

Browse source 
And remove some trailling whitepsaces
This commit is contained in:
Thibault Saunier 2016-12-16 11:11:57 -03:00
parent 6f50b59a20
commit d67f945177
3 changed files with 105 additions and 123 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

212
gst-libs/gst/pbutils/encoding-profile.c
View file

@ -22,114 +22,102 @@
* SECTION:encoding-profile * SECTION:encoding-profile
* @short_description: Encoding profile library * @short_description: Encoding profile library
* *
* <refsect2>
* <para>
* Functions to create and handle encoding profiles. * Functions to create and handle encoding profiles.
* </para> *
* <para> * Encoding profiles describe the media types and settings one wishes to use
* Encoding profiles describe the media types and settings one wishes to use for * for an encoding process. The top-level profiles are commonly
* an encoding process. The top-level profiles are commonly
* #GstEncodingContainerProfile(s) (which contains a user-readable name and * #GstEncodingContainerProfile(s) (which contains a user-readable name and
* description along with which container format to use). These, in turn, * description along with which container format to use). These, in turn,
* reference one or more #GstEncodingProfile(s) which indicate which encoding * reference one or more #GstEncodingProfile(s) which indicate which encoding
* format should be used on each individual streams. * format should be used on each individual streams.
* </para>
* <para>
* #GstEncodingProfile(s) can be provided to the 'encodebin' element, which will take
* care of selecting and setting up the required elements to produce an output stream
* conforming to the specifications of the profile.
* </para>
* <para>
* Unlike other systems, the encoding profiles do not specify which #GstElement to use
* for the various encoding and muxing steps, but instead relies on specifying the format
* one wishes to use.
* </para>
* <para>
* Encoding profiles can be created at runtime by the application or loaded from (and saved
* to) file using the #GstEncodingTarget API.
* </para>
* </refsect2>
* *
* <refsect2 id="gst-validate-transcoding--encoding-profile"> * #GstEncodingProfile(s) can be provided to the 'encodebin' element, which
* <title>The encoding profile serialization format</title> * will take care of selecting and setting up the required elements to produce
* <para>This is the serialization format of a <link linkend="GstEncodingProfile"><type>GstEncodingProfile</type></link>.</para> * an output stream conforming to the specifications of the profile.
* <para> *
* Internally the transcoding application uses <link linkend="GstEncodeBin"><type>GstEncodeBin</type></link>. <command>gst-validate-transcoding-&GST_API_VERSION;</command> uses its own * Unlike other systems, the encoding profiles do not specify which #GstElement
* serialization format to describe the <link linkend="GstEncodeBin--profile"><type>GstEncodeBin.profile</type></link> * to use for the various encoding and muxing steps, but instead relies on
* property of the encodebin. * specifying the format one wishes to use.
* </para> *
* <para> * Encoding profiles can be created at runtime by the application or loaded
* The simplest serialized profile looks like: * from (and saved to) file using the #GstEncodingTarget API.
* </para> *
* <informalexample> * # The encoding profile serialization format
* <programlisting>muxer_source_caps:videoencoder_source_caps:audioencoder_source_caps</programlisting> *
* </informalexample> * This is the serialization format of a #GstEncodingProfile The simplest
* <para> * serialized profile looks like:
* For example to encode a stream into a WebM container, with an OGG audio stream and a VP8 video stream, *
* the serialized <link linkend="GstEncodingProfile"><type>GstEncodingProfile</type></link> will look like:
* </para>
* <informalexample>
* <programlisting>video/webm:video/x-vp8:audio/x-vorbis</programlisting>
* </informalexample>
* <para>
* You can also set the preset name of the encoding profile using the caps+preset_name syntax as in:
* </para>
* <informalexample>
* <programlisting>video/webm:video/x-vp8+youtube-preset:audio/x-vorbis</programlisting>
* </informalexample>
* <para>
* Moreover, you can set the <link linkend="gst-encoding-profile-set-presence">presence</link> property of an
* encoding profile using the <code>|presence</code> syntax as in:
* </para>
* <informalexample>
* <programlisting>video/webm:video/x-vp8|1:audio/x-vorbis</programlisting>
* </informalexample>
* <para>
* This field allows you to specify how many times maximum a <link linkend="GstEncodingProfile"><type>GstEncodingProfile</type></link> can be used inside an encodebin.
* </para>
* <para>
* You can also use the <code>restriction_caps->encoded_format_caps</code> syntax to specify the
* <link linked="gst-encoding-profile-get-restriction">restriction caps</link>
* to be set on a <link linkend="GstEncodingProfile"><type>GstEncodingProfile</type></link>. It corresponds to the
* restriction <link linkend="GstCaps"><type>GstCaps</type></link> to apply before
* the encoder that will be used in the profile. The fields present in restriction
* caps are properties of the raw stream (that is, before encoding), such as height
* and width for video and depth and sampling rate for audio. This property does not
* make sense for muxers.
* </para>
* <para>
* To force a video stream to be encoded with a Full HD resolution (using WebM as the container format,
* VP8 as the video codec and Vorbis as the audio codec), you should use:
* </para>
* <informalexample>
* <programlisting>video/webm:video/x-raw,width=1920,height=1080->video/x-vp8:audio/x-vorbis</programlisting>
* </informalexample>
* <refsect3>
* <title>Some serialized encoding formats examples:</title>
* <para>
* MP3 audio and H264 in MP4:
* </para>
* <informalexample>
* <programlisting>video/quicktime,variant=iso:video/x-h264:audio/mpeg,mpegversion=1,layer=3</programlisting>
* </informalexample>
* <para>
* Vorbis and theora in OGG:
* </para>
* <informalexample>
* <programlisting>application/ogg:video/x-theora:audio/x-vorbis</programlisting>
* </informalexample>
* <para>
* AC3 and H264 in MPEG-TS:
* </para>
* <informalexample>
* <programlisting>video/mpegts:video/x-h264:audio/x-ac3</programlisting>
* </informalexample>
* </refsect3>
* </refsect2>
* <refsect2>
* <title>Example: Creating a profile</title>
* <para>
* |[ * |[
* muxer_source_caps:videoencoder_source_caps:audioencoder_source_caps
* ]|
*
* For example to encode a stream into a WebM container, with an OGG audio
* stream and a VP8 video stream, the serialized #GstEncodingProfilewill look
* like:
*
* |[
* video/webm:video/x-vp8:audio/x-vorbis
* ]|
*
* You can also set the preset name of the encoding profile using the
* caps+preset_name syntax as in:
*
* |[
* video/webm:video/x-vp8+youtube-preset:audio/x-vorbis
* ]|
*
* Moreover, you can set the `presence` property of an
* encoding profile using the `|presence` syntax as in:
*
* |[
* video/webm:video/x-vp8|1:audio/x-vorbis
* ]|
*
* This field allows specifies the maximum number of times a
* #GstEncodingProfile can be used inside an encodebin. If 0, it is not a
* mandatory stream.
*
* You can also use the `restriction_caps->encoded_format_caps` syntax to
* specify the restriction caps to be set on a #GstEncodingProfile
*
* It corresponds to the restriction #GstCaps to apply before the encoder that
* will be used in the profile. The fields present in restriction caps are
* properties of the raw stream (that is, before encoding), such as height and
* width for video and depth and sampling rate for audio. This property does
* not make sense for muxers. See #gst_encoding_profile_get_restriction for
* more details.
*
* To force a video stream to be encoded with a Full HD resolution (using WebM
* as the container format, VP8 as the video codec and Vorbis as the audio
* codec), you should use:
*
* |[
* video/webm:video/x-raw,width=1920,height=1080->video/x-vp8:audio/x-vorbis
* ]|
*
* ## Some serialized encoding formats examples:
*
* MP3 audio and H264 in MP4:
*
* |[
* video/quicktime,variant=iso:video/x-h264:audio/mpeg,mpegversion=1,layer=3
* ]|
*
* Vorbis and theora in OGG:
*
* |[
* application/ogg:video/x-theora:audio/x-vorbis
* ]|
*
* AC3 and H264 in MPEG-TS:
*
* |[
* video/mpegts:video/x-h264:audio/x-ac3
* ]|
*
* # Example: Creating a profile
*
* |[<!-- language="c" -->
* #include <gst/pbutils/encoding-profile.h> * #include <gst/pbutils/encoding-profile.h>
* ... * ...
* GstEncodingProfile * * GstEncodingProfile *
@ -159,12 +147,10 @@
* *
* *
* ]| * ]|
* </para> *
* </refsect2> * # Example: Using an encoder preset with a profile
* <refsect2> *
* <title>Example: Using an encoder preset with a profile</title> * |[ <!-- language="c" -->
* <para>
* |[
* #include <gst/pbutils/encoding-profile.h> * #include <gst/pbutils/encoding-profile.h>
* ... * ...
* GstEncodingProfile * * GstEncodingProfile *
@ -204,12 +190,10 @@
* *
* *
* ]| * ]|
* </para> *
* </refsect2> * # Example: Listing categories, targets and profiles
* <refsect2> *
* <title>Example: Listing categories, targets and profiles</title> * |[ <!-- language="C" -->
* <para>
* |[
* #include <gst/pbutils/encoding-profile.h> * #include <gst/pbutils/encoding-profile.h>
* ... * ...
* GstEncodingProfile *prof; * GstEncodingProfile *prof;
@ -238,8 +222,6 @@
* *
* ... * ...
* ]| * ]|
* </para>
* </refsect2>
*/ */
#ifdef HAVE_CONFIG_H #ifdef HAVE_CONFIG_H

4
gst/encoding/gstencodebin.c
View file

@ -1204,7 +1204,7 @@ _create_stream_group (GstEncodeBin * ebin, GstEncodingProfile * sprof,
sgroup->profile = sprof; sgroup->profile = sprof;
/* NOTE for people reading this code: /* NOTE for people reading this code:
* *
* We construct the group starting by the furthest downstream element * We construct the group starting by the furthest downstream element
* and making our way up adding/syncing/linking as we go. * and making our way up adding/syncing/linking as we go.
* *
@ -1881,7 +1881,7 @@ create_elements_and_pads (GstEncodeBin * ebin)
/* 2. Ghost the muxer source pad */ /* 2. Ghost the muxer source pad */
/* FIXME : We should figure out if it's a static/request/dyamic pad, /* FIXME : We should figure out if it's a static/request/dyamic pad,
* but for the time being let's assume it's a static pad :) */ * but for the time being let's assume it's a static pad :) */
muxerpad = gst_element_get_static_pad (muxer, "src"); muxerpad = gst_element_get_static_pad (muxer, "src");
if (G_UNLIKELY (muxerpad == NULL)) if (G_UNLIKELY (muxerpad == NULL))

12
gst/typefind/gsttypefindfunctions.c
View file

@ -2079,7 +2079,7 @@ static GstStaticCaps multipart_caps =
GST_STATIC_CAPS ("multipart/x-mixed-replace"); GST_STATIC_CAPS ("multipart/x-mixed-replace");
#define MULTIPART_CAPS gst_static_caps_get(&multipart_caps) #define MULTIPART_CAPS gst_static_caps_get(&multipart_caps)
/* multipart/x-mixed replace is: /* multipart/x-mixed replace is:
* <maybe some whitespace>--<some ascii chars>[\r]\n * <maybe some whitespace>--<some ascii chars>[\r]\n
* <more ascii chars>[\r]\nContent-type:<more ascii>[\r]\n */ * <more ascii chars>[\r]\nContent-type:<more ascii>[\r]\n */
static void static void
@ -2136,7 +2136,7 @@ static GstStaticCaps mpeg_sys_caps = GST_STATIC_CAPS ("video/mpeg, "
#define IS_MPEG_PES_HEADER(data) (IS_MPEG_HEADER (data) && \ #define IS_MPEG_PES_HEADER(data) (IS_MPEG_HEADER (data) && \
IS_MPEG_PES_CODE (((guint8 *)(data))[3])) IS_MPEG_PES_CODE (((guint8 *)(data))[3]))
#define MPEG2_MAX_PROBE_LENGTH (128 * 1024) /* 128kB should be 64 packs of the #define MPEG2_MAX_PROBE_LENGTH (128 * 1024) /* 128kB should be 64 packs of the
* most common 2kB pack size. */ * most common 2kB pack size. */
#define MPEG2_MIN_SYS_HEADERS 2 #define MPEG2_MIN_SYS_HEADERS 2
@ -2356,7 +2356,7 @@ mpeg_sys_type_find (GstTypeFind * tf, gpointer unused)
} }
/* If we at least saw MIN headers, and *some* were pes headers (pack headers /* If we at least saw MIN headers, and *some* were pes headers (pack headers
* are optional in an mpeg system stream) then return a lower-probability * are optional in an mpeg system stream) then return a lower-probability
* result */ * result */
if (pes_headers > 0 && (pack_headers + pes_headers) > MPEG2_MIN_SYS_HEADERS) if (pes_headers > 0 && (pack_headers + pes_headers) > MPEG2_MIN_SYS_HEADERS)
goto suggest; goto suggest;
@ -2448,7 +2448,7 @@ mpeg_ts_probe_headers (GstTypeFind * tf, guint64 offset, gint packet_size)
static void static void
mpeg_ts_type_find (GstTypeFind * tf, gpointer unused) mpeg_ts_type_find (GstTypeFind * tf, gpointer unused)
{ {
/* TS packet sizes to test: normal, DVHS packet size and /* TS packet sizes to test: normal, DVHS packet size and
* FEC with 16 or 20 byte codes packet size. */ * FEC with 16 or 20 byte codes packet size. */
const gint pack_sizes[] = { 188, 192, 204, 208 }; const gint pack_sizes[] = { 188, 192, 204, 208 };
const guint8 *data = NULL; const guint8 *data = NULL;
@ -2477,7 +2477,7 @@ mpeg_ts_type_find (GstTypeFind * tf, gpointer unused)
if (found >= GST_MPEGTS_TYPEFIND_MIN_HEADERS) { if (found >= GST_MPEGTS_TYPEFIND_MIN_HEADERS) {
gint probability; gint probability;
/* found at least 4 headers. 10 headers = MAXIMUM probability. /* found at least 4 headers. 10 headers = MAXIMUM probability.
* Arbitrarily, I assigned 10% probability for each header we * Arbitrarily, I assigned 10% probability for each header we
* found, 40% -> 100% */ * found, 40% -> 100% */
probability = MIN (10 * found, GST_TYPE_FIND_MAXIMUM); probability = MIN (10 * found, GST_TYPE_FIND_MAXIMUM);
@ -2719,7 +2719,7 @@ h264_video_type_find (GstTypeFind * tf, gpointer unused)
{ {
DataScanCtx c = { 0, NULL, 0 }; DataScanCtx c = { 0, NULL, 0 };
/* Stream consists of: a series of sync codes (00 00 00 01) followed /* Stream consists of: a series of sync codes (00 00 00 01) followed
* by NALs * by NALs
*/ */
gboolean seen_idr = FALSE; gboolean seen_idr = FALSE;