gstmeta.h 5.27 KB
Newer Older
1 2 3
/* GStreamer
 * Copyright (C) 2009 Wim Taymans <wim.taymans@gmail.be>
 *
Wim Taymans's avatar
Wim Taymans committed
4
 * gstmeta.h: Header for Metadata structures
5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Library General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Library General Public License for more details.
 *
 * 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.
 */


Wim Taymans's avatar
Wim Taymans committed
23 24
#ifndef __GST_META_H__
#define __GST_META_H__
25 26 27

G_BEGIN_DECLS

Wim Taymans's avatar
Wim Taymans committed
28 29
typedef struct _GstMeta GstMeta;
typedef struct _GstMetaInfo GstMetaInfo;
30 31

/**
Wim Taymans's avatar
Wim Taymans committed
32 33
 * GstMeta:
 * @info: pointer to the #GstMetaInfo
34
 *
Wim Taymans's avatar
Wim Taymans committed
35
 * Base structure for metadata. Custom metadata will put this structure
36 37
 * as the first member of their structure.
 */
Wim Taymans's avatar
Wim Taymans committed
38 39
struct _GstMeta {
  const GstMetaInfo *info;
40 41 42
};

/**
Wim Taymans's avatar
Wim Taymans committed
43
 * GST_META_TRACE_NAME:
44 45 46
 *
 * The name used for tracing memory allocations.
 */
Wim Taymans's avatar
Wim Taymans committed
47
#define GST_META_TRACE_NAME           "GstMeta"
48 49 50 51 52 53 54 55

/**
 * GstMetaInitFunction:
 * @meta: a #GstMeta
 * @buffer: a #GstBuffer
 *
 * Function called when @meta is initialized in @buffer.
 */
56
typedef gboolean (*GstMetaInitFunction) (GstMeta *meta, gpointer params, GstBuffer *buffer);
57 58 59 60 61 62 63 64

/**
 * GstMetaFreeFunction:
 * @meta: a #GstMeta
 * @buffer: a #GstBuffer
 *
 * Function called when @meta is freed in @buffer.
 */
Wim Taymans's avatar
Wim Taymans committed
65
typedef void (*GstMetaFreeFunction)     (GstMeta *meta, GstBuffer *buffer);
66

Wim Taymans's avatar
Wim Taymans committed
67 68
typedef void (*GstMetaCopyFunction)     (GstBuffer *dest, GstMeta *meta,
                                         GstBuffer *buffer, gsize offset, gsize size);
69 70 71
/**
 * GstMetaTransformFunction:
 * @transbuf: a #GstBuffer
72 73
 * @meta: a #GstMeta
 * @buffer: a #GstBuffer
74 75 76 77 78 79 80 81
 * @data: transform specific data.
 *
 * Function called for each @meta in @buffer as a result of performing a
 * transformation on @transbuf. Additional type specific transform data
 * is passed to the function.
 *
 * Implementations should check the type of the transform @data and parse
 * additional type specific field that should be used to perform the transform.
82
 */
83
typedef void (*GstMetaTransformFunction) (GstBuffer *transbuf, GstMeta *meta,
Wim Taymans's avatar
Wim Taymans committed
84
                                          GstBuffer *buffer, gpointer data);
85 86 87 88 89

/**
 * GstMetaSerializeFunction:
 * @meta: a #GstMeta
 */
Wim Taymans's avatar
Wim Taymans committed
90
typedef gchar * (*GstMetaSerializeFunction) (GstMeta *meta);
91 92 93 94 95

/**
 * GstMetaDeserializeFunction:
 * @meta: a #GstMeta
 */
Wim Taymans's avatar
Wim Taymans committed
96
typedef gboolean (*GstMetaDeserializeFunction) (GstMeta *meta,
97 98 99
                                                const gchar *s);

/**
Wim Taymans's avatar
Wim Taymans committed
100 101 102
 * GstMetaInfo:
 * @api: tag indentifying the metadata structure and api
 * @impl: tag indentifying the implementor of the api
103 104 105
 * @size: size of the metadata
 * @init_func: function for initializing the metadata
 * @free_func: function for freeing the metadata
Wim Taymans's avatar
Wim Taymans committed
106
 * @copy_func: function for copying the metadata
Wim Taymans's avatar
Wim Taymans committed
107
 * @transform_func: function for transforming the metadata
108 109 110
 * @serialize_func: function for serializing
 * @deserialize_func: function for deserializing
 *
Wim Taymans's avatar
Wim Taymans committed
111
 * The #GstMetaInfo provides information about a specific metadata
112 113
 * structure.
 */
Wim Taymans's avatar
Wim Taymans committed
114 115 116
struct _GstMetaInfo {
  GQuark                     api;
  GQuark                     impl;
117 118 119 120
  gsize                      size;

  GstMetaInitFunction        init_func;
  GstMetaFreeFunction        free_func;
Wim Taymans's avatar
Wim Taymans committed
121
  GstMetaCopyFunction        copy_func;
122
  GstMetaTransformFunction   transform_func;
123 124 125 126
  GstMetaSerializeFunction   serialize_func;
  GstMetaDeserializeFunction deserialize_func;
};

Wim Taymans's avatar
Wim Taymans committed
127
void _gst_meta_init (void);
128

Wim Taymans's avatar
Wim Taymans committed
129 130 131 132
const GstMetaInfo *  gst_meta_register        (const gchar *api, const gchar *impl,
                                               gsize size,
                                               GstMetaInitFunction        init_func,
                                               GstMetaFreeFunction        free_func,
Wim Taymans's avatar
Wim Taymans committed
133
                                               GstMetaCopyFunction        copy_func,
134
                                               GstMetaTransformFunction   transform_func,
Wim Taymans's avatar
Wim Taymans committed
135 136 137
                                               GstMetaSerializeFunction   serialize_func,
                                               GstMetaDeserializeFunction deserialize_func);
const GstMetaInfo *  gst_meta_get_info        (const gchar * impl);
138

139 140
/* default metadata */

Wim Taymans's avatar
Wim Taymans committed
141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157
/* timing metadata */
typedef struct _GstMetaTiming GstMetaTiming;

const GstMetaInfo *gst_meta_timing_get_info(void);
#define GST_META_TIMING_INFO (gst_meta_timing_get_info())

struct _GstMetaTiming {
  GstMeta        meta;        /* common meta header */

  GstClockTime   dts;         /* decoding timestamp */
  GstClockTime   pts;         /* presentation timestamp */
  GstClockTime   duration;    /* duration of the data */
  GstClockTime   clock_rate;  /* clock rate for the above values */
};

#define gst_buffer_get_meta_timing(b)  ((GstMetaTiming*)gst_buffer_get_meta((b),GST_META_TIMING_INFO))
#define gst_buffer_add_meta_timing(b)  ((GstMetaTiming*)gst_buffer_add_meta((b),GST_META_TIMING_INFO,NULL))
158

159 160
G_END_DECLS

Wim Taymans's avatar
Wim Taymans committed
161
#endif /* __GST_META_H__ */