diff --git a/libs/gst/base/gstadapter.c b/libs/gst/base/gstadapter.c index 59efc11d85..3d23fdb029 100644 --- a/libs/gst/base/gstadapter.c +++ b/libs/gst/base/gstadapter.c @@ -70,13 +70,13 @@ * } * ]| * - * For another example, a simple element inside GStreamer that uses GstAdapter + * For another example, a simple element inside GStreamer that uses #GstAdapter * is the libvisual element. * - * An element using GstAdapter in its sink pad chain function should ensure that + * An element using #GstAdapter in its sink pad chain function should ensure that * when the FLUSH_STOP event is received, that any queued data is cleared using * gst_adapter_clear(). Data should also be cleared or processed on EOS and - * when changing state from #GST_STATE_PAUSED to #GST_STATE_READY. + * when changing state from %GST_STATE_PAUSED to %GST_STATE_READY. * * Also check the GST_BUFFER_FLAG_DISCONT flag on the buffer. Some elements might * need to clear the adapter after a discontinuity. @@ -92,7 +92,7 @@ * gst_adapter_prev_pts_at_offset() can be used to determine the last * seen timestamp at a particular offset in the adapter. * - * A last thing to note is that while GstAdapter is pretty optimized, + * A last thing to note is that while #GstAdapter is pretty optimized, * merging buffers still might be an operation that requires a malloc() and * memcpy() operation, and these operations are not the fastest. Because of * this, some functions like gst_adapter_available_fast() are provided to help @@ -100,9 +100,9 @@ * gst_adapter_copy() can be used to copy data into a (statically allocated) * user provided buffer. * - * GstAdapter is not MT safe. All operations on an adapter must be serialized by + * #GstAdapter is not MT safe. All operations on an adapter must be serialized by * the caller. This is not normally a problem, however, as the normal use case - * of GstAdapter is inside one pad's chain function, in which case access is + * of #GstAdapter is inside one pad's chain function, in which case access is * serialized via the pad's STREAM_LOCK. * * Note that gst_adapter_push() takes ownership of the buffer passed. Use @@ -352,7 +352,7 @@ gst_adapter_push (GstAdapter * adapter, GstBuffer * buf) /* Internal method only. Tries to merge buffers at the head of the queue * to form a single larger buffer of size 'size'. * - * Returns TRUE if it managed to merge anything. + * Returns %TRUE if it managed to merge anything. */ static gboolean gst_adapter_try_to_merge_up (GstAdapter * adapter, gsize size) @@ -423,10 +423,10 @@ gst_adapter_try_to_merge_up (GstAdapter * adapter, gsize size) * as #GstBuffer memory or the potentially more performant * gst_adapter_take_buffer(). * - * Returns #NULL if @size bytes are not available. + * Returns %NULL if @size bytes are not available. * * Returns: (transfer none) (array length=size) (element-type guint8): - * a pointer to the first @size bytes of data, or NULL + * a pointer to the first @size bytes of data, or %NULL */ gconstpointer gst_adapter_map (GstAdapter * adapter, gsize size) @@ -532,7 +532,7 @@ gst_adapter_unmap (GstAdapter * adapter) * @size: the number of bytes to copy * * Copies @size bytes of data starting at @offset out of the buffers - * contained in @GstAdapter into an array @dest provided by the caller. + * contained in #GstAdapter into an array @dest provided by the caller. * * The array @dest should be large enough to contain @size bytes. * The user should check that the adapter has (@offset + @size) bytes @@ -709,7 +709,7 @@ gst_adapter_take_internal (GstAdapter * adapter, gsize nbytes) * Free-function: g_free * * Returns: (transfer full) (array length=nbytes) (element-type guint8): - * oven-fresh hot data, or #NULL if @nbytes bytes are not available + * oven-fresh hot data, or %NULL if @nbytes bytes are not available */ gpointer gst_adapter_take (GstAdapter * adapter, gsize nbytes) @@ -759,7 +759,7 @@ gst_adapter_take (GstAdapter * adapter, gsize nbytes) * Free-function: gst_buffer_unref * * Returns: (transfer full): a #GstBuffer containing the first @nbytes of - * the adapter, or #NULL if @nbytes bytes are not available. + * the adapter, or %NULL if @nbytes bytes are not available. * gst_buffer_unref() when no longer needed. * * Since: 1.2 @@ -841,7 +841,7 @@ done: * Free-function: gst_buffer_unref * * Returns: (transfer full): a #GstBuffer containing the first @nbytes of - * the adapter, or #NULL if @nbytes bytes are not available. + * the adapter, or %NULL if @nbytes bytes are not available. * gst_buffer_unref() when no longer needed. */ GstBuffer * @@ -918,7 +918,7 @@ done: * buffer in the list before freeing the list after usage. * * Returns: (element-type Gst.Buffer) (transfer full): a #GList of buffers - * containing the first @nbytes of the adapter, or #NULL if @nbytes bytes + * containing the first @nbytes of the adapter, or %NULL if @nbytes bytes * are not available */ GList * @@ -953,7 +953,7 @@ gst_adapter_take_list (GstAdapter * adapter, gsize nbytes) * * Gets the maximum amount of bytes available, that is it returns the maximum * value that can be supplied to gst_adapter_map() without that function - * returning NULL. + * returning %NULL. * * Returns: number of bytes available in @adapter */ @@ -1010,7 +1010,7 @@ gst_adapter_available_fast (GstAdapter * adapter) /** * gst_adapter_prev_pts: * @adapter: a #GstAdapter - * @distance: (out) (allow-none): pointer to location for distance, or NULL + * @distance: (out) (allow-none): pointer to location for distance, or %NULL * * Get the pts that was before the current byte in the adapter. When * @distance is given, the amount of bytes between the pts and the current @@ -1037,7 +1037,7 @@ gst_adapter_prev_pts (GstAdapter * adapter, guint64 * distance) /** * gst_adapter_prev_dts: * @adapter: a #GstAdapter - * @distance: (out) (allow-none): pointer to location for distance, or NULL + * @distance: (out) (allow-none): pointer to location for distance, or %NULL * * Get the dts that was before the current byte in the adapter. When * @distance is given, the amount of bytes between the dts and the current @@ -1065,7 +1065,7 @@ gst_adapter_prev_dts (GstAdapter * adapter, guint64 * distance) * gst_adapter_prev_pts_at_offset: * @adapter: a #GstAdapter * @offset: the offset in the adapter at which to get timestamp - * @distance: (out) (allow-none): pointer to location for distance, or NULL + * @distance: (out) (allow-none): pointer to location for distance, or %NULL * * Get the pts that was before the byte at offset @offset in the adapter. When * @distance is given, the amount of bytes between the pts and the current @@ -1113,7 +1113,7 @@ gst_adapter_prev_pts_at_offset (GstAdapter * adapter, gsize offset, * gst_adapter_prev_dts_at_offset: * @adapter: a #GstAdapter * @offset: the offset in the adapter at which to get timestamp - * @distance: (out) (allow-none): pointer to location for distance, or NULL + * @distance: (out) (allow-none): pointer to location for distance, or %NULL * * Get the dts that was before the byte at offset @offset in the adapter. When * @distance is given, the amount of bytes between the dts and the current @@ -1292,7 +1292,7 @@ gst_adapter_masked_scan_uint32_peek (GstAdapter * adapter, guint32 mask, * It is an error to call this function without making sure that there is * enough data (offset+size bytes) in the adapter. * - * This function calls gst_adapter_masked_scan_uint32_peek() passing NULL + * This function calls gst_adapter_masked_scan_uint32_peek() passing %NULL * for value. * * Returns: offset of the first match, or -1 if no match was found. diff --git a/libs/gst/base/gstbaseparse.c b/libs/gst/base/gstbaseparse.c index 7579b5e597..c3e63e1a12 100644 --- a/libs/gst/base/gstbaseparse.c +++ b/libs/gst/base/gstbaseparse.c @@ -50,22 +50,22 @@ * * Set-up phase * - * GstBaseParse calls @start to inform subclass that data processing is + * #GstBaseParse calls @start to inform subclass that data processing is * about to start now. * * - * GstBaseParse class calls @set_sink_caps to inform the subclass about + * #GstBaseParse class calls @set_sink_caps to inform the subclass about * incoming sinkpad caps. Subclass could already set the srcpad caps * accordingly, but this might be delayed until calling * gst_base_parse_finish_frame() with a non-queued frame. * * - * At least at this point subclass needs to tell the GstBaseParse class + * At least at this point subclass needs to tell the #GstBaseParse class * how big data chunks it wants to receive (min_frame_size). It can do * this with gst_base_parse_set_min_frame_size(). * * - * GstBaseParse class sets up appropriate data passing mode (pull/push) + * #GstBaseParse class sets up appropriate data passing mode (pull/push) * and starts to process the data. * * @@ -74,7 +74,7 @@ * * Parsing phase * - * GstBaseParse gathers at least min_frame_size bytes of data either + * #GstBaseParse gathers at least min_frame_size bytes of data either * by pulling it from upstream or collecting buffers in an internal * #GstAdapter. * @@ -101,7 +101,7 @@ * * Subclass is also responsible for setting the buffer metadata * (e.g. buffer timestamp and duration, or keyframe if applicable). - * (although the latter can also be done by GstBaseParse if it is + * (although the latter can also be done by #GstBaseParse if it is * appropriately configured, see below). Frame is provided with * timestamp derived from upstream (as much as generally possible), * duration obtained from configuration (see below), and offset @@ -118,7 +118,7 @@ * events, or to perform custom (segment) filtering. * * - * During the parsing process GstBaseParseClass will handle both srcpad + * During the parsing process #GstBaseParseClass will handle both srcpad * and sinkpad events. They will be passed to subclass if @event or * @src_event callbacks have been provided. * @@ -127,7 +127,7 @@ * * Shutdown phase * - * GstBaseParse class calls @stop to inform the subclass that data + * #GstBaseParse class calls @stop to inform the subclass that data * parsing will be stopped. * * @@ -139,12 +139,12 @@ * needs to set the fixed caps on srcpad, when the format is ensured (e.g. * when base class calls subclass' @set_sink_caps function). * - * This base class uses #GST_FORMAT_DEFAULT as a meaning of frames. So, + * This base class uses %GST_FORMAT_DEFAULT as a meaning of frames. So, * subclass conversion routine needs to know that conversion from - * #GST_FORMAT_TIME to #GST_FORMAT_DEFAULT must return the + * %GST_FORMAT_TIME to %GST_FORMAT_DEFAULT must return the * frame number that can be found from the given byte position. * - * GstBaseParse uses subclasses conversion methods also for seeking (or + * #GstBaseParse uses subclasses conversion methods also for seeking (or * otherwise uses its own default one, see also below). * * Subclass @start and @stop functions will be called to inform the beginning @@ -180,10 +180,10 @@ * * In particular, if subclass is unable to determine a duration, but * parsing (or specs) yields a frames per seconds rate, then this can be - * provided to GstBaseParse to enable it to cater for + * provided to #GstBaseParse to enable it to cater for * buffer time metadata (which will be taken from upstream as much as * possible). Internally keeping track of frame durations and respective - * sizes that have been pushed provides GstBaseParse with an estimated + * sizes that have been pushed provides #GstBaseParse with an estimated * bitrate. A default @convert (used if not overridden) will then use these * rates to perform obvious conversions. These rates are also used to * update (estimated) duration at regular frame intervals. @@ -561,11 +561,11 @@ gst_base_parse_class_init (GstBaseParseClass * klass) /** * GstBaseParse:disable-passthrough: * - * If set to #TRUE, baseparse will unconditionally force parsing of the + * If set to %TRUE, baseparse will unconditionally force parsing of the * incoming data. This can be required in the rare cases where the incoming * side-data (caps, pts, dts, ...) is not trusted by the user and wants to * force validation and parsing of the incoming data. - * If set to #FALSE, decision of whether to parse the data or not is up to + * If set to %FALSE, decision of whether to parse the data or not is up to * the implementation (standard behaviour). */ g_object_class_install_property (gobject_class, PROP_DISABLE_PASSTHROUGH, @@ -898,7 +898,7 @@ gst_base_parse_parse_frame (GstBaseParse * parse, GstBaseParseFrame * frame) * * Converts using configured "convert" vmethod in #GstBaseParse class. * - * Returns: TRUE if conversion was successful. + * Returns: %TRUE if conversion was successful. */ static gboolean gst_base_parse_convert (GstBaseParse * parse, @@ -949,7 +949,7 @@ gst_base_parse_convert (GstBaseParse * parse, * * Handler for sink pad events. * - * Returns: TRUE if the event was handled. + * Returns: %TRUE if the event was handled. */ static gboolean gst_base_parse_sink_event (GstPad * pad, GstObject * parent, GstEvent * event) @@ -1351,7 +1351,7 @@ gst_base_parse_src_query (GstPad * pad, GstObject * parent, GstQuery * query) * * Handler for source pad events. * - * Returns: TRUE if the event was handled. + * Returns: %TRUE if the event was handled. */ static gboolean gst_base_parse_src_event (GstPad * pad, GstObject * parent, GstEvent * event) @@ -1388,7 +1388,7 @@ gst_base_parse_is_seekable (GstBaseParse * parse) * * Default srcpad event handler. * - * Returns: TRUE if the event was handled and can be dropped. + * Returns: %TRUE if the event was handled and can be dropped. */ static gboolean gst_base_parse_src_event_default (GstBaseParse * parse, GstEvent * event) @@ -1419,7 +1419,7 @@ gst_base_parse_src_event_default (GstBaseParse * parse, GstEvent * event) * * Default implementation of "convert" vmethod in #GstBaseParse class. * - * Returns: TRUE if conversion was successful. + * Returns: %TRUE if conversion was successful. */ gboolean gst_base_parse_convert_default (GstBaseParse * parse, @@ -4504,7 +4504,7 @@ gst_base_parse_change_state (GstElement * element, GstStateChange transition) * * This function should only be called from a @handle_frame implementation. * - * GstBaseParse creates initial timestamps for frames by using the last + * #GstBaseParse creates initial timestamps for frames by using the last * timestamp seen in the stream before the frame starts. In certain * cases, the correct timestamps will occur in the stream after the * start of the frame, but before the start of the actual picture data. diff --git a/libs/gst/base/gstbasesink.c b/libs/gst/base/gstbasesink.c index 2f8ceac7ff..b6fc1fcf87 100644 --- a/libs/gst/base/gstbasesink.c +++ b/libs/gst/base/gstbasesink.c @@ -44,7 +44,7 @@ * GstElementClass *gstelement_class = GST_ELEMENT_CLASS (klass); * * // sinktemplate should be a #GstStaticPadTemplate with direction - * // #GST_PAD_SINK and name "sink" + * // %GST_PAD_SINK and name "sink" * gst_element_class_add_pad_template (gstelement_class, * gst_static_pad_template_get (&sinktemplate)); * @@ -57,14 +57,14 @@ * ]| * * #GstBaseSink will handle the prerolling correctly. This means that it will - * return #GST_STATE_CHANGE_ASYNC from a state change to PAUSED until the first + * return %GST_STATE_CHANGE_ASYNC from a state change to PAUSED until the first * buffer arrives in this element. The base class will call the * #GstBaseSinkClass.preroll() vmethod with this preroll buffer and will then * commit the state change to the next asynchronously pending state. * * When the element is set to PLAYING, #GstBaseSink will synchronise on the * clock using the times returned from #GstBaseSinkClass.get_times(). If this - * function returns #GST_CLOCK_TIME_NONE for the start time, no synchronisation + * function returns %GST_CLOCK_TIME_NONE for the start time, no synchronisation * will be done. Synchronisation can be disabled entirely by setting the object * #GstBaseSink:sync property to %FALSE. * @@ -84,14 +84,14 @@ * element receives EOS in PAUSED, preroll completes, the event is queued and an * EOS message is posted when going to PLAYING. * - * #GstBaseSink will internally use the #GST_EVENT_SEGMENT events to schedule + * #GstBaseSink will internally use the %GST_EVENT_SEGMENT events to schedule * synchronisation and clipping of buffers. Buffers that fall completely outside * of the current segment are dropped. Buffers that fall partially in the * segment are rendered (and prerolled). Subclasses should do any subbuffer * clipping themselves when needed. * * #GstBaseSink will by default report the current playback position in - * #GST_FORMAT_TIME based on the current clock time and segment information. + * %GST_FORMAT_TIME based on the current clock time and segment information. * If no clock has been set on the element, the query will be forwarded * upstream. * @@ -442,8 +442,8 @@ gst_base_sink_class_init (GstBaseSinkClass * klass) /** * GstBaseSink:async: * - * If set to #TRUE, the basesink will perform asynchronous state changes. - * When set to #FALSE, the sink will not signal the parent when it prerolls. + * If set to %TRUE, the basesink will perform asynchronous state changes. + * When set to %FALSE, the sink will not signal the parent when it prerolls. * Use this option when dealing with sparse streams or when synchronisation is * not required. */ @@ -466,9 +466,9 @@ gst_base_sink_class_init (GstBaseSinkClass * klass) /** * GstBaseSink:enable-last-sample: * - * Enable the last-sample property. If FALSE, basesink doesn't keep a + * Enable the last-sample property. If %FALSE, basesink doesn't keep a * reference to the last buffer arrived and the last-sample property is always - * set to NULL. This can be useful if you need buffers to be released as soon + * set to %NULL. This can be useful if you need buffers to be released as soon * as possible, eg. if you're using a buffer pool. */ g_object_class_install_property (gobject_class, PROP_ENABLE_LAST_SAMPLE, @@ -481,7 +481,7 @@ gst_base_sink_class_init (GstBaseSinkClass * klass) * * The last buffer that arrived in the sink and was used for preroll or for * rendering. This property can be used to generate thumbnails. This property - * can be NULL when the sink has not yet received a buffer. + * can be %NULL when the sink has not yet received a buffer. */ g_object_class_install_property (gobject_class, PROP_LAST_SAMPLE, g_param_spec_boxed ("last-sample", "Last Sample", @@ -688,8 +688,8 @@ gst_base_sink_finalize (GObject * object) * @sync: the new sync value. * * Configures @sink to synchronize on the clock or not. When - * @sync is FALSE, incoming samples will be played as fast as - * possible. If @sync is TRUE, the timestamps of the incoming + * @sync is %FALSE, incoming samples will be played as fast as + * possible. If @sync is %TRUE, the timestamps of the incoming * buffers will be used to schedule the exact render time of its * contents. */ @@ -710,7 +710,7 @@ gst_base_sink_set_sync (GstBaseSink * sink, gboolean sync) * Checks if @sink is currently configured to synchronize against the * clock. * - * Returns: TRUE if the sink is configured to synchronize against the clock. + * Returns: %TRUE if the sink is configured to synchronize against the clock. */ gboolean gst_base_sink_get_sync (GstBaseSink * sink) @@ -793,7 +793,7 @@ gst_base_sink_set_qos_enabled (GstBaseSink * sink, gboolean enabled) * Checks if @sink is currently configured to send Quality-of-Service events * upstream. * - * Returns: TRUE if the sink is configured to perform Quality-of-Service. + * Returns: %TRUE if the sink is configured to perform Quality-of-Service. */ gboolean gst_base_sink_is_qos_enabled (GstBaseSink * sink) @@ -835,7 +835,7 @@ gst_base_sink_set_async_enabled (GstBaseSink * sink, gboolean enabled) * Checks if @sink is currently configured to perform asynchronous state * changes to PAUSED. * - * Returns: TRUE if the sink is configured to perform asynchronous state + * Returns: %TRUE if the sink is configured to perform asynchronous state * changes. */ gboolean @@ -905,7 +905,7 @@ gst_base_sink_get_ts_offset (GstBaseSink * sink) * Free-function: gst_sample_unref * * Returns: (transfer full): a #GstSample. gst_sample_unref() after usage. - * This function returns NULL when no buffer has arrived in the sink yet + * This function returns %NULL when no buffer has arrived in the sink yet * or when the sink is not in PAUSED or PLAYING. */ GstSample * @@ -994,7 +994,7 @@ gst_base_sink_set_last_sample_enabled (GstBaseSink * sink, gboolean enabled) * Checks if @sink is currently configured to store the last received sample in * the last-sample property. * - * Returns: TRUE if the sink is configured to store the last received sample. + * Returns: %TRUE if the sink is configured to store the last received sample. */ gboolean gst_base_sink_is_last_sample_enabled (GstBaseSink * sink) @@ -1033,17 +1033,17 @@ gst_base_sink_get_latency (GstBaseSink * sink) * @max_latency: (out) (allow-none): the max latency of the upstream elements * * Query the sink for the latency parameters. The latency will be queried from - * the upstream elements. @live will be TRUE if @sink is configured to - * synchronize against the clock. @upstream_live will be TRUE if an upstream + * the upstream elements. @live will be %TRUE if @sink is configured to + * synchronize against the clock. @upstream_live will be %TRUE if an upstream * element is live. * - * If both @live and @upstream_live are TRUE, the sink will want to compensate + * If both @live and @upstream_live are %TRUE, the sink will want to compensate * for the latency introduced by the upstream elements by setting the * @min_latency to a strictly positive value. * * This function is mostly used by subclasses. * - * Returns: TRUE if the query succeeded. + * Returns: %TRUE if the query succeeded. */ gboolean gst_base_sink_query_latency (GstBaseSink * sink, gboolean * live, @@ -1526,8 +1526,8 @@ nothing_pending: /* Depending on the state, set our vars. We get in this situation when the * state change function got a change to update the state vars before the * streaming thread did. This is fine but we need to make sure that we - * update the need_preroll var since it was TRUE when we got here and might - * become FALSE if we got to PLAYING. */ + * update the need_preroll var since it was %TRUE when we got here and might + * become %FALSE if we got to PLAYING. */ GST_DEBUG_OBJECT (basesink, "nothing to commit, now in %s", gst_element_state_get_name (current)); switch (current) { @@ -1787,7 +1787,7 @@ handle_stepping (GstBaseSink * sink, GstSegment * segment, /* with STREAM_LOCK, PREROLL_LOCK * - * Returns TRUE if the object needs synchronisation and takes therefore + * Returns %TRUE if the object needs synchronisation and takes therefore * part in prerolling. * * rsstart/rsstop contain the start/stop in stream time. @@ -1979,7 +1979,7 @@ eos_done: out_of_segment: { /* we usually clip in the chain function already but stepping could cause - * the segment to be updated later. we return FALSE so that we don't try + * the segment to be updated later. we return %FALSE so that we don't try * to sync on it. */ GST_LOG_OBJECT (basesink, "buffer skipped, not in segment"); return FALSE; @@ -2024,14 +2024,14 @@ gst_base_sink_adjust_time (GstBaseSink * basesink, GstClockTime time) * gst_base_sink_wait_clock: * @sink: the sink * @time: the running_time to be reached - * @jitter: (out) (allow-none): the jitter to be filled with time diff, or NULL + * @jitter: (out) (allow-none): the jitter to be filled with time diff, or %NULL * * This function will block until @time is reached. It is usually called by * subclasses that use their own internal synchronisation. * - * If @time is not valid, no synchronisation is done and #GST_CLOCK_BADTIME is + * If @time is not valid, no synchronisation is done and %GST_CLOCK_BADTIME is * returned. Likewise, if synchronisation is disabled in the element or there - * is no clock, no synchronisation is done and #GST_CLOCK_BADTIME is returned. + * is no clock, no synchronisation is done and %GST_CLOCK_BADTIME is returned. * * This function should only be called with the PREROLL_LOCK held, like when * receiving an EOS event in the #GstBaseSinkClass.event() vmethod or when @@ -2132,14 +2132,14 @@ no_clock: * and call this method before continuing to render the remaining data. * * This function will block until a state change to PLAYING happens (in which - * case this function returns #GST_FLOW_OK) or the processing must be stopped due + * case this function returns %GST_FLOW_OK) or the processing must be stopped due * to a state change to READY or a FLUSH event (in which case this function - * returns #GST_FLOW_FLUSHING). + * returns %GST_FLOW_FLUSHING). * * This function should only be called with the PREROLL_LOCK held, like in the * render function. * - * Returns: #GST_FLOW_OK if the preroll completed and processing can + * Returns: %GST_FLOW_OK if the preroll completed and processing can * continue. Any other return value should be returned from the render vmethod. */ GstFlowReturn @@ -2184,7 +2184,7 @@ step_unlocked: * * This function should be called with the PREROLL_LOCK held. * - * Returns: #GST_FLOW_OK if the preroll completed and processing can + * Returns: %GST_FLOW_OK if the preroll completed and processing can * continue. Any other return value should be returned from the render vmethod. */ GstFlowReturn @@ -2274,7 +2274,7 @@ preroll_failed: * gst_base_sink_wait: * @sink: the sink * @time: the running_time to be reached - * @jitter: (out) (allow-none): the jitter to be filled with time diff, or NULL + * @jitter: (out) (allow-none): the jitter to be filled with time diff, or %NULL * * This function will wait for preroll to complete and will then block until @time * is reached. It is usually called by subclasses that use their own internal @@ -2360,7 +2360,7 @@ flushing: * immediately returns GST_FLOW_OK. * * for objects that arrive later than max-lateness to be synchronized to the - * clock have the @late boolean set to TRUE. + * clock have the @late boolean set to %TRUE. * * This function keeps a running average of the jitter (the diff between the * clock time and the requested sync time). The jitter is negative for @@ -2730,7 +2730,7 @@ gst_base_sink_reset_qos (GstBaseSink * sink) * * status and jitter contain the return values from the clock wait. * - * returns TRUE if the buffer was too late. + * returns %TRUE if the buffer was too late. */ static gboolean gst_base_sink_is_too_late (GstBaseSink * basesink, GstMiniObject * obj, @@ -4175,7 +4175,7 @@ gst_base_sink_negotiate_pull (GstBaseSink * basesink) result = FALSE; /* this returns the intersection between our caps and the peer caps. If there - * is no peer, it returns NULL and we can't operate in pull mode so we can + * is no peer, it returns %NULL and we can't operate in pull mode so we can * fail the negotiation. */ caps = gst_pad_get_allowed_caps (GST_BASE_SINK_PAD (basesink)); if (caps == NULL || gst_caps_is_empty (caps)) diff --git a/libs/gst/base/gstbasesrc.c b/libs/gst/base/gstbasesrc.c index 132e94246f..eb861a30f5 100644 --- a/libs/gst/base/gstbasesrc.c +++ b/libs/gst/base/gstbasesrc.c @@ -35,13 +35,13 @@ * * The source can be configured to operate in any #GstFormat with the * gst_base_src_set_format() method. The currently set format determines - * the format of the internal #GstSegment and any #GST_EVENT_SEGMENT - * events. The default format for #GstBaseSrc is #GST_FORMAT_BYTES. + * the format of the internal #GstSegment and any %GST_EVENT_SEGMENT + * events. The default format for #GstBaseSrc is %GST_FORMAT_BYTES. * * #GstBaseSrc always supports push mode scheduling. If the following * conditions are met, it also supports pull mode scheduling: * - * The format is set to #GST_FORMAT_BYTES (default). + * The format is set to %GST_FORMAT_BYTES (default). * * #GstBaseSrcClass.is_seekable() returns %TRUE. * @@ -50,7 +50,7 @@ * If all the conditions are met for operating in pull mode, #GstBaseSrc is * automatically seekable in push mode as well. The following conditions must * be met to make the element seekable in push mode when the format is not - * #GST_FORMAT_BYTES: + * %GST_FORMAT_BYTES: * * * #GstBaseSrcClass.is_seekable() returns %TRUE. @@ -82,7 +82,7 @@ * #GstBaseSrcClass.create() method will not be called in PAUSED but only in * PLAYING. To signal the pipeline that the element will not produce data, the * return value from the READY to PAUSED state will be - * #GST_STATE_CHANGE_NO_PREROLL. + * %GST_STATE_CHANGE_NO_PREROLL. * * A typical live source will timestamp the buffers it creates with the * current running time of the pipeline. This is one reason why a live source @@ -118,7 +118,7 @@ * { * GstElementClass *gstelement_class = GST_ELEMENT_CLASS (klass); * // srctemplate should be a #GstStaticPadTemplate with direction - * // #GST_PAD_SRC and name "src" + * // %GST_PAD_SRC and name "src" * gst_element_class_add_pad_template (gstelement_class, * gst_static_pad_template_get (&srctemplate)); * @@ -144,7 +144,7 @@ * * An application may send an EOS event to a source element to make it * perform the EOS logic (send EOS event downstream or post a - * #GST_MESSAGE_SEGMENT_DONE on the bus). This can typically be done + * %GST_MESSAGE_SEGMENT_DONE on the bus). This can typically be done * with the gst_element_send_event() function on the element or its parent bin. * * After the EOS has been sent to the element, the application should wait for @@ -506,11 +506,11 @@ gst_base_src_finalize (GObject * object) * and call this method before continuing to produce the remaining data. * * This function will block until a state change to PLAYING happens (in which - * case this function returns #GST_FLOW_OK) or the processing must be stopped due + * case this function returns %GST_FLOW_OK) or the processing must be stopped due * to a state change to READY or a FLUSH event (in which case this function - * returns #GST_FLOW_FLUSHING). + * returns %GST_FLOW_FLUSHING). * - * Returns: #GST_FLOW_OK if @src is PLAYING and processing can + * Returns: %GST_FLOW_OK if @src is PLAYING and processing can * continue. Any other return value should be returned from the create vmethod. */ GstFlowReturn @@ -592,7 +592,7 @@ gst_base_src_is_live (GstBaseSrc * src) * for sending SEGMENT events and for performing seeks. * * If a format of GST_FORMAT_BYTES is set, the element will be able to - * operate in pull mode if the #GstBaseSrcClass.is_seekable() returns TRUE. + * operate in pull mode if the #GstBaseSrcClass.is_seekable() returns %TRUE. * * This function must only be called in states < %GST_STATE_PAUSED. */ @@ -694,14 +694,14 @@ gst_base_src_is_async (GstBaseSrc * src) * @min_latency: (out) (allow-none): the min latency of the source * @max_latency: (out) (allow-none): the max latency of the source * - * Query the source for the latency parameters. @live will be TRUE when @src is + * Query the source for the latency parameters. @live will be %TRUE when @src is * configured as a live source. @min_latency will be set to the difference * between the running time and the timestamp of the first buffer. * @max_latency is always the undefined value of -1. * * This function is mostly used by subclasses. * - * Returns: TRUE if the query succeeded. + * Returns: %TRUE if the query succeeded. */ gboolean gst_base_src_query_latency (GstBaseSrc * src, gboolean * live, diff --git a/libs/gst/base/gstbasesrc.h b/libs/gst/base/gstbasesrc.h index 8b9eb4dbb0..75de438fc4 100644 --- a/libs/gst/base/gstbasesrc.h +++ b/libs/gst/base/gstbasesrc.h @@ -129,28 +129,31 @@ struct _GstBaseSrc { * these times. * @get_size: Return the total size of the resource, in the configured format. * @is_seekable: Check if the source can seek - * @prepare_seek_segment: Prepare the GstSegment that will be passed to the - * do_seek vmethod for executing a seek request. Sub-classes should override - * this if they support seeking in formats other than the configured native - * format. By default, it tries to convert the seek arguments to the - * configured native format and prepare a segment in that format. + * @prepare_seek_segment: Prepare the #GstSegment that will be passed to the + * #GstBaseSrcClass.do_seek() vmethod for executing a seek + * request. Sub-classes should override this if they support seeking in + * formats other than the configured native format. By default, it tries to + * convert the seek arguments to the configured native format and prepare a + * segment in that format. * @do_seek: Perform seeking on the resource to the indicated segment. - * @unlock: Unlock any pending access to the resource. Subclasses should - * unblock any blocked function ASAP. In particular, any create() function in + * @unlock: Unlock any pending access to the resource. Subclasses should unblock + * any blocked function ASAP. In particular, any create() function in * progress should be unblocked and should return GST_FLOW_FLUSHING. Any - * future @create() function call should also return GST_FLOW_FLUSHING - * until the @unlock_stop() function has been called. - * @unlock_stop: Clear the previous unlock request. Subclasses should clear - * any state they set during unlock(), such as clearing command queues. + * future #GstBaseSrcClass.create() function call should also return + * GST_FLOW_FLUSHING until the #GstBaseSrcClass.unlock_stop() function has + * been called. + * @unlock_stop: Clear the previous unlock request. Subclasses should clear any + * state they set during #GstBaseSrcClass.unlock(), such as clearing command + * queues. * @query: Handle a requested query. * @event: Override this to implement custom event handling. - * @create: Ask the subclass to create a buffer with offset and size. - * When the subclass returns GST_FLOW_OK, it MUST return a buffer of the - * requested size unless fewer bytes are available because an EOS condition - * is near. No buffer should be returned when the return value is different - * from GST_FLOW_OK. A return value of GST_FLOW_EOS signifies that the - * end of stream is reached. The default implementation will call @alloc and - * then call @fill. + * @create: Ask the subclass to create a buffer with offset and size. When the + * subclass returns GST_FLOW_OK, it MUST return a buffer of the requested size + * unless fewer bytes are available because an EOS condition is near. No + * buffer should be returned when the return value is different from + * GST_FLOW_OK. A return value of GST_FLOW_EOS signifies that the end of + * stream is reached. The default implementation will call + * #GstBaseSrcClass.alloc() and then call #GstBaseSrcClass.fill(). * @alloc: Ask the subclass to allocate a buffer with for offset and size. The * default implementation will create a new buffer from the negotiated allocator. * @fill: Ask the subclass to fill the buffer with data for offset and size. The diff --git a/libs/gst/base/gstbasetransform.c b/libs/gst/base/gstbasetransform.c index a7e493f5ba..c20a613328 100644 --- a/libs/gst/base/gstbasetransform.c +++ b/libs/gst/base/gstbasetransform.c @@ -57,14 +57,14 @@ * intact. * * - * On the GstBaseTransformClass is the passthrough_on_same_caps variable - * which will automatically set/unset passthrough based on whether the + * The #GstBaseTransformClass.passthrough_on_same_caps variable + * will automatically set/unset passthrough based on whether the * element negotiates the same caps on both pads. * * - * passthrough_on_same_caps on an element that doesn't implement a - * transform_caps function is useful for elements that only inspect data - * (such as level) + * #GstBaseTransformClass.passthrough_on_same_caps on an element that + * doesn't implement a transform_caps function is useful for elements that + * only inspect data (such as level) * * * @@ -94,7 +94,7 @@ * immediately. * * only implementing transform_ip and not transform implies always_in_place - * = TRUE + * = %TRUE * * * @@ -116,7 +116,7 @@ * * Elements wishing to operate in this mode should replace the * prepare_output_buffer method to create subbuffers of the input buffer - * and set always_in_place to TRUE + * and set always_in_place to %TRUE * * * @@ -185,10 +185,10 @@ * to the transform_ip function. * * - * Implied TRUE if no transform function is implemented. + * Implied %TRUE if no transform function is implemented. * * - * Implied FALSE if ONLY transform function is implemented. + * Implied %FALSE if ONLY transform function is implemented. * * * @@ -1717,7 +1717,7 @@ foreach_metadata (GstBuffer * inbuf, GstMeta ** meta, gpointer user_data) } /* we only copy metadata when the subclass implemented a transform_meta - * function and when it returns TRUE */ + * function and when it returns %TRUE */ if (do_copy) { GstMetaTransformCopy copy_data = { FALSE, 0, -1 }; GST_DEBUG_OBJECT (trans, "copy metadata %s", g_type_name (info->api)); @@ -1778,7 +1778,7 @@ not_writable: * We have two cache locations to store the size, one for the source caps * and one for the sink caps. * - * this function returns FALSE if no size could be calculated. + * this function returns %FALSE if no size could be calculated. */ static gboolean gst_base_transform_get_unit_size (GstBaseTransform * trans, GstCaps * caps, @@ -2439,7 +2439,7 @@ gst_base_transform_src_activate_mode (GstPad * pad, GstObject * parent, * Set passthrough mode for this filter by default. This is mostly * useful for filters that do not care about negotiation. * - * Always TRUE for filters which don't implement either a transform + * Always %TRUE for filters which don't implement either a transform * or transform_ip method. * * MT safe. @@ -2472,7 +2472,7 @@ gst_base_transform_set_passthrough (GstBaseTransform * trans, * * See if @trans is configured as a passthrough transform. * - * Returns: TRUE is the transform is configured in passthrough mode. + * Returns: %TRUE is the transform is configured in passthrough mode. * * MT safe. */ @@ -2499,8 +2499,8 @@ gst_base_transform_is_passthrough (GstBaseTransform * trans) * Determines whether a non-writable buffer will be copied before passing * to the transform_ip function. * - * Always TRUE if no transform function is implemented. - * Always FALSE if ONLY transform function is implemented. + * Always %TRUE if no transform function is implemented. + * Always %FALSE if ONLY transform function is implemented. * * * MT safe. @@ -2537,7 +2537,7 @@ gst_base_transform_set_in_place (GstBaseTransform * trans, gboolean in_place) * * See if @trans is configured as a in_place transform. * - * Returns: TRUE is the transform is configured in in_place mode. + * Returns: %TRUE is the transform is configured in in_place mode. * * MT safe. */ @@ -2612,7 +2612,7 @@ gst_base_transform_set_qos_enabled (GstBaseTransform * trans, gboolean enabled) * * Queries if the transform will handle QoS. * - * Returns: TRUE if QoS is enabled. + * Returns: %TRUE if QoS is enabled. * * MT safe. */ diff --git a/libs/gst/base/gstbasetransform.h b/libs/gst/base/gstbasetransform.h index 18cce1285f..3043a6294c 100644 --- a/libs/gst/base/gstbasetransform.h +++ b/libs/gst/base/gstbasetransform.h @@ -132,13 +132,13 @@ struct _GstBaseTransform { * If there is a @filter_meta method implementation, it will * be called for all metadata API in the downstream query, * otherwise the metadata API is removed. - * @filter_meta: Return TRUE if the metadata API should be proposed in the - * upstream allocation query. The default implementation is NULL + * @filter_meta: Return %TRUE if the metadata API should be proposed in the + * upstream allocation query. The default implementation is %NULL * and will cause all metadata to be removed. * @propose_allocation: Propose buffer allocation parameters for upstream elements. * This function must be implemented if the element reads or * writes the buffer content. The query that was passed to - * the decide_allocation is passed in this method (or NULL + * the decide_allocation is passed in this method (or %NULL * when the element is in passthrough mode). The default * implementation will pass the query downstream when in * passthrough mode and will copy all the filtered metadata @@ -176,9 +176,9 @@ struct _GstBaseTransform { * The default implementation will copy the flags, timestamps and * offsets of the buffer. * @transform_meta: Optional. Transform the metadata on the input buffer to the - * output buffer. By default this method is NULL and no + * output buffer. By default this method is %NULL and no * metadata is copied. subclasses can implement this method and - * return TRUE if the metadata is to be copied. + * return %TRUE if the metadata is to be copied. * @before_transform: Optional. * This method is called right before the base class will * start processing. Dynamic properties or other delayed diff --git a/libs/gst/base/gstcollectpads.c b/libs/gst/base/gstcollectpads.c index c6860ad601..8f97b71f0e 100644 --- a/libs/gst/base/gstcollectpads.c +++ b/libs/gst/base/gstcollectpads.c @@ -49,8 +49,8 @@ * * Data can be dequeued from the pad with the gst_collect_pads_pop() method. * One can peek at the data with the gst_collect_pads_peek() function. - * These functions will return NULL if the pad received an EOS event. When all - * pads return NULL from a gst_collect_pads_peek(), the element can emit an EOS + * These functions will return %NULL if the pad received an EOS event. When all + * pads return %NULL from a gst_collect_pads_peek(), the element can emit an EOS * event itself. * * @@ -296,7 +296,7 @@ gst_collect_pads_finalize (GObject * object) * * MT safe. * - * Returns: (transfer full): a new #GstCollectPads, or NULL in case of an error. + * Returns: (transfer full): a new #GstCollectPads, or %NULL in case of an error. */ GstCollectPads * gst_collect_pads_new (void) @@ -324,7 +324,7 @@ gst_collect_pads_set_buffer_function_locked (GstCollectPads * pads, * @user_data: (closure): user data passed to the function * * Set the callback function and user data that will be called with - * the oldest buffer when all pads have been collected, or NULL on EOS. + * the oldest buffer when all pads have been collected, or %NULL on EOS. * If a buffer is passed, the callback owns a reference and must unref * it. * @@ -606,7 +606,7 @@ gst_collect_pads_set_flush_function (GstCollectPads * pads, * * MT safe. * - * Returns: a new #GstCollectData to identify the new pad. Or NULL + * Returns: a new #GstCollectData to identify the new pad. Or %NULL * if wrong parameters are supplied. */ GstCollectData * @@ -924,7 +924,7 @@ gst_collect_pads_stop (GstCollectPads * pads) * * MT safe. * - * Returns: The buffer in @data or NULL if no buffer is queued. + * Returns: The buffer in @data or %NULL if no buffer is queued. * should unref the buffer after usage. */ GstBuffer * @@ -956,7 +956,7 @@ gst_collect_pads_peek (GstCollectPads * pads, GstCollectData * data) * * MT safe. * - * Returns: (transfer full): The buffer in @data or NULL if no buffer was + * Returns: (transfer full): The buffer in @data or %NULL if no buffer was * queued. You should unref the buffer after usage. */ GstBuffer * @@ -1124,7 +1124,7 @@ gst_collect_pads_flush (GstCollectPads * pads, GstCollectData * data, * MT safe. * * Returns: (transfer full): A sub buffer. The size of the buffer can be less that requested. - * A return of NULL signals that the pad is end-of-stream. + * A return of %NULL signals that the pad is end-of-stream. * Unref the buffer after use. */ GstBuffer * @@ -1163,7 +1163,7 @@ gst_collect_pads_read_buffer (GstCollectPads * pads, GstCollectData * data, * MT safe. * * Returns: A sub buffer. The size of the buffer can be less that requested. - * A return of NULL signals that the pad is end-of-stream. + * A return of %NULL signals that the pad is end-of-stream. * Unref the buffer after use. */ GstBuffer * @@ -1366,7 +1366,7 @@ gst_collect_pads_check_collected (GstCollectPads * pads) * * Must be called with STREAM_LOCK. * - * Returns TRUE if a pad was set to waiting + * Returns %TRUE if a pad was set to waiting * (from non-waiting state). */ static gboolean @@ -1639,7 +1639,7 @@ gst_collect_pads_clip_time (GstCollectPads * pads, GstCollectData * data, * @event: event being processed * @discard: process but do not send event downstream * - * Default GstCollectPads event handling that elements should always + * Default #GstCollectPads event handling that elements should always * chain up to to ensure proper operation. Element might however indicate * event should not be forwarded downstream. */ @@ -1893,7 +1893,7 @@ forward_event_to_all_sinkpads (GstPad * srcpad, GstEvent * event) * @pad: src #GstPad that received the event * @event: event being processed * - * Default GstCollectPads event handling for the src pad of elements. + * Default #GstCollectPads event handling for the src pad of elements. * Elements can chain up to this to let flushing seek event handling * be done by GstCollectPads. * @@ -2010,7 +2010,7 @@ pad_removed: * @query: query being processed * @discard: process but do not send event downstream * - * Default GstCollectPads query handling that elements should always + * Default #GstCollectPads query handling that elements should always * chain up to to ensure proper operation. Element might however indicate * query should not be forwarded downstream. */ diff --git a/libs/gst/base/gstcollectpads.h b/libs/gst/base/gstcollectpads.h index 3bcce87fca..0ba2dee96a 100644 --- a/libs/gst/base/gstcollectpads.h +++ b/libs/gst/base/gstcollectpads.h @@ -139,7 +139,7 @@ struct _GstCollectData * * A function that will be called when all pads have received data. * - * Returns: #GST_FLOW_OK for success + * Returns: %GST_FLOW_OK for success */ typedef GstFlowReturn (*GstCollectPadsFunction) (GstCollectPads *pads, gpointer user_data); @@ -151,10 +151,10 @@ typedef GstFlowReturn (*GstCollectPadsFunction) (GstCollectPads *pads, gpointer * @user_data: user data passed to gst_collect_pads_set_buffer_function() * * A function that will be called when a (considered oldest) buffer can be muxed. - * If all pads have reached EOS, this function is called with NULL @buffer - * and NULL @data. + * If all pads have reached EOS, this function is called with %NULL @buffer + * and %NULL @data. * - * Returns: #GST_FLOW_OK for success + * Returns: %GST_FLOW_OK for success */ typedef GstFlowReturn (*GstCollectPadsBufferFunction) (GstCollectPads *pads, GstCollectData *data, GstBuffer *buffer, gpointer user_data); diff --git a/libs/gst/base/gstdataqueue.c b/libs/gst/base/gstdataqueue.c index 39c4efefb5..3bc93babc4 100644 --- a/libs/gst/base/gstdataqueue.c +++ b/libs/gst/base/gstdataqueue.c @@ -336,7 +336,7 @@ gst_data_queue_flush (GstDataQueue * queue) * Queries if there are any items in the @queue. * MT safe. * - * Returns: #TRUE if @queue is empty. + * Returns: %TRUE if @queue is empty. * * Since: 1.2 */ @@ -360,7 +360,7 @@ gst_data_queue_is_empty (GstDataQueue * queue) * #GstDataQueueCheckFullFunction registered with @queue. * MT safe. * - * Returns: #TRUE if @queue is full. + * Returns: %TRUE if @queue is full. * * Since: 1.2 */ @@ -381,11 +381,11 @@ gst_data_queue_is_full (GstDataQueue * queue) * @queue: a #GstDataQueue. * @flushing: a #gboolean stating if the queue will be flushing or not. * - * Sets the queue to flushing state if @flushing is #TRUE. If set to flushing + * Sets the queue to flushing state if @flushing is %TRUE. If set to flushing * state, any incoming data on the @queue will be discarded. Any call currently * blocking on #gst_data_queue_push or #gst_data_queue_pop will return straight - * away with a return value of #FALSE. While the @queue is in flushing state, - * all calls to those two functions will return #FALSE. + * away with a return value of %FALSE. While the @queue is in flushing state, + * all calls to those two functions will return %FALSE. * * MT Safe. * @@ -436,10 +436,10 @@ gst_data_queue_push_force_unlocked (GstDataQueue * queue, * * Note that this function has slightly different semantics than gst_pad_push() * and gst_pad_push_event(): this function only takes ownership of @item and - * the #GstMiniObject contained in @item if the push was successful. If FALSE + * the #GstMiniObject contained in @item if the push was successful. If %FALSE * is returned, the caller is responsible for freeing @item and its contents. * - * Returns: #TRUE if the @item was successfully pushed on the @queue. + * Returns: %TRUE if the @item was successfully pushed on the @queue. * * Since: 1.2 */ @@ -484,10 +484,10 @@ flushing: * * Note that this function has slightly different semantics than gst_pad_push() * and gst_pad_push_event(): this function only takes ownership of @item and - * the #GstMiniObject contained in @item if the push was successful. If FALSE + * the #GstMiniObject contained in @item if the push was successful. If %FALSE * is returned, the caller is responsible for freeing @item and its contents. * - * Returns: #TRUE if the @item was successfully pushed on the @queue. + * Returns: %TRUE if the @item was successfully pushed on the @queue. * * Since: 1.2 */ @@ -566,7 +566,7 @@ _gst_data_queue_wait_non_empty (GstDataQueue * queue) * @queue is set to the flushing state. * MT safe. * - * Returns: #TRUE if an @item was successfully retrieved from the @queue. + * Returns: %TRUE if an @item was successfully retrieved from the @queue. * * Since: 1.2 */ @@ -636,7 +636,7 @@ is_of_type (gconstpointer a, gconstpointer b) * one item is available, OR the @queue is set to the flushing state. * MT safe. * - * Returns: #TRUE if an @item was successfully retrieved from the @queue. + * Returns: %TRUE if an @item was successfully retrieved from the @queue. * * Since: 1.2 */ @@ -688,7 +688,7 @@ flushing: * * Pop and unref the head-most #GstMiniObject with the given #GType. * - * Returns: TRUE if an element was removed. + * Returns: %TRUE if an element was removed. * * Since: 1.2 */ diff --git a/libs/gst/base/gstdataqueue.h b/libs/gst/base/gstdataqueue.h index c707c8b57d..7350c429cb 100644 --- a/libs/gst/base/gstdataqueue.h +++ b/libs/gst/base/gstdataqueue.h @@ -47,8 +47,8 @@ typedef struct _GstDataQueuePrivate GstDataQueuePrivate; * @object: the #GstMiniObject to queue. * @size: the size in bytes of the miniobject. * @duration: the duration in #GstClockTime of the miniobject. Can not be - * #GST_CLOCK_TIME_NONE. - * @visible: #TRUE if @object should be considered as a visible object. + * %GST_CLOCK_TIME_NONE. + * @visible: %TRUE if @object should be considered as a visible object. * @destroy: The #GDestroyNotify function to use to free the #GstDataQueueItem. * This function should also drop the reference to @object the owner of the * #GstDataQueueItem is assumed to hold. @@ -97,7 +97,7 @@ struct _GstDataQueueSize * The prototype of the function used to inform the queue that it should be * considered as full. * - * Returns: #TRUE if the queue should be considered full. + * Returns: %TRUE if the queue should be considered full. */ typedef gboolean (*GstDataQueueCheckFullFunction) (GstDataQueue * queue, guint visible, guint bytes, guint64 time, gpointer checkdata); diff --git a/libs/gst/base/gstindex.c b/libs/gst/base/gstindex.c index 3786e9572c..a0c5e86c15 100644 --- a/libs/gst/base/gstindex.c +++ b/libs/gst/base/gstindex.c @@ -25,7 +25,7 @@ * @short_description: Generate indexes on objects * @see_also: #GstIndexFactory * - * GstIndex is used to generate a stream index of one or more elements + * #GstIndex is used to generate a stream index of one or more elements * in a pipeline. * * Elements will overload the set_index and get_index virtual methods in @@ -368,7 +368,7 @@ gst_index_new_group (GstIndex * index) * * Set the current groupnumber to the given argument. * - * Returns: TRUE if the operation succeeded, FALSE if the group + * Returns: %TRUE if the operation succeeded, %FALSE if the group * did not exist. */ gboolean @@ -571,7 +571,7 @@ gst_index_entry_free (GstIndexEntry * entry) * @format: the format to add to the index * * Adds a format entry into the index. This function is - * used to map dynamic GstFormat ids to their original + * used to map dynamic #GstFormat ids to their original * format key. * * Free-function: gst_index_entry_free @@ -676,7 +676,7 @@ gst_index_gtype_resolver (GstIndex * index, GstObject * writer, /** * gst_index_get_writer_id: * @index: the index to get a unique write id for - * @writer: the GstObject to allocate an id for + * @writer: the #GstObject to allocate an id for * @id: a pointer to a gint to hold the id * * Before entries can be added to the index, a writer @@ -688,12 +688,12 @@ gst_index_gtype_resolver (GstIndex * index, GstObject * writer, * in the index. * * - * The caller must not hold @writer's #GST_OBJECT_LOCK, as the default + * The caller must not hold @writer's GST_OBJECT_LOCK(), as the default * resolver may call functions that take the object lock as well, and * the lock is not recursive. * * - * Returns: TRUE if the writer would be mapped to an id. + * Returns: %TRUE if the writer would be mapped to an id. */ gboolean gst_index_get_writer_id (GstIndex * index, GstObject * writer, gint * id) @@ -918,7 +918,7 @@ gst_index_compare_func (gconstpointer a, gconstpointer b, gpointer user_data) * * Finds the given format/value in the index * - * Returns: the entry associated with the value or NULL if the + * Returns: the entry associated with the value or %NULL if the * value was not found. */ GstIndexEntry * @@ -949,7 +949,7 @@ gst_index_get_assoc_entry (GstIndex * index, gint id, * Finds the given format/value in the index with the given * compare function and user_data. * - * Returns: the entry associated with the value or NULL if the + * Returns: the entry associated with the value or %NULL if the * value was not found. */ GstIndexEntry * @@ -981,7 +981,7 @@ gst_index_get_assoc_entry_full (GstIndex * index, gint id, * * Gets alternative formats associated with the indexentry. * - * Returns: TRUE if there was a value associated with the given + * Returns: %TRUE if there was a value associated with the given * format. */ gboolean diff --git a/libs/gst/base/gsttypefindhelper.c b/libs/gst/base/gsttypefindhelper.c index 5f30c8c0eb..1a0d32772f 100644 --- a/libs/gst/base/gsttypefindhelper.c +++ b/libs/gst/base/gsttypefindhelper.c @@ -163,7 +163,7 @@ helper_find_peek (gpointer data, gint64 offset, guint size) #endif /* getrange might silently return shortened buffers at the end of a file, - * we must, however, always return either the full requested data or NULL */ + * we must, however, always return either the full requested data or %NULL */ buf_offset = GST_BUFFER_OFFSET (buffer); buf_size = gst_buffer_get_size (buffer); @@ -246,13 +246,13 @@ helper_find_get_length (gpointer data) /** * gst_type_find_helper_get_range: * @obj: A #GstObject that will be passed as first argument to @func - * @parent: (allow-none): the parent of @obj or NULL + * @parent: (allow-none): the parent of @obj or %NULL * @func: (scope call): A generic #GstTypeFindHelperGetRangeFunction that will * be used to access data at random offsets when doing the typefinding * @size: The length in bytes * @extension: extension of the media * @prob: (out) (allow-none): location to store the probability of the found - * caps, or #NULL + * caps, or %NULL * * Utility function to do pull-based typefinding. Unlike gst_type_find_helper() * however, this function will use the specified function @func to obtain the @@ -263,14 +263,14 @@ helper_find_get_length (gpointer data) * callback can then call the upstream peer pad with offsets adjusted for the * tag size, for example). * - * When @extension is not NULL, this function will first try the typefind + * When @extension is not %NULL, this function will first try the typefind * functions for the given extension, which might speed up the typefinding * in many cases. * * Free-function: gst_caps_unref * * Returns: (transfer full): the #GstCaps corresponding to the data stream. - * Returns #NULL if no #GstCaps matches the data stream. + * Returns %NULL if no #GstCaps matches the data stream. */ GstCaps * gst_type_find_helper_get_range (GstObject * obj, GstObject * parent, @@ -389,7 +389,7 @@ gst_type_find_helper_get_range (GstObject * obj, GstObject * parent, * Free-function: gst_caps_unref * * Returns: (transfer full): the #GstCaps corresponding to the data stream. - * Returns #NULL if no #GstCaps matches the data stream. + * Returns %NULL if no #GstCaps matches the data stream. */ GstCaps * @@ -480,26 +480,26 @@ buf_helper_find_suggest (gpointer data, GstTypeFindProbability probability, /** * gst_type_find_helper_for_data: - * @obj: (allow-none): object doing the typefinding, or NULL (used for logging) + * @obj: (allow-none): object doing the typefinding, or %NULL (used for logging) * @data: (in) (transfer none): a pointer with data to typefind * @size: (in) (transfer none): the size of @data * @prob: (out) (allow-none): location to store the probability of the found - * caps, or #NULL + * caps, or %NULL * * Tries to find what type of data is contained in the given @data, the * assumption being that the data represents the beginning of the stream or * file. * * All available typefinders will be called on the data in order of rank. If - * a typefinding function returns a probability of #GST_TYPE_FIND_MAXIMUM, + * a typefinding function returns a probability of %GST_TYPE_FIND_MAXIMUM, * typefinding is stopped immediately and the found caps will be returned * right away. Otherwise, all available typefind functions will the tried, - * and the caps with the highest probability will be returned, or #NULL if + * and the caps with the highest probability will be returned, or %NULL if * the content of @data could not be identified. * * Free-function: gst_caps_unref * - * Returns: (transfer full): the #GstCaps corresponding to the data, or #NULL + * Returns: (transfer full): the #GstCaps corresponding to the data, or %NULL * if no type could be found. The caller should free the caps returned * with gst_caps_unref(). */ @@ -552,25 +552,25 @@ gst_type_find_helper_for_data (GstObject * obj, const guint8 * data, gsize size, /** * gst_type_find_helper_for_buffer: - * @obj: (allow-none): object doing the typefinding, or NULL (used for logging) + * @obj: (allow-none): object doing the typefinding, or %NULL (used for logging) * @buf: (in) (transfer none): a #GstBuffer with data to typefind * @prob: (out) (allow-none): location to store the probability of the found - * caps, or #NULL + * caps, or %NULL * * Tries to find what type of data is contained in the given #GstBuffer, the * assumption being that the buffer represents the beginning of the stream or * file. * * All available typefinders will be called on the data in order of rank. If - * a typefinding function returns a probability of #GST_TYPE_FIND_MAXIMUM, + * a typefinding function returns a probability of %GST_TYPE_FIND_MAXIMUM, * typefinding is stopped immediately and the found caps will be returned * right away. Otherwise, all available typefind functions will the tried, - * and the caps with the highest probability will be returned, or #NULL if + * and the caps with the highest probability will be returned, or %NULL if * the content of the buffer could not be identified. * * Free-function: gst_caps_unref * - * Returns: (transfer full): the #GstCaps corresponding to the data, or #NULL + * Returns: (transfer full): the #GstCaps corresponding to the data, or %NULL * if no type could be found. The caller should free the caps returned * with gst_caps_unref(). */ @@ -596,7 +596,7 @@ gst_type_find_helper_for_buffer (GstObject * obj, GstBuffer * buf, /** * gst_type_find_helper_for_extension: - * @obj: (allow-none): object doing the typefinding, or NULL (used for logging) + * @obj: (allow-none): object doing the typefinding, or %NULL (used for logging) * @extension: an extension * * Tries to find the best #GstCaps associated with @extension. @@ -608,7 +608,7 @@ gst_type_find_helper_for_buffer (GstObject * obj, GstBuffer * buf, * Free-function: gst_caps_unref * * Returns: (transfer full): the #GstCaps corresponding to @extension, or - * #NULL if no type could be found. The caller should free the caps + * %NULL if no type could be found. The caller should free the caps * returned with gst_caps_unref(). */ GstCaps * diff --git a/libs/gst/base/gsttypefindhelper.h b/libs/gst/base/gsttypefindhelper.h index 9447f9ba5a..6770e4fd19 100644 --- a/libs/gst/base/gsttypefindhelper.h +++ b/libs/gst/base/gsttypefindhelper.h @@ -44,7 +44,7 @@ GstCaps * gst_type_find_helper_for_extension (GstObject * obj, /** * GstTypeFindHelperGetRangeFunction: * @obj: a #GstObject that will handle the getrange request - * @parent: (allow-none): the parent of @obj or NULL + * @parent: (allow-none): the parent of @obj or %NULL * @offset: the offset of the range * @length: the length of the range * @buffer: a memory location to hold the result buffer