pcm_extplug.h

Go to the documentation of this file.

/*
 * ALSA external PCM plugin SDK (draft version)
 *
 * Copyright (c) 2005 Takashi Iwai <tiwai@suse.de>
 *
 *   This library is free software; you can redistribute it and/or modify
 *   it under the terms of the GNU Lesser General Public License as
 *   published by the Free Software Foundation; either version 2.1 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 Lesser General Public License for more details.
 *
 *   You should have received a copy of the GNU Lesser General Public
 *   License along with this library; if not, write to the Free Software
 *   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 *
 */

#if !defined(__ALSA_PCM_EXTERNAL_H) && !defined(ALSA_LIBRARY_BUILD)
#warning "use #include <alsa/pcm_external.h>, <alsa/pcm_extplug.h> should not be used directly"
#include <alsa/pcm_external.h>
#endif

#ifndef __ALSA_PCM_EXTPLUG_H
#define __ALSA_PCM_EXTPLUG_H 
enum {
    SND_PCM_EXTPLUG_HW_FORMAT,  
    SND_PCM_EXTPLUG_HW_CHANNELS,    
    SND_PCM_EXTPLUG_HW_PARAMS   
};

typedef struct snd_pcm_extplug snd_pcm_extplug_t;
typedef struct snd_pcm_extplug_callback snd_pcm_extplug_callback_t;
#ifdef DOC_HIDDEN
/* redefine typedefs for stupid doxygen */
typedef snd_pcm_extplug snd_pcm_extplug_t;
typedef snd_pcm_extplug_callback snd_pcm_extplug_callback_t;
#endif

/*
 * Protocol version
 */
#define SND_PCM_EXTPLUG_VERSION_MAJOR   1   
#define SND_PCM_EXTPLUG_VERSION_MINOR   0   
#define SND_PCM_EXTPLUG_VERSION_TINY    2   
#define SND_PCM_EXTPLUG_VERSION     ((SND_PCM_EXTPLUG_VERSION_MAJOR<<16) |\
                     (SND_PCM_EXTPLUG_VERSION_MINOR<<8) |\
                     (SND_PCM_EXTPLUG_VERSION_TINY))

struct snd_pcm_extplug {
    unsigned int version;
    const char *name;
    const snd_pcm_extplug_callback_t *callback;
    void *private_data;
    snd_pcm_t *pcm;
    snd_pcm_stream_t stream;
    snd_pcm_format_t format;
    snd_pcm_subformat_t subformat;
    unsigned int channels;
    unsigned int rate;
    snd_pcm_format_t slave_format;
    snd_pcm_subformat_t slave_subformat;
    unsigned int slave_channels;
};

struct snd_pcm_extplug_callback {
    snd_pcm_sframes_t (*transfer)(snd_pcm_extplug_t *ext,
                      const snd_pcm_channel_area_t *dst_areas,
                      snd_pcm_uframes_t dst_offset,
                      const snd_pcm_channel_area_t *src_areas,
                      snd_pcm_uframes_t src_offset,
                      snd_pcm_uframes_t size);
    int (*close)(snd_pcm_extplug_t *ext);
    int (*hw_params)(snd_pcm_extplug_t *ext, snd_pcm_hw_params_t *params);
    int (*hw_free)(snd_pcm_extplug_t *ext);
    void (*dump)(snd_pcm_extplug_t *ext, snd_output_t *out);
    int (*init)(snd_pcm_extplug_t *ext);
    snd_pcm_chmap_query_t **(*query_chmaps)(snd_pcm_extplug_t *ext);
    snd_pcm_chmap_t *(*get_chmap)(snd_pcm_extplug_t *ext);
    int (*set_chmap)(snd_pcm_extplug_t *ext, const snd_pcm_chmap_t *map);
};


int snd_pcm_extplug_create(snd_pcm_extplug_t *ext, const char *name,
               snd_config_t *root, snd_config_t *slave_conf,
               snd_pcm_stream_t stream, int mode);
int snd_pcm_extplug_delete(snd_pcm_extplug_t *ext);

/* clear hw_parameter setting */
void snd_pcm_extplug_params_reset(snd_pcm_extplug_t *ext);

/* hw_parameter setting */
int snd_pcm_extplug_set_param_list(snd_pcm_extplug_t *extplug, int type, unsigned int num_list, const unsigned int *list);
int snd_pcm_extplug_set_param_minmax(snd_pcm_extplug_t *extplug, int type, unsigned int min, unsigned int max);
int snd_pcm_extplug_set_slave_param_list(snd_pcm_extplug_t *extplug, int type, unsigned int num_list, const unsigned int *list);
int snd_pcm_extplug_set_slave_param_minmax(snd_pcm_extplug_t *extplug, int type, unsigned int min, unsigned int max);
int snd_pcm_extplug_set_param_link(snd_pcm_extplug_t *extplug, int type,
                   int keep_link);

static __inline__ int snd_pcm_extplug_set_param(snd_pcm_extplug_t *extplug, int type, unsigned int val)
{
    return snd_pcm_extplug_set_param_list(extplug, type, 1, &val);
}

static __inline__ int snd_pcm_extplug_set_slave_param(snd_pcm_extplug_t *extplug, int type, unsigned int val)
{
    return snd_pcm_extplug_set_slave_param_list(extplug, type, 1, &val);
}

#endif /* __ALSA_PCM_EXTPLUG_H */