// ----------------------------------------------------------------------------
//   ___  ___  ___  ___       ___  ____  ___  _  _
//  /__/ /__/ /  / /__  /__/ /__    /   /_   / |/ /
// /    / \  /__/ ___/ ___/ ___/   /   /__  /    /  emulator
//
// ----------------------------------------------------------------------------
// Copyright 2005 Greg Stanton
// 
// 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., 675 Mass Ave, Cambridge, MA 02139, USA.
// ----------------------------------------------------------------------------
// Cartridge.h
// ----------------------------------------------------------------------------
#ifndef CARTRIDGE_H
#define CARTRIDGE_H

#include <stdio.h>
#include <string.h>
#include "Equates.h"
#include "Memory.h"
#include "Hash.h"
#include "Pokey.h"

#include "shared.h"

#define MAX_CART_SIZE (1024 * 1024) // 1MB Cart is HUGE!

extern u8  use_composite_filtering;
extern u8  bios_show_counter;
extern u8  bios_available;

#define CARTRIDGE_CONTROLLER_NONE        0
#define CARTRIDGE_CONTROLLER_JOYSTICK    1
#define CARTRIDGE_CONTROLLER_LIGHTGUN    2
#define CARTRIDGE_CONTROLLER_PADDLES     3
#define CARTRIDGE_CONTROLLER_TWIN_STICKS 4
#define CARTRIDGE_CONTROLLER_SOTA        5
#define CARTRIDGE_CONTROLLER_SNES2ATARI  6

#define JOY     CARTRIDGE_CONTROLLER_JOYSTICK
#define LGN     CARTRIDGE_CONTROLLER_LIGHTGUN
#define PAD     CARTRIDGE_CONTROLLER_PADDLES
#define TWIN    CARTRIDGE_CONTROLLER_TWIN_STICKS
#define SOTA    CARTRIDGE_CONTROLLER_SOTA
#define SNES    CARTRIDGE_CONTROLLER_SNES2ATARI

#define CARTRIDGE_CYCLE_STEALING_MASK   0x01
#define CARTRIDGE_WSYNC_MASK            0x02

#define POKEY_NONE                      0
#define POKEY_AT_4000                   1
#define POKEY_AT_450                    2
#define POKEY_AT_800                    3

#define FRAMESKIP_DISABLE               0
#define FRAMESKIP_MEDIUM                1
#define FRAMESKIP_AGGRESSIVE            2

#define HSC_YES                         true
#define HSC_NO                          false

#define NTSC                            0  
#define PAL                             1

#define STEAL_CYCLE                     true
#define NO_STEALING                     false

#define USES_WSYNC                      true
#define SKIP_WSYNC                      false

#define CARTRIDGE_TYPE_NORMAL           0
#define CARTRIDGE_TYPE_SUPERCART        1
#define CARTRIDGE_TYPE_SUPERCART_LARGE  2
#define CARTRIDGE_TYPE_SUPERCART_RAM    3
#define CARTRIDGE_TYPE_SUPERCART_ROM    4
#define CARTRIDGE_TYPE_SUPERCART_RAMX2  5
#define CARTRIDGE_TYPE_ABSOLUTE         6
#define CARTRIDGE_TYPE_ACTIVISION       7
#define CARTRIDGE_TYPE_FRACTALUS        8
#define CARTRIDGE_TYPE_FLAT_WITH_RAM    9
#define CARTRIDGE_TYPE_BANKSETS         10
#define CARTRIDGE_TYPE_BANKSETS_RAM     11
#define CARTRIDGE_TYPE_BANKSETS_HALTRAM 12

#define CT_NORMAL       CARTRIDGE_TYPE_NORMAL
#define CT_SUPCAR       CARTRIDGE_TYPE_SUPERCART
#define CT_SUPLRG       CARTRIDGE_TYPE_SUPERCART_LARGE
#define CT_SUPRAM       CARTRIDGE_TYPE_SUPERCART_RAM
#define CT_SUPRAMX2     CARTRIDGE_TYPE_SUPERCART_RAMX2
#define CT_SUPROM       CARTRIDGE_TYPE_SUPERCART_ROM
#define CT_ABSOLU       CARTRIDGE_TYPE_ABSOLUTE
#define CT_ACTVIS       CARTRIDGE_TYPE_ACTIVISION
#define CT_FRACTALUS    CARTRIDGE_TYPE_FRACTALUS
#define CT_FLATWRAM     CARTRIDGE_TYPE_FLAT_WITH_RAM
#define CT_BANKSETS     CARTRIDGE_TYPE_BANKSETS
#define CT_BANKSRAM     CARTRIDGE_TYPE_BANKSETS_RAM
#define CT_BANKSHALT    CARTRIDGE_TYPE_BANKSETS_HALTRAM

extern bool cartridge_Load(char* filename);
extern void cartridge_Store( );
extern void cartridge_Write(word address, byte data);
extern bool cartridge_IsLoaded( );
extern void cartridge_Release( );
extern void bios_check_and_load(void);
extern void bios_Store(void);
extern char cartridge_title[256];
extern byte cartridge_digest[256];
extern char cartridge_filename[256];

#endif