scope_plugin.h

Go to the documentation of this file.

/*  scope_plugin.h
 *  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 __scope_plugin_h__
#define __scope_plugin_h__

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

#define SCOPE_PLUGIN_BASE_VERSION 0x1000

#define SCOPE_PLUGIN_VERSION    (SCOPE_PLUGIN_BASE_VERSION + 7)

#define SCOPE_NICE      10

#define SCOPE_SLEEP 20000

#define SCOPE_BG_RED    0

#define SCOPE_BG_GREEN  0

#define SCOPE_BG_BLUE   0

typedef int scope_version_type;

typedef int(*scope_init_type)(void *arg);

typedef void(*scope_start_type)(void);

typedef int(*scope_running_type)(void);

typedef void(*scope_stop_type)(void);

typedef void(*scope_shutdown_type)(void);

typedef void(*scope_set_data_type)(void *buffer, int count);

typedef void(*scope_set_fft_type)(void *buffer, int samples, int channels);

typedef struct _scope_plugin
{
        scope_version_type version;
        char *name;
        char *author;
        void *handle;
        scope_init_type init;
        scope_start_type start;
        scope_running_type running;
        scope_stop_type stop;
        scope_shutdown_type shutdown;
        scope_set_data_type set_data;
        scope_set_fft_type set_fft;
} scope_plugin;

typedef scope_plugin*(*scope_plugin_info_type)(void);

#ifdef __cplusplus
extern "C"
#endif
scope_plugin* scope_plugin_info(void);

#endif