aboutsummaryrefslogtreecommitdiffstats
path: root/src/tag/TagHandler.hxx
diff options
context:
space:
mode:
authorMax Kellermann <max@duempel.org>2013-09-05 18:22:02 +0200
committerMax Kellermann <max@duempel.org>2013-09-05 18:26:56 +0200
commit3f267b1795d68e660af9ec1678909a6102102d7d (patch)
treedf4269532c85eab2f74fa31a1b1b400e32113dbd /src/tag/TagHandler.hxx
parent7a4c9f5f4c38b568a51ec13988f5fcfbbe278afa (diff)
downloadmpd-3f267b1795d68e660af9ec1678909a6102102d7d.tar.gz
mpd-3f267b1795d68e660af9ec1678909a6102102d7d.tar.xz
mpd-3f267b1795d68e660af9ec1678909a6102102d7d.zip
Tag, ...: move to libtag.a
Diffstat (limited to 'src/tag/TagHandler.hxx')
-rw-r--r--src/tag/TagHandler.hxx101
1 files changed, 101 insertions, 0 deletions
diff --git a/src/tag/TagHandler.hxx b/src/tag/TagHandler.hxx
new file mode 100644
index 000000000..3303dd27e
--- /dev/null
+++ b/src/tag/TagHandler.hxx
@@ -0,0 +1,101 @@
+/*
+ * Copyright (C) 2003-2013 The Music Player Daemon Project
+ * 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.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+ */
+
+#ifndef MPD_TAG_HANDLER_HXX
+#define MPD_TAG_HANDLER_HXX
+
+#include "check.h"
+#include "TagType.h"
+
+#include <assert.h>
+
+/**
+ * A callback table for receiving metadata of a song.
+ */
+struct tag_handler {
+ /**
+ * Declare the duration of a song, in seconds. Do not call
+ * this when the duration could not be determined, because
+ * there is no magic value for "unknown duration".
+ */
+ void (*duration)(unsigned seconds, void *ctx);
+
+ /**
+ * A tag has been read.
+ *
+ * @param the value of the tag; the pointer will become
+ * invalid after returning
+ */
+ void (*tag)(enum tag_type type, const char *value, void *ctx);
+
+ /**
+ * A name-value pair has been read. It is the codec specific
+ * representation of tags.
+ */
+ void (*pair)(const char *key, const char *value, void *ctx);
+};
+
+static inline void
+tag_handler_invoke_duration(const struct tag_handler *handler, void *ctx,
+ unsigned seconds)
+{
+ assert(handler != nullptr);
+
+ if (handler->duration != nullptr)
+ handler->duration(seconds, ctx);
+}
+
+static inline void
+tag_handler_invoke_tag(const struct tag_handler *handler, void *ctx,
+ enum tag_type type, const char *value)
+{
+ assert(handler != nullptr);
+ assert((unsigned)type < TAG_NUM_OF_ITEM_TYPES);
+ assert(value != nullptr);
+
+ if (handler->tag != nullptr)
+ handler->tag(type, value, ctx);
+}
+
+static inline void
+tag_handler_invoke_pair(const struct tag_handler *handler, void *ctx,
+ const char *name, const char *value)
+{
+ assert(handler != nullptr);
+ assert(name != nullptr);
+ assert(value != nullptr);
+
+ if (handler->pair != nullptr)
+ handler->pair(name, value, ctx);
+}
+
+/**
+ * This #tag_handler implementation adds tag values to a #tag object
+ * (casted from the context pointer).
+ */
+extern const struct tag_handler add_tag_handler;
+
+/**
+ * This #tag_handler implementation adds tag values to a #tag object
+ * (casted from the context pointer), and supports the has_playlist
+ * attribute.
+ */
+extern const struct tag_handler full_tag_handler;
+
+#endif