Commit 515a768d authored by Tim-Philipp Müller's avatar Tim-Philipp Müller
Browse files

docs: add new codec utils API to docs

parent def1cf72
......@@ -201,6 +201,7 @@
flags.
</para>
<xi:include href="xml/gstpbutils.xml" />
<xi:include href="xml/gstpbutilscodecutils.xml" />
<xi:include href="xml/gstpbutilsdescriptions.xml" />
<xi:include href="xml/gstpbutilsmissingplugins.xml" />
<xi:include href="xml/gstpbutilsinstallplugins.xml" />
......
......@@ -1819,6 +1819,24 @@ gst_pb_utils_add_codec_description_to_tag_list
gst_pb_utils_get_codec_description
</SECTION>
<SECTION>
<FILE>gstpbutilscodecutils</FILE>
<INCLUDE>gst/pbutils/codec-utils.h</INCLUDE>
<SUBSECTION>
gst_codec_utils_aac_get_sample_rate_from_index
gst_codec_utils_aac_get_profile
gst_codec_utils_aac_get_level
gst_codec_utils_aac_caps_set_level_and_profile
<SUBSECTION>
gst_codec_utils_h264_get_profile
gst_codec_utils_h264_get_level
gst_codec_utils_h264_caps_set_level_and_profile
<SUBSECTION>
gst_codec_utils_mpeg4video_get_profile
gst_codec_utils_mpeg4video_get_level
gst_codec_utils_mpeg4video_caps_set_level_and_profile
</SECTION>
# video
<SECTION>
......
......@@ -62,6 +62,8 @@ digit_to_string (guint digit)
* rate.
*
* Returns: The sample rate if @sr_idx is valid, 0 otherwise.
*
* Since: 0.10.31
*/
guint
gst_codec_utils_aac_get_sample_rate_from_index (guint sr_idx)
......@@ -94,6 +96,8 @@ gst_codec_utils_aac_get_sample_rate_from_index (guint sr_idx)
*
* Returns: The profile as a const string and NULL if the profile could not be
* determined.
*
* Since: 0.10.31
*/
const gchar *
gst_codec_utils_aac_get_profile (const guint8 * audio_config, guint len)
......@@ -147,6 +151,8 @@ gst_codec_utils_aac_get_profile (const guint8 * audio_config, guint len)
*
* Returns: The level as a const string and NULL if the level could not be
* determined.
*
* Since: 0.10.31
*/
const gchar *
gst_codec_utils_aac_get_level (const guint8 * audio_config, guint len)
......@@ -314,9 +320,11 @@ gst_codec_utils_aac_get_level (const guint8 * audio_config, guint len)
* @audio_config. See #gst_codec_utils_aac_get_level() and
* gst_codec_utils_aac_get_profile() for more details on the parameters.
* @caps must be audio/mpeg caps with an "mpegversion" field of either 2 or 4.
* If mpegversion is 4, the <tt>base-profile</tt> field is also set in @caps.
* If mpegversion is 4, the "base-profile" field is also set in @caps.
*
* Returns: TRUE if the level and profile could be set, FALSE otherwise.
*
* Since: 0.10.31
*/
gboolean
gst_codec_utils_aac_caps_set_level_and_profile (GstCaps * caps,
......@@ -361,7 +369,7 @@ gst_codec_utils_aac_caps_set_level_and_profile (GstCaps * caps,
* @sps: Pointer to the sequence parameter set for the stream.
* @len: Length of the data available in @sps.
*
* Converts the profile indication (<tt>profile_idc</tt>) in the stream's
* Converts the profile indication (profile_idc) in the stream's
* sequence parameter set into a string. The SPS is expected to have the
* following format, as defined in the H.264 specification. The SPS is viewed
* as a bitstream here, with bit 0 being the most significant bit of the first
......@@ -377,6 +385,8 @@ gst_codec_utils_aac_caps_set_level_and_profile (GstCaps * caps,
* Bit 16:24 - Level indication
*
* Returns: The profile as a const string, or NULL if there is an error.
*
* Since: 0.10.31
*/
const gchar *
gst_codec_utils_h264_get_profile (const guint8 * sps, guint len)
......@@ -441,11 +451,13 @@ gst_codec_utils_h264_get_profile (const guint8 * sps, guint len)
* @sps: Pointer to the sequence parameter set for the stream.
* @len: Length of the data available in @sps.
*
* Converts the level indication (<tt>level_idc</tt>) in the stream's
* Converts the level indication (level_idc) in the stream's
* sequence parameter set into a string. The SPS is expected to have the
* same format as for @gst_codec_utils_aac_get_profile().
*
* Returns: The level as a const string, or NULL if there is an error.
*
* Since: 0.10.31
*/
const gchar *
gst_codec_utils_h264_get_level (const guint8 * sps, guint len)
......@@ -502,6 +514,8 @@ gst_codec_utils_h264_get_level (const guint8 * sps, guint len)
* for more details on the parameters.
*
* Returns: TRUE if the level and profile could be set, FALSE otherwise.
*
* Since: 0.10.31
*/
gboolean
gst_codec_utils_h264_caps_set_level_and_profile (GstCaps * caps,
......@@ -538,6 +552,8 @@ gst_codec_utils_h264_caps_set_level_and_profile (GstCaps * caps,
* (profile_and_level_indication) is used.
*
* Returns: The profile as a const string, or NULL if there is an error.
*
* Since: 0.10.31
*/
const gchar *
gst_codec_utils_mpeg4video_get_profile (const guint8 * vis_obj_seq, guint len)
......@@ -606,6 +622,8 @@ gst_codec_utils_mpeg4video_get_profile (const guint8 * vis_obj_seq, guint len)
* (profile_and_level_indication) is used.
*
* Returns: The level as a const string, or NULL if there is an error.
*
* Since: 0.10.31
*/
const gchar *
gst_codec_utils_mpeg4video_get_level (const guint8 * vis_obj_seq, guint len)
......@@ -685,6 +703,8 @@ gst_codec_utils_mpeg4video_get_level (const guint8 * vis_obj_seq, guint len)
* parameters.
*
* Returns: TRUE if the level and profile could be set, FALSE otherwise.
*
* Since: 0.10.31
*/
gboolean
gst_codec_utils_mpeg4video_caps_set_level_and_profile (GstCaps * caps,
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment