/* * Copyright (C) 2003-2009 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_DECODER_PLUGIN_H #define MPD_DECODER_PLUGIN_H #include <stdbool.h> #include <stddef.h> struct config_param; struct input_stream; struct tag; /** * Opaque handle which the decoder plugin passes to the functions in * this header. */ struct decoder; struct decoder_plugin { const char *name; /** * 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 */ bool (*init)(const struct config_param *param); /** * optional, set this to NULL if the InputPlugin doesn't have/need one */ void (*finish)(void); /** * this will be used to decode InputStreams, and is * recommended for files and networked (HTTP) connections. * * @return false if the plugin cannot decode the stream, and * true if it was able to do so (even if an error occured * during playback) */ void (*stream_decode)(struct decoder *, struct input_stream *); /** * 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) * * @return false if the plugin cannot decode the file, and * true if it was able to do so (even if an error occured * during playback) */ void (*file_decode)(struct decoder *, const char *path); /** * file should be the full path! Returns NULL if a tag cannot * be found or read */ struct tag *(*tag_dup)(const char *file); /** * @brief Return a "virtual" filename for subtracks in * container formats like flac * @param const char* pathname full pathname for the file on fs * @param const unsigned int tnum track number * * @return NULL if there are no multiple files * a filename for every single track according to tnum (param 2) * do not include full pathname here, just the "virtual" file */ char* (*container_scan)(const char* pathname, const unsigned int tnum); /* last element in these arrays must always be a NULL: */ const char *const*suffixes; const char *const*mime_types; }; /** * Initialize a decoder plugin. * * @param param a configuration block for this plugin, or NULL if none * is configured * @return true if the plugin was initialized successfully, false if * the plugin is not available */ static inline bool decoder_plugin_init(const struct decoder_plugin *plugin, const struct config_param *param) { return plugin->init != NULL ? plugin->init(param) : true; } /** * Deinitialize a decoder plugin which was initialized successfully. */ static inline void decoder_plugin_finish(const struct decoder_plugin *plugin) { if (plugin->finish != NULL) plugin->finish(); } /** * Decode a stream. */ static inline void decoder_plugin_stream_decode(const struct decoder_plugin *plugin, struct decoder *decoder, struct input_stream *is) { plugin->stream_decode(decoder, is); } /** * Decode a file. */ static inline void decoder_plugin_file_decode(const struct decoder_plugin *plugin, struct decoder *decoder, const char *path_fs) { plugin->file_decode(decoder, path_fs); } /** * Read the tag of a file. */ static inline struct tag * decoder_plugin_tag_dup(const struct decoder_plugin *plugin, const char *path_fs) { return plugin->tag_dup(path_fs); } /** * return "virtual" tracks in a container */ static inline char * decoder_plugin_container_scan( const struct decoder_plugin *plugin, const char* pathname, const unsigned int tnum) { return plugin->container_scan(pathname, tnum); } #endif