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
25G_BEGIN_DECLS
26
27/**
28 * GST_PROTECTION_SYSTEM_ID_CAPS_FIELD:
29 *
30 * The field name in a GstCaps that is used to signal the UUID of the protection
31 * system.
32 *
33 * Since: 1.6
34 */
35#define GST_PROTECTION_SYSTEM_ID_CAPS_FIELD "protection-system"
36
37/**
38 * GST_PROTECTION_UNSPECIFIED_SYSTEM_ID:
39 *
40 * The protection system value of the unspecified UUID.
41 * In some cases the system protection ID is not present in the contents or in their
42 * metadata, as encrypted WebM.
43 * This define is used to set the value of the "system_id" field in GstProtectionEvent,
44 * with this value, the application will use an external information to choose which
45 * protection system to use.
46 *
47 * Example: The matroskademux uses this value in the case of encrypted WebM,
48 * the application will choose the appropriate protection system based on the information
49 * received through EME API.
50 *
51 * Since: 1.16
52 */
53#define GST_PROTECTION_UNSPECIFIED_SYSTEM_ID "unspecified-system-id"
54
55typedef struct _GstProtectionMeta GstProtectionMeta;
56/**
57 * GstProtectionMeta:
58 * @meta: the parent #GstMeta.
59 * @info: the cryptographic information needed to decrypt the sample.
60 *
61 * Metadata type that holds information about a sample from a protection-protected
62 * track, including the information needed to decrypt it (if it is encrypted).
63 *
64 * Since: 1.6
65 */
66struct _GstProtectionMeta
67{
68 GstMeta meta;
69
70 GstStructure *info;
71};
72
73GST_API
74GType gst_protection_meta_api_get_type (void);
75
76#define GST_PROTECTION_META_API_TYPE (gst_protection_meta_api_get_type())
77
78#define gst_buffer_get_protection_meta(b) \
79 ((GstProtectionMeta*)gst_buffer_get_meta ((b), GST_PROTECTION_META_API_TYPE))
80
81#define GST_PROTECTION_META_INFO (gst_protection_meta_get_info())
82
83GST_API
84const GstMetaInfo * gst_protection_meta_get_info (void);
85
86GST_API
87GstProtectionMeta * gst_buffer_add_protection_meta (GstBuffer * buffer,
88 GstStructure * info);
89GST_API
90const gchar * gst_protection_select_system (const gchar ** system_identifiers);
91
92GST_API
93gchar ** gst_protection_filter_systems_by_available_decryptors (
94 const gchar ** system_identifiers);
95
96G_END_DECLS
97#endif /* __GST_PROTECTION_META_H__ */
98