gdp: GCC 4 fixen.
[platform/upstream/gstreamer.git] / gst / gdp / 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  */
22
23 #ifdef HAVE_CONFIG_H
24 #include "config.h"
25 #endif
26
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"
32
33 /* debug category */
34 GST_DEBUG_CATEGORY (data_protocol_debug);
35 #define GST_CAT_DEFAULT data_protocol_debug
36
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  */
45
46 #define POLY       0x1021
47 #define CRC_INIT   0xFFFF
48
49 static guint16
50 gst_dp_crc (const guint8 * buffer, register guint length)
51 {
52   static gboolean initialized = FALSE;
53   static guint16 crc_table[256];
54   guint16 crc_register;
55   unsigned long i, j, k;
56
57   if (!initialized) {
58     for (i = 0; i < 256; i++) {
59       j = i << 8;
60       for (k = 8; k--;) {
61         j = j & 0x8000 ? (j << 1) ^ POLY : j << 1;
62       }
63
64       crc_table[i] = (guint16) j;
65     }
66     initialized = TRUE;
67   }
68
69   crc_register = CRC_INIT;      /* always init register */
70
71   /* calc CRC */
72   for (; length--;) {
73     crc_register = (guint16) ((crc_register << 8) ^
74         crc_table[((crc_register >> 8) & 0x00ff) ^ *buffer++]);
75   }
76   return (0xffff ^ crc_register);
77 }
78
79 /* debugging function; dumps byte array values per 8 bytes */
80 /* FIXME: would be nice to merge this with gst_util_dump_mem () */
81 void
82 gst_dp_dump_byte_array (guint8 * array, guint length)
83 {
84   int i;
85   int n = 8;                    /* number of bytes per line */
86   gchar *line = g_malloc (3 * n + 1);
87
88   GST_LOG ("dumping byte array of length %d", length);
89   for (i = 0; i < length; ++i) {
90     g_sprintf (line + 3 * (i % n), "%02x ", array[i]);
91     if (i % n == (n - 1)) {
92       GST_LOG ("%03d: %s", i - (n - 1), line);
93     }
94   }
95   if (i % n != 0) {
96     GST_LOG ("%03d: %s", (i / n) * n, line);
97   }
98   g_free (line);
99 }
100
101 /**
102  * gst_dp_init:
103  *
104  * Initialize GStreamer Data Protocol library.
105  *
106  * Should be called before using these functions; either from source linking
107  * to this source file or from plugin_init.
108  */
109 void
110 gst_dp_init (void)
111 {
112   static gboolean _gst_dp_initialized = FALSE;
113
114   if (_gst_dp_initialized)
115     return;
116
117   _gst_dp_initialized = TRUE;
118
119   GST_DEBUG_CATEGORY_INIT (data_protocol_debug, "gdp", 0,
120       "GStreamer Data Protocol");
121 }
122
123 /*** PUBLIC FUNCTIONS ***/
124
125 /**
126  * gst_dp_header_payload_length:
127  * @header: the byte header of the packet array
128  *
129  * Returns: the length of the payload this header describes.
130  */
131 guint32
132 gst_dp_header_payload_length (const guint8 * header)
133 {
134   return GST_DP_HEADER_PAYLOAD_LENGTH (header);
135 }
136
137 /**
138  * gst_dp_header_payload_type:
139  * @header: the byte header of the packet array
140  *
141  * Returns: the #GstDPPayloadType the payload this header describes.
142  */
143 GstDPPayloadType
144 gst_dp_header_payload_type (const guint8 * header)
145 {
146   return GST_DP_HEADER_PAYLOAD_TYPE (header);
147 }
148
149 /**
150  * gst_dp_header_from_buffer:
151  * @buffer: a #GstBuffer to create a header for
152  * @flags: the #GDPHeaderFlags to create the header with
153  * @length: a guint pointer to store the header length in
154  * @header: a guint8 * pointer to store a newly allocated header byte array in
155  *
156  * Creates a GDP header from the given buffer.
157  *
158  * Returns: %TRUE if the header was successfully created.
159  */
160
161 gboolean
162 gst_dp_header_from_buffer (const GstBuffer * buffer, GstDPHeaderFlag flags,
163     guint * length, guint8 ** header)
164 {
165   guint8 *h;
166   guint16 crc;
167   guint16 flags_mask;
168
169   g_return_val_if_fail (GST_IS_BUFFER (buffer), FALSE);
170   g_return_val_if_fail (GST_BUFFER_REFCOUNT_VALUE (buffer) > 0, FALSE);
171   g_return_val_if_fail (header, FALSE);
172
173   *length = GST_DP_HEADER_LENGTH;
174   h = g_malloc (GST_DP_HEADER_LENGTH);
175
176   /* version, flags, type */
177   h[0] = (guint8) GST_DP_VERSION_MAJOR;
178   h[1] = (guint8) GST_DP_VERSION_MINOR;
179   h[2] = (guint8) flags;
180   h[3] = GST_DP_PAYLOAD_BUFFER;
181
182   /* buffer properties */
183   GST_WRITE_UINT32_BE (h + 4, GST_BUFFER_SIZE (buffer));
184   GST_WRITE_UINT64_BE (h + 8, GST_BUFFER_TIMESTAMP (buffer));
185   GST_WRITE_UINT64_BE (h + 16, GST_BUFFER_DURATION (buffer));
186   GST_WRITE_UINT64_BE (h + 24, GST_BUFFER_OFFSET (buffer));
187   GST_WRITE_UINT64_BE (h + 32, GST_BUFFER_OFFSET_END (buffer));
188
189   /* data flags */
190   /* we only copy KEY_UNIT,DELTA_UNIT and IN_CAPS flags */
191   flags_mask = GST_DATA_FLAG_SHIFT (GST_BUFFER_PREROLL) |
192       GST_DATA_FLAG_SHIFT (GST_BUFFER_IN_CAPS) |
193       GST_DATA_FLAG_SHIFT (GST_BUFFER_DELTA_UNIT);
194
195   GST_WRITE_UINT16_BE (h + 40, GST_BUFFER_FLAGS (buffer) & flags_mask);
196
197   /* ABI padding */
198   GST_WRITE_UINT16_BE (h + 42, (guint64) 0);
199   GST_WRITE_UINT32_BE (h + 44, (guint64) 0);
200   GST_WRITE_UINT64_BE (h + 48, (guint64) 0);
201
202   /* CRC */
203   crc = 0;
204   if (flags & GST_DP_HEADER_FLAG_CRC_HEADER) {
205     /* we don't crc the last four bytes of the header since they are crc's */
206     crc = gst_dp_crc (h, 56);
207   }
208   GST_WRITE_UINT16_BE (h + 56, crc);
209
210   crc = 0;
211   if (flags & GST_DP_HEADER_FLAG_CRC_PAYLOAD) {
212     crc = gst_dp_crc (GST_BUFFER_DATA (buffer), GST_BUFFER_SIZE (buffer));
213   }
214   GST_WRITE_UINT16_BE (h + 58, crc);
215
216   GST_LOG ("created header from buffer:");
217   gst_dp_dump_byte_array (h, GST_DP_HEADER_LENGTH);
218   *header = h;
219   return TRUE;
220 }
221
222  /**
223  * gst_dp_packet_from_caps:
224  * @caps: a #GstCaps to create a packet for
225  * @flags: the #GDPHeaderFlags to create the header with
226  * @length: a guint pointer to store the header length in
227  * @header: a guint8 pointer to store a newly allocated header byte array in
228  * @payload: a guint8 pointer to store a newly allocated payload byte array in
229  *
230  * Creates a GDP packet from the given caps.
231  *
232  * Returns: %TRUE if the packet was successfully created.
233  */
234 gboolean
235 gst_dp_packet_from_caps (const GstCaps * caps, GstDPHeaderFlag flags,
236     guint * length, guint8 ** header, guint8 ** payload)
237 {
238   guint8 *h;
239   guint16 crc;
240   guchar *string;
241
242   /* FIXME: GST_IS_CAPS doesn't work
243      g_return_val_if_fail (GST_IS_CAPS (caps), FALSE); */
244   g_return_val_if_fail (caps, FALSE);
245   g_return_val_if_fail (header, FALSE);
246   g_return_val_if_fail (payload, FALSE);
247
248   *length = GST_DP_HEADER_LENGTH;
249   h = g_malloc (GST_DP_HEADER_LENGTH);
250
251   string = (guchar *) gst_caps_to_string (caps);
252
253   /* version, flags, type */
254   h[0] = (guint8) GST_DP_VERSION_MAJOR;
255   h[1] = (guint8) GST_DP_VERSION_MINOR;
256   h[2] = (guint8) flags;
257   h[3] = GST_DP_PAYLOAD_CAPS;
258
259   /* buffer properties */
260   GST_WRITE_UINT32_BE (h + 4, strlen ((gchar *) string) + 1);   /* include trailing 0 */
261   GST_WRITE_UINT64_BE (h + 8, (guint64) 0);
262   GST_WRITE_UINT64_BE (h + 16, (guint64) 0);
263   GST_WRITE_UINT64_BE (h + 24, (guint64) 0);
264   GST_WRITE_UINT64_BE (h + 32, (guint64) 0);
265
266   /* ABI padding */
267   GST_WRITE_UINT64_BE (h + 40, (guint64) 0);
268   GST_WRITE_UINT64_BE (h + 48, (guint64) 0);
269
270   /* CRC */
271   crc = 0;
272   if (flags & GST_DP_HEADER_FLAG_CRC_HEADER) {
273     crc = gst_dp_crc (h, 56);
274   }
275   GST_WRITE_UINT16_BE (h + 56, crc);
276
277   crc = 0;
278   if (flags & GST_DP_HEADER_FLAG_CRC_PAYLOAD) {
279     crc = gst_dp_crc (string, strlen ((gchar *) string) + 1);
280   }
281   GST_WRITE_UINT16_BE (h + 58, crc);
282
283   GST_LOG ("created header from caps:");
284   gst_dp_dump_byte_array (h, GST_DP_HEADER_LENGTH);
285   *header = h;
286   *payload = string;
287   return TRUE;
288 }
289
290 /**
291  * gst_dp_packet_from_event:
292  * @event: a #GstEvent to create a packet for
293  * @flags: the #GDPHeaderFlags to create the header with
294  * @length: a guint pointer to store the header length in
295  * @header: a guint8 pointer to store a newly allocated header byte array in
296  * @payload: a guint8 pointer to store a newly allocated payload byte array in
297  *
298  * Creates a GDP packet from the given event.
299  *
300  * Returns: %TRUE if the packet was successfully created.
301  */
302 gboolean
303 gst_dp_packet_from_event (const GstEvent * event, GstDPHeaderFlag flags,
304     guint * length, guint8 ** header, guint8 ** payload)
305 {
306   guint8 *h;
307   guint16 crc;
308   guint pl_length;              /* length of payload */
309
310   g_return_val_if_fail (event, FALSE);
311   g_return_val_if_fail (GST_IS_EVENT (event), FALSE);
312   g_return_val_if_fail (header, FALSE);
313   g_return_val_if_fail (payload, FALSE);
314
315   *length = GST_DP_HEADER_LENGTH;
316   h = g_malloc0 (GST_DP_HEADER_LENGTH);
317
318   /* first construct payload, since we need the length */
319   switch (GST_EVENT_TYPE (event)) {
320     case GST_EVENT_UNKNOWN:
321       g_warning ("Unknown event, ignoring");
322       *length = 0;
323       g_free (h);
324       return FALSE;
325     case GST_EVENT_EOS:
326     case GST_EVENT_FLUSH:
327     case GST_EVENT_DISCONTINUOUS:
328       GST_WRITE_UINT64_BE (h + 8, GST_EVENT_TIMESTAMP (event));
329       pl_length = 0;
330       *payload = NULL;
331       break;
332     case GST_EVENT_SEEK:
333       pl_length = 4 + 8 + 8 + 4;
334       *payload = g_malloc0 (pl_length);
335       GST_WRITE_UINT32_BE (*payload, (guint32) GST_EVENT_SEEK_TYPE (event));
336       GST_WRITE_UINT64_BE (*payload + 4,
337           (guint64) GST_EVENT_SEEK_OFFSET (event));
338       GST_WRITE_UINT64_BE (*payload + 12,
339           (guint64) GST_EVENT_SEEK_ENDOFFSET (event));
340       GST_WRITE_UINT32_BE (*payload + 20,
341           (guint32) GST_EVENT_SEEK_ACCURACY (event));
342       break;
343     case GST_EVENT_QOS:
344     case GST_EVENT_SIZE:
345     case GST_EVENT_RATE:
346     case GST_EVENT_NAVIGATION:
347     case GST_EVENT_TAG:
348       g_warning ("Unhandled event type %d, ignoring", GST_EVENT_TYPE (event));
349       return FALSE;
350     default:
351       g_warning ("Unknown event type %d, ignoring", GST_EVENT_TYPE (event));
352       *length = 0;
353       g_free (h);
354       return FALSE;
355   }
356
357   /* version, flags, type */
358   h[0] = (guint8) GST_DP_VERSION_MAJOR;
359   h[1] = (guint8) GST_DP_VERSION_MINOR;
360   h[2] = (guint8) flags;
361   h[3] = GST_DP_PAYLOAD_EVENT_NONE + GST_EVENT_TYPE (event);
362
363   /* length */
364   GST_WRITE_UINT32_BE (h + 4, (guint32) pl_length);
365   /* timestamp */
366   GST_WRITE_UINT64_BE (h + 8, GST_EVENT_TIMESTAMP (event));
367
368   /* ABI padding */
369   GST_WRITE_UINT64_BE (h + 40, (guint64) 0);
370   GST_WRITE_UINT64_BE (h + 48, (guint64) 0);
371
372   /* CRC */
373   crc = 0;
374   if (flags & GST_DP_HEADER_FLAG_CRC_HEADER) {
375     crc = gst_dp_crc (h, 56);
376   }
377   GST_WRITE_UINT16_BE (h + 56, crc);
378
379   crc = 0;
380   /* events can have a NULL payload */
381   if (*payload && flags & GST_DP_HEADER_FLAG_CRC_PAYLOAD) {
382     crc = gst_dp_crc (*payload, strlen ((gchar *) * payload) + 1);
383   }
384   GST_WRITE_UINT16_BE (h + 58, crc);
385
386   GST_LOG ("created header from event:");
387   gst_dp_dump_byte_array (h, GST_DP_HEADER_LENGTH);
388   *header = h;
389   return TRUE;
390 }
391
392
393 /**
394  * gst_dp_buffer_from_header:
395  * @header_length: the length of the packet header
396  * @header: the byte array of the packet header
397  *
398  * Creates a newly allocated #GstBuffer from the given header.
399  * The buffer data needs to be copied into it before validating.
400  *
401  * Use this function if you want to pre-allocate a buffer based on the
402  * packet header to read the packet payload in to.
403  *
404  * Returns: %TRUE if the buffer was successfully created.
405  */
406 GstBuffer *
407 gst_dp_buffer_from_header (guint header_length, const guint8 * header)
408 {
409   GstBuffer *buffer;
410
411   g_return_val_if_fail (GST_DP_HEADER_PAYLOAD_TYPE (header) ==
412       GST_DP_PAYLOAD_BUFFER, FALSE);
413   buffer =
414       gst_buffer_new_and_alloc ((guint) GST_DP_HEADER_PAYLOAD_LENGTH (header));
415   GST_BUFFER_TIMESTAMP (buffer) = GST_DP_HEADER_TIMESTAMP (header);
416   GST_BUFFER_DURATION (buffer) = GST_DP_HEADER_DURATION (header);
417   GST_BUFFER_OFFSET (buffer) = GST_DP_HEADER_OFFSET (header);
418   GST_BUFFER_OFFSET_END (buffer) = GST_DP_HEADER_OFFSET_END (header);
419   GST_BUFFER_FLAGS (buffer) = GST_DP_HEADER_BUFFER_FLAGS (header);
420
421   return buffer;
422 }
423
424 /**
425  * gst_dp_caps_from_packet:
426  * @header_length: the length of the packet header
427  * @header: the byte array of the packet header
428  * @payload: the byte array of the packet payload
429  *
430  * Creates a newly allocated #GstCaps from the given packet.
431  *
432  * Returns: %TRUE if the caps was successfully created.
433  */
434 GstCaps *
435 gst_dp_caps_from_packet (guint header_length, const guint8 * header,
436     const guint8 * payload)
437 {
438   GstCaps *caps;
439   const gchar *string;
440
441   g_return_val_if_fail (header, FALSE);
442   g_return_val_if_fail (payload, FALSE);
443   g_return_val_if_fail (GST_DP_HEADER_PAYLOAD_TYPE (header) ==
444       GST_DP_PAYLOAD_CAPS, FALSE);
445
446   string = (gchar *) payload;
447   caps = gst_caps_from_string (string);
448   return caps;
449 }
450
451 /**
452  * gst_dp_event_from_packet:
453  * @header_length: the length of the packet header
454  * @header: the byte array of the packet header
455  * @payload: the byte array of the packet payload
456  *
457  * Creates a newly allocated #GstEvent from the given packet.
458  *
459  * Returns: %TRUE if the event was successfully created.
460  */
461 GstEvent *
462 gst_dp_event_from_packet (guint header_length, const guint8 * header,
463     const guint8 * payload)
464 {
465   GstEvent *event = NULL;
466   GstEventType type;
467
468   g_return_val_if_fail (header, FALSE);
469   /* payload can be NULL, e.g. for an EOS event */
470
471   type = GST_DP_HEADER_PAYLOAD_TYPE (header) - GST_DP_PAYLOAD_EVENT_NONE;
472   switch (type) {
473     case GST_EVENT_UNKNOWN:
474       g_warning ("Unknown event, ignoring");
475       return FALSE;
476     case GST_EVENT_EOS:
477     case GST_EVENT_FLUSH:
478     case GST_EVENT_DISCONTINUOUS:
479       event = gst_event_new (type);
480       GST_EVENT_TIMESTAMP (event) = GST_DP_HEADER_TIMESTAMP (header);
481       break;
482     case GST_EVENT_SEEK:
483     {
484       GstSeekType type;
485       gint64 offset, endoffset;
486       GstSeekAccuracy accuracy;
487
488       type = (GstSeekType) GST_READ_UINT32_BE (payload);
489       offset = (gint64) GST_READ_UINT64_BE (payload + 4);
490       endoffset = (gint64) GST_READ_UINT64_BE (payload + 12);
491       accuracy = (GstSeekAccuracy) GST_READ_UINT32_BE (payload + 20);
492       event = gst_event_new_segment_seek (type, offset, endoffset);
493       GST_EVENT_TIMESTAMP (event) = GST_DP_HEADER_TIMESTAMP (header);
494       GST_EVENT_SEEK_ACCURACY (event) = accuracy;
495       break;
496     }
497     case GST_EVENT_QOS:
498     case GST_EVENT_SIZE:
499     case GST_EVENT_RATE:
500     case GST_EVENT_NAVIGATION:
501     case GST_EVENT_TAG:
502       g_warning ("Unhandled event type %d, ignoring", GST_EVENT_TYPE (event));
503       return FALSE;
504     default:
505       g_warning ("Unknown event type %d, ignoring", GST_EVENT_TYPE (event));
506       return FALSE;
507   }
508
509   return event;
510 }
511
512 /**
513  * gst_dp_validate_header:
514  * @header_length: the length of the packet header
515  * @header: the byte array of the packet header
516  *
517  * Validates the given packet header by checking the CRC checksum.
518  *
519  * Returns: %TRUE if the CRC matches, or no CRC checksum is present.
520  */
521 gboolean
522 gst_dp_validate_header (guint header_length, const guint8 * header)
523 {
524   guint16 crc_read, crc_calculated;
525
526   if (!(GST_DP_HEADER_FLAGS (header) & GST_DP_HEADER_FLAG_CRC_HEADER))
527     return TRUE;
528   crc_read = GST_DP_HEADER_CRC_HEADER (header);
529   /* don't included the last two crc fields for the crc check */
530   crc_calculated = gst_dp_crc (header, header_length - 4);
531   if (crc_read != crc_calculated) {
532     GST_WARNING ("header crc mismatch: read %02x, calculated %02x", crc_read,
533         crc_calculated);
534     return FALSE;
535   }
536   GST_LOG ("header crc validation: %02x", crc_read);
537   return TRUE;
538 }
539
540 /**
541  * gst_dp_validate_payload:
542  * @header_length: the length of the packet header
543  * @header: the byte array of the packet header
544  * @payload: the byte array of the packet payload
545  *
546  * Validates the given packet payload using the given packet header
547  * by checking the CRC checksum.
548  *
549  * Returns: %TRUE if the CRC matches, or no CRC checksum is present.
550  */
551 gboolean
552 gst_dp_validate_payload (guint header_length, const guint8 * header,
553     const guint8 * payload)
554 {
555   guint16 crc_read, crc_calculated;
556
557   if (!(GST_DP_HEADER_FLAGS (header) & GST_DP_HEADER_FLAG_CRC_PAYLOAD))
558     return TRUE;
559   crc_read = GST_DP_HEADER_CRC_PAYLOAD (header);
560   crc_calculated = gst_dp_crc (payload, GST_DP_HEADER_PAYLOAD_LENGTH (header));
561   if (crc_read != crc_calculated) {
562     GST_WARNING ("payload crc mismatch: read %02x, calculated %02x", crc_read,
563         crc_calculated);
564     return FALSE;
565   }
566   GST_LOG ("payload crc validation: %02x", crc_read);
567   return TRUE;
568 }
569
570 /**
571  * gst_dp_validate_packet:
572  * @header_length: the length of the packet header
573  * @header: the byte array of the packet header
574  * @payload: the byte array of the packet payload
575  *
576  * Validates the given packet by checking version information and checksums.
577  *
578  * Returns: %TRUE if the packet validates.
579  */
580 gboolean
581 gst_dp_validate_packet (guint header_length, const guint8 * header,
582     const guint8 * payload)
583 {
584   if (!gst_dp_validate_header (header_length, header))
585     return FALSE;
586   if (!gst_dp_validate_payload (header_length, header, payload))
587     return FALSE;
588
589   return TRUE;
590 }
591
592 /*** PLUGIN STUFF ***/
593 static gboolean
594 plugin_init (GstPlugin * plugin)
595 {
596   gst_dp_init ();
597
598   return TRUE;
599 }
600
601 GST_PLUGIN_DEFINE (GST_VERSION_MAJOR,
602     GST_VERSION_MINOR,
603     "gstdataprotocol",
604     "a data protocol to serialize buffers, caps and events",
605     plugin_init, VERSION, GST_LICENSE, GST_PACKAGE, GST_ORIGIN)