src/lib/16_vrs.h

   1 /* Project 16 Source Code~
   2  * Copyright (C) 2012-2016 sparky4 & pngwen & andrius4669 & joncampbell123 & yakui-lover
   3  *
   4  * This file is part of Project 16.
   5  *
   6  * Project 16 is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 3 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * Project 16 is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program.  If not, see <http://www.gnu.org/licenses/>, or
  18  * write to the Free Software Foundation, Inc., 51 Franklin Street,
  19  * Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  */
  22 #ifndef __16_VRS__
  23 #define __16_VRS__
  24
  25 #include "src/lib/16_head.h"
  26 #include "src/lib/modex16.h"
  27 //#include <hw/cpu/cpu.h>
  28 //#include <hw/dos/dos.h>
  29 //#include <hw/vga/vga.h>
  30
  31 // Container for .vrs files loaded in memory with useful info
  32 // Includes:
  33 // + size of the .vrs blob in memory
  34 // + pointer to the blob/vrs header
  35 // + id of the curent (shown) animation
  36 // + id of the first sprite of the curret animation (supplementary)
  37 // + id of the current (shown) sprite
  38
  39 struct vrs_container{
  40         dword size;
  41         union{
  42                 byte *buffer;
  43                 struct vrs_header *vrs_hdr;
  44         };
  45         uint16_t anchor_sprite_id;
  46         uint16_t current_sprite_id;
  47 };
  48
  49 // Container for .vrl files loaded in memory with useful info
  50 // Includes:
  51 // + size of the .vrl blob in memory
  52 // + pointer to the blob/vrl header
  53 struct vrl_container{
  54         dword size;
  55         union{
  56                 byte *buffer;
  57                 struct vrl1_vgax_header *vrl_header;
  58         };
  59 };
  60
  61 // Read .vrs file into memory
  62 // In:
  63 // + char *filename - name of the file to load
  64 // + struct vrs_container *vrs_cont - pointer to the vrs_container
  65 // to load the file into
  66 // Out:
  67 // + int - 0 on succes, 1 on failure
  68 int read_vrs(char *filename, struct vrs_container *vrs_cont);
  69
  70 // Seek and return a specified .vrl blob from .vrs blob in memory
  71 // In:
  72 // + struct vrs_container *vrs_cont - pointer to the vrs_container
  73 // with a loaded .vrs file
  74 // + uint16_t id - id of the vrl to retrive
  75 // Out:
  76 // struct vrl_container* - a pointer to a vrl_container with a pointer
  77 // to the requested .vrl blob
  78 struct vrl_container* get_vrl_by_id(struct vrs_container *vrs_cont, uint16_t id);
  79
  80 #endif