Extrayendo bytes de nuestro recurso

El método read extraerá bytes de nuestro archivo o buffer de memoria, en el caso de ser un archivo convencional nuestros métodos serán indirecciones a los método homónimos de la clase ifstream (el precio que debemos pagar por la transparencia), pero si no lo es se comportará como si lo fuera para el resto del programa ¡y esto es muy bueno!. Veamos el flujo:

Figura 2. El flujo del método read

Analizando el flujo del método read, podemos apreciar que existe una división en dos partes: si hemos abierto un archivo convencional o si hemos abierto un archivo comprimido.

La idea aquí es manejar un buffer de memoria como si fuese un stream, para esto requerimos mantener mediante un cursor (una propiedad del tipo número entero) que nos indique en que parte del “archivo” estamos situados. De este modo cuando copiemos la información de un buffer a otro, lo haremos relativamente al cursor, es decir, en función de donde estemos parados dentro de nuestro buffer.
A esto debemos sumarle la verificación de no pasarnos en la lectura de nuestro buffer de memoria, ya que si lo hacemos podríamos generar un error de violación de acceso, tras lo cual nuestro programa se cerraría abruptamente. Es decir, si nuestro buffer es de 34 bytes y el usuario nos solicita leer 64 bytes, entonces deberemos leer el máximo e informarle (mediante el valor de retorno de la función) que hemos leído menos información de la solicitada.

Luego, la verificación del “end of file” (eof) para nuestro buffer de memoria será simplemente verificar si el cursor posee un valor inferior al tamaño total del buffer.

La implementación del seek, respecto al buffer de memoria, consiste simplemente en realizar cuentas con la propiedad cursor verificando siempre dejarla en valores válidos (entre cero y el tamaño máximo del archivo).

Los métodos especiales

Finalmente agregaremos algunos métodos más a nuestra clase ifstreamrar que nos serán muy útiles pero sólo tendrán sentido cuando estemos hablando de recursos empaquetados.

. getFirstElement
. getNextElement

Estos métodos nos permitirán inspeccionar el contenido de un archivo empaquetado, es decir, mirar los archivos que posee comprimidos en su interior. Los prototipos de ambas funciones son iguales:

bool getFirstElement(char * pszPackFilename, char * pszElementName, int iMaxElementNameLength, unsigned long & ulPackedSize, unsigned long & ulUnPackedSize);

bool getNextElement(char * pszPackFilename, char * pszElementName, int iMaxElementNameLength, unsigned long & ulPackedSize, unsigned long & ulUnPackedSize);

pszPackFilename : Nombre del archivo empaquetado (entrada)
pszElementName : Nombre del elemento primero o siguiente dentro del archivo empaquetado (salida)
iMaxElementNameLength : Tamaño total del buffer pasado como parámetro para que el método copie el nombre del elemento (entrada)
ulPackedSize : Tamaño en bytes del elemento comprimido (salida)
ulUnPackedSize : Tamaño en bytes del elemento sin comprimir (salida)

Como utilizar nuestra clase ifstreamrar

Veamos tres casos típicos de uso de nuestra flamante clase.

Abrir un archivo convencional o recurso comprimido

En este primer caso haremos uso de la facilidad de transparencia que adicional la clase ifstreamrar a nuestro proyecto. Intentaremos abrir un recurso de nuestro sistema sin saber necesariamente si el mismo se encuentra comprimido o no.

Para esto bastarán las siguientes líneas de código:


| char * pszBuf = NULL;
| // Abro el recurso
| if (ifs.open("./res/archivo_prueba_1.txt"))
| {
| // Dimensiono el buffer en donde copiaré los datos
| // descomprimidos
| pszBuf = new char[ifs.getSize()];
|
| // Obtengo el contenido del archivo
| ifs.read(pszBuf, ifs.getSize());
|
| // Cierro el recurso
| ifs.close();
| }
| else
| cout << "No pudo abrirse el recurso" << endl;


En el listado anterior utilizo sólo tres métodos de mi clase:

open: Para abrir el empaquetado o el archivo.
read: Para leer los datos del archivo abierto o del item perteneciente al empaquetado.
close: Para cerrar el empaquetado o el archivo.

Obtener el listado de elementos de un empaquetado

Para obtener el listado del contenido de elementos comprimidos dentro de un empaquetado utilizaremos los métodos getFirstResource y getNextResource del siguiente modo:


| char szElementName[512];
| unsigned long ulPackedSize;
| unsigned long ulUnpackedSize;
| bool bRes = ifs.getFirstResource("./res.rar", szElementName, 512, ulPackedSize, ulUnpackedSize);
|
| while (bRes)
| {
| // Muestro el contenido de un elemento a pantalla
| cout << szElementName << " (packed: " << ulPackedSize << ", unpacked: " << ulUnpackedSize << ")" << endl;
|
| // Tomo el siguiente elemento
| bRes = ifs.getNextResource("./res.rar", szElementName, 512, ulPackedSize, ulUnpackedSize);
| }


Invocamos una vez getFirstResource y si el valor de retorno es verdadero ingresamos dentro de un bucle donde el corte de control se encuentra dado por el valor de retorno del método getNextResource, que es invocado en la última línea del bucle, tarde o temprano el listado llegará a su fin y este método nos retornará falso.

De cada las propiedades de cada elemento, el par de métodos retorna: nombre, tamaño de elemento comprimido y tamaño del elemento sin comprimir (de estas dos últimas propiedades se puede calcular la relación de compresión).

Empaquetados con contraseña

El último caso de uso de un empaquetado es una variedad del primero, simplemente agregamos una contraseña para tornar un poquito más difícil la tarea de algún curioso. Se basa en utilizar un segundo parámetro del método open que está declarado como opcional y es la contraseña que se utilizará para abrir el empaquetado.


| // …
| if (ifs.open("./res_passwd/archivo_prueba_1.txt", "code"))
| // …


Otras librerías de compresión

Conclusiones

Las razones por las cuales podríamos desear incorporar esta facilidad a nuestros juegos son variadas: podríamos querer ocultar los archivos utilizados para evitar su modificación (ej: archivos del tipo bmp, jpg, wav, mid, txt, etc.), podríamos querer disminuir el tamaño total de nuestra aplicación (¡hasta un 80%!), podríamos querer facilitar la distribución de nuestra aplicación (distribución comprimir sin requerir instalación), etc.

Ahora sólo resta que experimentes un poco y agregues esta característica a tu próximo juego.

~fuzzyLogic

Pages: 1 2 3

Comentarios (2)