--- /dev/null
+/** * NNStreamer Configurations / Environmental Variable Manager.
+ * Copyright (C) 2018 MyungJoo Ham <myungjoo.ham@samsung.com>
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Library General Public
+ * License as published by the Free Software Foundation; either
+ * version 2 of the License, or (at your option) any later version.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * Library General Public License for more details.
+ *
+ */
+/**
+ * @file nnstreamer_conf.c
+ * @date 26 Nov 2018
+ * @brief NNStreamer Configuration (conf file, env-var) Management.
+ * @see https://github.com/nnsuite/nnstreamer
+ * @author MyungJoo Ham <myungjoo.ham@samsung.com>
+ * @bug No known bugs except for NYI items
+ *
+ */
+
+#include <stdlib.h>
+#include <stdint.h>
+#include <string.h>
+#include <glib.h>
+#include <glib/gprintf.h>
+#include <glib/gstdio.h>
+#include <sys/types.h>
+#include <sys/stat.h>
+#include <gmodule.h>
+#include "nnstreamer_conf.h"
+
+#define CONF_SOURCES (3)
+typedef struct
+{
+ gboolean loaded; /**< TRUE if loaded at least once */
+
+ gchar *conffile; /**< Location of conf file. */
+
+ /* 0: ENVVAR. 1: CONFFILE, 2: Hardcoded */
+ gchar *pathFILTERS[CONF_SOURCES]; /**< directory paths for FILTERS */
+ gchar *pathDECODERS[CONF_SOURCES]; /**< directory paths for DECODERS */
+ gchar *pathCUSTOM_FILTERS[CONF_SOURCES]; /**< directory paths for CUSTOM FILTERS */
+
+ gchar **filesFILTERS; /**< Null terminated list of full filepaths for FILTERS */
+ gchar **filesDECODERS;; /**< Null terminated list of full filepaths for DECODERS */
+ gchar **filesCUSTOM_FILTERS; /**< Null terminated list of full filepaths for CUSTOM FILTERS */
+
+ gchar **basenameFILTERS; /**< Null terminated list of basenames for FILTERS */
+ gchar **basenameDECODERS;; /**< Null terminated list of basenames for DECODERS */
+ gchar **basenameCUSTOM_FILTERS; /**< Null terminated list of basenames for CUSTOM FILTERS */
+} confdata;
+
+static confdata conf = { 0 };
+
+/**
+ * @brief Private function to get strdup-ed env-var if it's valid.
+ * Otherwise, NULL
+ *
+ * @retval strdup-ed env-var value
+ * @param[in] name Environmetal variable name
+ */
+static gchar *
+_strdup_getenv (const char *name)
+{
+ /**
+ * @todo Evaluate if we need to use secure_getenv() here
+ * (and compatible with other OS
+ */
+ char *tmp = getenv (name);
+
+ if (tmp == NULL)
+ return tmp;
+ return g_strdup (tmp);
+}
+
+/**
+ * @brief Private function to fill in ".so list" with fullpath-filenames in a directory.
+ * @param[in] dir Directory to be searched
+ * @param[in] list The filename list to be updated
+ * @param[in/out] counter increased by the number of appended elements.
+ * @return The list updated.
+ * @todo This assumes .so for all sub plugins. Support Windows/Mac/iOS!
+ */
+static GSList *
+_get_fullpath_filenames (const gchar * dir, GSList * list, uint32_t * counter)
+{
+ GDir *gdir = g_dir_open (dir, 0U, NULL);
+ const gchar *name;
+ gchar *dirfullpath;
+
+ if (gdir == NULL)
+ return list;
+
+ if (dir[strlen (dir) - 1] != '/')
+ dirfullpath = g_strconcat (dir, "/", NULL);
+ else
+ dirfullpath = g_strdup (dir);
+
+ while (NULL != (name = g_dir_read_name (gdir))) {
+ list = g_slist_prepend (list, g_strconcat (dirfullpath, name, NULL));
+ *counter = *counter + 1;
+ }
+ g_free (dirfullpath);
+ return list;
+}
+
+/**
+ * @brief Private function to fill in ".so list" with basenames in a directory.
+ * @param[in] dir Directory to be searched
+ * @param[in] list The filename list to be updated
+ * @param[in/out] counter increased by the number of appended elements.
+ * @return The updated list
+ * @todo This assumes .so for all sub plugins. Support Windows/Mac/iOS!
+ */
+static GSList *
+_get_basenames (const gchar * dir, GSList * list, uint32_t * counter)
+{
+ GDir *gdir = g_dir_open (dir, 0U, NULL);
+ const gchar *name;
+
+ if (gdir == NULL)
+ return list;
+
+ while (NULL != (name = g_dir_read_name (gdir))) {
+ list = g_slist_prepend (list, g_path_get_basename (name));
+ *counter = *counter + 1;
+ }
+ return list;
+}
+
+/**
+ * @brief Data structure for _g_list_foreach_vstr_helper
+ */
+typedef struct
+{
+ gchar **vstr; /**< The vstr data (string array) */
+ uint32_t cursor; /**< The first "empty" element in vstr */
+ uint32_t size; /**< The number of "g_char *" in vstr, excluding the terminator */
+} vstr_helper;
+
+/**
+ * @brief Private function to help convert linked-list to vstr with foreach
+ * @data The element data of linked-list
+ * @user_data The struct to fill in vstr
+ */
+static void
+_g_list_foreach_vstr_helper (gpointer data, gpointer user_data)
+{
+ vstr_helper *helper = (vstr_helper *) user_data;
+ g_assert (helper->cursor < helper->size);
+ helper->vstr[helper->cursor] = data;
+ helper->cursor++;
+}
+
+/**
+ * @brief Private function to fill in vstr
+ */
+static void
+_fill_in_vstr (gchar *** fullpath_vstr, gchar *** basename_vstr,
+ gchar * searchpath[CONF_SOURCES])
+{
+ GSList *lstF = NULL, *lstB = NULL;
+ vstr_helper vstrF, vstrB;
+ uint32_t counterF = 0, counterB = 0;
+ int i;
+
+ counterF = 0;
+ counterB = 0;
+ for (i = 0; i < CONF_SOURCES; i++) {
+ lstF = _get_fullpath_filenames (searchpath[i], lstF, &counterF);
+ lstB = _get_basenames (searchpath[i], lstB, &counterB);
+ }
+ g_assert (counterF == counterB);
+
+ /* Because _get_* does "prepend", reverse them to have the correct order. */
+ lstF = g_slist_reverse (lstF);
+ lstB = g_slist_reverse (lstB);
+
+ *fullpath_vstr = g_malloc_n (counterF + 1, sizeof (gchar *));
+ *basename_vstr = g_malloc_n (counterB + 1, sizeof (gchar *));
+
+ vstrF.vstr = *fullpath_vstr;
+ vstrB.vstr = *basename_vstr;
+ vstrF.size = counterF;
+ vstrB.size = counterB;
+ vstrF.cursor = 0;
+ vstrB.cursor = 0;
+ g_slist_foreach (lstF, _g_list_foreach_vstr_helper, (gpointer) & vstrF);
+ g_slist_foreach (lstB, _g_list_foreach_vstr_helper, (gpointer) & vstrB);
+
+ /* Do not free elements. They are now at vstr */
+ g_slist_free (lstF);
+ g_slist_free (lstB);
+}
+
+/** @brief Public function defined in the header */
+gboolean
+nnstreamer_loadconf (gboolean force_reload)
+{
+ g_autoptr (GError) error = NULL;
+ g_autoptr (GKeyFile) key_file;
+ GStatBuf gsbuf;
+ int stt, i;
+
+ if (FALSE == force_reload && TRUE == conf.loaded)
+ return TRUE;
+
+ key_file = g_key_file_new ();
+
+ if (TRUE == force_reload && TRUE == conf.loaded) {
+ /* Do Clean Up */
+ g_free (conf.conffile);
+
+ for (i = 0; i < CONF_SOURCES; i++) {
+ g_free (conf.pathFILTERS[i]);
+ g_free (conf.pathDECODERS[i]);
+ g_free (conf.pathCUSTOM_FILTERS[i]);
+ }
+
+ g_strfreev (conf.filesFILTERS);
+ g_strfreev (conf.filesDECODERS);
+ g_strfreev (conf.filesCUSTOM_FILTERS);
+ g_strfreev (conf.basenameFILTERS);
+ g_strfreev (conf.basenameDECODERS);
+ g_strfreev (conf.basenameCUSTOM_FILTERS);
+ }
+
+ /* Read from Environmental Variables */
+ conf.conffile = _strdup_getenv (NNSTREAMER_ENVVAR_CONF_FILE);
+ stt = 0; /* File not found or not configured */
+ if (conf.conffile != NULL) {
+ if (0 == g_stat (conf.conffile, &gsbuf)) {
+ /** @todo Check g_stat results (OK if it's regular file) */
+ stt = 1;
+ }
+ }
+ if (0 == stt) {
+ if (NULL != conf.conffile)
+ g_free (conf.conffile);
+ conf.conffile = g_strdup (NNSTREAMER_DEFAULT_CONF_FILE);
+ }
+
+ conf.pathFILTERS[0] = _strdup_getenv (NNSTREAMER_ENVVAR_FILTERS);
+ conf.pathDECODERS[0] = _strdup_getenv (NNSTREAMER_ENVVAR_DECODERS);
+ conf.pathCUSTOM_FILTERS[0] = _strdup_getenv (NNSTREAMER_ENVVAR_CUSTOMFILTERS);
+
+ /* Read the conf file. It's ok even if we cannot load it. */
+ if (conf.conffile &&
+ g_key_file_load_from_file (key_file, conf.conffile, G_KEY_FILE_NONE,
+ &error)) {
+
+ conf.pathFILTERS[1] =
+ g_key_file_get_string (key_file, "filter", "filters", &error);
+ conf.pathDECODERS[1] =
+ g_key_file_get_string (key_file, "decoder", "decoders", &error);
+ conf.pathCUSTOM_FILTERS[1] =
+ g_key_file_get_string (key_file, "filter", "customfilters", &error);
+ }
+
+ /* Strdup the hardcoded */
+ conf.pathFILTERS[2] = g_strdup (NNSTREAMER_FILTERS);
+ conf.pathDECODERS[2] = g_strdup (NNSTREAMER_DECODERS);
+ conf.pathCUSTOM_FILTERS[2] = g_strdup (NNSTREAMER_CUSTOM_FILTERS);
+
+ /* Fill in conf.files* */
+ _fill_in_vstr (&conf.filesFILTERS, &conf.basenameFILTERS, conf.pathFILTERS);
+ _fill_in_vstr (&conf.filesDECODERS, &conf.basenameDECODERS,
+ conf.pathDECODERS);
+ _fill_in_vstr (&conf.filesCUSTOM_FILTERS, &conf.basenameCUSTOM_FILTERS,
+ conf.pathCUSTOM_FILTERS);
+
+ conf.loaded = TRUE;
+ g_key_file_free (key_file);
+
+ return TRUE;
+}
+
+/** @brief Public function defined in the header */
+const gchar *
+nnsconf_get_fullpath_fromfile (const gchar * file2find, nnsconf_type type)
+{
+ gchar **vstr, **vstrFull;
+ int i;
+
+ switch (type) {
+ case NNSCONF_FILTERS:
+ vstr = conf.basenameFILTERS;
+ vstrFull = conf.filesFILTERS;
+ break;
+ case NNSCONF_DECODERS:
+ vstr = conf.basenameDECODERS;
+ vstrFull = conf.filesDECODERS;
+ break;
+ case NNSCONF_CUSTOM_FILTERS:
+ vstr = conf.basenameCUSTOM_FILTERS;
+ vstrFull = conf.filesCUSTOM_FILTERS;
+ break;
+ default:
+ return NULL;
+ }
+
+ if (vstr == NULL)
+ return NULL;
+
+ i = 0;
+ while (vstr[i] != NULL) {
+ /** @todo To support Windows, use case insensitive if it's Windows */
+ if (!g_strcmp0 (file2find, vstr[i]))
+ return vstrFull[i];
+ i++;
+ };
+
+ return NULL;
+}
+
+const gchar *subplugin_prefixes[NNSCONF_END] = {
+ [NNSCONF_FILTERS] = NNSTREAMER_PREFIX_DECODER,
+ [NNSCONF_DECODERS] = NNSTREAMER_PREFIX_FILTER,
+ [NNSCONF_CUSTOM_FILTERS] = NNSTREAMER_PREFIX_CUSTOMFILTERS,
+ NULL,
+};
+
+/** @brief Public function defined in the header */
+const gchar *
+nnsconf_get_fullpath (const gchar * subpluginname, nnsconf_type type)
+{
+ gchar *filename =
+ g_strconcat (subplugin_prefixes[type], subpluginname, ".so", NULL);
+ const gchar *ret = nnsconf_get_fullpath_fromfile (filename, type);
+
+ g_free (filename);
+ return ret;
+}
--- /dev/null
+/**
+ * NNStreamer Configurations / Environmental Variable Manager.
+ * Copyright (C) 2018 MyungJoo Ham <myungjoo.ham@samsung.com>
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Library General Public
+ * License as published by the Free Software Foundation; either
+ * version 2 of the License, or (at your option) any later version.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * Library General Public License for more details.
+ *
+ */
+/**
+ * @file nnstreamer_conf.h
+ * @date 26 Nov 2018
+ * @brief Internal header for conf/env-var management.
+ * @see https://github.com/nnsuite/nnstreamer
+ * @author MyungJoo Ham <myungjoo.ham@samsung.com>
+ * @bug No known bugs except for NYI items
+ *
+ * If there are duplicated configurations for the same element,
+ * the one with higher priority may override (if it cannot be stacked up),
+ *
+ * - (Highest) Environmental variables
+ * - The configuration file (default: /etc/nnstreamer.ini)
+ * - (Lowest) Internal hardcoded values.
+ *
+ * Do not export this to devel pacakge. This is an internal header.
+ */
+#ifndef __GST_NNSTREAMER_CONF_H__
+#define __GST_NNSTREAMER_CONF_H__
+
+#include <glib.h>
+
+/* Env-var names */
+#define NNSTREAMER_ENVVAR_CONF_FILE "NNSTREAMER_CONF"
+#define NNSTREAMER_ENVVAR_FILTERS "NNSTREAMER_FILTERS"
+#define NNSTREAMER_ENVVAR_DECODERS "NNSTREAMER_DECODERS"
+#define NNSTREAMER_ENVVAR_CUSTOMFILTERS "NNSTREAMER_CUSTOMFILTERS"
+
+/* Internal Hardcoded Values */
+#define NNSTREAMER_DEFAULT_CONF_FILE "/etc/nnstreamer.ini"
+#define NNSTREAMER_FILTERS "/usr/lib/nnstreamer/filters/"
+#define NNSTREAMER_DECODERS "/usr/lib/nnstreamer/decoders/"
+#define NNSTREAMER_CUSTOM_FILTERS "/usr/lib/nnstreamer/customfilters/"
+/**
+ * Note that users still can place their custom filters anywhere if they
+ * designate them with the full path.
+ */
+
+/* Subplugin Naming Rules */
+#define NNSTREAMER_PREFIX_DECODER "libnnstreamer_decoder_"
+#define NNSTREAMER_PREFIX_FILTER "libnnstreamer_filter_"
+#define NNSTREAMER_PREFIX_CUSTOMFILTERS ""
+/* Custom filter does not have prefix */
+
+typedef enum {
+ NNSCONF_FILTERS = 0,
+ NNSCONF_DECODERS,
+ NNSCONF_CUSTOM_FILTERS,
+ NNSCONF_CONFFILE,
+
+ NNSCONF_END,
+} nnsconf_type;
+
+extern const gchar *subplugin_prefixes[NNSCONF_END];
+
+/**
+ * @brief Load the .ini file
+ * @param[in] force_reload TRUE if you want to clean up and load conf again.
+ * @return TRUE if successful or skipped. FALSE if error reading something.
+ */
+extern gboolean
+nnsconf_loadconf (gboolean force_reload);
+
+/**
+ * @brief Search for "file2find" file in the configured paths for the type
+ * @param[in] file2find The filename including extensions (e.g., .so) to find.
+ * @param[in] type The type (FILTERS/DECODERS/CUSTOM_FILTERS)
+ * @return The full path to the file. Caller MUST NOT modify this.
+ * Returns NULL if we cannot find the file.
+ */
+extern const gchar *
+nnsconf_get_fullpath_fromfile (const gchar *file2find, nnsconf_type type);
+
+/**
+ * @brief Search for "file2find" file in the configured paths for the type
+ * @param[in] The subplugin name except for the prefix and postfix (.so) to find
+ * @param[in] type The type (FILTERS/DECODERS/CUSTOM_FILTERS)
+ * @return The full path to the file. Caller MUST NOT modify this.
+ * Returns NULL if we cannot find the file.
+ *
+ * This is mainly supposed to be used by CUSTOM_FILTERS
+ */
+extern const gchar *
+nnsconf_get_fullpath (const gchar *subpluginname, nnsconf_type type);
+
+#endif /* __GST_NNSTREAMER_CONF_H__ */
projects / platform / upstream / nnstreamer.git / commitdiff