decoder_api: moved struct decoder_plugin to decoder_plugin.h

The decoder_plugin struct is used by both the MPD core and the decoder
plugin implementations.  Move it to a shared header file, to minimize
header dependencies.
This commit is contained in:
Max Kellermann 2009-02-15 17:48:37 +01:00
parent 92c203d705
commit a28287073b
7 changed files with 89 additions and 60 deletions

View File

@ -62,6 +62,7 @@ mpd_headers = \
dbUtils.h \
decoder_thread.h \
decoder_control.h \
decoder_plugin.h \
decoder_api.h \
decoder_internal.h \
directory.h \

View File

@ -17,6 +17,7 @@
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
#include "decoder_api.h"
#include "decoder_internal.h"
#include "decoder_control.h"
#include "player_control.h"

View File

@ -26,6 +26,7 @@
*
*/
#include "decoder_plugin.h"
#include "input_stream.h"
#include "replay_gain.h"
#include "tag.h"
@ -41,63 +42,6 @@ enum decoder_command {
};
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)(void);
/**
* 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);
/* last element in these arrays must always be a NULL: */
const char *const*suffixes;
const char *const*mime_types;
};
/**
* Opaque handle which the decoder plugin passes to the functions in
* this header.
*/
struct decoder;
/**
* Notify the player thread that it has finished initialization and
* that it has read the song's meta data.

View File

@ -19,7 +19,6 @@
#ifndef MPD_DECODER_INTERNAL_H
#define MPD_DECODER_INTERNAL_H
#include "decoder_api.h"
#include "pcm_convert.h"
struct decoder {

View File

@ -17,12 +17,14 @@
*/
#include "decoder_list.h"
#include "decoder_api.h"
#include "decoder_plugin.h"
#include "utils.h"
#include "config.h"
#include <glib.h>
#include <string.h>
extern const struct decoder_plugin mp3Plugin;
extern const struct decoder_plugin vorbis_decoder_plugin;
extern const struct decoder_plugin flac_decoder_plugin;

80
src/decoder_plugin.h Normal file
View File

@ -0,0 +1,80 @@
/*
* 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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
#ifndef MPD_DECODER_PLUGIN_H
#define MPD_DECODER_PLUGIN_H
#include <stdbool.h>
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)(void);
/**
* 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);
/* last element in these arrays must always be a NULL: */
const char *const*suffixes;
const char *const*mime_types;
};
#endif

View File

@ -21,8 +21,9 @@
#include "directory.h"
#include "mapper.h"
#include "decoder_list.h"
#include "decoder_api.h"
#include "decoder_plugin.h"
#include "tag_id3.h"
#include "tag.h"
#include <glib.h>
@ -30,6 +31,7 @@
#include <sys/types.h>
#include <sys/stat.h>
#include <unistd.h>
#include <string.h>
static struct song *
song_alloc(const char *url, struct directory *parent)