op.h

   1 /*
   2  * Copyright 2004 Timo Hirvonen
   3  *
   4  * This program is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU General Public License as
   6  * published by the Free Software Foundation; either version 2 of the
   7  * License, or (at your option) any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful, but
  10  * WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with this program; if not, write to the Free Software
  16  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
  17  * 02111-1307, USA.
  18  */
  19
  20 #ifndef _OP_H
  21 #define _OP_H
  22
  23 #include "sf.h"
  24
  25 enum {
  26         /* no error */
  27         OP_ERROR_SUCCESS,
  28         /* system error (error code in errno) */
  29         OP_ERROR_ERRNO,
  30         /* no such plugin */
  31         OP_ERROR_NO_PLUGIN,
  32         /* plugin not initialized */
  33         OP_ERROR_NOT_INITIALIZED,
  34         /* function not supported */
  35         OP_ERROR_NOT_SUPPORTED,
  36         /* mixer not open */
  37         OP_ERROR_NOT_OPEN,
  38         /* plugin does not support the sample format */
  39         OP_ERROR_SAMPLE_FORMAT,
  40         /* plugin does not have this option */
  41         OP_ERROR_NOT_OPTION,
  42         /*  */
  43         OP_ERROR_INTERNAL
  44 };
  45
  46 struct output_plugin_ops {
  47         int (*init)(void);
  48         int (*exit)(void);
  49         int (*open)(sample_format_t sf);
  50         int (*close)(void);
  51         int (*drop)(void);
  52         int (*write)(const char *buffer, int count);
  53         int (*buffer_space)(void);
  54
  55         /* these can be NULL */
  56         int (*pause)(void);
  57         int (*unpause)(void);
  58
  59         int (*set_option)(int key, const char *val);
  60         int (*get_option)(int key, char **val);
  61 };
  62
  63 /* symbols exported by plugin */
  64 extern const struct output_plugin_ops op_pcm_ops;
  65 extern const char * const op_pcm_options[];
  66 extern const int op_priority;
  67
  68 #endif