gstevent.c 7.63 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 26
#include "gstinfo.h"
#include "gstdata_private.h"
27
#include "gstmemchunk.h"
28 29 30
#include "gstevent.h"
#include "gstlog.h"

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

37 38
static GstMemChunk *chunk;

39 40
/* #define MEMPROF */

41 42 43 44 45
GType _gst_event_type;

void
_gst_event_initialize (void)
{
46
  /* register the type */
47 48 49
  _gst_event_type = g_boxed_type_register_static ("GstEvent",
                                               (GBoxedCopyFunc) gst_data_ref,
                                               (GBoxedFreeFunc) gst_data_unref);
50

Wim Taymans's avatar
Wim Taymans committed
51
#ifndef GST_DISABLE_TRACE
52
  _event_trace = gst_alloc_trace_register (GST_EVENT_TRACE_NAME);
Wim Taymans's avatar
Wim Taymans committed
53
#endif
54 55 56

  chunk = gst_mem_chunk_new ("GstEventChunk", sizeof (GstEvent),
                                 sizeof (GstEvent) * 50, 0);
57 58
}

59 60
static GstEvent*
_gst_event_copy (GstEvent *event)
Wim Taymans's avatar
Wim Taymans committed
61 62 63
{
  GstEvent *copy;

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

  memcpy (copy, event, sizeof (GstEvent));
  
  /* FIXME copy/ref additional fields */

  return copy;
}

76 77
static void
_gst_event_free (GstEvent* event)
78
{
Wim Taymans's avatar
Wim Taymans committed
79 80
  GST_INFO (GST_CAT_EVENT, "freeing event %p", event);

81 82 83 84 85 86 87
  if (GST_EVENT_SRC (event)) {
    gst_object_unref (GST_EVENT_SRC (event));
  }
  switch (GST_EVENT_TYPE (event)) {
    default:
      break;
  }
88
  _GST_DATA_DISPOSE (GST_DATA (event));
Wim Taymans's avatar
Wim Taymans committed
89
#ifndef GST_DISABLE_TRACE
90
  gst_alloc_trace_free (_event_trace, event);
Wim Taymans's avatar
Wim Taymans committed
91
#endif
92
  gst_mem_chunk_free (chunk, event);
93 94
}

95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122
/**
 * 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;
}

123 124 125 126 127 128
GType
gst_event_get_type (void)
{
  return _gst_event_type;
}

129 130 131 132 133 134 135 136 137 138 139 140 141
/**
 * 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;

142
  event = gst_mem_chunk_alloc0 (chunk);
Wim Taymans's avatar
Wim Taymans committed
143
#ifndef GST_DISABLE_TRACE
144
  gst_alloc_trace_new (_event_trace, event);
Wim Taymans's avatar
Wim Taymans committed
145
#endif
146

Wim Taymans's avatar
Wim Taymans committed
147
  GST_INFO (GST_CAT_EVENT, "creating new event %p %d", event, type);
148 149 150 151 152 153 154 155

  _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
156
  GST_EVENT_TIMESTAMP (event) = G_GINT64_CONSTANT (0);
157 158 159
  GST_EVENT_SRC (event) = NULL;

  return event;
160 161
}

162 163 164 165 166 167 168 169 170
/**
 * 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.
 */
171
GstEvent*       
172
gst_event_new_seek (GstSeekType type, gint64 offset)
173 174 175 176
{
  GstEvent *event;

  event = gst_event_new (GST_EVENT_SEEK);
177

178 179
  GST_EVENT_SEEK_TYPE (event) = type;
  GST_EVENT_SEEK_OFFSET (event) = offset;
180
  GST_EVENT_SEEK_ENDOFFSET (event) = -1;
181 182 183

  return event;
}
184

Wim Taymans's avatar
Wim Taymans committed
185 186 187 188 189 190
/**
 * 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
 *
191 192 193 194
 * 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
195 196 197
 *
 * Returns: A new discontinuous event.
 */
198
GstEvent*
199
gst_event_new_discontinuous (gboolean new_media, GstFormat format1, ...)
200 201 202 203 204 205
{
  va_list var_args;
  GstEvent *event;
  gint count = 0;

  event = gst_event_new (GST_EVENT_DISCONTINUOUS);
Wim Taymans's avatar
Wim Taymans committed
206
  GST_EVENT_DISCONT_NEW_MEDIA (event) = new_media;
207 208 209

  va_start (var_args, format1);
	        
210
  while (format1 >= GST_FORMAT_UNDEFINED && count < 8) {
211 212 213 214

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

215
    format1 = va_arg (var_args, GstFormat);
216 217 218 219 220 221 222 223 224 225

    count++;
  }
  va_end (var_args);

  GST_EVENT_DISCONT_OFFSET_LEN (event) = count;
		    
  return event;
}

Wim Taymans's avatar
Wim Taymans committed
226 227 228 229 230 231 232 233 234 235
/**
 * 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.
 */
236
gboolean
Wim Taymans's avatar
Wim Taymans committed
237
gst_event_discont_get_value (GstEvent *event, GstFormat format, gint64 *value)
238 239 240
{
  gint i, n;

Wim Taymans's avatar
Wim Taymans committed
241 242
  g_return_val_if_fail (event != NULL, FALSE);
  g_return_val_if_fail (value != NULL, FALSE);
243 244 245 246

  n = GST_EVENT_DISCONT_OFFSET_LEN (event);

  for (i = 0; i < n; i++) {
Wim Taymans's avatar
Wim Taymans committed
247
    if (GST_EVENT_DISCONT_OFFSET(event,i).format == format) {
248 249 250 251 252 253 254 255 256
      *value = GST_EVENT_DISCONT_OFFSET(event,i).value;
      return TRUE;
    }
  }
  
  return FALSE;
}


257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275
/**
 * gst_event_has_new_media:
 * @event: The event to check
 *
 * Checks if a given event indicates a new media.
 *
 * Returns: True if the event indicates a new media
 */
gboolean
gst_event_has_new_media (GstEvent *event)
{
  g_return_val_if_fail (GST_IS_EVENT (event), FALSE);
  g_return_val_if_fail (GST_EVENT_TYPE (event) == GST_EVENT_DISCONTINUOUS ||
                        GST_EVENT_TYPE (event) == GST_EVENT_NEW_MEDIA, FALSE);
  if (GST_EVENT_TYPE (event) == GST_EVENT_NEW_MEDIA)
    return TRUE;

  return GST_EVENT_DISCONT_NEW_MEDIA (event);  
}
276 277 278 279 280 281 282 283 284
/**
 * 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.
 */
285 286 287 288 289 290
GstEvent*
gst_event_new_size (GstFormat format, gint64 value)
{
  GstEvent *event;

  event = gst_event_new (GST_EVENT_SIZE);
291

292 293 294 295 296 297
  GST_EVENT_SIZE_FORMAT (event) = format;
  GST_EVENT_SIZE_VALUE (event) = value;
  
  return event;
}

298

299 300 301 302 303 304 305 306 307 308 309 310 311 312 313
/**
 * 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;

314 315
  g_return_val_if_fail (start < stop, NULL);

316 317 318 319 320 321 322 323
  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;
}