mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2024-11-27 04:01:08 +00:00
Code Issues 1 Projects Releases Wiki Activity

gst: fix awkward dest_format inout parameter in query utility functions

Browse source 
The idea was originally that if one passed &dest_fmt with
dest_fmt=GST_FORMAT_DEFAULT, then the code answering the query
could change dest_fmt to the actual default format used. However,
in more than half a decade of GStreamer 0.10 no piece of code in
GStreamer has ever used that feature, nor are there that many
users of this API that actually check whether the format returned
is the original format passed before using the values returned.
Also, it's just annoying-to-use API in its own right.

For all these reasons, make it so that the destination format is
passed directly and can't be changed by the element queried.
This commit is contained in:
Tim-Philipp Müller 2011-07-27 00:17:02 +01:00
parent cf18fa9ce5
commit ef8ca3549e
4 changed files with 74 additions and 70 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
docs/random/porting-to-0.11.txt
View file

@ -254,6 +254,19 @@ The 0.11 porting guide
gst_query_parse_formats_length() -> gst_query_parse_n_formats()
gst_query_parse_formats_nth() -> gst_query_parse_nth_format()
Some query utility functionsno longer use an inout parameter for the
destination/query format:
- gst_pad_query_position()
- gst_pad_query_duration()
- gst_pad_query_convert()
- gst_pad_query_peer_position()
- gst_pad_query_peer_duration()
- gst_pad_query_peer_convert()
- gst_element_query_position()
- gst_element_query_duration()
- gst_element_query_convert()
* GstBufferList
Is now a boxed type derived from GstMiniObject.

18
gst/gstquery.c
View file

@ -413,12 +413,15 @@ gst_query_new_position (GstFormat format)
void
gst_query_set_position (GstQuery * query, GstFormat format, gint64 cur)
{
GstStructure *structure;
GstStructure *s;
g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_POSITION);
structure = GST_QUERY_STRUCTURE (query);
gst_structure_id_set (structure,
s = GST_QUERY_STRUCTURE (query);
g_return_if_fail (format == g_value_get_enum (gst_structure_id_get_value (s,
GST_QUARK (FORMAT))));
gst_structure_id_set (s,
GST_QUARK (FORMAT), GST_TYPE_FORMAT, format,
GST_QUARK (CURRENT), G_TYPE_INT64, cur, NULL);
}
@ -488,13 +491,14 @@ gst_query_new_duration (GstFormat format)
void
gst_query_set_duration (GstQuery * query, GstFormat format, gint64 duration)
{
GstStructure *structure;
GstStructure *s;
g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_DURATION);
structure = GST_QUERY_STRUCTURE (query);
gst_structure_id_set (structure,
GST_QUARK (FORMAT), GST_TYPE_FORMAT, format,
s = GST_QUERY_STRUCTURE (query);
g_return_if_fail (format == g_value_get_enum (gst_structure_id_get_value (s,
GST_QUARK (FORMAT))));
gst_structure_id_set (s, GST_QUARK (FORMAT), GST_TYPE_FORMAT, format,
GST_QUARK (DURATION), G_TYPE_INT64, duration, NULL);
}

89
gst/gstutils.c
View file

@ -2238,8 +2238,7 @@ gst_element_unlink (GstElement * src, GstElement * dest)
/**
* gst_element_query_position:
* @element: a #GstElement to invoke the position query on.
* @format: (inout): a pointer to the #GstFormat asked for.
* On return contains the #GstFormat used.
* @format: the #GstFormat requested
* @cur: (out) (allow-none): a location in which to store the current
* position, or NULL.
*
@ -2249,20 +2248,20 @@ gst_element_unlink (GstElement * src, GstElement * dest)
* Returns: TRUE if the query could be performed.
*/
gboolean
gst_element_query_position (GstElement * element, GstFormat * format,
gst_element_query_position (GstElement * element, GstFormat format,
gint64 * cur)
{
GstQuery *query;
gboolean ret;
g_return_val_if_fail (GST_IS_ELEMENT (element), FALSE);
g_return_val_if_fail (format != NULL, FALSE);
g_return_val_if_fail (format != GST_FORMAT_UNDEFINED, FALSE);
query = gst_query_new_position (*format);
query = gst_query_new_position (format);
ret = gst_element_query (element, query);
if (ret)
gst_query_parse_position (query, format, cur);
gst_query_parse_position (query, NULL, cur);
gst_query_unref (query);
@ -2272,8 +2271,7 @@ gst_element_query_position (GstElement * element, GstFormat * format,
/**
* gst_element_query_duration:
* @element: a #GstElement to invoke the duration query on.
* @format: (inout): a pointer to the #GstFormat asked for.
* On return contains the #GstFormat used.
* @format: the #GstFormat requested
* @duration: (out): A location in which to store the total duration, or NULL.
*
* Queries an element for the total stream duration.
@ -2281,20 +2279,20 @@ gst_element_query_position (GstElement * element, GstFormat * format,
* Returns: TRUE if the query could be performed.
*/
gboolean
gst_element_query_duration (GstElement * element, GstFormat * format,
gst_element_query_duration (GstElement * element, GstFormat format,
gint64 * duration)
{
GstQuery *query;
gboolean ret;
g_return_val_if_fail (GST_IS_ELEMENT (element), FALSE);
g_return_val_if_fail (format != NULL, FALSE);
g_return_val_if_fail (format != GST_FORMAT_UNDEFINED, FALSE);
query = gst_query_new_duration (*format);
query = gst_query_new_duration (format);
ret = gst_element_query (element, query);
if (ret)
gst_query_parse_duration (query, format, duration);
gst_query_parse_duration (query, NULL, duration);
gst_query_unref (query);
@ -2306,7 +2304,7 @@ gst_element_query_duration (GstElement * element, GstFormat * format,
* @element: a #GstElement to invoke the convert query on.
* @src_format: (inout): a #GstFormat to convert from.
* @src_val: a value to convert.
* @dest_format: (inout): a pointer to the #GstFormat to convert to.
* @dest_format: the #GstFormat to convert to.
* @dest_val: (out): a pointer to the result.
*
* Queries an element to convert @src_val in @src_format to @dest_format.
@ -2315,25 +2313,25 @@ gst_element_query_duration (GstElement * element, GstFormat * format,
*/
gboolean
gst_element_query_convert (GstElement * element, GstFormat src_format,
gint64 src_val, GstFormat * dest_format, gint64 * dest_val)
gint64 src_val, GstFormat dest_format, gint64 * dest_val)
{
GstQuery *query;
gboolean ret;
g_return_val_if_fail (GST_IS_ELEMENT (element), FALSE);
g_return_val_if_fail (dest_format != NULL, FALSE);
g_return_val_if_fail (dest_format != GST_FORMAT_UNDEFINED, FALSE);
g_return_val_if_fail (dest_val != NULL, FALSE);
if (*dest_format == src_format || src_val == -1) {
if (dest_format == src_format || src_val == -1) {
*dest_val = src_val;
return TRUE;
}
query = gst_query_new_convert (src_format, src_val, *dest_format);
query = gst_query_new_convert (src_format, src_val, dest_format);
ret = gst_element_query (element, query);
if (ret)
gst_query_parse_convert (query, NULL, NULL, dest_format, dest_val);
gst_query_parse_convert (query, NULL, NULL, NULL, dest_val);
gst_query_unref (query);
@ -2828,8 +2826,7 @@ error:
/**
* gst_pad_query_position:
* @pad: a #GstPad to invoke the position query on.
* @format: (inout): a pointer to the #GstFormat asked for.
* On return contains the #GstFormat used.
* @format: the #GstFormat requested
* @cur: (out): A location in which to store the current position, or NULL.
*
* Queries a pad for the stream position.
@ -2837,19 +2834,19 @@ error:
* Returns: TRUE if the query could be performed.
*/
gboolean
gst_pad_query_position (GstPad * pad, GstFormat * format, gint64 * cur)
gst_pad_query_position (GstPad * pad, GstFormat format, gint64 * cur)
{
GstQuery *query;
gboolean ret;
g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
g_return_val_if_fail (format != NULL, FALSE);
g_return_val_if_fail (format != GST_FORMAT_UNDEFINED, FALSE);
query = gst_query_new_position (*format);
query = gst_query_new_position (format);
ret = gst_pad_query (pad, query);
if (ret)
gst_query_parse_position (query, format, cur);
gst_query_parse_position (query, NULL, cur);
gst_query_unref (query);
@ -2860,8 +2857,7 @@ gst_pad_query_position (GstPad * pad, GstFormat * format, gint64 * cur)
* gst_pad_query_peer_position:
* @pad: a #GstPad on whose peer to invoke the position query on.
* Must be a sink pad.
* @format: (inout): a pointer to the #GstFormat asked for.
* On return contains the #GstFormat used.
* @format: the #GstFormat requested
* @cur: (out) (allow-none): a location in which to store the current
* position, or NULL.
*
@ -2870,14 +2866,14 @@ gst_pad_query_position (GstPad * pad, GstFormat * format, gint64 * cur)
* Returns: TRUE if the query could be performed.
*/
gboolean
gst_pad_query_peer_position (GstPad * pad, GstFormat * format, gint64 * cur)
gst_pad_query_peer_position (GstPad * pad, GstFormat format, gint64 * cur)
{
gboolean ret = FALSE;
GstPad *peer;
g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
g_return_val_if_fail (GST_PAD_IS_SINK (pad), FALSE);
g_return_val_if_fail (format != NULL, FALSE);
g_return_val_if_fail (format != GST_FORMAT_UNDEFINED, FALSE);
peer = gst_pad_get_peer (pad);
if (peer) {
@ -2891,8 +2887,7 @@ gst_pad_query_peer_position (GstPad * pad, GstFormat * format, gint64 * cur)
/**
* gst_pad_query_duration:
* @pad: a #GstPad to invoke the duration query on.
* @format: (inout): a pointer to the #GstFormat asked for.
* On return contains the #GstFormat used.
* @format: the #GstFormat requested
* @duration: (out) (allow-none): a location in which to store the total
* duration, or NULL.
*
@ -2901,19 +2896,19 @@ gst_pad_query_peer_position (GstPad * pad, GstFormat * format, gint64 * cur)
* Returns: TRUE if the query could be performed.
*/
gboolean
gst_pad_query_duration (GstPad * pad, GstFormat * format, gint64 * duration)
gst_pad_query_duration (GstPad * pad, GstFormat format, gint64 * duration)
{
GstQuery *query;
gboolean ret;
g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
g_return_val_if_fail (format != NULL, FALSE);
g_return_val_if_fail (format != GST_FORMAT_UNDEFINED, FALSE);
query = gst_query_new_duration (*format);
query = gst_query_new_duration (format);
ret = gst_pad_query (pad, query);
if (ret)
gst_query_parse_duration (query, format, duration);
gst_query_parse_duration (query, NULL, duration);
gst_query_unref (query);
@ -2924,8 +2919,7 @@ gst_pad_query_duration (GstPad * pad, GstFormat * format, gint64 * duration)
* gst_pad_query_peer_duration:
* @pad: a #GstPad on whose peer pad to invoke the duration query on.
* Must be a sink pad.
* @format: (inout) :a pointer to the #GstFormat asked for.
* On return contains the #GstFormat used.
* @format: the #GstFormat requested
* @duration: (out) (allow-none): a location in which to store the total
* duration, or NULL.
*
@ -2934,15 +2928,14 @@ gst_pad_query_duration (GstPad * pad, GstFormat * format, gint64 * duration)
* Returns: TRUE if the query could be performed.
*/
gboolean
gst_pad_query_peer_duration (GstPad * pad, GstFormat * format,
gint64 * duration)
gst_pad_query_peer_duration (GstPad * pad, GstFormat format, gint64 * duration)
{
gboolean ret = FALSE;
GstPad *peer;
g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
g_return_val_if_fail (GST_PAD_IS_SINK (pad), FALSE);
g_return_val_if_fail (format != NULL, FALSE);
g_return_val_if_fail (format != GST_FORMAT_UNDEFINED, FALSE);
peer = gst_pad_get_peer (pad);
if (peer) {
@ -2958,7 +2951,7 @@ gst_pad_query_peer_duration (GstPad * pad, GstFormat * format,
* @pad: a #GstPad to invoke the convert query on.
* @src_format: a #GstFormat to convert from.
* @src_val: a value to convert.
* @dest_format: (inout): a pointer to the #GstFormat to convert to.
* @dest_format: the #GstFormat to convert to.
* @dest_val: (out): a pointer to the result.
*
* Queries a pad to convert @src_val in @src_format to @dest_format.
@ -2967,25 +2960,25 @@ gst_pad_query_peer_duration (GstPad * pad, GstFormat * format,
*/
gboolean
gst_pad_query_convert (GstPad * pad, GstFormat src_format, gint64 src_val,
GstFormat * dest_format, gint64 * dest_val)
GstFormat dest_format, gint64 * dest_val)
{
GstQuery *query;
gboolean ret;
g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
g_return_val_if_fail (dest_format != NULL, FALSE);
g_return_val_if_fail (dest_format != GST_FORMAT_UNDEFINED, FALSE);
g_return_val_if_fail (dest_val != NULL, FALSE);
if (*dest_format == src_format || src_val == -1) {
if (dest_format == src_format || src_val == -1) {
*dest_val = src_val;
return TRUE;
}
query = gst_query_new_convert (src_format, src_val, *dest_format);
query = gst_query_new_convert (src_format, src_val, dest_format);
ret = gst_pad_query (pad, query);
if (ret)
gst_query_parse_convert (query, NULL, NULL, dest_format, dest_val);
gst_query_parse_convert (query, NULL, NULL, NULL, dest_val);
gst_query_unref (query);
@ -2998,7 +2991,7 @@ gst_pad_query_convert (GstPad * pad, GstFormat src_format, gint64 src_val,
* Must be a sink pad.
* @src_format: a #GstFormat to convert from.
* @src_val: a value to convert.
* @dest_format: (inout): a pointer to the #GstFormat to convert to.
* @dest_format: the #GstFormat to convert to.
* @dest_val: (out): a pointer to the result.
*
* Queries the peer pad of a given sink pad to convert @src_val in @src_format
@ -3008,14 +3001,14 @@ gst_pad_query_convert (GstPad * pad, GstFormat src_format, gint64 src_val,
*/
gboolean
gst_pad_query_peer_convert (GstPad * pad, GstFormat src_format, gint64 src_val,
GstFormat * dest_format, gint64 * dest_val)
GstFormat dest_format, gint64 * dest_val)
{
gboolean ret = FALSE;
GstPad *peer;
g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
g_return_val_if_fail (GST_PAD_IS_SINK (pad), FALSE);
g_return_val_if_fail (dest_format != NULL, FALSE);
g_return_val_if_fail (dest_format != GST_FORMAT_UNDEFINED, FALSE);
g_return_val_if_fail (dest_val != NULL, FALSE);
peer = gst_pad_get_peer (pad);

24
gst/gstutils.h
View file

@ -894,12 +894,10 @@ gboolean gst_element_factory_can_sink_any_caps (GstElementFactory *factory, cons
gboolean gst_element_factory_can_src_any_caps (GstElementFactory *factory, const GstCaps *caps);
/* util query functions */
gboolean gst_element_query_position (GstElement *element, GstFormat *format,
gint64 *cur);
gboolean gst_element_query_duration (GstElement *element, GstFormat *format,
gint64 *duration);
gboolean gst_element_query_position (GstElement *element, GstFormat format, gint64 *cur);
gboolean gst_element_query_duration (GstElement *element, GstFormat format, gint64 *duration);
gboolean gst_element_query_convert (GstElement *element, GstFormat src_format, gint64 src_val,
GstFormat *dest_format, gint64 *dest_val);
GstFormat dest_format, gint64 *dest_val);
/* element class functions */
void gst_element_class_install_std_props (GstElementClass * klass,
@ -912,19 +910,15 @@ GstCaps* gst_pad_proxy_getcaps (GstPad * pad, GstCaps * filter);
GstElement* gst_pad_get_parent_element (GstPad *pad);
/* util query functions */
gboolean gst_pad_query_position (GstPad *pad, GstFormat *format,
gint64 *cur);
gboolean gst_pad_query_duration (GstPad *pad, GstFormat *format,
gint64 *duration);
gboolean gst_pad_query_position (GstPad *pad, GstFormat format, gint64 *cur);
gboolean gst_pad_query_duration (GstPad *pad, GstFormat format, gint64 *duration);
gboolean gst_pad_query_convert (GstPad *pad, GstFormat src_format, gint64 src_val,
GstFormat *dest_format, gint64 *dest_val);
GstFormat dest_format, gint64 *dest_val);
gboolean gst_pad_query_peer_position (GstPad *pad, GstFormat *format,
gint64 *cur);
gboolean gst_pad_query_peer_duration (GstPad *pad, GstFormat *format,
gint64 *duration);
gboolean gst_pad_query_peer_position (GstPad *pad, GstFormat format, gint64 *cur);
gboolean gst_pad_query_peer_duration (GstPad *pad, GstFormat format, gint64 *duration);
gboolean gst_pad_query_peer_convert (GstPad *pad, GstFormat src_format, gint64 src_val,
GstFormat *dest_format, gint64 *dest_val);
GstFormat dest_format, gint64 *dest_val);
/* bin functions */
void gst_bin_add_many (GstBin *bin, GstElement *element_1, ...) G_GNUC_NULL_TERMINATED;