*
* You should have received a copy of the GNU Library General Public
* License along with this library; if not, write to the
- * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
- * Boston, MA 02111-1307, USA.
+ * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
+ * Boston, MA 02110-1301, USA.
*/
/**
* SECTION:gstsample
+ * @title: GstSample
* @short_description: A media sample
* @see_also: #GstBuffer, #GstCaps, #GstSegment
*
* A #GstSample is a small object containing data, a type, timing and
* extra arbitrary information.
- *
- * Last reviewed on 2012-03-29 (0.11.3)
*/
#include "gst_private.h"
#include "gstsample.h"
+GST_DEBUG_CATEGORY_STATIC (gst_sample_debug);
+#define GST_CAT_DEFAULT gst_sample_debug
+
struct _GstSample
{
GstMiniObject mini_object;
GstCaps *caps;
GstSegment segment;
GstStructure *info;
+ GstBufferList *buffer_list;
};
GType _gst_sample_type = 0;
_priv_gst_sample_initialize (void)
{
_gst_sample_type = gst_sample_get_type ();
+
+ GST_DEBUG_CATEGORY_INIT (gst_sample_debug, "sample", 0, "GstSample debug");
}
static GstSample *
GstSample *copy;
copy = gst_sample_new (sample->buffer, sample->caps, &sample->segment,
- gst_structure_copy (sample->info));
+ (sample->info) ? gst_structure_copy (sample->info) : NULL);
+
+ if (sample->buffer_list) {
+ copy->buffer_list = gst_buffer_list_ref (sample->buffer_list);
+ gst_mini_object_add_parent (GST_MINI_OBJECT_CAST (copy->buffer_list),
+ GST_MINI_OBJECT_CAST (copy));
+ }
return copy;
}
{
GST_LOG ("free %p", sample);
- if (sample->buffer)
+ if (sample->buffer) {
+ gst_mini_object_remove_parent (GST_MINI_OBJECT_CAST (sample->buffer),
+ GST_MINI_OBJECT_CAST (sample));
gst_buffer_unref (sample->buffer);
- if (sample->caps)
+ }
+
+ if (sample->caps) {
+ gst_mini_object_remove_parent (GST_MINI_OBJECT_CAST (sample->caps),
+ GST_MINI_OBJECT_CAST (sample));
gst_caps_unref (sample->caps);
+ }
+
+ if (sample->info) {
+ gst_structure_set_parent_refcount (sample->info, NULL);
+ gst_structure_free (sample->info);
+ }
+ if (sample->buffer_list) {
+ gst_mini_object_remove_parent (GST_MINI_OBJECT_CAST (sample->buffer_list),
+ GST_MINI_OBJECT_CAST (sample));
+ gst_buffer_list_unref (sample->buffer_list);
+ }
+#ifdef USE_POISONING
+ memset (sample, 0xff, sizeof (GstSample));
+#endif
- g_slice_free1 (GST_MINI_OBJECT_SIZE (sample), sample);
+ g_slice_free1 (sizeof (GstSample), sample);
}
/**
* gst_sample_new:
- * @buffer: a #GstBuffer
- * @caps: a #GstCaps
- * @segment: a #GstSegment
- * @info: a #GstStructure
+ * @buffer: (transfer none) (allow-none): a #GstBuffer, or %NULL
+ * @caps: (transfer none) (allow-none): a #GstCaps, or %NULL
+ * @segment: (transfer none) (allow-none): a #GstSegment, or %NULL
+ * @info: (transfer full) (allow-none): a #GstStructure, or %NULL
*
* Create a new #GstSample with the provided details.
*
*
* Returns: (transfer full): the new #GstSample. gst_sample_unref()
* after usage.
- *
- * Since: 0.10.24
*/
GstSample *
gst_sample_new (GstBuffer * buffer, GstCaps * caps, const GstSegment * segment,
GST_LOG ("new %p", sample);
- gst_mini_object_init (GST_MINI_OBJECT_CAST (sample), _gst_sample_type,
- sizeof (GstSample));
+ gst_mini_object_init (GST_MINI_OBJECT_CAST (sample), 0, _gst_sample_type,
+ (GstMiniObjectCopyFunction) _gst_sample_copy, NULL,
+ (GstMiniObjectFreeFunction) _gst_sample_free);
- sample->mini_object.copy = (GstMiniObjectCopyFunction) _gst_sample_copy;
- sample->mini_object.free = (GstMiniObjectFreeFunction) _gst_sample_free;
+ if (buffer) {
+ sample->buffer = gst_buffer_ref (buffer);
+ gst_mini_object_add_parent (GST_MINI_OBJECT_CAST (sample->buffer),
+ GST_MINI_OBJECT_CAST (sample));
+ }
- sample->buffer = buffer ? gst_buffer_ref (buffer) : NULL;
- sample->caps = caps ? gst_caps_ref (caps) : NULL;
+ if (caps) {
+ sample->caps = gst_caps_ref (caps);
+ gst_mini_object_add_parent (GST_MINI_OBJECT_CAST (sample->caps),
+ GST_MINI_OBJECT_CAST (sample));
+ }
+ /* FIXME 2.0: initialize with GST_FORMAT_UNDEFINED by default */
if (segment)
gst_segment_copy_into (segment, &sample->segment);
else
*
* Get the buffer associated with @sample
*
- * Returns: (transfer none): the buffer of @sample or NULL when there
- * is no buffer. The buffer remains valid as long as @sample is valid.
+ * Returns: (transfer none) (nullable): the buffer of @sample or %NULL
+ * when there is no buffer. The buffer remains valid as long as
+ * @sample is valid. If you need to hold on to it for longer than
+ * that, take a ref to the buffer with gst_buffer_ref().
*/
GstBuffer *
gst_sample_get_buffer (GstSample * sample)
*
* Get the caps associated with @sample
*
- * Returns: (transfer none): the caps of @sample or NULL when there
- * is no caps. The caps remain valid as long as @sample is valid.
+ * Returns: (transfer none) (nullable): the caps of @sample or %NULL
+ * when there is no caps. The caps remain valid as long as @sample is
+ * valid. If you need to hold on to the caps for longer than that,
+ * take a ref to the caps with gst_caps_ref().
*/
GstCaps *
gst_sample_get_caps (GstSample * sample)
*
* Get extra information associated with @sample.
*
- * Returns: (transfer none): the extra info of @sample.
+ * Returns: (transfer none) (nullable): the extra info of @sample.
* The info remains valid as long as @sample is valid.
*/
const GstStructure *
return sample->info;
}
+
+/**
+ * gst_sample_get_buffer_list:
+ * @sample: a #GstSample
+ *
+ * Get the buffer list associated with @sample
+ *
+ * Returns: (transfer none) (nullable): the buffer list of @sample or %NULL
+ * when there is no buffer list. The buffer list remains valid as long as
+ * @sample is valid. If you need to hold on to it for longer than
+ * that, take a ref to the buffer list with gst_mini_object_ref ().
+ *
+ * Since: 1.6
+ */
+GstBufferList *
+gst_sample_get_buffer_list (GstSample * sample)
+{
+ g_return_val_if_fail (GST_IS_SAMPLE (sample), NULL);
+
+ return sample->buffer_list;
+}
+
+/**
+ * gst_sample_set_buffer_list:
+ * @sample: a #GstSample
+ * @buffer_list: a #GstBufferList
+ *
+ * Set the buffer list associated with @sample. @sample must be writable.
+ *
+ * Since: 1.6
+ */
+void
+gst_sample_set_buffer_list (GstSample * sample, GstBufferList * buffer_list)
+{
+ GstBufferList *old = NULL;
+ g_return_if_fail (GST_IS_SAMPLE (sample));
+ g_return_if_fail (gst_sample_is_writable (sample));
+
+ old = sample->buffer_list;
+
+ if (old == buffer_list)
+ return;
+
+ if (buffer_list) {
+ sample->buffer_list = gst_buffer_list_ref (buffer_list);
+ gst_mini_object_add_parent (GST_MINI_OBJECT_CAST (sample->buffer_list),
+ GST_MINI_OBJECT_CAST (sample));
+ } else {
+ sample->buffer_list = NULL;
+ }
+
+ if (old) {
+ gst_mini_object_remove_parent (GST_MINI_OBJECT_CAST (old),
+ GST_MINI_OBJECT_CAST (sample));
+ gst_buffer_list_unref (old);
+ }
+}
+
+/**
+ * gst_sample_set_buffer:
+ * @sample: A #GstSample
+ * @buffer: (transfer none): A #GstBuffer
+ *
+ * Set the buffer associated with @sample. @sample must be writable.
+ *
+ * Since: 1.16
+ */
+void
+gst_sample_set_buffer (GstSample * sample, GstBuffer * buffer)
+{
+ GstBuffer *old = NULL;
+
+ g_return_if_fail (GST_IS_SAMPLE (sample));
+ g_return_if_fail (gst_sample_is_writable (sample));
+
+ old = sample->buffer;
+
+ if (old == buffer)
+ return;
+
+ if (buffer) {
+ sample->buffer = gst_buffer_ref (buffer);
+ gst_mini_object_add_parent (GST_MINI_OBJECT_CAST (sample->buffer),
+ GST_MINI_OBJECT_CAST (sample));
+ } else {
+ sample->buffer = NULL;
+ }
+
+ if (old) {
+ gst_mini_object_remove_parent (GST_MINI_OBJECT_CAST (old),
+ GST_MINI_OBJECT_CAST (sample));
+ gst_buffer_unref (old);
+ }
+}
+
+/**
+ * gst_sample_set_caps:
+ * @sample: A #GstSample
+ * @caps: (transfer none): A #GstCaps
+ *
+ * Set the caps associated with @sample. @sample must be writable.
+ *
+ * Since: 1.16
+ */
+void
+gst_sample_set_caps (GstSample * sample, GstCaps * caps)
+{
+ GstCaps *old = NULL;
+
+ g_return_if_fail (GST_IS_SAMPLE (sample));
+ g_return_if_fail (gst_sample_is_writable (sample));
+
+ old = sample->caps;
+
+ if (old == caps)
+ return;
+
+ if (caps) {
+ sample->caps = gst_caps_ref (caps);
+ gst_mini_object_add_parent (GST_MINI_OBJECT_CAST (sample->caps),
+ GST_MINI_OBJECT_CAST (sample));
+ } else {
+ sample->caps = NULL;
+ }
+
+ if (old) {
+ gst_mini_object_remove_parent (GST_MINI_OBJECT_CAST (old),
+ GST_MINI_OBJECT_CAST (sample));
+ gst_caps_unref (old);
+ }
+}
+
+/**
+ * gst_sample_set_segment:
+ * @sample: A #GstSample
+ * @segment: (transfer none): A #GstSegment
+ *
+ * Set the segment associated with @sample. @sample must be writable.
+ *
+ * Since: 1.16
+ */
+void
+gst_sample_set_segment (GstSample * sample, const GstSegment * segment)
+{
+ g_return_if_fail (GST_IS_SAMPLE (sample));
+ g_return_if_fail (gst_sample_is_writable (sample));
+
+ /* FIXME 2.0: initialize with GST_FORMAT_UNDEFINED by default */
+ if (segment)
+ gst_segment_copy_into (segment, &sample->segment);
+ else
+ gst_segment_init (&sample->segment, GST_FORMAT_TIME);
+}
+
+/**
+ * gst_sample_set_info:
+ * @sample: A #GstSample
+ * @info: (transfer full): A #GstStructure
+ *
+ * Set the info structure associated with @sample. @sample must be writable,
+ * and @info must not have a parent set already.
+ *
+ * Since: 1.16
+ */
+gboolean
+gst_sample_set_info (GstSample * sample, GstStructure * info)
+{
+ g_return_val_if_fail (GST_IS_SAMPLE (sample), FALSE);
+ g_return_val_if_fail (gst_sample_is_writable (sample), FALSE);
+
+ if (info) {
+ if (!gst_structure_set_parent_refcount (info,
+ &sample->mini_object.refcount))
+ goto had_parent;
+ }
+
+ if (sample->info) {
+ gst_structure_set_parent_refcount (sample->info, NULL);
+ gst_structure_free (sample->info);
+ }
+
+ sample->info = info;
+
+ return TRUE;
+
+had_parent:
+ g_warning ("structure is already owned by another object");
+ return FALSE;
+}