From 515a768dbc0b1b3ae1fc6265771b8bc8a776966a Mon Sep 17 00:00:00 2001 From: =?utf8?q?Tim-Philipp=20M=C3=BCller?= Date: Thu, 30 Sep 2010 00:19:29 +0100 Subject: [PATCH] docs: add new codec utils API to docs --- docs/libs/gst-plugins-base-libs-docs.sgml | 1 + docs/libs/gst-plugins-base-libs-sections.txt | 18 ++++++++++++++++++ gst-libs/gst/pbutils/codec-utils.c | 26 +++++++++++++++++++++++--- 3 files changed, 42 insertions(+), 3 deletions(-) diff --git a/docs/libs/gst-plugins-base-libs-docs.sgml b/docs/libs/gst-plugins-base-libs-docs.sgml index 64885ec..1c68a1b 100644 --- a/docs/libs/gst-plugins-base-libs-docs.sgml +++ b/docs/libs/gst-plugins-base-libs-docs.sgml @@ -201,6 +201,7 @@ flags. + diff --git a/docs/libs/gst-plugins-base-libs-sections.txt b/docs/libs/gst-plugins-base-libs-sections.txt index 310a74e..10efdb3 100644 --- a/docs/libs/gst-plugins-base-libs-sections.txt +++ b/docs/libs/gst-plugins-base-libs-sections.txt @@ -1819,6 +1819,24 @@ gst_pb_utils_add_codec_description_to_tag_list gst_pb_utils_get_codec_description +
+gstpbutilscodecutils +gst/pbutils/codec-utils.h + +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 + +gst_codec_utils_h264_get_profile +gst_codec_utils_h264_get_level +gst_codec_utils_h264_caps_set_level_and_profile + +gst_codec_utils_mpeg4video_get_profile +gst_codec_utils_mpeg4video_get_level +gst_codec_utils_mpeg4video_caps_set_level_and_profile +
+ # video
diff --git a/gst-libs/gst/pbutils/codec-utils.c b/gst-libs/gst/pbutils/codec-utils.c index 372ef90..f1231af 100644 --- a/gst-libs/gst/pbutils/codec-utils.c +++ b/gst-libs/gst/pbutils/codec-utils.c @@ -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 base-profile 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 (profile_idc) 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 (level_idc) 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, -- 2.7.4