protection: add GstProtectionMeta to support protected content
[platform/upstream/gstreamer.git] / gst / gstprotection.h
1 /* GStreamer
2  * Copyright (C) <2015> YouView TV Ltd.
3  *
4  * This library is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU Library General Public
6  * License as published by the Free Software Foundation; either
7  * version 2 of the License, or (at your option) any later version.
8  *
9  * This library is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12  * Library General Public License for more details.
13  *
14  * You should have received a copy of the GNU Library General Public
15  * License along with this library; if not, write to the
16  * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
17  * Boston, MA 02110-1301, USA.
18  */
19
20 #ifndef __GST_PROTECTION_H__
21 #define __GST_PROTECTION_H__
22
23 #include <gst/gst.h>
24
25 G_BEGIN_DECLS
26
27 /* @PROTECTION_SYSTEM_ID_CAPS_FIELD: The field name in a GstCaps that is
28  * used to signal the UUID of the protection system
29  */
30 #define PROTECTION_SYSTEM_ID_CAPS_FIELD "protection-system"
31
32 typedef struct _GstProtectionMeta GstProtectionMeta;
33 /**
34  * GstProtectionMeta:
35  * @meta: the parent #GstMeta.
36  * @info: the cryptographic information needed to decrypt the sample.
37  *
38  * Metadata type that holds information about a sample from a protection-protected
39  * track, including the information needed to decrypt it (if it is encrypted).
40  */
41 struct _GstProtectionMeta
42 {
43   GstMeta meta;
44
45   GstStructure *info;
46 };
47
48 GType gst_protection_meta_api_get_type (void);
49 #define GST_PROTECTION_META_API_TYPE (gst_protection_meta_api_get_type())
50
51 #define gst_buffer_get_protection_meta(b) \
52     ((GstProtectionMeta*)gst_buffer_get_meta ((b), GST_PROTECTION_META_API_TYPE))
53
54 #define GST_PROTECTION_META_INFO (gst_protection_meta_get_info())
55
56 const GstMetaInfo *gst_protection_meta_get_info (void);
57
58 GstProtectionMeta *gst_buffer_add_protection_meta (GstBuffer * buffer,
59     GstStructure * info);
60
61 const gchar *gst_protection_select_system (const gchar ** system_identifiers);
62
63 G_END_DECLS
64 #endif /* __GST_PROTECTION_META_H__ */