/*
 * tape.h - Tape unit emulation.
 *
 * Written by
 *  Jouko Valta <jopi@stekt.oulu.fi>
 *  Andreas Boose <viceteam@t-online.de>
 *
 * This file is part of VICE, the Versatile Commodore Emulator.
 * See README for copyright notice.
 *
 *  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.
 *
 */

#ifndef VICE_TAPE_H
#define VICE_TAPE_H

#include <stdio.h>

#include "types.h"


#define TAPE_TYPE_T64 0
#define TAPE_TYPE_TAP 1

#define TAPE_ENCODING_NONE      0
#define TAPE_ENCODING_CBM       1
#define TAPE_ENCODING_TURBOTAPE 2

/* Note: PETs and CBM2 machines use (only) type 1, but they always load absolute anyway */
#define TAPE_CAS_TYPE_BAS           1 /* Relocatable Program (loaded to basic start, SAVE "",1,0) */
#define TAPE_CAS_TYPE_DATA_BLOCK    2 /* Data Block (SEQ) */
#define TAPE_CAS_TYPE_PRG           3 /* Binary Program (absolute load, SAVE "",1,1 (VIC-20 and later)) */
#define TAPE_CAS_TYPE_DATA          4 /* Data File Header (SEQ) */
#define TAPE_CAS_TYPE_EOF           5 /* End of Tape marker (SAVE "",1,n+2) */

#define TAPE_BEHAVIOUR_NORMAL 0 /* tape interrupt is falling-edge triggered, normal tape blocks end with a long and a short pulse */
#define TAPE_BEHAVIOUR_C16    1 /* tape senses both falling edges and rising edges, normal tape blocks end with a medium and a short pulse */

struct trap_s;

struct tape_image_s {
    char *name;
    unsigned int read_only;
    unsigned int type;
    void *data;
};
typedef struct tape_image_s tape_image_t;

struct tape_init_s {
    uint16_t buffer_pointer_addr;
    uint16_t st_addr;
    uint16_t verify_flag_addr;
    uint16_t irqtmp;
    int irqval;
    uint16_t stal_addr;
    uint16_t eal_addr;
    uint16_t kbd_buf_addr;
    uint16_t kbd_buf_pending_addr;
    const struct trap_s *trap_list;
    int pulse_short_min;
    int pulse_short_max;
    int pulse_middle_min;
    int pulse_middle_max;
    int pulse_long_min;
    int pulse_long_max;
};
typedef struct tape_init_s tape_init_t;

struct tape_file_record_s {
    uint8_t name[17];
    uint8_t type, encoding;
    uint16_t start_addr;
    uint16_t end_addr;
};
typedef struct tape_file_record_s tape_file_record_t;


extern tape_image_t *tape_image_dev[];

int tape_init(const tape_init_t *init);
int tape_reinit(const tape_init_t *init);
void tape_shutdown(void);
int tape_deinstall(void);
void tape_get_header(tape_image_t *tape_image, uint8_t *name);
int tape_find_header_trap(void);
int tape_receive_trap(void);
int tape_find_header_trap_plus4(void);
int tape_receive_trap_plus4(void);
const char *tape_get_file_name(int port);
int tape_tap_attached(int port);

void tape_traps_install(void);
void tape_traps_deinstall(void);

tape_file_record_t *tape_get_current_file_record(tape_image_t *tape_image);
int tape_seek_start(tape_image_t *tape_image);
int tape_seek_to_file(tape_image_t *tape_image, unsigned int file_number);
int tape_seek_to_next_file(tape_image_t *tape_image, unsigned int allow_rewind);
int tape_seek_to_offset(tape_image_t *tape_image, unsigned long offset);
unsigned long tape_get_offset(tape_image_t *tape_image);
int tape_read(tape_image_t *tape_image, uint8_t *buf, size_t size);

int tape_internal_close_tape_image(tape_image_t *tape_image);
tape_image_t *tape_internal_open_tape_image(const char *name, unsigned int read_only);

/* External tape image interface.  */
int tape_image_detach(unsigned int unit);
void tape_image_detach_all(void);
int tape_image_detach_internal(unsigned int unit);
int tape_image_attach(unsigned int unit, const char *name);
int tape_image_open(tape_image_t *tape_image);
int tape_image_close(tape_image_t *tape_image);
int tape_image_create(const char *name, unsigned int type);
void tape_image_event_playback(unsigned int unit, const char *filename);

#endif