00001
00002
00003
00004
00005
00006
00007
00008
00009
00010
00011
00012
00013
00014
00015
00016
00017
00018
00019
00020 #ifndef __XMMS_XFORMPLUGIN_H__
00021 #define __XMMS_XFORMPLUGIN_H__
00022
00023 #include <glib.h>
00024 #include <string.h>
00025
00026
00027
00028
00029
00030
00031
00032
00033
00034
00035
00036
00037
00038
00039
00040
00041
00042
00043
00044
00045
00046
00047
00048
00049
00050
00051
00052 #define XMMS_XFORM_API_VERSION 6
00053
00054 #include "xmms/xmms_error.h"
00055 #include "xmms/xmms_plugin.h"
00056 #include "xmms/xmms_sample.h"
00057 #include "xmms/xmms_streamtype.h"
00058 #include "xmms/xmms_config.h"
00059 #include "xmms/xmms_medialib.h"
00060
00061
00062 G_BEGIN_DECLS
00063
00064 struct xmms_xform_plugin_St;
00065
00066
00067
00068 typedef struct xmms_xform_plugin_St xmms_xform_plugin_t;
00069
00070
00071
00072
00073
00074
00075
00076
00077
00078
00079
00080
00081
00082
00083
00084
00085
00086
00087
00088
00089
00090 #define XMMS_XFORM_PLUGIN(shname, name, ver, desc, setupfunc) XMMS_PLUGIN(XMMS_PLUGIN_TYPE_XFORM, XMMS_XFORM_API_VERSION, shname, name, ver, desc, (gboolean (*)(gpointer))setupfunc)
00091
00092
00093
00094 struct xmms_xform_St;
00095
00096 typedef struct xmms_xform_St xmms_xform_t;
00097
00098
00099
00100
00101 typedef enum xmms_xform_seek_mode_E {
00102 XMMS_XFORM_SEEK_CUR = 1,
00103 XMMS_XFORM_SEEK_SET = 2,
00104 XMMS_XFORM_SEEK_END = 3
00105 } xmms_xform_seek_mode_t;
00106
00107
00108
00109
00110 typedef struct xmms_xform_methods_St {
00111
00112
00113
00114
00115
00116
00117
00118
00119
00120
00121 gboolean (*init)(xmms_xform_t *);
00122
00123
00124
00125
00126
00127
00128 void (*destroy)(xmms_xform_t *);
00129
00130
00131
00132
00133
00134 gint (*read)(xmms_xform_t *, gpointer, gint, xmms_error_t *);
00135
00136
00137
00138
00139
00140
00141
00142
00143 gint64 (*seek)(xmms_xform_t *, gint64, xmms_xform_seek_mode_t, xmms_error_t *);
00144
00145
00146
00147
00148
00149
00150
00151 gboolean (*browse)(xmms_xform_t *, const gchar *, xmms_error_t *);
00152 } xmms_xform_methods_t;
00153
00154 #define XMMS_XFORM_METHODS_INIT(m) memset (&m, 0, sizeof (xmms_xform_methods_t))
00155
00156
00157
00158
00159
00160
00161 void xmms_xform_plugin_methods_set (xmms_xform_plugin_t *plugin, xmms_xform_methods_t *methods);
00162
00163
00164
00165
00166
00167
00168
00169
00170
00171
00172
00173
00174
00175
00176
00177
00178
00179 void xmms_xform_plugin_indata_add (xmms_xform_plugin_t *plugin, ...);
00180
00181
00182
00183
00184
00185
00186
00187 gpointer xmms_xform_private_data_get (xmms_xform_t *xform);
00188
00189
00190
00191
00192
00193
00194
00195
00196
00197
00198 void xmms_xform_private_data_set (xmms_xform_t *xform, gpointer data);
00199
00200
00201 void xmms_xform_outdata_type_add (xmms_xform_t *xform, ...);
00202 void xmms_xform_outdata_type_copy (xmms_xform_t *xform);
00203
00204
00205
00206
00207
00208
00209
00210
00211 void xmms_xform_metadata_set_int (xmms_xform_t *xform, const gchar *key, int val);
00212
00213
00214
00215
00216
00217
00218
00219 void xmms_xform_metadata_set_str (xmms_xform_t *xform, const gchar *key, const char *val);
00220
00221 gboolean xmms_xform_metadata_has_val (xmms_xform_t *xform, const gchar *key);
00222 gboolean xmms_xform_metadata_get_int (xmms_xform_t *xform, const gchar *key,
00223 gint *val);
00224 gboolean xmms_xform_metadata_get_str (xmms_xform_t *xform, const gchar *key,
00225 const gchar **val);
00226 void xmms_xform_auxdata_barrier (xmms_xform_t *xform);
00227 void xmms_xform_auxdata_set_int (xmms_xform_t *xform, const gchar *key, gint32 val);
00228 void xmms_xform_auxdata_set_str (xmms_xform_t *xform, const gchar *key, const gchar *val);
00229 void xmms_xform_auxdata_set_bin (xmms_xform_t *xform, const gchar *key, gpointer data, gssize len);
00230 gboolean xmms_xform_auxdata_has_val (xmms_xform_t *xform, const gchar *key);
00231 gboolean xmms_xform_auxdata_get_int (xmms_xform_t *xform, const gchar *key, gint32 *val);
00232 gboolean xmms_xform_auxdata_get_str (xmms_xform_t *xform, const gchar *key, const gchar **val);
00233 gboolean xmms_xform_auxdata_get_bin (xmms_xform_t *xform, const gchar *key, gpointer *data, gssize *datalen);
00234
00235 const char *xmms_xform_indata_get_str (xmms_xform_t *xform, xmms_stream_type_key_t key);
00236 gint xmms_xform_indata_get_int (xmms_xform_t *xform, xmms_stream_type_key_t key);
00237
00238
00239
00240
00241
00242
00243
00244
00245
00246
00247
00248
00249
00250
00251
00252
00253
00254 gint xmms_xform_peek (xmms_xform_t *xform, gpointer buf, gint siz, xmms_error_t *err);
00255
00256
00257
00258
00259
00260
00261
00262
00263
00264
00265
00266 gchar *xmms_xform_read_line (xmms_xform_t *xform, gchar *buf, xmms_error_t *err);
00267
00268
00269
00270
00271
00272
00273
00274
00275
00276
00277
00278
00279
00280
00281
00282 gint xmms_xform_read (xmms_xform_t *xform, gpointer buf, gint siz, xmms_error_t *err);
00283
00284
00285
00286
00287
00288
00289
00290
00291
00292
00293
00294
00295
00296 gint64 xmms_xform_seek (xmms_xform_t *xform, gint64 offset, xmms_xform_seek_mode_t whence, xmms_error_t *err);
00297 gboolean xmms_xform_iseos (xmms_xform_t *xform);
00298
00299 gboolean xmms_magic_add (const gchar *desc, const gchar *mime, ...);
00300 gboolean xmms_magic_extension_add (const gchar *mime, const gchar *ext);
00301
00302 xmms_config_property_t *xmms_xform_plugin_config_property_register (
00303 xmms_xform_plugin_t *xform_plugin,
00304 const gchar *name,
00305 const gchar *default_value,
00306 xmms_object_handler_t cb,
00307 gpointer userdata);
00308 xmms_config_property_t *xmms_xform_config_lookup (xmms_xform_t *xform,
00309 const gchar *path);
00310
00311
00312
00313
00314
00315
00316
00317 xmms_medialib_entry_t xmms_xform_entry_get (xmms_xform_t *xform);
00318 const gchar *xmms_xform_get_url (xmms_xform_t *xform);
00319
00320 #define XMMS_XFORM_BROWSE_FLAG_DIR (1 << 0)
00321
00322 void xmms_xform_browse_add_entry (xmms_xform_t *xform, const gchar *path, guint32 flags);
00323 void xmms_xform_browse_add_entry_property (xmms_xform_t *xform, const gchar *key, xmms_object_cmd_value_t *val);
00324 void xmms_xform_browse_add_entry_property_str (xmms_xform_t *xform,
00325 const gchar *key,
00326 const gchar *value);
00327 void xmms_xform_browse_add_entry_property_int (xmms_xform_t *xform,
00328 const gchar *key,
00329 gint value);
00330 void xmms_xform_browse_add_symlink (xmms_xform_t *xform, const gchar *basename, const gchar *url);
00331 void xmms_xform_browse_add_symlink_args (xmms_xform_t *xform, const gchar *basename, const gchar *url, gint nargs, char **args);
00332
00333 #define XMMS_XFORM_MAX_LINE_SIZE 1024
00334
00335
00336
00337
00338 G_END_DECLS
00339
00340 #endif