src/.svn/text-base/inputStream.h.svn-base

   1 /* the Music Player Daemon (MPD)
   2  * Copyright (C) 2003-2007 by Warren Dukes (warren.dukes@gmail.com)
   3  * This project's homepage is: http://www.musicpd.org
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU General Public License for more details.
  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  02111-1307  USA
  17  */
  18
  19 #ifndef INPUT_STREAM_H
  20 #define INPUT_STREAM_H
  21
  22 #include <stdlib.h>
  23
  24 typedef struct _InputStream InputStream;
  25
  26 typedef int (*InputStreamSeekFunc) (InputStream * inStream, long offset,
  27                                     int whence);
  28 typedef size_t(*InputStreamReadFunc) (InputStream * inStream, void *ptr,
  29                                       size_t size, size_t nmemb);
  30 typedef int (*InputStreamCloseFunc) (InputStream * inStream);
  31 typedef int (*InputStreamAtEOFFunc) (InputStream * inStream);
  32 typedef int (*InputStreamBufferFunc) (InputStream * inStream);
  33
  34 struct _InputStream {
  35         int error;
  36         long offset;
  37         size_t size;
  38         char *mime;
  39         int seekable;
  40
  41         /* don't touc this stuff */
  42         InputStreamSeekFunc seekFunc;
  43         InputStreamReadFunc readFunc;
  44         InputStreamCloseFunc closeFunc;
  45         InputStreamAtEOFFunc atEOFFunc;
  46         InputStreamBufferFunc bufferFunc;
  47         void *data;
  48         char *metaName;
  49         char *metaTitle;
  50 };
  51
  52 void initInputStream(void);
  53
  54 int isUrlSaneForInputStream(char *url);
  55
  56 /* if an error occurs for these 3 functions, then -1 is returned and errno
  57    for the input stream is set */
  58 int openInputStream(InputStream * inStream, char *url);
  59 int seekInputStream(InputStream * inStream, long offset, int whence);
  60 int closeInputStream(InputStream * inStream);
  61 int inputStreamAtEOF(InputStream * inStream);
  62
  63 /* return value: -1 is error, 1 inidicates stuff was buffered, 0 means nothing
  64    was buffered */
  65 int bufferInputStream(InputStream * inStream);
  66
  67 size_t readFromInputStream(InputStream * inStream, void *ptr, size_t size,
  68                            size_t nmemb);
  69
  70 #endif