85c798e929d468a1f9f83c82d2f4c79954ee9873
[glsdk/gstreamer0-10.git] / libs / gst / dataprotocol / dataprotocol.c
1 /* GStreamer
2  * Copyright (C) <1999> Erik Walthinsen <omega@cse.ogi.edu>
3  * Copyright (C) <2004> Thomas Vander Stichele <thomas at apestaart dot org>
4  *
5  * dataprotocol.c: Functions implementing the GStreamer Data Protocol
6  *
7  * This library is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU Library General Public
9  * License as published by the Free Software Foundation; either
10  * version 2 of the License, or (at your option) any later version.
11  *
12  * This library is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  * Library General Public License for more details.
16  *
17  * You should have received a copy of the GNU Library General Public
18  * License along with this library; if not, write to the
19  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
20  * Boston, MA 02111-1307, USA.
21  */
23 #ifdef HAVE_CONFIG_H
24 #include "config.h"
25 #endif
27 #include <gst/gst.h>
28 #include <gst/dataprotocol/dataprotocol.h>
29 #include <glib/gprintf.h>       /* g_sprintf */
30 #include <string.h>             /* strlen */
31 #include "dp-private.h"
33 /* debug category */
34 GST_DEBUG_CATEGORY (data_protocol_debug);
35 #define GST_CAT_DEFAULT data_protocol_debug
37 /* calculate a CCITT 16 bit CRC check value for a given byte array */
38 /*
39  * this code snippet is adapted from a web page I found
40  * it is identical except for cleanups, and a final XOR with 0xffff
41  * as outlined in the uecp spec
42  *
43  * XMODEM    x^16 + x^12 + x^5 + 1
44  */
46 #define POLY       0x1021
47 #define CRC_INIT   0xFFFF
49 static guint16
50 gst_dp_crc (const guint8 * buffer, register guint length)
51 {
52   static gboolean initialized = FALSE;
53   static guint16 crc_register, crc_table[256];
54   unsigned long i, j, k;
56   if (!initialized) {
57     for (i = 0; i < 256; i++) {
58       j = i << 8;
59       for (k = 8; k--;) {
60         j = j & 0x8000 ? (j << 1) ^ POLY : j << 1;
61       }
63       crc_table[i] = (guint16) j;
64     }
65     initialized = TRUE;
66   }
68   crc_register = CRC_INIT;      /* always init register */
70   /* calc CRC */
71   for (; length--;) {
72     crc_register = (guint16) ((crc_register << 8) ^
73         crc_table[((crc_register >> 8) & 0x00ff) ^ *buffer++]);
74   }
75   return (0xffff ^ crc_register);
76 }
78 /* debugging function; dumps byte array values per 8 bytes */
79 /* FIXME: would be nice to merge this with gst_util_dump_mem () */
80 void
81 gst_dp_dump_byte_array (guint8 * array, guint length)
82 {
83   int i;
84   int n = 8;                    /* number of bytes per line */
85   gchar *line = g_malloc (3 * n);
87   GST_LOG ("dumping byte array of length %d", length);
88   for (i = 0; i < length; ++i) {
89     g_sprintf (line + 3 * (i % n), "%02x ", array[i]);
90     if (i % n == (n - 1)) {
91       GST_LOG ("%03d: %s", i - (n - 1), line);
92     }
93   }
94   if (i % n != 0) {
95     GST_LOG ("%03d: %s", (i / n) * n, line);
96   }
97   g_free (line);
98 }
100 /**
101  * gst_dp_init:
102  *
103  * Initialize GStreamer Data Protocol library.
104  *
105  * Should be called before using these functions; either from source linking
106  * to this source file or from plugin_init.
107  */
108 void
109 gst_dp_init (void)
111   static gboolean _gst_dp_initialized = FALSE;
113   if (_gst_dp_initialized)
114     return;
116   _gst_dp_initialized = TRUE;
118   GST_DEBUG_CATEGORY_INIT (data_protocol_debug, "gdp", 0,
119       "GStreamer Data Protocol");
122 /*** PUBLIC FUNCTIONS ***/
124 /**
125  * gst_dp_header_payload_length:
126  * @header: the byte header of the packet array
127  *
128  * Returns: the length of the payload this header describes.
129  */
130 guint32
131 gst_dp_header_payload_length (const guint8 * header)
133   return GST_DP_HEADER_PAYLOAD_LENGTH (header);
136 /**
137  * gst_dp_header_payload_type:
138  * @header: the byte header of the packet array
139  *
140  * Returns: the #GstDPPayloadType the payload this header describes.
141  */
142 GstDPPayloadType
143 gst_dp_header_payload_type (const guint8 * header)
145   return GST_DP_HEADER_PAYLOAD_TYPE (header);
148 /**
149  * gst_dp_header_from_buffer:
150  * @buffer: a #GstBuffer to create a header for
151  * @flags: the #GDPHeaderFlags to create the header with
152  * @length: a guint pointer to store the header length in
153  * @header: a guint8 * pointer to store a newly allocated header byte array in
154  *
155  * Creates a GDP header from the given buffer.
156  *
157  * Returns: %TRUE if the header was successfully created
158  */
160 gboolean
161 gst_dp_header_from_buffer (const GstBuffer * buffer, GstDPHeaderFlag flags,
162     guint * length, guint8 ** header)
164   guint8 *h;
165   guint16 crc;
167   g_return_val_if_fail (GST_IS_BUFFER (buffer), FALSE);
168   g_return_val_if_fail (GST_BUFFER_REFCOUNT_VALUE (buffer) > 0, FALSE);
169   g_return_val_if_fail (header, FALSE);
171   *length = GST_DP_HEADER_LENGTH;
172   h = g_malloc (GST_DP_HEADER_LENGTH);
174   /* version, flags, type */
175   h[0] = (guint8) GST_DP_VERSION_MAJOR;
176   h[1] = (guint8) GST_DP_VERSION_MINOR;
177   h[2] = (guint8) flags;
178   h[3] = GST_DP_PAYLOAD_BUFFER;
180   /* buffer properties */
181   GST_WRITE_UINT32_BE (h + 4, GST_BUFFER_SIZE (buffer));
182   GST_WRITE_UINT64_BE (h + 8, GST_BUFFER_TIMESTAMP (buffer));
183   GST_WRITE_UINT64_BE (h + 16, GST_BUFFER_DURATION (buffer));
184   GST_WRITE_UINT64_BE (h + 24, GST_BUFFER_OFFSET (buffer));
185   GST_WRITE_UINT64_BE (h + 32, GST_BUFFER_OFFSET_END (buffer));
187   /* ABI padding */
188   GST_WRITE_UINT64_BE (h + 40, (guint64) 0);
189   GST_WRITE_UINT64_BE (h + 48, (guint64) 0);
191   /* CRC */
192   crc = 0;
193   if (flags & GST_DP_HEADER_FLAG_CRC_HEADER) {
194     /* we don't crc the last four bytes of the header since they are crc's */
195     crc = gst_dp_crc (h, 56);
196   }
197   GST_WRITE_UINT16_BE (h + 56, crc);
199   crc = 0;
200   if (flags & GST_DP_HEADER_FLAG_CRC_PAYLOAD) {
201     crc = gst_dp_crc (GST_BUFFER_DATA (buffer), GST_BUFFER_SIZE (buffer));
202   }
203   GST_WRITE_UINT16_BE (h + 58, crc);
205   GST_LOG ("created header from buffer:");
206   gst_dp_dump_byte_array (h, GST_DP_HEADER_LENGTH);
207   *header = h;
208   return TRUE;
211  /**
212  * gst_dp_packet_from_caps:
213  * @caps: a #GstCaps to create a packet for
214  * @flags: the #GDPHeaderFlags to create the header with
215  * @length: a guint pointer to store the header length in
216  * @header: a guint8 pointer to store a newly allocated header byte array in
217  * @payload: a guint8 pointer to store a newly allocated payload byte array in
218  *
219  * Creates a GDP packet from the given caps.
220  *
221  * Returns: %TRUE if the packet was successfully created
222  */
223 gboolean
224 gst_dp_packet_from_caps (const GstCaps * caps, GstDPHeaderFlag flags,
225     guint * length, guint8 ** header, guint8 ** payload)
227   guint8 *h;
228   guint16 crc;
229   gchar *string;
231   /* FIXME: GST_IS_CAPS doesn't work
232      g_return_val_if_fail (GST_IS_CAPS (caps), FALSE); */
233   g_return_val_if_fail (caps, FALSE);
234   g_return_val_if_fail (header, FALSE);
235   g_return_val_if_fail (payload, FALSE);
237   *length = GST_DP_HEADER_LENGTH;
238   h = g_malloc (GST_DP_HEADER_LENGTH);
240   string = gst_caps_to_string (caps);
242   /* version, flags, type */
243   h[0] = (guint8) GST_DP_VERSION_MAJOR;
244   h[1] = (guint8) GST_DP_VERSION_MINOR;
245   h[2] = (guint8) flags;
246   h[3] = GST_DP_PAYLOAD_CAPS;
248   /* buffer properties */
249   GST_WRITE_UINT32_BE (h + 4, strlen (string) + 1);     /* include trailing 0 */
250   GST_WRITE_UINT64_BE (h + 8, (guint64) 0);
251   GST_WRITE_UINT64_BE (h + 16, (guint64) 0);
252   GST_WRITE_UINT64_BE (h + 24, (guint64) 0);
253   GST_WRITE_UINT64_BE (h + 32, (guint64) 0);
255   /* ABI padding */
256   GST_WRITE_UINT64_BE (h + 40, (guint64) 0);
257   GST_WRITE_UINT64_BE (h + 48, (guint64) 0);
259   /* CRC */
260   crc = 0;
261   if (flags & GST_DP_HEADER_FLAG_CRC_HEADER) {
262     crc = gst_dp_crc (h, 56);
263   }
264   GST_WRITE_UINT16_BE (h + 56, crc);
266   crc = 0;
267   if (flags & GST_DP_HEADER_FLAG_CRC_PAYLOAD) {
268     crc = gst_dp_crc (string, strlen (string) + 1);
269   }
270   GST_WRITE_UINT16_BE (h + 58, crc);
272   GST_LOG ("created header from caps:");
273   gst_dp_dump_byte_array (h, GST_DP_HEADER_LENGTH);
274   *header = h;
275   *payload = string;
276   return TRUE;
279 /**
280  * gst_dp_packet_from_event:
281  * @event: a #GstEvent to create a packet for
282  * @flags: the #GDPHeaderFlags to create the header with
283  * @length: a guint pointer to store the header length in
284  * @header: a guint8 pointer to store a newly allocated header byte array in
285  * @payload: a guint8 pointer to store a newly allocated payload byte array in
286  *
287  * Creates a GDP packet from the given event.
288  *
289  * Returns: %TRUE if the packet was successfully created
290  */
291 gboolean
292 gst_dp_packet_from_event (const GstEvent * event, GstDPHeaderFlag flags,
293     guint * length, guint8 ** header, guint8 ** payload)
295   guint8 *h;
296   guint16 crc;
297   guint pl_length;              /* length of payload */
299   g_return_val_if_fail (event, FALSE);
300   g_return_val_if_fail (GST_IS_EVENT (event), FALSE);
301   g_return_val_if_fail (header, FALSE);
302   g_return_val_if_fail (payload, FALSE);
304   *length = GST_DP_HEADER_LENGTH;
305   h = g_malloc0 (GST_DP_HEADER_LENGTH);
307   /* first construct payload, since we need the length */
308   switch (GST_EVENT_TYPE (event)) {
309     case GST_EVENT_UNKNOWN:
310       g_warning ("Unknown event, ignoring");
311       *length = 0;
312       g_free (h);
313       return FALSE;
314     case GST_EVENT_EOS:
315     case GST_EVENT_FLUSH:
316     case GST_EVENT_EMPTY:
317     case GST_EVENT_DISCONTINUOUS:
318       GST_WRITE_UINT64_BE (h + 8, GST_EVENT_TIMESTAMP (event));
319       pl_length = 0;
320       *payload = NULL;
321       break;
322     case GST_EVENT_SEEK:
323       pl_length = 4 + 8 + 4;
324       *payload = g_malloc0 (pl_length);
325       GST_WRITE_UINT32_BE (*payload, (guint32) GST_EVENT_SEEK_TYPE (event));
326       GST_WRITE_UINT64_BE (*payload + 4,
327           (guint64) GST_EVENT_SEEK_OFFSET (event));
328       GST_WRITE_UINT32_BE (*payload + 12,
329           (guint32) GST_EVENT_SEEK_ACCURACY (event));
330       break;
331     case GST_EVENT_SEEK_SEGMENT:
332       pl_length = 4 + 8 + 8 + 4;
333       *payload = g_malloc0 (pl_length);
334       GST_WRITE_UINT32_BE (*payload, (guint32) GST_EVENT_SEEK_TYPE (event));
335       GST_WRITE_UINT64_BE (*payload + 4,
336           (guint64) GST_EVENT_SEEK_OFFSET (event));
337       GST_WRITE_UINT64_BE (*payload + 12,
338           (guint64) GST_EVENT_SEEK_ENDOFFSET (event));
339       GST_WRITE_UINT32_BE (*payload + 20,
340           (guint32) GST_EVENT_SEEK_ACCURACY (event));
341       break;
342     case GST_EVENT_QOS:
343     case GST_EVENT_SEGMENT_DONE:
344     case GST_EVENT_SIZE:
345     case GST_EVENT_RATE:
346     case GST_EVENT_FILLER:
347     case GST_EVENT_TS_OFFSET:
348     case GST_EVENT_INTERRUPT:
349     case GST_EVENT_NAVIGATION:
350     case GST_EVENT_TAG:
351       g_warning ("Unhandled event type %d, ignoring", GST_EVENT_TYPE (event));
352       return FALSE;
353     default:
354       g_warning ("Unknown event type %d, ignoring", GST_EVENT_TYPE (event));
355       *length = 0;
356       g_free (h);
357       return FALSE;
358   }
360   /* version, flags, type */
361   h[0] = (guint8) GST_DP_VERSION_MAJOR;
362   h[1] = (guint8) GST_DP_VERSION_MINOR;
363   h[2] = (guint8) flags;
364   h[3] = GST_DP_PAYLOAD_EVENT_NONE + GST_EVENT_TYPE (event);
366   /* length */
367   GST_WRITE_UINT32_BE (h + 4, (guint32) pl_length);
368   /* timestamp */
369   GST_WRITE_UINT64_BE (h + 8, GST_EVENT_TIMESTAMP (event));
371   /* ABI padding */
372   GST_WRITE_UINT64_BE (h + 40, (guint64) 0);
373   GST_WRITE_UINT64_BE (h + 48, (guint64) 0);
375   /* CRC */
376   crc = 0;
377   if (flags & GST_DP_HEADER_FLAG_CRC_HEADER) {
378     crc = gst_dp_crc (h, 56);
379   }
380   GST_WRITE_UINT16_BE (h + 56, crc);
382   crc = 0;
383   /* events can have a NULL payload */
384   if (*payload && flags & GST_DP_HEADER_FLAG_CRC_PAYLOAD) {
385     crc = gst_dp_crc (*payload, strlen (*payload) + 1);
386   }
387   GST_WRITE_UINT16_BE (h + 58, crc);
389   GST_LOG ("created header from event:");
390   gst_dp_dump_byte_array (h, GST_DP_HEADER_LENGTH);
391   *header = h;
392   return TRUE;
396 /**
397  * gst_dp_buffer_from_header:
398  * @header_length: the length of the packet header
399  * @header: the byte array of the packet header
400  *
401  * Creates a newly allocated #GstBuffer from the given header.
402  * The buffer data needs to be copied into it before validating.
403  *
404  * Use this function if you want to pre-allocate a buffer based on the
405  * packet header to read the packet payload in to.
406  *
407  * Returns: %TRUE if the buffer was successfully created
408  */
409 GstBuffer *
410 gst_dp_buffer_from_header (guint header_length, const guint8 * header)
412   GstBuffer *buffer;
414   g_return_val_if_fail (GST_DP_HEADER_PAYLOAD_TYPE (header) ==
415       GST_DP_PAYLOAD_BUFFER, FALSE);
416   buffer =
417       gst_buffer_new_and_alloc ((guint) GST_DP_HEADER_PAYLOAD_LENGTH (header));
418   GST_BUFFER_TIMESTAMP (buffer) = GST_DP_HEADER_TIMESTAMP (header);
419   GST_BUFFER_DURATION (buffer) = GST_DP_HEADER_DURATION (header);
420   GST_BUFFER_OFFSET (buffer) = GST_DP_HEADER_OFFSET (header);
421   GST_BUFFER_OFFSET_END (buffer) = GST_DP_HEADER_OFFSET_END (header);
423   return buffer;
426 /**
427  * gst_dp_caps_from_packet:
428  * @header_length: the length of the packet header
429  * @header: the byte array of the packet header
430  * @payload: the byte array of the packet payload
431  *
432  * Creates a newly allocated #GstCaps from the given packet.
433  *
434  * Returns: %TRUE if the caps was successfully created
435  */
436 GstCaps *
437 gst_dp_caps_from_packet (guint header_length, const guint8 * header,
438     const guint8 * payload)
440   GstCaps *caps;
441   const gchar *string;
443   g_return_val_if_fail (header, FALSE);
444   g_return_val_if_fail (payload, FALSE);
445   g_return_val_if_fail (GST_DP_HEADER_PAYLOAD_TYPE (header) ==
446       GST_DP_PAYLOAD_CAPS, FALSE);
448   string = payload;
449   caps = gst_caps_from_string (string);
450   return caps;
453 /**
454  * gst_dp_event_from_packet:
455  * @header_length: the length of the packet header
456  * @header: the byte array of the packet header
457  * @payload: the byte array of the packet payload
458  *
459  * Creates a newly allocated #GstEvent from the given packet.
460  *
461  * Returns: %TRUE if the event was successfully created
462  */
463 GstEvent *
464 gst_dp_event_from_packet (guint header_length, const guint8 * header,
465     const guint8 * payload)
467   GstEvent *event = NULL;
468   GstEventType type;
470   g_return_val_if_fail (header, FALSE);
471   /* payload can be NULL, e.g. for an EOS event */
473   type = GST_DP_HEADER_PAYLOAD_TYPE (header) - GST_DP_PAYLOAD_EVENT_NONE;
474   switch (type) {
475     case GST_EVENT_UNKNOWN:
476       g_warning ("Unknown event, ignoring");
477       return FALSE;
478     case GST_EVENT_EOS:
479     case GST_EVENT_FLUSH:
480     case GST_EVENT_EMPTY:
481     case GST_EVENT_DISCONTINUOUS:
482       event = gst_event_new (type);
483       GST_EVENT_TIMESTAMP (event) = GST_DP_HEADER_TIMESTAMP (header);
484       break;
485     case GST_EVENT_SEEK:
486     {
487       GstSeekType type;
488       gint64 offset;
489       GstSeekAccuracy accuracy;
491       type = (GstSeekType) GST_READ_UINT32_BE (payload);
492       offset = (gint64) GST_READ_UINT64_BE (payload + 4);
493       accuracy = (GstSeekAccuracy) GST_READ_UINT32_BE (payload + 12);
494       event = gst_event_new_seek (type, offset);
495       GST_EVENT_TIMESTAMP (event) = GST_DP_HEADER_TIMESTAMP (header);
496       GST_EVENT_SEEK_ACCURACY (event) = accuracy;
497       break;
498     }
499     case GST_EVENT_SEEK_SEGMENT:
500     {
501       GstSeekType type;
502       gint64 offset, endoffset;
503       GstSeekAccuracy accuracy;
505       type = (GstSeekType) GST_READ_UINT32_BE (payload);
506       offset = (gint64) GST_READ_UINT64_BE (payload + 4);
507       endoffset = (gint64) GST_READ_UINT64_BE (payload + 12);
508       accuracy = (GstSeekAccuracy) GST_READ_UINT32_BE (payload + 20);
509       event = gst_event_new_segment_seek (type, offset, endoffset);
510       GST_EVENT_TIMESTAMP (event) = GST_DP_HEADER_TIMESTAMP (header);
511       GST_EVENT_SEEK_ACCURACY (event) = accuracy;
512       break;
513     }
514     case GST_EVENT_QOS:
515     case GST_EVENT_SEGMENT_DONE:
516     case GST_EVENT_SIZE:
517     case GST_EVENT_RATE:
518     case GST_EVENT_FILLER:
519     case GST_EVENT_TS_OFFSET:
520     case GST_EVENT_INTERRUPT:
521     case GST_EVENT_NAVIGATION:
522     case GST_EVENT_TAG:
523       g_warning ("Unhandled event type %d, ignoring", GST_EVENT_TYPE (event));
524       return FALSE;
525     default:
526       g_warning ("Unknown event type %d, ignoring", GST_EVENT_TYPE (event));
527       return FALSE;
528   }
530   return event;
533 /**
534  * gst_dp_validate_header:
535  * @header_length: the length of the packet header
536  * @header: the byte array of the packet header
537  *
538  * Validates the given packet header by checking the CRC checksum.
539  *
540  * Returns: %TRUE if the CRC matches, or no CRC checksum is present
541  */
542 gboolean
543 gst_dp_validate_header (guint header_length, const guint8 * header)
545   guint16 crc_read, crc_calculated;
547   if (!(GST_DP_HEADER_FLAGS (header) & GST_DP_HEADER_FLAG_CRC_HEADER))
548     return TRUE;
549   crc_read = GST_DP_HEADER_CRC_HEADER (header);
550   /* don't included the last two crc fields for the crc check */
551   crc_calculated = gst_dp_crc (header, header_length - 4);
552   if (crc_read != crc_calculated) {
553     GST_WARNING ("header crc mismatch: read %02x, calculated %02x", crc_read,
554         crc_calculated);
555     return FALSE;
556   }
557   GST_LOG ("header crc validation: %02x", crc_read);
558   return TRUE;
561 /**
562  * gst_dp_validate_payload:
563  * @header_length: the length of the packet header
564  * @header: the byte array of the packet header
565  * @payload: the byte array of the packet payload
566  *
567  * Validates the given packet payload using the given packet header
568  * by checking the CRC checksum.
569  *
570  * Returns: %TRUE if the CRC matches, or no CRC checksum is present
571  */
572 gboolean
573 gst_dp_validate_payload (guint header_length, const guint8 * header,
574     const guint8 * payload)
576   guint16 crc_read, crc_calculated;
578   if (!(GST_DP_HEADER_FLAGS (header) & GST_DP_HEADER_FLAG_CRC_PAYLOAD))
579     return TRUE;
580   crc_read = GST_DP_HEADER_CRC_PAYLOAD (header);
581   crc_calculated = gst_dp_crc (payload, GST_DP_HEADER_PAYLOAD_LENGTH (header));
582   if (crc_read != crc_calculated) {
583     GST_WARNING ("payload crc mismatch: read %02x, calculated %02x", crc_read,
584         crc_calculated);
585     return FALSE;
586   }
587   GST_LOG ("payload crc validation: %02x", crc_read);
588   return TRUE;
591 /**
592  * gst_dp_validate_packet:
593  * @header_length: the length of the packet header
594  * @header: the byte array of the packet header
595  * @payload: the byte array of the packet payload
596  *
597  * Validates the given packet by checking version information and checksums.
598  *
599  * Returns: %TRUE if the packet validates
600  */
601 gboolean
602 gst_dp_validate_packet (guint header_length, const guint8 * header,
603     const guint8 * payload)
605   if (!gst_dp_validate_header (header_length, header))
606     return FALSE;
607   if (!gst_dp_validate_payload (header_length, header, payload))
608     return FALSE;
610   return TRUE;
613 /*** PLUGIN STUFF ***/
614 static gboolean
615 plugin_init (GstPlugin * plugin)
617   gst_dp_init ();
619   return TRUE;
622 GST_PLUGIN_DEFINE (GST_VERSION_MAJOR,
623     GST_VERSION_MINOR,
624     "gstdataprotocol",
625     "a data protocol to serialize buffers, caps and events",
626     plugin_init, VERSION, GST_LICENSE, GST_PACKAGE, GST_ORIGIN)