gstevent.c 8.32 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22
/* GStreamer
 * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
 *                    2000 Wim Taymans <wim.taymans@chello.be>
 *
 * gstevent.h: Header for GstEvent subsystem
 *
 * 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.
 */

Benjamin Otte's avatar
Benjamin Otte committed
23
#include <string.h>		/* memcpy */
24

25
#include "gst_private.h"
26
#include "gstdata_private.h"
27 28

#include "gstinfo.h"
29
#include "gstmemchunk.h"
30 31
#include "gstevent.h"
#include "gstlog.h"
Benjamin Otte's avatar
Benjamin Otte committed
32 33
#include "gsttag.h"

Wim Taymans's avatar
Wim Taymans committed
34
#ifndef GST_DISABLE_TRACE
35 36
/* #define GST_WITH_ALLOC_TRACE */
#include "gsttrace.h"
Wim Taymans's avatar
Wim Taymans committed
37 38
static GstAllocTrace *_event_trace;
#endif
39

40 41
static GstMemChunk *chunk;

42 43
/* #define MEMPROF */

44 45 46 47 48
GType _gst_event_type;

void
_gst_event_initialize (void)
{
49
  /* register the type */
50 51 52
  _gst_event_type = g_boxed_type_register_static ("GstEvent",
                                               (GBoxedCopyFunc) gst_data_ref,
                                               (GBoxedFreeFunc) gst_data_unref);
53

Wim Taymans's avatar
Wim Taymans committed
54
#ifndef GST_DISABLE_TRACE
55
  _event_trace = gst_alloc_trace_register (GST_EVENT_TRACE_NAME);
Wim Taymans's avatar
Wim Taymans committed
56
#endif
57 58 59

  chunk = gst_mem_chunk_new ("GstEventChunk", sizeof (GstEvent),
                                 sizeof (GstEvent) * 50, 0);
60 61
}

62 63
static GstEvent*
_gst_event_copy (GstEvent *event)
Wim Taymans's avatar
Wim Taymans committed
64 65 66
{
  GstEvent *copy;

67
  copy = gst_mem_chunk_alloc (chunk);
Wim Taymans's avatar
Wim Taymans committed
68
#ifndef GST_DISABLE_TRACE
69
  gst_alloc_trace_new (_event_trace, copy);
Wim Taymans's avatar
Wim Taymans committed
70
#endif
Wim Taymans's avatar
Wim Taymans committed
71 72 73 74

  memcpy (copy, event, sizeof (GstEvent));
  
  /* FIXME copy/ref additional fields */
Benjamin Otte's avatar
Benjamin Otte committed
75 76 77 78 79 80
  switch (GST_EVENT_TYPE (event)) {
    case GST_EVENT_TAG:
      copy->event_data.structure.structure = gst_structure_copy (event->event_data.structure.structure);
    default:
      break;
  }
Wim Taymans's avatar
Wim Taymans committed
81 82 83 84

  return copy;
}

85 86
static void
_gst_event_free (GstEvent* event)
87
{
88
  GST_CAT_INFO (GST_CAT_EVENT, "freeing event %p", event);
Wim Taymans's avatar
Wim Taymans committed
89

90 91 92 93
  if (GST_EVENT_SRC (event)) {
    gst_object_unref (GST_EVENT_SRC (event));
  }
  switch (GST_EVENT_TYPE (event)) {
Benjamin Otte's avatar
Benjamin Otte committed
94
    case GST_EVENT_TAG:
95 96
      if (GST_IS_TAG_LIST (event->event_data.structure.structure))
        gst_tag_list_free (event->event_data.structure.structure);
97
      break;
98 99
    case GST_EVENT_NAVIGATION:
      gst_structure_free (event->event_data.structure.structure);
100
      break;
101 102 103
    default:
      break;
  }
104
  _GST_DATA_DISPOSE (GST_DATA (event));
Wim Taymans's avatar
Wim Taymans committed
105
#ifndef GST_DISABLE_TRACE
106
  gst_alloc_trace_free (_event_trace, event);
Wim Taymans's avatar
Wim Taymans committed
107
#endif
108
  gst_mem_chunk_free (chunk, event);
109 110
}

111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138
/**
 * gst_event_masks_contains:
 * @masks: The eventmask array to search
 * @mask: the event mask to find
 *
 * See if the given eventmask is inside the eventmask array.
 *
 * Returns: TRUE if the eventmask is found inside the array
 */
gboolean
gst_event_masks_contains (const GstEventMask *masks, GstEventMask *mask)
{
  g_return_val_if_fail (mask != NULL, FALSE);

  if (!masks)
    return FALSE;
  
  while (masks->type) {
    if (masks->type == mask->type &&
        (masks->flags & mask->flags) == mask->flags)
      return TRUE;

    masks++;
  }

  return FALSE;
}

139 140 141 142 143 144
GType
gst_event_get_type (void)
{
  return _gst_event_type;
}

145 146 147 148 149 150 151 152 153 154 155 156 157
/**
 * gst_event_new:
 * @type: The type of the new event
 *
 * Allocate a new event of the given type.
 *
 * Returns: A new event.
 */
GstEvent*
gst_event_new (GstEventType type)
{
  GstEvent *event;

158
  event = gst_mem_chunk_alloc0 (chunk);
Wim Taymans's avatar
Wim Taymans committed
159
#ifndef GST_DISABLE_TRACE
160
  gst_alloc_trace_new (_event_trace, event);
Wim Taymans's avatar
Wim Taymans committed
161
#endif
162

163
  GST_CAT_INFO (GST_CAT_EVENT, "creating new event %p %d", event, type);
164 165 166 167 168 169 170 171

  _GST_DATA_INIT (GST_DATA (event),
		  _gst_event_type,
		  0,
		  (GstDataFreeFunction) _gst_event_free,
		  (GstDataCopyFunction) _gst_event_copy);

  GST_EVENT_TYPE (event) = type;
Wim Taymans's avatar
Wim Taymans committed
172
  GST_EVENT_TIMESTAMP (event) = G_GINT64_CONSTANT (0);
173 174 175
  GST_EVENT_SRC (event) = NULL;

  return event;
176 177
}

178 179 180 181 182 183 184 185 186
/**
 * gst_event_new_seek:
 * @type: The type of the seek event
 * @offset: The offset of the seek
 *
 * Allocate a new seek event with the given parameters.
 *
 * Returns: A new seek event.
 */
187
GstEvent*       
188
gst_event_new_seek (GstSeekType type, gint64 offset)
189 190 191 192
{
  GstEvent *event;

  event = gst_event_new (GST_EVENT_SEEK);
193

194 195
  GST_EVENT_SEEK_TYPE (event) = type;
  GST_EVENT_SEEK_OFFSET (event) = offset;
196
  GST_EVENT_SEEK_ENDOFFSET (event) = -1;
197 198 199

  return event;
}
200

Wim Taymans's avatar
Wim Taymans committed
201
/**
202
 * gst_event_new_discontinuous_valist:
Wim Taymans's avatar
Wim Taymans committed
203 204
 * @new_media: A flag indicating a new media type starts
 * @format1: The format of the discont value
205
 * @var_args: more discont values and formats
Wim Taymans's avatar
Wim Taymans committed
206
 *
207 208 209 210
 * Allocate a new discontinuous event with the given format/value pairs. Note
 * that the values are of type gint64 - you may not use simple integers such
 * as "0" when calling this function, always cast them like "(gint64) 0".
 * Terminate the list with #GST_FORMAT_UNDEFINED.
Wim Taymans's avatar
Wim Taymans committed
211 212 213
 *
 * Returns: A new discontinuous event.
 */
214
GstEvent*
215
gst_event_new_discontinuous_valist (gboolean new_media, GstFormat format1, va_list var_args)
216 217 218 219 220
{
  GstEvent *event;
  gint count = 0;

  event = gst_event_new (GST_EVENT_DISCONTINUOUS);
Wim Taymans's avatar
Wim Taymans committed
221
  GST_EVENT_DISCONT_NEW_MEDIA (event) = new_media;
222

Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
223
  while (format1 != GST_FORMAT_UNDEFINED && count < 8) {
224 225 226 227

    GST_EVENT_DISCONT_OFFSET (event, count).format = format1 & GST_SEEK_FORMAT_MASK;
    GST_EVENT_DISCONT_OFFSET (event, count).value = va_arg (var_args, gint64);

228
    format1 = va_arg (var_args, GstFormat);
229 230 231 232 233 234 235 236 237

    count++;
  }

  GST_EVENT_DISCONT_OFFSET_LEN (event) = count;
		    
  return event;
}

238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258
/**
 * gst_event_new_discontinuous:
 * @new_media: A flag indicating a new media type starts
 * @format1: The format of the discont value
 * @...: more discont values and formats
 *
 * Allocate a new discontinuous event with the given format/value pairs. Note
 * that the values are of type gint64 - you may not use simple integers such
 * as "0" when calling this function, always cast them like "(gint64) 0".
 * Terminate the list with #GST_FORMAT_UNDEFINED.
 *
 * Returns: A new discontinuous event.
 */
GstEvent*
gst_event_new_discontinuous (gboolean new_media, GstFormat format1, ...)
{
  va_list var_args;
  GstEvent *event;

  va_start (var_args, format1);

259
  event = gst_event_new_discontinuous_valist (new_media, format1, var_args);
260 261 262 263 264 265

  va_end (var_args);

  return event;
}

Wim Taymans's avatar
Wim Taymans committed
266 267 268 269 270 271 272 273 274 275
/**
 * gst_event_discont_get_value:
 * @event: The event to query
 * @format: The format of the discont value
 * @value: A pointer to the value
 *
 * Get the value for the given format in the dicont event.
 *
 * Returns: TRUE if the discont event caries the specified format/value pair.
 */
276
gboolean
Wim Taymans's avatar
Wim Taymans committed
277
gst_event_discont_get_value (GstEvent *event, GstFormat format, gint64 *value)
278 279 280
{
  gint i, n;

Wim Taymans's avatar
Wim Taymans committed
281 282
  g_return_val_if_fail (event != NULL, FALSE);
  g_return_val_if_fail (value != NULL, FALSE);
283 284 285 286

  n = GST_EVENT_DISCONT_OFFSET_LEN (event);

  for (i = 0; i < n; i++) {
Wim Taymans's avatar
Wim Taymans committed
287
    if (GST_EVENT_DISCONT_OFFSET(event,i).format == format) {
288 289 290 291 292 293 294 295 296
      *value = GST_EVENT_DISCONT_OFFSET(event,i).value;
      return TRUE;
    }
  }
  
  return FALSE;
}


297 298 299 300 301 302 303 304 305
/**
 * gst_event_new_size:
 * @format: The format of the size value
 * @value: The value of the size event
 *
 * Create a new size event with the given values.
 *
 * Returns: The new size event.
 */
306 307 308 309 310 311
GstEvent*
gst_event_new_size (GstFormat format, gint64 value)
{
  GstEvent *event;

  event = gst_event_new (GST_EVENT_SIZE);
312

313 314 315 316 317 318
  GST_EVENT_SIZE_FORMAT (event) = format;
  GST_EVENT_SIZE_VALUE (event) = value;
  
  return event;
}

319

320 321 322 323 324 325 326 327 328 329 330 331 332 333 334
/**
 * gst_event_new_segment_seek:
 * @type: The type of the seek event
 * @start: The start offset of the seek
 * @stop: The stop offset of the seek
 *
 * Allocate a new segment seek event with the given parameters. 
 *
 * Returns: A new segment seek event.
 */
GstEvent*       
gst_event_new_segment_seek (GstSeekType type, gint64 start, gint64 stop)
{
  GstEvent *event;

335 336
  g_return_val_if_fail (start < stop, NULL);

337 338 339 340 341 342 343 344
  event = gst_event_new (GST_EVENT_SEEK_SEGMENT);

  GST_EVENT_SEEK_TYPE (event) = type;
  GST_EVENT_SEEK_OFFSET (event) = start;
  GST_EVENT_SEEK_ENDOFFSET (event) = stop;

  return event;
}