86 lines
2.0 KiB
C++
86 lines
2.0 KiB
C++
/*
|
|
* Copyright (C) 2003-2014 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_INPUT_PLUGIN_HXX
|
|
#define MPD_INPUT_PLUGIN_HXX
|
|
|
|
#include "thread/Mutex.hxx"
|
|
#include "thread/Cond.hxx"
|
|
|
|
#include <stddef.h>
|
|
#include <stdint.h>
|
|
|
|
#ifdef WIN32
|
|
#include <windows.h>
|
|
/* damn you, windows.h! */
|
|
#ifdef ERROR
|
|
#undef ERROR
|
|
#endif
|
|
#endif
|
|
|
|
struct config_param;
|
|
class InputStream;
|
|
class Error;
|
|
struct Tag;
|
|
|
|
struct InputPlugin {
|
|
enum class InitResult {
|
|
/**
|
|
* A fatal error has occurred (e.g. misconfiguration).
|
|
* The #Error has been set.
|
|
*/
|
|
ERROR,
|
|
|
|
/**
|
|
* The plugin was initialized successfully and is
|
|
* ready to be used.
|
|
*/
|
|
SUCCESS,
|
|
|
|
/**
|
|
* The plugin is not available and shall be disabled.
|
|
* The #Error may be set describing the situation (to
|
|
* be logged).
|
|
*/
|
|
UNAVAILABLE,
|
|
};
|
|
|
|
const char *name;
|
|
|
|
/**
|
|
* Global initialization. This method is called when MPD starts.
|
|
*
|
|
* @return true on success, false if the plugin should be
|
|
* disabled
|
|
*/
|
|
InitResult (*init)(const config_param ¶m, Error &error);
|
|
|
|
/**
|
|
* Global deinitialization. Called once before MPD shuts
|
|
* down (only if init() has returned true).
|
|
*/
|
|
void (*finish)(void);
|
|
|
|
InputStream *(*open)(const char *uri,
|
|
Mutex &mutex, Cond &cond,
|
|
Error &error);
|
|
};
|
|
|
|
#endif
|