input.h

   1 /*
   2  * Copyright 2005 Timo Hirvonen
   3  */
   4
   5 #ifndef _INPUT_H
   6 #define _INPUT_H
   7
   8 #include "comment.h"
   9 #include "sf.h"
  10
  11 struct input_plugin;
  12
  13 void ip_load_plugins(void);
  14
  15 /*
  16  * allocates new struct input_plugin.
  17  * never fails. does not check if the file is really playable
  18  */
  19 struct input_plugin *ip_new(const char *filename);
  20
  21 /*
  22  * frees struct input_plugin closing it first if necessary
  23  */
  24 void ip_delete(struct input_plugin *ip);
  25
  26 /*
  27  * errors: IP_ERROR_{ERRNO, FILE_FORMAT, SAMPLE_FORMAT}
  28  */
  29 int ip_open(struct input_plugin *ip);
  30
  31 void ip_setup(struct input_plugin *ip);
  32
  33 /*
  34  * errors: none?
  35  */
  36 int ip_close(struct input_plugin *ip);
  37
  38 /*
  39  * errors: IP_ERROR_{ERRNO, FILE_FORMAT}
  40  */
  41 int ip_read(struct input_plugin *ip, char *buffer, int count);
  42
  43 /*
  44  * errors: IP_ERROR_{FUNCTION_NOT_SUPPORTED}
  45  */
  46 int ip_seek(struct input_plugin *ip, double offset);
  47
  48 /*
  49  * errors: IP_ERROR_{ERRNO}
  50  */
  51 int ip_read_comments(struct input_plugin *ip, struct keyval **comments);
  52
  53 int ip_duration(struct input_plugin *ip);
  54
  55 sample_format_t ip_get_sf(struct input_plugin *ip);
  56 const char *ip_get_filename(struct input_plugin *ip);
  57 const char *ip_get_metadata(struct input_plugin *ip);
  58 int ip_is_remote(struct input_plugin *ip);
  59 int ip_metadata_changed(struct input_plugin *ip);
  60 int ip_eof(struct input_plugin *ip);
  61 char *ip_get_error_msg(struct input_plugin *ip, int rc, const char *arg);
  62 char **ip_get_supported_extensions(void);
  63 void ip_dump_plugins(void);
  64
  65 #endif