ByteStream.hpp

00001 /*********************************************************************** 00002 * * 00003 * ViTooKi * 00004 * * 00005 * title: ByteStream.hpp * 00006 * * 00007 * * 00008 * * 00009 * ITEC institute of the University of Klagenfurt (Austria) * 00010 * http://www.itec.uni-klu.ac.at * 00011 * * 00012 * * 00013 * For more information visit the ViTooKi homepage: * 00014 * http://ViTooKi.sourceforge.net * 00015 * vitooki-user@lists.sourceforge.net * 00016 * vitooki-devel@lists.sourceforge.net * 00017 * * 00018 * This file is part of ViTooKi, a free video toolkit. * 00019 * ViTooKi is free software; you can redistribute it and/or * 00020 * modify it under the terms of the GNU General Public License * 00021 * as published by the Free Software Foundation; either version 2 * 00022 * of the License, or (at your option) any later version. * 00023 * * 00024 * This program is distributed in the hope that it will be useful, * 00025 * but WITHOUT ANY WARRANTY; without even the implied warranty of * 00026 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * 00027 * GNU General Public License for more details. * 00028 * * 00029 * You should have received a copy of the GNU General Public License * 00030 * along with this program; if not, write to the Free Software * 00031 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, * 00032 * MA 02111-1307, USA. * 00033 * * 00034 ***********************************************************************/ 00035 00036 /*********************************************************************** 00037 * * 00038 * REVISION HISTORY: * 00039 * * 00040 * * 00041 * * 00042 ***********************************************************************/ 00043 #ifndef VITOOKI_BYTESTREAM_HPP_ 00044 #define VITOOKI_BYTESTREAM_HPP_ 00045 00046 #include "global.hpp" 00047 00048 00061 class ByteStream { 00062 public: 00063 ByteStream(const char* uri, bool forReading = true); 00064 00065 virtual ~ByteStream() {}; 00066 00067 const char *getUrl(); 00068 00069 bool isReadOnly() {return readOnly; }; 00070 00071 virtual bool open() = 0; 00072 00073 virtual bool close() = 0; 00074 00075 /* reads the next character from stream and @returns it as an unsigned char cast to an int, 00076 or EOF (-1) on end of file or error 00077 */ 00078 virtual int getChar() = 0; 00079 00080 /* reads @param size number of bytes into the buffer @param ptr 00081 * @returns the number of bytes read (which might be less than @param size) or EOF (-1) 00082 */ 00083 virtual int read(void *ptr, int size) = 0; 00084 00085 /* writes @param size number of bytes from the given buffer @param ptr 00086 * @returns the number of bytes successfully written, or -1 if an error occurs 00087 */ 00088 virtual int write(void *ptr, int size) = 0; 00089 00090 /* sets the file pointer to the given byte position in the byteStream */ 00091 virtual int seek(u64 pos) = 0; 00092 00093 /* @returns the actual byte position in the byteStream */ 00094 virtual u64 tell() = 0; 00095 00096 00097 protected: 00098 char url[MAX_STR_LEN]; 00099 bool readOnly; 00100 00101 }; 00102 00103 00104 #endif