2009-03-02 20:13:08 +01:00
|
|
|
/*
|
2010-01-01 05:55:13 +01:00
|
|
|
* Copyright (C) 2003-2010 The Music Player Daemon Project
|
2009-03-02 20:13:08 +01:00
|
|
|
* 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.
|
2009-03-13 18:43:16 +01:00
|
|
|
*
|
|
|
|
* 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.
|
2009-03-02 20:13:08 +01:00
|
|
|
*/
|
|
|
|
|
|
|
|
#ifndef MPD_INPUT_PLUGIN_H
|
|
|
|
#define MPD_INPUT_PLUGIN_H
|
|
|
|
|
|
|
|
#include "input_stream.h"
|
|
|
|
|
|
|
|
#include <stddef.h>
|
|
|
|
#include <stdbool.h>
|
|
|
|
#include <sys/types.h>
|
|
|
|
|
2009-03-02 23:08:17 +01:00
|
|
|
struct config_param;
|
2009-03-02 20:13:08 +01:00
|
|
|
struct input_stream;
|
|
|
|
|
|
|
|
struct input_plugin {
|
2009-03-02 23:08:17 +01:00
|
|
|
const char *name;
|
|
|
|
|
2009-03-02 20:45:50 +01:00
|
|
|
/**
|
|
|
|
* Global initialization. This method is called when MPD starts.
|
|
|
|
*
|
2009-12-14 22:29:46 +01:00
|
|
|
* @param error_r location to store the error occuring, or
|
|
|
|
* NULL to ignore errors
|
2009-03-02 20:45:50 +01:00
|
|
|
* @return true on success, false if the plugin should be
|
|
|
|
* disabled
|
|
|
|
*/
|
2009-12-14 22:29:46 +01:00
|
|
|
bool (*init)(const struct config_param *param, GError **error_r);
|
2009-03-02 20:45:50 +01:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Global deinitialization. Called once before MPD shuts
|
|
|
|
* down (only if init() has returned true).
|
|
|
|
*/
|
|
|
|
void (*finish)(void);
|
|
|
|
|
2009-11-14 23:53:04 +01:00
|
|
|
bool (*open)(struct input_stream *is, const char *url,
|
|
|
|
GError **error_r);
|
2009-03-02 20:13:08 +01:00
|
|
|
void (*close)(struct input_stream *is);
|
|
|
|
|
|
|
|
struct tag *(*tag)(struct input_stream *is);
|
2009-11-14 23:53:04 +01:00
|
|
|
int (*buffer)(struct input_stream *is, GError **error_r);
|
|
|
|
size_t (*read)(struct input_stream *is, void *ptr, size_t size,
|
|
|
|
GError **error_r);
|
2009-03-02 20:13:08 +01:00
|
|
|
bool (*eof)(struct input_stream *is);
|
2009-11-14 23:53:04 +01:00
|
|
|
bool (*seek)(struct input_stream *is, goffset offset, int whence,
|
|
|
|
GError **error_r);
|
2009-03-02 20:13:08 +01:00
|
|
|
};
|
|
|
|
|
|
|
|
#endif
|