aboutsummaryrefslogtreecommitdiffstats
path: root/trunk/src/inputPlugin.h
diff options
context:
space:
mode:
Diffstat (limited to 'trunk/src/inputPlugin.h')
-rw-r--r--trunk/src/inputPlugin.h109
1 files changed, 109 insertions, 0 deletions
diff --git a/trunk/src/inputPlugin.h b/trunk/src/inputPlugin.h
new file mode 100644
index 000000000..398ddc1cb
--- /dev/null
+++ b/trunk/src/inputPlugin.h
@@ -0,0 +1,109 @@
+/* the Music Player Daemon (MPD)
+ * Copyright (C) 2003-2007 by Warren Dukes (warren.dukes@gmail.com)
+ * This project's homepage is: http://www.musicpd.org
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program 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 General Public License for more details.
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+ */
+
+#ifndef INPUT_PLUGIN_H
+#define INPUT_PLUGIN_H
+
+#include "../config.h"
+#include "inputStream.h"
+#include "decode.h"
+#include "outputBuffer.h"
+#include "tag.h"
+
+/* valid values for streamTypes in the InputPlugin struct: */
+#define INPUT_PLUGIN_STREAM_FILE 0x01
+#define INPUT_PLUGIN_STREAM_URL 0x02
+
+/* optional, set this to NULL if the InputPlugin doesn't have/need one
+ * this must return < 0 if there is an error and >= 0 otherwise */
+typedef int (*InputPlugin_initFunc) ();
+
+/* optional, set this to NULL if the InputPlugin doesn't have/need one */
+typedef void (*InputPlugin_finishFunc) ();
+
+/* boolean return value, returns 1 if the InputStream is decodable by
+ * the InputPlugin, 0 if not */
+typedef unsigned int (*InputPlugin_tryDecodeFunc) (InputStream *);
+
+/* this will be used to decode InputStreams, and is recommended for files
+ * and networked (HTTP) connections.
+ *
+ * returns -1 on error, 0 on success */
+typedef int (*InputPlugin_streamDecodeFunc) (OutputBuffer *, DecoderControl *,
+ InputStream *);
+
+/* use this if and only if your InputPlugin can only be passed a filename or
+ * handle as input, and will not allow callbacks to be set (like Ogg-Vorbis
+ * and FLAC libraries allow)
+ *
+ * returns -1 on error, 0 on success */
+typedef int (*InputPlugin_fileDecodeFunc) (OutputBuffer *, DecoderControl *,
+ char *path);
+
+/* file should be the full path! Returns NULL if a tag cannot be found
+ * or read */
+typedef MpdTag *(*InputPlugin_tagDupFunc) (char *file);
+
+typedef struct _InputPlugin {
+ char *name;
+ InputPlugin_initFunc initFunc;
+ InputPlugin_finishFunc finishFunc;
+ InputPlugin_tryDecodeFunc tryDecodeFunc;
+ InputPlugin_streamDecodeFunc streamDecodeFunc;
+ InputPlugin_fileDecodeFunc fileDecodeFunc;
+ InputPlugin_tagDupFunc tagDupFunc;
+
+ /* one or more of the INPUT_PLUGIN_STREAM_* values OR'd together */
+ unsigned char streamTypes;
+
+ /* last element in these arrays must always be a NULL: */
+ char **suffixes;
+ char **mimeTypes;
+} InputPlugin;
+
+/* individual functions to load/unload plugins */
+void loadInputPlugin(InputPlugin * inputPlugin);
+void unloadInputPlugin(InputPlugin * inputPlugin);
+
+/* interface for using plugins */
+
+InputPlugin *getInputPluginFromSuffix(char *suffix, unsigned int next);
+
+InputPlugin *getInputPluginFromMimeType(char *mimeType, unsigned int next);
+
+InputPlugin *getInputPluginFromName(char *name);
+
+void printAllInputPluginSuffixes(FILE * fp);
+
+/* this is where we "load" all the "plugins" ;-) */
+void initInputPlugins(void);
+
+/* this is where we "unload" all the "plugins" */
+void finishInputPlugins(void);
+
+extern InputPlugin mp3Plugin;
+extern InputPlugin oggvorbisPlugin;
+extern InputPlugin flacPlugin;
+extern InputPlugin oggflacPlugin;
+extern InputPlugin audiofilePlugin;
+extern InputPlugin mp4Plugin;
+extern InputPlugin mpcPlugin;
+extern InputPlugin aacPlugin;
+extern InputPlugin modPlugin;
+
+#endif