* Most of the event API is used inside plugins. Applications usually only
* construct and use seek events.
* To do that gst_event_new_seek() is used to create a seek event. It takes
- * the needed parameters to specity seeking time and mode.
+ * the needed parameters to specify seeking time and mode.
* <example>
* <title>performing a seek on a pipeline</title>
* <programlisting>
typedef struct
{
- GstQOSType type;
- gdouble proportion;
- gint64 diff;
- GstClockTime timestamp;
-} GstEventQOSData;
-
-typedef struct
-{
GstEvent event;
GstStructure *structure;
-
- union
- {
- GstEventQOSData qos;
- };
} GstEventImpl;
-#define GST_EVENT_STRUCTURE(e) (((GstEventImpl *)(e))->structure)
-#define GST_EVENT_IMPL(e,data,field) (((GstEventImpl *)(e))->data.field)
+#define GST_EVENT_STRUCTURE(e) (((GstEventImpl *)(e))->structure)
typedef struct
{
{GST_EVENT_FLUSH_STOP, "flush-stop", 0},
{GST_EVENT_EOS, "eos", 0},
{GST_EVENT_CAPS, "caps", 0},
- {GST_EVENT_NEWSEGMENT, "newsegment", 0},
+ {GST_EVENT_SEGMENT, "segment", 0},
{GST_EVENT_TAG, "tag", 0},
{GST_EVENT_BUFFERSIZE, "buffersize", 0},
{GST_EVENT_SINK_MESSAGE, "sink-message", 0},
{0, NULL, 0}
};
+GST_DEFINE_MINI_OBJECT_TYPE (GstEvent, gst_event);
+
void
-_gst_event_initialize (void)
+_priv_gst_event_initialize (void)
{
gint i;
- _gst_event_type = gst_mini_object_register ("GstEvent");
+ _gst_event_type = gst_event_get_type ();
g_type_class_ref (gst_seek_flags_get_type ());
g_type_class_ref (gst_seek_type_get_type ());
g_slice_free1 (GST_MINI_OBJECT_SIZE (event), event);
}
+static void gst_event_init (GstEventImpl * event, gsize size,
+ GstEventType type);
+
static GstEvent *
-_gst_event_copy (GstEventImpl * event)
+_gst_event_copy (GstEvent * event)
{
GstEventImpl *copy;
GstStructure *s;
- copy = g_slice_dup (GstEventImpl, event);
- gst_mini_object_init (GST_MINI_OBJECT_CAST (copy), _gst_event_type,
- sizeof (GstEventImpl));
+ copy = g_slice_new0 (GstEventImpl);
+
+ gst_event_init (copy, sizeof (GstEventImpl), GST_EVENT_TYPE (event));
- GST_EVENT_TYPE (copy) = GST_EVENT_TYPE (event);
GST_EVENT_TIMESTAMP (copy) = GST_EVENT_TIMESTAMP (event);
GST_EVENT_SEQNUM (copy) = GST_EVENT_SEQNUM (event);
GstEvent *event;
/* structure must not have a parent */
- if (structure)
- g_return_val_if_fail (structure->parent_refcount == NULL, NULL);
-
event = gst_event_new (type);
if (structure) {
- gst_structure_set_parent_refcount (structure, &event->mini_object.refcount);
+ if (!gst_structure_set_parent_refcount (structure,
+ &event->mini_object.refcount))
+ goto had_parent;
+
GST_EVENT_STRUCTURE (event) = structure;
}
return event;
+
+ /* ERRORS */
+had_parent:
+ {
+ gst_event_unref (event);
+ g_warning ("structure is already owned by another object");
+ return NULL;
+ }
}
/**
if (structure == NULL) {
structure =
- gst_structure_id_empty_new (gst_event_type_to_quark (GST_EVENT_TYPE
+ gst_structure_new_id_empty (gst_event_type_to_quark (GST_EVENT_TYPE
(event)));
gst_structure_set_parent_refcount (structure, &event->mini_object.refcount);
GST_EVENT_STRUCTURE (event) = structure;
* required.
*
* Note that events and messages share the same sequence number incrementor;
- * two events or messages will never not have the same sequence number unless
+ * two events or messages will never have the same sequence number unless
* that correspondence was made explicitly.
*
* Returns: The event's sequence number.
/**
* gst_event_new_flush_stop:
+ * @reset_time: if time should be reset
*
* Allocate a new flush stop event. The flush stop event can be sent
* upstream and downstream and travels serialized with the dataflow.
* Returns: (transfer full): a new flush stop event.
*/
GstEvent *
-gst_event_new_flush_stop (void)
+gst_event_new_flush_stop (gboolean reset_time)
+{
+ GstEvent *event;
+
+ GST_CAT_INFO (GST_CAT_EVENT, "creating flush stop %d", reset_time);
+
+ event = gst_event_new_custom (GST_EVENT_FLUSH_STOP,
+ gst_structure_new_id (GST_QUARK (EVENT_FLUSH_STOP),
+ GST_QUARK (RESET_TIME), G_TYPE_BOOLEAN, reset_time, NULL));
+
+ return event;
+}
+
+/**
+ * gst_event_parse_flush_stop:
+ * @event: The event to parse
+ * @reset_time: (out): if time should be reset
+ *
+ * Parse the FLUSH_STOP event and retrieve the @reset_time member.
+ */
+void
+gst_event_parse_flush_stop (GstEvent * event, gboolean * reset_time)
{
- return gst_event_new (GST_EVENT_FLUSH_STOP);
+ GstStructure *structure;
+
+ g_return_if_fail (GST_IS_EVENT (event));
+ g_return_if_fail (GST_EVENT_TYPE (event) == GST_EVENT_FLUSH_STOP);
+
+ structure = GST_EVENT_STRUCTURE (event);
+ if (G_LIKELY (reset_time))
+ *reset_time =
+ g_value_get_boolean (gst_structure_id_get_value (structure,
+ GST_QUARK (RESET_TIME)));
}
/**
/**
* gst_event_new_caps:
- * @caps: a #GstCaps
+ * @caps: (transfer none): a #GstCaps
*
* Create a new CAPS event for @caps. The caps event can only travel downstream
- * synchronized with the buffer flow and contain the format of the buffers
+ * synchronized with the buffer flow and contains the format of the buffers
* that will follow after the event.
*
* Returns: (transfer full): the new CAPS event.
{
GstEvent *event;
- g_return_val_if_fail (caps != NULL && gst_caps_is_fixed (caps), NULL);
+ g_return_val_if_fail (caps != NULL, NULL);
+ g_return_val_if_fail (gst_caps_is_fixed (caps), NULL);
GST_CAT_INFO (GST_CAT_EVENT, "creating caps event %" GST_PTR_FORMAT, caps);
event = gst_event_new_custom (GST_EVENT_CAPS,
- gst_structure_id_new (GST_QUARK (EVENT_CAPS),
+ gst_structure_new_id (GST_QUARK (EVENT_CAPS),
GST_QUARK (CAPS), GST_TYPE_CAPS, caps, NULL));
return event;
}
/**
- * gst_event_new_new_segment:
- * @update: Whether this segment is an update to a previous one
- * @rate: A new rate for playback
- * @applied_rate: The rate factor which has already been applied
- * @format: The format of the segment values
- * @start: The start value of the segment
- * @stop: The stop value of the segment
- * @time: the time value of the segment
+ * gst_event_new_segment:
+ * @segment: (transfer none): a #GstSegment
*
- * Allocate a new newsegment event with the given format/values triplets.
+ * Create a new SEGMENT event for @segment. The segment event can only travel
+ * downstream synchronized with the buffer flow and contains timing information
+ * and playback properties for the buffers that will follow.
*
* The newsegment event marks the range of buffers to be processed. All
* data not within the segment range is not to be processed. This can be
* values.
*
* The time value of the segment is used in conjunction with the start
- * value to convert the buffer timestamps into the stream time. This is
- * usually done in sinks to report the current stream_time.
- * @time represents the stream_time of a buffer carrying a timestamp of
+ * value to convert the buffer timestamps into the stream time. This is
+ * usually done in sinks to report the current stream_time.
+ * @time represents the stream_time of a buffer carrying a timestamp of
* @start. @time cannot be -1.
*
* @start cannot be -1, @stop can be -1. If there
- * is a valid @stop given, it must be greater or equal the @start, including
+ * is a valid @stop given, it must be greater or equal the @start, including
* when the indicated playback @rate is < 0.
*
* The @applied_rate value provides information about any rate adjustment that
- * has already been made to the timestamps and content on the buffers of the
- * stream. (@rate * @applied_rate) should always equal the rate that has been
- * requested for playback. For example, if an element has an input segment
- * with intended playback @rate of 2.0 and applied_rate of 1.0, it can adjust
- * incoming timestamps and buffer content by half and output a newsegment event
+ * has already been made to the timestamps and content on the buffers of the
+ * stream. (@rate * @applied_rate) should always equal the rate that has been
+ * requested for playback. For example, if an element has an input segment
+ * with intended playback @rate of 2.0 and applied_rate of 1.0, it can adjust
+ * incoming timestamps and buffer content by half and output a newsegment event
* with @rate of 1.0 and @applied_rate of 2.0
*
* After a newsegment event, the buffer stream time is calculated with:
*
* time + (TIMESTAMP(buf) - start) * ABS (rate * applied_rate)
*
- * Returns: (transfer full): a new newsegment event.
- *
- * Since: 0.10.6
+ * Returns: (transfer full): the new SEGMENT event.
*/
GstEvent *
-gst_event_new_new_segment (gboolean update, gdouble rate,
- gdouble applied_rate, GstFormat format, gint64 start, gint64 stop,
- gint64 time)
+gst_event_new_segment (const GstSegment * segment)
{
GstEvent *event;
- GstStructure *structure;
- g_return_val_if_fail (rate != 0.0, NULL);
- g_return_val_if_fail (applied_rate != 0.0, NULL);
+ g_return_val_if_fail (segment != NULL, NULL);
- if (format == GST_FORMAT_TIME) {
- GST_CAT_INFO (GST_CAT_EVENT,
- "creating newsegment update %d, rate %lf, format GST_FORMAT_TIME, "
- "start %" GST_TIME_FORMAT ", stop %" GST_TIME_FORMAT
- ", time %" GST_TIME_FORMAT,
- update, rate, GST_TIME_ARGS (start),
- GST_TIME_ARGS (stop), GST_TIME_ARGS (time));
- } else {
- GST_CAT_INFO (GST_CAT_EVENT,
- "creating newsegment update %d, rate %lf, format %s, "
- "start %" G_GINT64_FORMAT ", stop %" G_GINT64_FORMAT ", time %"
- G_GINT64_FORMAT, update, rate, gst_format_get_name (format), start,
- stop, time);
- }
-
- g_return_val_if_fail (time != -1, NULL);
- g_return_val_if_fail (start != -1, NULL);
- if (stop != -1)
- g_return_val_if_fail (start <= stop, NULL);
+ GST_CAT_INFO (GST_CAT_EVENT, "creating segment event %" GST_SEGMENT_FORMAT,
+ segment);
- structure = gst_structure_id_new (GST_QUARK (EVENT_NEWSEGMENT),
- GST_QUARK (UPDATE), G_TYPE_BOOLEAN, update,
- GST_QUARK (RATE), G_TYPE_DOUBLE, rate,
- GST_QUARK (APPLIED_RATE), G_TYPE_DOUBLE, applied_rate,
- GST_QUARK (FORMAT), GST_TYPE_FORMAT, format,
- GST_QUARK (START), G_TYPE_INT64, start,
- GST_QUARK (STOP), G_TYPE_INT64, stop,
- GST_QUARK (TIME), G_TYPE_INT64, time, NULL);
- event = gst_event_new_custom (GST_EVENT_NEWSEGMENT, structure);
+ event = gst_event_new_custom (GST_EVENT_SEGMENT,
+ gst_structure_new_id (GST_QUARK (EVENT_SEGMENT),
+ GST_QUARK (SEGMENT), GST_TYPE_SEGMENT, segment, NULL));
return event;
}
/**
- * gst_event_parse_new_segment:
- * @event: The event to query
- * @update: (out): A pointer to the update flag of the segment
- * @rate: (out): A pointer to the rate of the segment
- * @applied_rate: (out): A pointer to the applied_rate of the segment
- * @format: (out): A pointer to the format of the newsegment values
- * @start: (out): A pointer to store the start value in
- * @stop: (out): A pointer to store the stop value in
- * @time: (out): A pointer to store the time value in
- *
- * Get the update, rate, applied_rate, format, start, stop and
- * time in the newsegment event. See gst_event_new_new_segment()
- * for a full description of the newsegment event.
- *
- * Since: 0.10.6
+ * gst_event_parse_segment:
+ * @event: The event to parse
+ * @segment: (out) (transfer none): a pointer to a #GstSegment
+ *
+ * Parses a segment @event and stores the result in the given @segment location.
+ * @segment remains valid only until the @event is freed. Don't modify the segment
+ * and make a copy if you want to modify it or store it for later use.
*/
void
-gst_event_parse_new_segment (GstEvent * event, gboolean * update,
- gdouble * rate, gdouble * applied_rate, GstFormat * format,
- gint64 * start, gint64 * stop, gint64 * time)
+gst_event_parse_segment (GstEvent * event, const GstSegment ** segment)
{
- const GstStructure *structure;
+ GstStructure *structure;
g_return_if_fail (GST_IS_EVENT (event));
- g_return_if_fail (GST_EVENT_TYPE (event) == GST_EVENT_NEWSEGMENT);
+ g_return_if_fail (GST_EVENT_TYPE (event) == GST_EVENT_SEGMENT);
- structure = GST_EVENT_STRUCTURE (event);
- if (G_LIKELY (update))
- *update =
- g_value_get_boolean (gst_structure_id_get_value (structure,
- GST_QUARK (UPDATE)));
- if (G_LIKELY (rate))
- *rate =
- g_value_get_double (gst_structure_id_get_value (structure,
- GST_QUARK (RATE)));
- if (G_LIKELY (applied_rate))
- *applied_rate =
- g_value_get_double (gst_structure_id_get_value (structure,
- GST_QUARK (APPLIED_RATE)));
- if (G_LIKELY (format))
- *format =
- g_value_get_enum (gst_structure_id_get_value (structure,
- GST_QUARK (FORMAT)));
- if (G_LIKELY (start))
- *start =
- g_value_get_int64 (gst_structure_id_get_value (structure,
- GST_QUARK (START)));
- if (G_LIKELY (stop))
- *stop =
- g_value_get_int64 (gst_structure_id_get_value (structure,
- GST_QUARK (STOP)));
- if (G_LIKELY (time))
- *time =
- g_value_get_int64 (gst_structure_id_get_value (structure,
- GST_QUARK (TIME)));
+ if (segment) {
+ structure = GST_EVENT_STRUCTURE (event);
+ *segment = g_value_get_boxed (gst_structure_id_get_value (structure,
+ GST_QUARK (SEGMENT)));
+ }
+}
+
+/**
+ * gst_event_copy_segment:
+ * @event: The event to parse
+ * @segment: a pointer to a #GstSegment
+ *
+ * Parses a segment @event and copies the #GstSegment into the location
+ * given by @segment.
+ */
+void
+gst_event_copy_segment (GstEvent * event, GstSegment * segment)
+{
+ const GstSegment *src;
+
+ g_return_if_fail (GST_IS_EVENT (event));
+ g_return_if_fail (GST_EVENT_TYPE (event) == GST_EVENT_SEGMENT);
+
+ if (segment) {
+ gst_event_parse_segment (event, &src);
+ gst_segment_copy_into (src, segment);
+ }
}
/**
* Create a new buffersize event. The event is sent downstream and notifies
* elements that they should provide a buffer of the specified dimensions.
*
- * When the @async flag is set, a thread boundary is prefered.
+ * When the @async flag is set, a thread boundary is preferred.
*
* Returns: (transfer full): a new #GstEvent
*/
", maxsize %" G_GINT64_FORMAT ", async %d", gst_format_get_name (format),
minsize, maxsize, async);
- structure = gst_structure_id_new (GST_QUARK (EVENT_BUFFER_SIZE),
+ structure = gst_structure_new_id (GST_QUARK (EVENT_BUFFER_SIZE),
GST_QUARK (FORMAT), GST_TYPE_FORMAT, format,
GST_QUARK (MINSIZE), G_TYPE_INT64, minsize,
GST_QUARK (MAXSIZE), G_TYPE_INT64, maxsize,
structure = GST_EVENT_STRUCTURE (event);
if (format)
- *format =
+ *format = (GstFormat)
g_value_get_enum (gst_structure_id_get_value (structure,
GST_QUARK (FORMAT)));
if (minsize)
GstClockTimeDiff diff, GstClockTime timestamp)
{
GstEvent *event;
+ GstStructure *structure;
/* diff must be positive or timestamp + diff must be positive */
g_return_val_if_fail (diff >= 0 || -diff <= timestamp, NULL);
", timestamp %" GST_TIME_FORMAT, type, proportion,
diff, GST_TIME_ARGS (timestamp));
- event = gst_event_new (GST_EVENT_QOS);
-
- GST_EVENT_IMPL (event, qos, type) = type;
- GST_EVENT_IMPL (event, qos, proportion) = proportion;
- GST_EVENT_IMPL (event, qos, diff) = diff;
- GST_EVENT_IMPL (event, qos, timestamp) = timestamp;
+ structure = gst_structure_new_id (GST_QUARK (EVENT_QOS),
+ GST_QUARK (TYPE), GST_TYPE_QOS_TYPE, type,
+ GST_QUARK (PROPORTION), G_TYPE_DOUBLE, proportion,
+ GST_QUARK (DIFF), G_TYPE_INT64, diff,
+ GST_QUARK (TIMESTAMP), G_TYPE_UINT64, timestamp, NULL);
+ event = gst_event_new_custom (GST_EVENT_QOS, structure);
return event;
}
gst_event_parse_qos (GstEvent * event, GstQOSType * type,
gdouble * proportion, GstClockTimeDiff * diff, GstClockTime * timestamp)
{
+ const GstStructure *structure;
+
g_return_if_fail (GST_IS_EVENT (event));
g_return_if_fail (GST_EVENT_TYPE (event) == GST_EVENT_QOS);
+ structure = GST_EVENT_STRUCTURE (event);
if (type)
- *type = GST_EVENT_IMPL (event, qos, type);
+ *type = (GstQOSType)
+ g_value_get_enum (gst_structure_id_get_value (structure,
+ GST_QUARK (TYPE)));
if (proportion)
- *proportion = GST_EVENT_IMPL (event, qos, proportion);
+ *proportion =
+ g_value_get_double (gst_structure_id_get_value (structure,
+ GST_QUARK (PROPORTION)));
if (diff)
- *diff = GST_EVENT_IMPL (event, qos, diff);
+ *diff =
+ g_value_get_int64 (gst_structure_id_get_value (structure,
+ GST_QUARK (DIFF)));
if (timestamp)
- *timestamp = GST_EVENT_IMPL (event, qos, timestamp);
+ *timestamp =
+ g_value_get_uint64 (gst_structure_id_get_value (structure,
+ GST_QUARK (TIMESTAMP)));
}
/**
stop);
}
- structure = gst_structure_id_new (GST_QUARK (EVENT_SEEK),
+ structure = gst_structure_new_id (GST_QUARK (EVENT_SEEK),
GST_QUARK (RATE), G_TYPE_DOUBLE, rate,
GST_QUARK (FORMAT), GST_TYPE_FORMAT, format,
GST_QUARK (FLAGS), GST_TYPE_SEEK_FLAGS, flags,
g_value_get_double (gst_structure_id_get_value (structure,
GST_QUARK (RATE)));
if (format)
- *format =
+ *format = (GstFormat)
g_value_get_enum (gst_structure_id_get_value (structure,
GST_QUARK (FORMAT)));
if (flags)
- *flags =
+ *flags = (GstSeekFlags)
g_value_get_flags (gst_structure_id_get_value (structure,
GST_QUARK (FLAGS)));
if (start_type)
- *start_type =
+ *start_type = (GstSeekType)
g_value_get_enum (gst_structure_id_get_value (structure,
GST_QUARK (CUR_TYPE)));
if (start)
g_value_get_int64 (gst_structure_id_get_value (structure,
GST_QUARK (CUR)));
if (stop_type)
- *stop_type =
+ *stop_type = (GstSeekType)
g_value_get_enum (gst_structure_id_get_value (structure,
GST_QUARK (STOP_TYPE)));
if (stop)
GST_CAT_INFO (GST_CAT_EVENT,
"creating latency event %" GST_TIME_FORMAT, GST_TIME_ARGS (latency));
- structure = gst_structure_id_new (GST_QUARK (EVENT_LATENCY),
+ structure = gst_structure_new_id (GST_QUARK (EVENT_LATENCY),
GST_QUARK (LATENCY), G_TYPE_UINT64, latency, NULL);
event = gst_event_new_custom (GST_EVENT_LATENCY, structure);
* to skip @amount (expressed in @format) of media. It can be used to implement
* stepping through the video frame by frame or for doing fast trick modes.
*
- * A rate of <= 0.0 is not allowed, pause the pipeline or reverse the playback
- * direction of the pipeline to get the same effect.
+ * A rate of <= 0.0 is not allowed. Pause the pipeline, for the effect of rate
+ * = 0.0 or first reverse the direction of playback using a seek event to get
+ * the same effect as rate < 0.0.
*
* The @flush flag will clear any pending data in the pipeline before starting
* the step operation.
GST_CAT_INFO (GST_CAT_EVENT, "creating step event");
- structure = gst_structure_id_new (GST_QUARK (EVENT_STEP),
+ structure = gst_structure_new_id (GST_QUARK (EVENT_STEP),
GST_QUARK (FORMAT), GST_TYPE_FORMAT, format,
GST_QUARK (AMOUNT), G_TYPE_UINT64, amount,
GST_QUARK (RATE), G_TYPE_DOUBLE, rate,
structure = GST_EVENT_STRUCTURE (event);
if (format)
- *format = g_value_get_enum (gst_structure_id_get_value (structure,
+ *format =
+ (GstFormat) g_value_get_enum (gst_structure_id_get_value (structure,
GST_QUARK (FORMAT)));
if (amount)
*amount = g_value_get_uint64 (gst_structure_id_get_value (structure,
*
* Returns: (transfer full): a new #GstEvent
*
- * Since: 0.10.34
+ * Since: 0.11.0
*/
GstEvent *
gst_event_new_reconfigure (void)
GST_CAT_INFO (GST_CAT_EVENT, "creating sink-message event");
- structure = gst_structure_id_new (GST_QUARK (EVENT_SINK_MESSAGE),
+ structure = gst_structure_new_id (GST_QUARK (EVENT_SINK_MESSAGE),
GST_QUARK (MESSAGE), GST_TYPE_MESSAGE, msg, NULL);
event = gst_event_new_custom (GST_EVENT_SINK_MESSAGE, structure);
projects / platform / upstream / gstreamer.git / blobdiff