D:/WorkAround/prequengine/trunk/src/filereader.h File Reference

This file contains movies routines. More...

#include <stdio.h>
#include <stdlib.h>
#include <string.h>

Include dependency graph for filereader.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	filereader
Defines
#define	SECTORS_IN_BUFFER   (3)
#define	BUFFER_SIZE   (2048*SECTORS_IN_BUFFER)
Functions
void	frfeed (filereader *fr)
void	frread (filereader *fr, void *destPtr, unsigned long int size)
void	frseek (filereader *fr, unsigned long int seekPosition)
int	fropen (filereader *fr, const char *filename)
void	frclose (filereader *fr)

---

Detailed Description

This file contains movies routines.

Prequengine: a Little Big Adventure engine

Copyright (C) 2008 Prequengine team
Copyright (C) 2002-2007 The TwinEngine team

This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
as published by the Free Software Foundation; either version 2
of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.

Definition in file filereader.h.

---

Define Documentation

#define BUFFER_SIZE   (2048*SECTORS_IN_BUFFER)

Buffer size

Definition at line 35 of file filereader.h.

Referenced by frfeed(), and frread().

#define SECTORS_IN_BUFFER   (3)

Number of sector in the buffer

Definition at line 33 of file filereader.h.

---

Function Documentation

void frclose

(

filereader *

fr

)

Close file

Parameters:

fr

filereader pointer

Definition at line 111 of file filereader.c.

References filereader::fd.

Referenced by hqr_entry_size(), and hqr_get_entry().

void frfeed

(

filereader *

fr

)

Feed buffer from file

Parameters:

fr

filereader pointer

Definition at line 29 of file filereader.c.

References filereader::buffer, BUFFER_SIZE, filereader::bufferPos, and filereader::fd.

Referenced by fropen(), frread(), and frseek().

int fropen	(	filereader *	fr,
		const char *	filename
	)

Open file

Parameters:

	fr	filereader pointer
	filename	file path

Returns:

true if file open and false if error occurred

Definition at line 95 of file filereader.c.

References filereader::currSector, filereader::fd, and frfeed().

Referenced by hqr_entry_size(), hqr_get_entry(), hqr_num_entries(), and play_fla_movie().

void frread	(	filereader *	fr,
		void *	destPtr,
		unsigned long int	size
	)

Read file

Parameters:

	fr	filereader pointer
	destPtr	content destination pointer
	size	size of read characters

Definition at line 39 of file filereader.c.

References filereader::buffer, BUFFER_SIZE, filereader::bufferPos, filereader::currSector, and frfeed().

Referenced by hqr_entry_size(), hqr_get_entry(), hqr_num_entries(), play_fla_movie(), and process_frame().

void frseek	(	filereader *	fr,
		unsigned long int	seekPosition
	)

Seek file

Parameters:

	fr	filereader pointer
	seekPosition	position to seek

Definition at line 78 of file filereader.c.

References filereader::bufferPos, filereader::currSector, filereader::fd, and frfeed().

Referenced by hqr_entry_size(), and hqr_get_entry().