gstbuffer.h: move FLAG_LAST documentation back to the bottom
[platform/upstream/gstreamer.git] / gst / gstregistrybinary.h
1 /* GStreamer
2  * Copyright (C) 2006 Josep Torra <josep@fluendo.com>
3  * Copyright (C) 2006 Mathieu Garcia  <matthieu@fluendo.com>
4  * Copyright (C) 2006 Stefan Kost <ensonic@sonicpulse.de>
5  *
6  * gstregistrybinary.h: Header for registry handling
7  *
8  * This library is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU Library General Public
10  * License as published by the Free Software Foundation; either
11  * version 2 of the License, or (at your option) any later version.
12  *
13  * This library is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
16  * Library General Public License for more details.
17  *
18  * You should have received a copy of the GNU Library General Public
19  * License along with this library; if not, write to the
20  * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
21  * Boston, MA 02110-1301, USA.
22  */
23
24 /* SUGGESTIONS AND TODO :
25 ** ====================
26 ** - Use a compressed registry, but would induce performance loss
27 ** - Encrypt the registry, for security purpose, but would also reduce performances
28 */
29
30 #ifndef __GST_REGISTRYBINARY_H__
31 #define __GST_REGISTRYBINARY_H__
32
33 #include <gst/gstpad.h>
34 #include <gst/gstregistry.h>
35
36 G_BEGIN_DECLS
37
38 /*
39  * GST_MAGIC_BINARY_REGISTRY_STR:
40  *
41  * A tag, written at the beginning of the file
42  */
43 #define GST_MAGIC_BINARY_REGISTRY_STR "\xc0\xde\xf0\x0d"
44 /*
45  * GST_MAGIC_BINARY_REGISTRY_LEN:
46  *
47  * length of the header tag.
48  */
49 #define GST_MAGIC_BINARY_REGISTRY_LEN (4)
50
51 /*
52  * GST_MAGIC_BINARY_VERSION_STR:
53  *
54  * The current version of the binary registry format.
55  * This _must_ be updated whenever the registry format changes,
56  * we currently use the core version where this change happened.
57  */
58 #define GST_MAGIC_BINARY_VERSION_STR "1.3.0"
59
60 /*
61  * GST_MAGIC_BINARY_VERSION_LEN:
62  *
63  * Maximum length of the version string in the header.
64  */
65 #define GST_MAGIC_BINARY_VERSION_LEN (64)
66
67 typedef struct _GstBinaryRegistryMagic
68 {
69   gchar magic[GST_MAGIC_BINARY_REGISTRY_LEN];
70   gchar version[GST_MAGIC_BINARY_VERSION_LEN];
71 } GstBinaryRegistryMagic;
72
73 G_END_DECLS
74
75 #endif /* !__GST_REGISTRYBINARY_H__ */
76