input_plugin.h

Go to the documentation of this file.

/*  input_plugin.h -  Use this to write input plugins
 *  Copyright (C) 1999-2002 Andy Lo A Foe <andy@alsaplayer.org>
 *
 *  This file is part of AlsaPlayer.
 *
 *  AlsaPlayer 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 3 of the License, or
 *  (at your option) any later version.
 *
 *  AlsaPlayer 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, see <http://www.gnu.org/licenses/>.
 *
 */

#ifndef __input_plugin_h__
#define __input_plugin_h__

#include "stream_info.h"

#include <pthread.h>

#define P_SEEK          1

#define P_PERFECTSEEK   2

#define P_REENTRANT     4

#define P_FILEBASED     8

#define P_STREAMBASED   16

#define P_BUFFERING     32

/*
 * Format of version number is 0x1000 + version
 * So 0x1001 is *binary* format version 1
 * THE VERSION NUMBER IS *NOT* A USER SERVICABLE PART!
 */

#define INPUT_PLUGIN_BASE_VERSION       0x1000

#define INPUT_PLUGIN_VERSION    (INPUT_PLUGIN_BASE_VERSION + 16)

typedef struct _input_object
{
        int ready;
        int flags;
        int nr_blocks;
        int nr_tracks;
        int nr_channels;
        int block_size;
        void *local_data;
        char* path;
        pthread_mutex_t object_mutex;
} input_object;


typedef int input_version_type;

typedef int input_flags_type;

typedef int(*input_init_type)(void);

typedef void(*input_shutdown_type)(void);

typedef void* input_plugin_handle_type;

typedef float(*input_can_handle_type)(const char *path);

typedef int(*input_open_type)(input_object *obj, const char *path);

typedef void(*input_close_type)(input_object *obj);

typedef int(*input_play_block_type)(input_object *obj, short *buffer);

typedef int(*input_block_seek_type)(input_object *obj, int block);

typedef int(*input_block_size_type)(input_object *obj);

typedef int(*input_nr_blocks_type)(input_object *obj);

typedef int64_t (*input_frame_count_type)(input_object *obj);

typedef  long(*input_block_to_sec_type)(input_object *obj ,int block);

typedef int(*input_sample_rate_type)(input_object *obj);

typedef int(*input_channels_type)(input_object *obj);

typedef int(*input_stream_info_type)(input_object *obj,stream_info *info);

typedef int(*input_nr_tracks_type)(input_object *obj);

/* @param obj input object
 * @param track track to seek to
 *
 * Seek to a track. Optional
 */
typedef int(*input_track_seek_type)(input_object *obj, int track);


typedef struct _input_plugin
{
        input_version_type version;
        input_flags_type        flags;
        const char *name;
        const char *author;
        void *handle;
        input_init_type init;
        input_shutdown_type shutdown;
        input_plugin_handle_type plugin_handle;
        input_can_handle_type can_handle;
        input_open_type open;
        input_close_type close;
        input_play_block_type play_block;
        input_block_seek_type block_seek;
        input_block_size_type block_size;
        input_nr_blocks_type nr_blocks;
        input_frame_count_type frame_count;
        input_block_to_sec_type block_to_sec;
        input_sample_rate_type sample_rate;
        input_channels_type channels;
        input_stream_info_type stream_info;
        input_nr_tracks_type nr_tracks;
        input_track_seek_type track_seek;
} input_plugin;

typedef input_plugin*(*input_plugin_info_type)(void);

#ifdef __cplusplus
extern "C"
#endif
input_plugin* input_plugin_info (void);

#endif