cmus/output.h

   1 /*
   2  * Copyright 2005 Timo Hirvonen
   3  */
   4
   5 #ifndef _OUTPUT_H
   6 #define _OUTPUT_H
   7
   8 #include <sf.h>
   9
  10 extern void op_init_plugins(void);
  11
  12 /*
  13  * errors: OP_ERROR_{}
  14  */
  15 extern int op_init(void);
  16
  17 /*
  18  * errors: OP_ERROR_{}
  19  */
  20 extern int op_exit(void);
  21
  22 /*
  23  * select output plugin and open its mixer
  24  *
  25  * errors: OP_ERROR_{ERRNO, NO_PLUGIN}
  26  */
  27 extern int op_select(const char *name);
  28
  29 /*
  30  * open selected plugin
  31  *
  32  * errors: OP_ERROR_{}
  33  */
  34 extern int op_open(sample_format_t sf);
  35
  36 /*
  37  * returns:
  38  *     0 if sample format didn't change
  39  *     1 if sample format did change
  40  *     OP_ERROR_{} on error
  41  */
  42 extern int op_set_sf(sample_format_t sf);
  43
  44 extern int op_second_size(void);
  45
  46 /*
  47  * drop pcm data
  48  *
  49  * errors: OP_ERROR_{ERRNO}
  50  */
  51 extern int op_drop(void);
  52
  53 /*
  54  * close plugin
  55  *
  56  * errors: OP_ERROR_{}
  57  */
  58 extern int op_close(void);
  59
  60 /*
  61  * returns bytes written or error
  62  *
  63  * errors: OP_ERROR_{ERRNO}
  64  */
  65 extern int op_write(const char *buffer, int count);
  66
  67 /*
  68  * errors: OP_ERROR_{}
  69  */
  70 extern int op_pause(void);
  71 extern int op_unpause(void);
  72
  73 /*
  74  * returns space in output buffer in bytes or -1 if busy
  75  */
  76 extern int op_buffer_space(void);
  77
  78 /*
  79  * errors: OP_ERROR_{}
  80  */
  81 extern int op_reset(void);
  82
  83 /*
  84  * set volume (0..100)
  85  *
  86  * returns actual volume which might not be same as given volume
  87  * because of rounding
  88  */
  89 extern int op_set_volume(int *left, int *right);
  90
  91 /*
  92  * get volume (0..100)
  93  *
  94  * errors: OP_ERROR_{}
  95  */
  96 extern int op_get_volume(int *left, int *right);
  97
  98 /*
  99  * adds volume and returns new volume
 100  *
 101  * NOTE: adds volume to internal volume which might not be 0..100.
 102  *       returned volume is always 0..100.
 103  */
 104 extern int op_add_volume(int *left, int *right);
 105
 106 /*
 107  * returns 1 if changed, 0 otherwise
 108  */
 109 extern int op_volume_changed(int *left, int *right);
 110
 111 /*
 112  * errors: OP_ERROR_{NO_PLUGIN, NOT_INITIALIZED, NOT_OPTION}
 113  */
 114 extern int op_set_option(const char *key, const char *val);
 115 extern int op_get_option(const char *key, char **val);
 116
 117 extern int op_for_each_option(void (*callback)(void *data, const char *key), void *data);
 118 extern char *op_get_error_msg(int rc, const char *arg);
 119 extern void op_dump_plugins(void);
 120 extern char *op_get_current(void);
 121
 122 #endif