Commit ef258c22 authored by Peter Kjellerstedt's avatar Peter Kjellerstedt

gst/: Fixed a bunch of typos.

Original commit message from CVS:
* gst/gstclock.c:
* gst/gstclock.h:
* gst/gsttask.c:
* gst/gsttask.h:
Fixed a bunch of typos.
parent aed9ed88
2008-05-26 Peter Kjellerstedt <pkj@axis.com>
* gst/gstclock.c:
* gst/gstclock.h:
* gst/gsttask.c:
* gst/gsttask.h:
Fixed a bunch of typos.
2008-05-25 Tim-Philipp Müller <tim.muller at collabora co uk>
* gst/gstpad.h:
......
......@@ -54,16 +54,16 @@
* interrupted with the gst_clock_id_unschedule() call. If the blocking wait is
* unscheduled a return value of GST_CLOCK_UNSCHEDULED is returned.
*
* Periodic callbacks scheduled async will be repeadedly called automatically
* Periodic callbacks scheduled async will be repeatedly called automatically
* until it is unscheduled. To schedule a sync periodic callback,
* gst_clock_id_wait() should be called repeadedly.
* gst_clock_id_wait() should be called repeatedly.
*
* The async callbacks can happen from any thread, either provided by the core
* or from a streaming thread. The application should be prepared for this.
*
* A #GstClockID that has been unscheduled cannot be used again for any wait
* operation, a new #GstClockID should be created and the old unscheduled one
* should be destroyed wirth gst_clock_id_unref().
* should be destroyed with gst_clock_id_unref().
*
* It is possible to perform a blocking wait on the same #GstClockID from
* multiple threads. However, registering the same #GstClockID for multiple
......@@ -82,9 +82,9 @@
* running. Some clocks however do not progress when the element that provided
* the clock is not PLAYING.
*
* When a clock has the GST_CLOCK_FLAG_CAN_SET_MASTER flag set, it can be
* When a clock has the #GST_CLOCK_FLAG_CAN_SET_MASTER flag set, it can be
* slaved to another #GstClock with the gst_clock_set_master(). The clock will
* then automatically be synchronized to this master clock by repeadedly
* then automatically be synchronized to this master clock by repeatedly
* sampling the master clock and the slave clock and recalibrating the slave
* clock with gst_clock_set_calibration(). This feature is mostly useful for
* plugins that have an internal clock but must operate with another clock
......@@ -258,8 +258,8 @@ gst_clock_new_single_shot_id (GstClock * clock, GstClockTime time)
* @interval: the requested interval
*
* Get an ID from @clock to trigger a periodic notification.
* The periodeic notifications will be start at time start_time and
* will then be fired with the given interval. @id should be unreffed
* The periodic notifications will start at time @start_time and
* will then be fired with the given @interval. @id should be unreffed
* after usage.
*
* Returns: A #GstClockID that can be used to request the time notification.
......@@ -329,14 +329,14 @@ gst_clock_id_get_time (GstClockID id)
/**
* gst_clock_id_wait
* @id: The #GstClockID to wait on
* @jitter: A pointer that will contain the jitter, can be NULL.
* @jitter: A pointer that will contain the jitter, can be %NULL.
*
* Perform a blocking wait on @id.
* @id should have been created with gst_clock_new_single_shot_id()
* or gst_clock_new_periodic_id() and should not have been unscheduled
* with a call to gst_clock_id_unschedule().
*
* If the @jitter argument is not NULL and this function returns #GST_CLOCK_OK
* If the @jitter argument is not %NULL and this function returns #GST_CLOCK_OK
* or #GST_CLOCK_EARLY, it will contain the difference
* against the clock and the time of @id when this method was
* called.
......@@ -437,11 +437,11 @@ not_supported:
* gst_clock_id_wait_async:
* @id: a #GstClockID to wait on
* @func: The callback function
* @user_data: User data passed in the calback
* @user_data: User data passed in the callback
*
* Register a callback on the given #GstClockID @id with the given
* function and user_data. When passing a #GstClockID with an invalid
* time to this function, the callback will be called immediatly
* time to this function, the callback will be called immediately
* with a time set to GST_CLOCK_TIME_NONE. The callback will
* be called when the time of @id has been reached.
*
......@@ -732,7 +732,7 @@ gst_clock_get_resolution (GstClock * clock)
* that the returned time is increasing. This function should be called with the
* clock's OBJECT_LOCK held and is mainly used by clock subclasses.
*
* This function is te reverse of gst_clock_unadjust_unlocked().
* This function is the reverse of gst_clock_unadjust_unlocked().
*
* Returns: the converted time of the clock.
*/
......@@ -754,7 +754,7 @@ gst_clock_adjust_unlocked (GstClock * clock, GstClockTime internal)
/* The formula is (internal - cinternal) * cnum / cdenom + cexternal
*
* Since we do math on unsigned 64-bit ints we have to special case for
* interal < cinternal to get the sign right. this case is not very common,
* internal < cinternal to get the sign right. this case is not very common,
* though.
*/
if (G_LIKELY (internal >= cinternal)) {
......@@ -785,7 +785,7 @@ gst_clock_adjust_unlocked (GstClock * clock, GstClockTime internal)
* This function should be called with the clock's OBJECT_LOCK held and
* is mainly used by clock subclasses.
*
* This function is te reverse of gst_clock_adjust_unlocked().
* This function is the reverse of gst_clock_adjust_unlocked().
*
* Returns: the internal time of the clock corresponding to @external.
*
......@@ -828,7 +828,7 @@ gst_clock_unadjust_unlocked (GstClock * clock, GstClockTime external)
* unadjusted for the offset and the rate.
*
* Returns: the internal time of the clock. Or GST_CLOCK_TIME_NONE when
* giving wrong input.
* given invalid input.
*
* MT safe.
*/
......@@ -870,7 +870,7 @@ not_supported:
* offset and rate.
*
* Returns: the time of the clock. Or GST_CLOCK_TIME_NONE when
* giving wrong input.
* given invalid input.
*
* MT safe.
*/
......@@ -915,7 +915,7 @@ gst_clock_get_time (GstClock * clock)
* follows:
*
* <programlisting>
* time = (internal_time - @internal) * @rate_num / @rate_denom + @external
* time = (internal_time - internal) * rate_num / rate_denom + external
* </programlisting>
*
* This formula is implemented in gst_clock_adjust_unlocked(). Of course, it
......@@ -961,7 +961,7 @@ gst_clock_set_calibration (GstClock * clock, GstClockTime internal, GstClockTime
* Gets the internal rate and reference time of @clock. See
* gst_clock_set_calibration() for more information.
*
* @internal, @external, @rate_num, and @rate_denom can be left NULL if the
* @internal, @external, @rate_num, and @rate_denom can be left %NULL if the
* caller is not interested in the values.
*
* MT safe.
......@@ -984,7 +984,7 @@ gst_clock_get_calibration (GstClock * clock, GstClockTime * internal,
GST_OBJECT_UNLOCK (clock);
}
/* will be called repeadedly to sample the master and slave clock
/* will be called repeatedly to sample the master and slave clock
* to recalibrate the clock */
static gboolean
gst_clock_slave_callback (GstClock * master, GstClockTime time,
......@@ -1020,13 +1020,13 @@ gst_clock_slave_callback (GstClock * master, GstClockTime time,
* A clock provider that slaves its clock to a master can get the current
* calibration values with gst_clock_get_calibration().
*
* @master can be NULL in which case @clock will not be slaved anymore. It will
* @master can be %NULL in which case @clock will not be slaved anymore. It will
* however keep reporting its time adjusted with the last configured rate
* and time offsets.
*
* Returns: TRUE if the clock is capable of being slaved to a master clock.
* Returns: %TRUE if the clock is capable of being slaved to a master clock.
* Trying to set a master on a clock without the
* GST_CLOCK_FLAG_CAN_SET_MASTER flag will make this function return FALSE.
* #GST_CLOCK_FLAG_CAN_SET_MASTER flag will make this function return %FALSE.
*
* MT safe.
*/
......@@ -1083,11 +1083,11 @@ not_supported:
* gst_clock_get_master
* @clock: a #GstClock
*
* Get the master clock that @clock is slaved to or NULL when the clock is
* Get the master clock that @clock is slaved to or %NULL when the clock is
* not slaved to any master clock.
*
* Returns: a master #GstClock or NULL when this clock is not slaved to a master
* clock. Unref after usage.
* Returns: a master #GstClock or %NULL when this clock is not slaved to a
* master clock. Unref after usage.
*
* MT safe.
*/
......@@ -1242,12 +1242,12 @@ invalid:
* observations and @clock is recalibrated.
*
* If this functions returns %TRUE, @r_squared will contain the
* correlation coefficient of the interpollation. A value of 1.0
* correlation coefficient of the interpolation. A value of 1.0
* means a perfect regression was performed. This value can
* be used to control the sampling frequency of the master and slave
* clocks.
*
* Returns: TRUE if enough observations were added to run the
* Returns: %TRUE if enough observations were added to run the
* regression algorithm.
*
* MT safe.
......
......@@ -50,14 +50,14 @@ typedef guint64 GstClockTime;
/**
* GST_TYPE_CLOCK_TIME:
*
* The GType of a GstClockTime.
* The #GType of a #GstClockTime.
*/
#define GST_TYPE_CLOCK_TIME G_TYPE_UINT64
/**
* GstClockTimeDiff:
*
* A datatype to hold a timedifference, measured in nanoseconds.
* A datatype to hold a time difference, measured in nanoseconds.
*/
typedef gint64 GstClockTimeDiff;
/**
......@@ -158,20 +158,20 @@ typedef gpointer GstClockID;
* GST_TIMEVAL_TO_TIME:
* @tv: the timeval to convert
*
* Convert a GTimeVal to a #GstClockTime.
* Convert a #GTimeVal to a #GstClockTime.
*/
#define GST_TIMEVAL_TO_TIME(tv) (GstClockTime)((tv).tv_sec * GST_SECOND + (tv).tv_usec * GST_USECOND)
/**
* GST_TIME_TO_TIMEVAL:
* @t: The GstClockTime to convert
* @t: The #GstClockTime to convert
* @tv: The target timeval
*
* Note: on 32-bit systems, a timeval has a range of only 2^32 - 1 seconds,
* which is about 68 years. Expect trouble if you want to schedule stuff
* in your pipeline for 2038.
*
* Convert a GstClockTime to a GTimeVal
* Convert a #GstClockTime to a #GTimeVal
*/
#define GST_TIME_TO_TIMEVAL(t,tv) \
G_STMT_START { \
......@@ -190,7 +190,7 @@ G_STMT_START { \
#define GST_TIMESPEC_TO_TIME(ts) (GstClockTime)((ts).tv_sec * GST_SECOND + (ts).tv_nsec * GST_NSECOND)
/**
* GST_TIME_TO_TIMESPEC:
* @t: The GstClockTime to convert
* @t: The #GstClockTime to convert
* @ts: The target timespec
*
* Convert a #GstClockTime to a struct timespec (see man pselect)
......@@ -206,7 +206,7 @@ G_STMT_START { \
* GST_TIME_FORMAT:
*
* A format that can be used in printf like format strings to format
* a GstClockTime value.
* a #GstClockTime value.
*/
#define GST_TIME_FORMAT "u:%02u:%02u.%09u"
/**
......@@ -252,12 +252,12 @@ typedef gboolean (*GstClockCallback) (GstClock *clock, GstClockTime time,
GstClockID id, gpointer user_data);
/**
* GstClockReturn:
* @GST_CLOCK_OK: The operation succeded.
* @GST_CLOCK_OK: The operation succeeded.
* @GST_CLOCK_EARLY: The operation was scheduled too late.
* @GST_CLOCK_UNSCHEDULED: The clockID was unscheduled
* @GST_CLOCK_BUSY: The ClockID is busy
* @GST_CLOCK_BADTIME: A bad time was provided to a function.
* @GST_CLOCK_ERROR: An error occured
* @GST_CLOCK_ERROR: An error occurred
* @GST_CLOCK_UNSUPPORTED: Operation is not supported
*
* The return value of a clock operation.
......@@ -382,7 +382,7 @@ typedef enum {
* GST_CLOCK_COND:
* @clock: the clock to query
*
* Gets the #GCond that gets signaled when the entries of the clock
* Gets the #GCond that gets signalled when the entries of the clock
* changed.
*/
#define GST_CLOCK_COND(clock) (GST_CLOCK_CAST(clock)->entries_changed)
......@@ -396,10 +396,10 @@ typedef enum {
/**
* GST_CLOCK_TIMED_WAIT:
* @clock: the clock to wait on
* @tv: a GTimeVal to wait.
* @tv: a #GTimeVal to wait.
*
* Wait on the clock until the entries changed or the specified timeout
* occured.
* occurred.
*/
#define GST_CLOCK_TIMED_WAIT(clock,tv) g_cond_timed_wait(GST_CLOCK_COND(clock),GST_OBJECT_GET_LOCK(clock),tv)
/**
......@@ -413,7 +413,7 @@ typedef enum {
/**
* GstClock:
*
* GstClock base structure. The values of this structure are
* #GstClock base structure. The values of this structure are
* protected for subclasses, use the methods to use the #GstClock.
*/
struct _GstClock {
......@@ -457,11 +457,11 @@ struct _GstClock {
* be acceptable. The new resolution should be returned.
* @get_resolution: get the resolution of the clock.
* @get_internal_time: get the internal unadjusted time of the clock.
* @wait: perform a blocking wait for the given GstClockEntry. Deprecated,
* @wait: perform a blocking wait for the given #GstClockEntry. Deprecated,
* implement @wait_jitter instead.
* @wait_async: perform an asynchronous wait for the given GstClockEntry.
* @wait_async: perform an asynchronous wait for the given #GstClockEntry.
* @unschedule: unblock a blocking or async wait operation.
* @wait_jitter: perform a blocking wait on the given GstClockEntry and return
* @wait_jitter: perform a blocking wait on the given #GstClockEntry and return
* the jitter. (Since: 0.10.10)
*
* GStreamer clock class. Override the vmethods to implement the clock
......
......@@ -44,11 +44,11 @@
* The task can be started, paused and stopped with gst_task_start(), gst_task_pause()
* and gst_task_stop() respectively.
*
* A #GstTask will repeadedly call the #GstTaskFunction with the user data
* A #GstTask will repeatedly call the #GstTaskFunction with the user data
* that was provided when creating the task with gst_task_create(). Before calling
* the function it will acquire the provided lock.
*
* Stopping a task with gst_task_stop() will not immediatly make sure the task is
* Stopping a task with gst_task_stop() will not immediately make sure the task is
* not running anymore. Use gst_task_join() to make sure the task is completely
* stopped and the thread is stopped.
*
......@@ -228,7 +228,7 @@ no_lock:
* gst_task_cleanup_all:
*
* Wait for all tasks to be stopped. This is mainly used internally
* to ensure proper cleanup of internal datastructures in testsuites.
* to ensure proper cleanup of internal data structures in test suites.
*
* MT safe.
*/
......@@ -258,12 +258,12 @@ gst_task_cleanup_all (void)
* @func: The #GstTaskFunction to use
* @data: User data to pass to @func
*
* Create a new Task that will repeadedly call the provided @func
* Create a new Task that will repeatedly call the provided @func
* with @data as a parameter. Typically the task will run in
* a new thread.
*
* The function cannot be changed after the task has been created. You
* must create a new GstTask to change the function.
* must create a new #GstTask to change the function.
*
* Returns: A new #GstTask.
*
......@@ -286,7 +286,7 @@ gst_task_create (GstTaskFunction func, gpointer data)
/**
* gst_task_set_lock:
* @task: The #GstTask to use
* @mutex: The GMutex to use
* @mutex: The #GMutex to use
*
* Set the mutex used by the task. The mutex will be acquired before
* calling the #GstTaskFunction.
......@@ -345,9 +345,9 @@ gst_task_get_state (GstTask * task)
* @task: The #GstTask to start
*
* Starts @task. The @task must have a lock associated with it using
* gst_task_set_lock() or thsi function will return FALSE.
* gst_task_set_lock() or this function will return %FALSE.
*
* Returns: TRUE if the task could be started.
* Returns: %TRUE if the task could be started.
*
* MT safe.
*/
......@@ -376,8 +376,8 @@ gst_task_start (GstTask * task)
if (task->running)
break;
/* new task, push on threadpool. We ref before so
* that it remains alive while on the threadpool. */
/* new task, push on thread pool. We ref before so
* that it remains alive while on the thread pool. */
gst_object_ref (task);
/* mark task as running so that a join will wait until we schedule
* and exit the task function. */
......@@ -420,7 +420,7 @@ no_lock:
* will not wait for the task to have completely stopped. Use
* gst_task_join() to stop and wait for completion.
*
* Returns: TRUE if the task could be stopped.
* Returns: %TRUE if the task could be stopped.
*
* MT safe.
*/
......@@ -462,7 +462,7 @@ gst_task_stop (GstTask * task)
* in the paused state. This function does not wait for the task to complete
* the paused state.
*
* Returns: TRUE if the task could be paused.
* Returns: %TRUE if the task could be paused.
*
* MT safe.
*/
......@@ -531,7 +531,7 @@ no_lock:
* would cause a deadlock. The function will detect this and print a
* g_warning.
*
* Returns: TRUE if the task could be joined.
* Returns: %TRUE if the task could be joined.
*
* MT safe.
*/
......@@ -547,14 +547,14 @@ gst_task_join (GstTask * task)
GST_DEBUG_OBJECT (task, "Joining task %p, thread %p", task, tself);
/* we don't use a real thread join here because we are using
* threadpools */
* thread pools */
GST_OBJECT_LOCK (task);
if (G_UNLIKELY (tself == task->abidata.ABI.thread))
goto joining_self;
task->state = GST_TASK_STOPPED;
/* signal the state change for when it was blocked in PAUSED. */
GST_TASK_SIGNAL (task);
/* we set the running flag when pushing the task on the threadpool.
/* we set the running flag when pushing the task on the thread pool.
* This means that the task function might not be called when we try
* to join it here. */
while (G_LIKELY (task->running))
......
......@@ -31,8 +31,8 @@ G_BEGIN_DECLS
* GstTaskFunction:
* @data: user data passed to the function
*
* A function that will repeadedly be called in the thread created by
* a GstTask.
* A function that will repeatedly be called in the thread created by
* a #GstTask.
*/
typedef void (*GstTaskFunction) (void *data);
......@@ -51,7 +51,7 @@ typedef struct _GstTaskClass GstTaskClass;
/**
* GstTaskState:
* @GST_TASK_STARTED: the task is started and running
* @GST_TASK_STOPPED: the task is stopped
* @GST_TASK_STOPPED: the task is stopped
* @GST_TASK_PAUSED: the task is paused
*
* The different states a task can be in
......@@ -111,10 +111,10 @@ typedef enum {
* GstTask:
* @state: the state of the task
* @cond: used to pause/resume the task
* @lock: The lock taken when iterating the taskfunction
* @lock: The lock taken when iterating the task function
* @func: the function executed by this task
* @data: data passed to the task function
* @running: a flag indicating that the task is running.
* @running: a flag indicating that the task is running
*
* The #GstTask object.
*/
......@@ -172,4 +172,3 @@ gboolean gst_task_join (GstTask *task);
G_END_DECLS
#endif /* __GST_TASK_H__ */
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