validate-scenario: fix g-i warning in annotation
[platform/upstream/gstreamer.git] / scripts / generate_init_static_plugins.py
1 #!/usr/bin/env python3
2
3 import argparse
4 import os
5 from string import Template
6
7 TEMPLATE = Template('''
8 #include <gst/gst.h>
9
10 $elements_declaration
11 $typefind_funcs_declaration
12 $device_providers_declaration
13 $dynamic_types_declaration
14 $plugins_declaration
15 $giomodules_declaration
16
17 void
18 gst_init_static_plugins (void)
19 {
20   static gsize initialization_value = 0;
21   if (g_once_init_enter (&initialization_value)) {
22     $elements_registration
23     $typefind_funcs_registration
24     $device_providers_registration
25     $dynamic_types_registration
26     $plugins_registration
27     $giomodules_registration
28
29     g_once_init_leave (&initialization_value, 1);
30   }
31 }
32 ''')
33
34
35 # Retrieve the plugin name as it can be a plugin filename
36 def get_plugin_name(name):
37     for p in plugins:
38         if name in p:
39             return p
40     return ''
41
42
43 def process_features(features_list, plugins, feature_prefix):
44     plugins_list = plugins
45     feature_declaration = []
46     feature_registration = []
47     if features_list is not None:
48         feature_plugins = features_list.split(';')
49         for plugin in feature_plugins:
50             split = plugin.split(':')
51             plugin_name = split[0].strip()
52             if len(split) == 2:
53                 if (get_plugin_name(plugin_name)) != '':
54                     plugins_list.remove(get_plugin_name(plugin_name))
55                 features = split[1].split(',')
56                 for feature in features:
57                     feature = feature.replace("-", "_")
58                     feature_declaration += ['%s_REGISTER_DECLARE(%s);' % (feature_prefix, feature)]
59                     feature_registration += ['%s_REGISTER(%s, NULL);' % (feature_prefix, feature)]
60     return (plugins_list, feature_declaration, feature_registration)
61
62
63 if __name__ == "__main__":
64     parser = argparse.ArgumentParser()
65     parser.add_argument('-o', dest="output", help="Output file")
66     parser.add_argument('-p', '--plugins', nargs='?', default='', dest="plugins", help="The list of plugins")
67     parser.add_argument('-e', '--elements', nargs='?', default='', dest="elements", help="The list of plugin:elements")
68     parser.add_argument('-t', '--type-finds', nargs='?', default='',
69                         dest="typefindfuncs", help="The list of plugin:typefinds")
70     parser.add_argument('-d', '--devide-providers', nargs='?', default='',
71                         dest="deviceproviders", help="The list of plugin:deviceproviders")
72     parser.add_argument('-T', '--dynamic-types', nargs='?', default='',
73                         dest="dynamictypes", help="The list of plugin:dynamictypes")
74     parser.add_argument('--giomodules', nargs='?', default='',
75                         dest="giomodules", help="The list of GIO modules")
76     options = parser.parse_args()
77     if options.output is None:
78         output_file = 'gstinitstaticplugins.c'
79     else:
80         output_file = options.output
81     enable_staticelements_plugin = 0
82     elements_declaration = []
83     elements_registration = []
84     typefind_funcs_declaration = []
85     typefind_funcs_registration = []
86     device_providers_declaration = []
87     device_providers_registration = []
88     dynamic_types_declaration = []
89     dynamic_types_registration = []
90     plugins_declaration = []
91     plugins_registration = []
92     giomodules_declaration = []
93     giomodules_registration = []
94
95     if ',' in options.plugins or ':' in options.plugins:
96         print("Only ';' is allowed in the list of plugins.")
97         exit(1)
98
99     if options.plugins is None or options.plugins.isspace():
100         plugins = []
101     else:
102         plugins = options.plugins.split(';')
103
104     # process the features
105     (plugins, elements_declaration, elements_registration) = process_features(options.elements, plugins, 'GST_ELEMENT')
106     (plugins, typefind_funcs_declaration, typefind_funcs_registration) = process_features(
107         options.typefindfuncs, plugins, 'GST_TYPE_FIND')
108     (plugins, device_providers_declaration, device_providers_registration) = process_features(
109         options.deviceproviders, plugins, 'GST_DEVICE_PROVIDER')
110     (plugins, dynamic_types_declaration, dynamic_types_registration) = process_features(
111         options.dynamictypes, plugins, 'GST_DYNAMIC_TYPE')
112
113     # Enable plugin or elements according to the ';' separated list.
114     for plugin in plugins:
115         split = plugin.split(':')
116         plugin_name = split[0]
117         if plugin_name == '':
118             continue
119         filename = os.path.basename(plugin).strip()
120         if filename.startswith('libgst') and filename.endswith('.a'):
121             plugin_name = filename[len('libgst'):-len('.a')]
122         plugins_registration += ['GST_PLUGIN_STATIC_REGISTER(%s);' % (plugin_name)]
123         plugins_declaration += ['GST_PLUGIN_STATIC_DECLARE(%s);' % (plugin_name)]
124
125     giomodules = options.giomodules.split(';') if options.giomodules else []
126     for module_name in giomodules:
127         if module_name.startswith('gio'):
128             module_name = module_name[3:]
129         giomodules_declaration.append(f'extern void g_io_{module_name}_load (gpointer data);')
130         giomodules_registration.append(f'g_io_{module_name}_load (NULL);')
131
132     with open(output_file.strip(), "w") as f:
133         static_elements_plugin = ''
134         f.write(TEMPLATE.substitute({
135             'elements_declaration': '\n'.join(elements_declaration),
136             'elements_registration': '\n    '.join(elements_registration),
137             'typefind_funcs_declaration': '\n'.join(typefind_funcs_declaration),
138             'typefind_funcs_registration': '\n    '.join(typefind_funcs_registration),
139             'device_providers_declaration': '\n'.join(device_providers_declaration),
140             'device_providers_registration': '\n    '.join(device_providers_registration),
141             'dynamic_types_declaration': '\n'.join(dynamic_types_declaration),
142             'dynamic_types_registration': '\n    '.join(dynamic_types_registration),
143             'plugins_declaration': '\n'.join(plugins_declaration),
144             'plugins_registration': '\n    '.join(plugins_registration),
145             'giomodules_declaration': '\n'.join(giomodules_declaration),
146             'giomodules_registration': '\n    '.join(giomodules_registration),
147         }))