osd.c

/*
Copyright 2005, 2006, 2007 Dennis van Weeren
Copyright 2008, 2009 Jakub Bednarski

This file is part of Minimig

Minimig 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 3 of the License, or
(at your option) any later version.

Minimig 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, see <http://www.gnu.org/licenses/>.

This is the Minimig OSD (on-screen-display) handler.

2012-02-09 - Split character rom out to separate header file, with upper 128 entries
             as rotated copies of the first 128 entries.  -- AMR

29-12-2006 - created
30-12-2006 - improved and simplified
-- JB --
2008-10-04 - ARM version
2008-10-26 - added cpu and floppy configuration functions
2008-12-31 - added enable HDD command
2009-02-03 - full keyboard support
2009-06-23 - hires OSD display
2009-08-23 - adapted ConfigIDE() - support for 2 hardfiles
*/

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

#include "osd.h"
#include "spi.h"

#include "logo.h"
#include "state.h"
#include "user_io.h"

extern unsigned char charfont[128][8];

// conversion table of Amiga keyboard scan codes to ASCII codes
const char keycode_table[128] =
{
      0,'1','2','3','4','5','6','7','8','9','0',  0,  0,  0,  0,  0,
    'Q','W','E','R','T','Y','U','I','O','P',  0,  0,  0,  0,  0,  0,
    'A','S','D','F','G','H','J','K','L',  0,  0,  0,  0,  0,  0,  0,
      0,'Z','X','C','V','B','N','M',  0,  0,  0,  0,  0,  0,  0,  0,
      0,  0,  0,  0,  0,  0,  0,  0,  0,  0,  0,  0,  0,  0,  0,  0,
      0,  0,  0,  0,  0,  0,  0,  0,  0,  0,  0,  0,  0,  0,  0,  0,
      0,  0,  0,  0,  0,  0,  0,  0,  0,  0,  0,  0,  0,  0,  0,  0,
      0,  0,  0,  0,  0,  0,  0,  0,  0,  0,  0,  0,  0,  0,  0,  0
};

struct star
{
	int x, y;
	int dx, dy;
};

struct star stars[64];

static char linebuffer[256];

static int quickrand()
{
	static int prev;
#ifndef MIST
	int r=*(volatile unsigned long *)0x80000c;
#else
	int r = GetRTTC();
#endif
	r^=(prev&0xc75a)<<4;
	r^=(prev&0x5a7c)>>(prev&7);
	prev=r;
	return(r);
}


void StarsInit()
{
	int i;
	int lines=OsdLines()*8 - 10;
	for(i=0;i<64;++i)
	{
		stars[i].x=(quickrand()%228)<<4;	// X centre
		stars[i].y=(quickrand()%(lines))<<4;	// Y centre
		stars[i].dx=-(quickrand()&7)-3;
		stars[i].dy=0;
	}
}

void StarsUpdate()
{
	int i;
	int lines=OsdLines()*8 - 10;
	for(i=0;i<64;++i)
	{
		stars[i].x+=stars[i].dx;
		stars[i].y+=stars[i].dy;
		if((stars[i].x<0)||(stars[i].x>(228<<4)) ||
			(stars[i].y<0)||(stars[i].y>(lines<<4)))
		{
			stars[i].x=228<<4;
			stars[i].y=(quickrand()%lines)<<4;
			stars[i].dx=-(quickrand()&7)-3;
			stars[i].dy=0;
		}
	}
}


// time delay after which file/dir name starts to scroll
#define SCROLL_DELAY 1000
#define SCROLL_DELAY2 10
#define SCROLL_DELAY3 50

static unsigned long scroll_offset=0; // file/dir name scrolling position
static unsigned long scroll_timer=0;  // file/dir name scrolling timer

extern char s[FF_LFN_BUF + 1];

static int arrow;
static unsigned char titlebuffer[128];

static void rotatechar(unsigned char *in,unsigned char *out)
{
	int a;
	int b;
	int c;
	for(b=0;b<8;++b)
	{
		a=0;
		for(c=0;c<8;++c)
		{
			a<<=1;
			a|=(in[c]>>b)&1;
		}
		out[b]=a;
	}		
}

void OsdSetTitle(char *s,int a)
{
	// Compose the title, condensing character gaps
	arrow=a;
	char zeros=0;
	int i=0,j=0;
	int outp=0;
	int bufsize = 8*OsdLines();
	while(1)
	{
		int c=s[i++];
		if(c && (outp<bufsize))
		{
			unsigned char *p = &charfont[c][0];
			for(j=0;j<8;++j)
			{
				unsigned char nc=*p++;
				if(nc)
				{
					zeros=0;
					titlebuffer[outp++]=nc;
				}
				else if(zeros==0)
				{
					titlebuffer[outp++]=0;
					zeros=1;
				}
				if(outp>(bufsize-1))
					break;
			}
		}
		else
			break;
	}
	for(i=outp;i<bufsize;++i)
	{
		titlebuffer[i]=0;
	}

	// Now centre it:
	int c=(bufsize-1-outp)/2;
	for(i=(bufsize-1-c);i>=0;--i)
	{
		titlebuffer[i+c]=titlebuffer[i];
	}
	for(i=0;i<c;++i)
		titlebuffer[i]=0;

	// Finally rotate it.
	for(i=0;i<bufsize;i+=8)
	{
		unsigned char tmp[8];
		rotatechar(&titlebuffer[i],tmp);
		for(c=0;c<8;++c)
		{
			titlebuffer[i+c]=tmp[c];
		}
	}
}

char OsdLines()
{
  if (user_io_core_type() == CORE_TYPE_8BIT && (user_io_get_core_features() & FEAT_BIGOSD))
    return 16;
  else
    return 8;
}

void OsdWrite(unsigned char n, char *s, unsigned char invert, unsigned char stipple)
{
  OsdWriteOffset(n, s, invert, stipple, 0);
}

// write a null-terminated string <s> to the OSD buffer starting at line <n>
void OsdWriteOffset(unsigned char n, char *s, unsigned char invert, unsigned char stipple,char offset)
{
  char *text = s;
  char arrowline[31];
  if(n==OsdLines()-1 && arrow) {
    text = arrowline;
    memset(arrowline, 32, sizeof(arrowline));
    memcpy(&arrowline, s, strnlen(s, sizeof(arrowline)));
    arrowline[30] = 0;
    if (arrow & OSD_ARROW_LEFT) {
      arrowline[0] = 0x10;
      arrowline[1] = 0x14;
    }
    if (arrow & OSD_ARROW_RIGHT) {
      arrowline[27] = 0x15;
      arrowline[28] = 0x11;
    }
  }
  OsdPrintText(n, text, 22, OSDLINELEN-3*8, 0, offset, invert, stipple);
}


void OsdDrawLogo(unsigned char n, char row,char superimpose) {
  unsigned short i;
  const unsigned char *p;
  int linelimit=OSDLINELEN;

  // select buffer and line to write to
  if(!minimig_v2())
    spi_osd_cmd_cont(MM1_OSDCMDWRITE | n);
  else
    spi_osd_cmd32_cont(OSD_CMD_OSD_WR, n);

  const unsigned char *lp;
  int bytes=sizeof(logodata[0]);
  int logoheight = (sizeof(logodata)/bytes);
  int startrow = (OsdLines()-2-logoheight)/2;
  if(row>=startrow+logoheight || row<startrow)
    lp=0;
  else
    lp=logodata[row-startrow];
  i = 0;
  // send all characters in string to OSD

  if(superimpose) {
    int j;
    memset(linebuffer, 0, sizeof(linebuffer));
    for (j=0; j<64; j++) {
      if(stars[j].y>>7 == n) linebuffer[stars[j].x>>4] |= (1<<((stars[j].y>>4) & 7));
    }
    char *bg = linebuffer;

    while (bytes) {
      if(i==0) {	// Render sidestripe
        p = &titlebuffer[(OsdLines()-1-n)*8];
        spi16(0xffff);
        for(j=0;j<8;j++) spi_n(255^*p++, 2);
        spi16(0xffff);
        spi16(0x0000);
        i += 22;
      }
      if(i>=linelimit) 
        break;
      if(lp)
        spi8(*lp++ | *bg++);
      else
        spi8(*bg++);
      --bytes;
      ++i;
    }
    for (; i < linelimit; i++) // clear end of line
      spi8(*bg++);
  } else {
    while (bytes) {
      if(i==0) { // Render sidestripe
        unsigned char b;
        p = &titlebuffer[(OsdLines()-1-n)*8];
        spi16(0xffff);
        for(b=0;b<8;b++) spi_n(255^*p++, 2);
        spi16(0xffff);
        spi16(0x0000);
        i += 22;
      }
      if(i>=linelimit)
        break;
      if(lp)
        spi8(*lp++);
      else
        spi8(0);
      --bytes;
      ++i;
    }
    for (; i < linelimit; i++) // clear end of line
      spi8(0);
  }
  // deselect OSD SPI device
  DisableOsd();
}


// write a null-terminated string <s> to the OSD buffer starting at line <n>
void OsdPrintText(unsigned char line, char *text, unsigned long start, unsigned long width, unsigned long xoffset, unsigned char yoffset, unsigned char invert, unsigned char stipple)
{
  // line : OSD line number (0-7)
  // text : pointer to null-terminated string
  // start : start position (in pixels)
  // width : printed text length in pixels
  // xoffset : scroll offset in pixels counting from the start of the string (0-7)
  // yoffset : first raster line of the text to display (0-7)
  // invert : invertion flag
  // stipple : disabled item flag

  const unsigned char *p;
  char c;
  int i,j;
  unsigned char stipplemask=0xff;

  if(stipple) {
    stipplemask=0x55;
    stipple=0xff;
  } else
    stipple=0;

  // select buffer and line to write to
  if(!minimig_v2())
    spi_osd_cmd_cont(MM1_OSDCMDWRITE | line);
  else 
    spi_osd_cmd32_cont(OSD_CMD_OSD_WR, line);

  if(invert)
    invert=0xff;

  p = &titlebuffer[(OsdLines()-1-line)*8];
  if(start>2) {
    spi16(0xffff);
    start-=2;
  }

  i=start>16 ? 16 : start;
  for(j=0;j<(i/2);++j)
    spi_n(255^*p++, 2);

  if(i&1)
    spi8(255^*p);
  start-=i;

  if(start>2) {
    spi16(0xffff);
    start-=2;
  }

  while (start--)
    spi8(0x00);

  if (xoffset) {
    width -= 8 - xoffset;
    p = &charfont[*text++][xoffset];
    for (; xoffset < 8; xoffset++)
      spi8(*p++^invert);
  }

  while (width > 8) {
    unsigned char b;
    c = *text;
    if(c)text++;
    p = &charfont[c][0];
    for(b=0;b<8;b++) {
      spi8(((*p++<<yoffset)&stipplemask)^invert);
      stipplemask^=stipple;
    }
    width -= 8;
  }

  if (width) {
    c = *text;
    if(c)text++;
    p = &charfont[c][0];
    while (width--) {
      spi8(((*p++<<yoffset)&stipplemask)^invert);
      stipplemask^=stipple;
    }
  }

  DisableOsd();
}

// clear OSD frame buffer
void OsdClear(void)
{
    // select buffer to write to
    if(!minimig_v2())
      spi_osd_cmd_cont(MM1_OSDCMDWRITE | 0x18);
    else
      spi_osd_cmd32_cont(OSD_CMD_OSD_WR, 0x18);

    // clear buffer
    spi_n(0x00, OSDLINELEN * OsdLines());

    // deselect OSD SPI device
    DisableOsd();
}

// enable displaying of OSD
void OsdEnable(unsigned char mode)
{
  user_io_osd_key_enable(mode & DISABLE_KEYBOARD);

  if(!minimig_v2())
    spi_osd_cmd(MM1_OSDCMDENABLE | (mode & DISABLE_KEYBOARD));
  else
    spi_osd_cmd8(OSD_CMD_OSD, 0x01 | (mode & DISABLE_KEYBOARD));
}

// disable displaying of OSD
void OsdDisable(void)
{
    user_io_osd_key_enable(0);

    if(!minimig_v2()) 
      spi_osd_cmd(MM1_OSDCMDDISABLE);
    else 
      spi_osd_cmd8(OSD_CMD_OSD, 0x00);
}

void OsdReset(unsigned char boot)
{
    if(minimig_v1())
      spi_osd_cmd(MM1_OSDCMDRST | (boot & 0x01));
    else {
      spi_osd_cmd8(OSD_CMD_RST, 0x01);
      spi_osd_cmd8(OSD_CMD_RST, 0x00);
    }
}

void MM1_ConfigFilter(unsigned char lores, unsigned char hires) {
  spi_osd_cmd(MM1_OSDCMDCFGFLT | ((hires & 0x03) << 2) | (lores & 0x03));
}

void ConfigVideo(unsigned char hires, unsigned char lores, unsigned char scanlines) {
  spi_osd_cmd8(OSD_CMD_VID, (((scanlines>>2)&0x03)<< 6) | ((hires & 0x03) << 4) | ((lores & 0x03)<<2) | (scanlines & 0x03) );
}

void ConfigMemory(unsigned char memory)
{
    if(minimig_v1()) {
      spi_osd_cmd(MM1_OSDCMDCFGMEM | (memory & 0x03));		//chip
      spi_osd_cmd(MM1_OSDCMDCFGMEM | 0x04 | ((memory>>2) & 0x03));	//slow
      spi_osd_cmd(MM1_OSDCMDCFGMEM | 0x08 | ((memory>>4) & 0x03));	//fast
    } else
      spi_osd_cmd8(OSD_CMD_MEM, memory);
}

void ConfigCPU(unsigned char cpu)
{
    if(minimig_v1())
      spi_osd_cmd(MM1_OSDCMDCFGCPU | (cpu & 0x03));		//CPU
    else 
      spi_osd_cmd8(OSD_CMD_CPU, cpu & 0x0f);
}

void ConfigChipset(unsigned char chipset)
{
    if(minimig_v1()) 
      spi_osd_cmd(MM1_OSDCMDCFGCHP | (chipset & 0x0F));
    else
      spi_osd_cmd8(OSD_CMD_CHIP, chipset & 0x1f);
}

void ConfigFloppy(unsigned char drives, unsigned char speed)
{
    if(minimig_v1())
      spi_osd_cmd(MM1_OSDCMDCFGFLP | ((drives & 0x03) << 2) | (speed & 0x03));
    else
      spi_osd_cmd8(OSD_CMD_FLP, ((drives & 0x03) << 2) | (speed & 0x03));
}

void MM1_ConfigScanlines(unsigned char scanlines)
{
    spi_osd_cmd(MM1_OSDCMDCFGSCL | (scanlines & 0x0F));
}

void ConfigIDE(unsigned char gayle, unsigned char master, unsigned char slave)
{
    if(minimig_v1())
      spi_osd_cmd(MM1_OSDCMDCFGIDE | (slave ? 4 : 0) | (master ? 2 : 0) | (gayle ? 1 : 0));
    else
      spi_osd_cmd8(OSD_CMD_HDD0 + ((gayle >> 1) << 2), (slave ? 4 : 0) | (master ? 2 : 0) | ((gayle & 0x01)));
}

void ConfigAutofire(unsigned char autofire)
{
    if(minimig_v1())
      spi_osd_cmd(MM1_OSDCMDAUTOFIRE | (autofire & 0x03));
    else
      spi_osd_cmd8(OSD_CMD_JOY, autofire & 0x0F);
}

void ConfigFeatures(unsigned char audiofiltermode, unsigned char powerledoffstate)
{
    if(!minimig_v1())
      spi_osd_cmd8(OSD_CMD_FEATURES, ((powerledoffstate & 0x01) << 2) | (audiofiltermode & 0x03));
}

static unsigned char disable_menu = 0;

// get key status
unsigned char OsdGetCtrl(void)
{
    static unsigned char c2;
    static unsigned long delay;
    static unsigned long repeat;
    static unsigned char repeat2;
    unsigned char c1,c;

    // minimig OSD is controlled by key codes from core 
    if(user_io_core_type() == CORE_TYPE_MINIMIG) {
      // send command and get current ctrl status
      EnableOsd();
      c1 = SPI(MM1_OSDCMDREAD);
      DisableOsd();
    }

    // minimig OSD is controlled by key codes from core 
    if(user_io_core_type() == CORE_TYPE_MINIMIG2) {
      // send command and get current ctrl status
      EnableOsd();
      c1 = SPI(OSD_CMD_READ);
      DisableOsd();
    }

    // mist/atari, archie and 8bit cores use local queue
    if((user_io_core_type() == CORE_TYPE_MIST) ||
       (user_io_core_type() == CORE_TYPE_MIST2) ||
       (user_io_core_type() == CORE_TYPE_ARCHIE) ||
       (user_io_core_type() == CORE_TYPE_8BIT))
      c1 = OsdKeyGet();

    // OsdKeyGet permanently returns the last key event. 

    // generate normal "key-pressed" event
    c = 0;
    if (c1 != c2)
       c = c1;

    c2 = c1;

    // inject a fake "MENU_KEY" if no menu is visible and the menu key is loaded
    if(!user_io_osd_is_visible() &&
       !strcmp(user_io_get_core_name(), "MENU"))
       c = KEY_MENU;

    // generate repeat "key-pressed" events
    if ((c1 & KEY_UPSTROKE) || (!c1))
        repeat = GetTimer(REPEATDELAY);
    else if (CheckTimer(repeat)) {
        repeat = GetTimer(REPEATRATE);
        if (c1 == KEY_UP || c1 == KEY_DOWN)
           c = c1;
        repeat2++;
        if (repeat2 == 2)
        {
            repeat2 = 0;
            if (c1 == KEY_PGUP || c1 == KEY_PGDN || c1 == KEY_LEFT || c1 == KEY_RIGHT || GetASCIIKey(c1))
                c = c1;
        }
    }

    // currently no key pressed
    if(!c) {
      static unsigned char last_but = 0;
        if(!disable_menu) {
          unsigned char but = CheckButton() || StateJoyGetMenuAny();
          if(!but && last_but) c = KEY_MENU;
          last_but = but;
        } else {
          last_but = 0;
        }
    }

    return(c);
}

void OsdDisableMenuButton(unsigned char disable)
{
    disable_menu = disable;
}

unsigned char GetASCIIKey(unsigned char keycode)
{
    if (keycode & KEY_UPSTROKE)
       return 0;

    return keycode_table[keycode & 0x7F];
}


void ScrollText(char n, const char *str, int len, int max_len, unsigned char invert, int len_offset)
{
// this function is called periodically when a string longer than the window is displayed.

    #define BLANKSPACE 10 // number of spaces between the end and start of repeated name

    long offset;
    if(!max_len)
        max_len=30;

    if (str && str[0] && CheckTimer(scroll_timer)) // scroll if long name and timer delay elapsed
    {
        scroll_timer = GetTimer(SCROLL_DELAY2); // reset scroll timer to repeat delay

        scroll_offset++; // increase scroll position (1 pixel unit)
        memset(s, ' ', 32); // clear buffer

        if(!len)
            len = strlen(str); // get name length

        if (len + len_offset > max_len) // scroll name if longer than display size
        {
            if (scroll_offset >= (len + BLANKSPACE) << 3) // reset scroll position if it exceeds predefined maximum
                scroll_offset = 0;

            offset = scroll_offset >> 3; // get new starting character of the name (scroll_offset is no longer in 2 pixel unit)

            len -= offset; // remaining number of characters in the name

            if(len>max_len)
                len=max_len;

            if (len > 0)
                strncpy(s, &str[offset], len); // copy name substring

            if (len < max_len - BLANKSPACE) // file name substring and blank space is shorter than display line size
                strncpy(s + len + BLANKSPACE, str, max_len - len - BLANKSPACE); // repeat the name after its end and predefined number of blank space

            OsdPrintText(n, s, 22, (max_len - 1) << 3, (scroll_offset & 0x7), 0, invert, 0); // OSD print function with pixel precision
        }
    }
}

void ScrollReset()
{
    scroll_timer = GetTimer(SCROLL_DELAY); // set timer to start name scrolling after predefined time delay
    scroll_offset = 0; // start scrolling from the start
}

/* the Atari core handles OSD keys competely inside the core */
static unsigned char osd_key;

void OsdKeySet(unsigned char c) {
  //  iprintf("OSD enqueue: %x\n", c);
  osd_key = c;
}

unsigned char OsdKeyGet() {
  return osd_key;
}

/*
   core currently loaded
   core name + version string (8bit) or
   filename(until fits into the buffer)
*/
static char lastcorename[65] = "CORE";
void OsdCoreNameSet(const char* str) {
	strncpy(lastcorename, str, sizeof(lastcorename));
	lastcorename[sizeof(lastcorename)-1] = 0;
}
char* OsdCoreName() {
	return lastcorename;
}