1 /*****************************************************************************
2 * vlc_addons.h : addons handling and describing
3 *****************************************************************************
4 * Copyright (C) 2013 VideoLAN and authors
6 * This program is free software; you can redistribute it and/or modify it
7 * under the terms of the GNU Lesser General Public License as published by
8 * the Free Software Foundation; either version 2.1 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU Lesser General Public License for more details.
16 * You should have received a copy of the GNU Lesser General Public License
17 * along with this program; if not, write to the Free Software Foundation,
18 * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
19 *****************************************************************************/
22 #define VLC_ADDONS_H 1
24 #include <vlc_arrays.h>
25 #include <vlc_events.h>
31 typedef enum addon_type_t
35 ADDON_PLAYLIST_PARSER,
36 ADDON_SERVICE_DISCOVERY,
42 typedef enum addon_state_t
44 ADDON_NOTINSTALLED = 0,
50 typedef enum addon_flags_t
52 ADDON_BROKEN = 1, /* Have install inconsistency */
53 ADDON_MANAGEABLE = 1 << 1, /* Have manifest, can install or uninstall files */
54 ADDON_UPDATABLE = 1 << 2,
57 #define ADDON_UUID_SIZE 16
58 #define ADDON_UUID_PSZ_SIZE (ADDON_UUID_SIZE * 2 + 4)
59 typedef uint8_t addon_uuid_t[ADDON_UUID_SIZE];
61 typedef struct addon_file_t
63 addon_type_t e_filetype;
64 char *psz_download_uri;
73 addon_state_t e_state;
74 addon_flags_t e_flags;
76 /* data describing addon */
80 char *psz_description;
82 char *psz_source_uri; /* webpage, ... */
84 char *psz_image_data; /* base64, png */
92 char *psz_source_module;
95 char *psz_archive_uri; /* Archive */
96 DECL_ARRAY(addon_file_t *) files;
98 /* custom data storage (if needed by module/source) */
101 typedef struct addon_entry_t addon_entry_t;
103 typedef struct addons_finder_t addons_finder_t;
104 typedef struct addons_finder_sys_t addons_finder_sys_t;
105 struct addons_finder_t
109 int ( * pf_find )( addons_finder_t * );
110 int ( * pf_retrieve )( addons_finder_t *, addon_entry_t * );
111 DECL_ARRAY( addon_entry_t * ) entries;
114 addons_finder_sys_t *p_sys;
117 typedef struct addons_storage_t addons_storage_t;
118 typedef struct addons_storage_sys_t addons_storage_sys_t;
119 struct addons_storage_t
123 int ( * pf_install )( addons_storage_t *, addon_entry_t * );
124 int ( * pf_remove )( addons_storage_t *, addon_entry_t * );
125 int ( * pf_catalog ) ( addons_storage_t *, addon_entry_t **, int );
127 addons_storage_sys_t *p_sys;
130 typedef struct addons_manager_private_t addons_manager_private_t;
131 struct addons_manager_t
133 vlc_event_manager_t * p_event_manager;
135 addons_manager_private_t *p_priv;
137 typedef struct addons_manager_t addons_manager_t;
140 * addon entry lifecycle
142 VLC_API addon_entry_t *addon_entry_New( void );
143 VLC_API addon_entry_t *addon_entry_Hold(addon_entry_t *);
144 VLC_API void addon_entry_Release(addon_entry_t *);
147 * addons manager lifecycle
149 VLC_API addons_manager_t *addons_manager_New( vlc_object_t * );
150 VLC_API void addons_manager_Delete( addons_manager_t * );
153 * Charge currently installed, usable and manageable addons
154 * (default "addons storage" module)
156 VLC_API int addons_manager_LoadCatalog( addons_manager_t * );
159 * Gather addons info from repository (default "addons finder" module)
160 * If psz_uri is not NULL, only gather info from the pointed package.
162 VLC_API void addons_manager_Gather( addons_manager_t *, const char *psz_uri );
165 * Install or Remove the addon identified by its uuid
167 VLC_API int addons_manager_Install( addons_manager_t *p_manager, const addon_uuid_t uuid );
168 VLC_API int addons_manager_Remove( addons_manager_t *p_manager, const addon_uuid_t uuid );
171 * String uuid to binary uuid helpers
173 static inline bool addons_uuid_read( const char *psz_uuid, addon_uuid_t *p_uuid )
175 if ( !psz_uuid ) return false;
176 if ( strlen( psz_uuid ) < ADDON_UUID_PSZ_SIZE ) return false;
179 while ( i<ADDON_UUID_PSZ_SIZE )
181 if ( *( psz_uuid + i ) == '-' )
184 sscanf( psz_uuid + i, "%02x", &v );
185 (*p_uuid)[j++] = v & 0xFF;
192 static inline char * addons_uuid_to_psz( const addon_uuid_t * p_uuid )
194 char *psz = (char*) calloc( ADDON_UUID_PSZ_SIZE + 1 , sizeof(char) );
199 while ( i < ADDON_UUID_SIZE )
201 if ( i == 4 || i== 7 || i== 9 || i== 11 )
203 int v = 0xFF & (*p_uuid)[i];
204 sprintf( p, "%02x", v );