aboutsummaryrefslogtreecommitdiffstats
path: root/src/decoder_api.h
diff options
context:
space:
mode:
authorMax Kellermann <max@duempel.org>2008-08-26 08:27:06 +0200
committerMax Kellermann <max@duempel.org>2008-08-26 08:27:06 +0200
commit08bdb43bef5173f045a868289b05a4a698ab811e (patch)
tree1617e8a043be98b1ab4a8336f90b1350526593fc /src/decoder_api.h
parent4a87f1e8159c5d26cba08b895b8c4eb5251cf4ba (diff)
downloadmpd-08bdb43bef5173f045a868289b05a4a698ab811e.tar.gz
mpd-08bdb43bef5173f045a868289b05a4a698ab811e.tar.xz
mpd-08bdb43bef5173f045a868289b05a4a698ab811e.zip
moved InputPlugin to decoder_api.h
InputPlugin is the API which is implemented by a decoder plugin. This belongs to the public API/ABI, so move it to decoder_api.h. It will later be renamed to something like "decoder_plugin".
Diffstat (limited to 'src/decoder_api.h')
-rw-r--r--src/decoder_api.h61
1 files changed, 60 insertions, 1 deletions
diff --git a/src/decoder_api.h b/src/decoder_api.h
index ba61af577..6595b865b 100644
--- a/src/decoder_api.h
+++ b/src/decoder_api.h
@@ -26,9 +26,67 @@
*
*/
-#include "inputPlugin.h"
#include "inputStream.h"
#include "replayGain.h"
+#include "tag.h"
+#include "playerData.h"
+
+
+/* valid values for streamTypes in the InputPlugin struct: */
+#define INPUT_PLUGIN_STREAM_FILE 0x01
+#define INPUT_PLUGIN_STREAM_URL 0x02
+
+
+struct decoder;
+
+
+/* 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) (void);
+
+/* optional, set this to NULL if the InputPlugin doesn't have/need one */
+typedef void (*InputPlugin_finishFunc) (void);
+
+/* 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) (struct decoder *,
+ 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) (struct decoder *,
+ 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 {
+ const 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: */
+ const char *const*suffixes;
+ const char *const*mimeTypes;
+} InputPlugin;
+
/**
* Opaque handle which the decoder plugin passes to the functions in
@@ -36,6 +94,7 @@
*/
struct decoder;
+
/**
* Notify the player thread that it has finished initialization and
* that it has read the song's meta data.