view src/adplug/core/cff.cxx @ 2008:b3002edfa3b9

Converted the last plugin to the new build system.

/*
  AdPlug - Replayer for many OPL2/OPL3 audio file formats.
  Copyright (C) 1999 - 2006 Simon Peter <[e-mail]>, et al.

  This library is free software; you can redistribute it and/or
  modify it under the terms of the GNU Lesser General Public
  License as published by the Free Software Foundation; either
  version 2.1 of the License, or (at your option) any later version.

  This library 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
  Lesser General Public License for more details.

  You should have received a copy of the GNU Lesser General Public
  License along with this library; if not, write to the Free Software
  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA

  cff.cpp - BoomTracker loader by Riven the Mage <[e-mail]>
*/
/*
  NOTE: Conversion of slides is not 100% accurate. Original volume slides
  have effect on carrier volume only. Also, original arpeggio, frequency & volume
  slides use previous effect data instead of current.
*/

#include <stdlib.h>

#include "cff.h"

/* -------- Public Methods -------------------------------- */

CPlayer *
CcffLoader::factory (Copl * newopl)
{
  return new CcffLoader (newopl);
}

bool
CcffLoader::load (VFSFile * fd, const CFileProvider & fp)
{
  binistream *f = fp.open (fd);
  if (!f)
    return false;
  const unsigned char conv_inst[11] = { 2, 1, 10, 9, 4, 3, 6, 5, 0, 8, 7 };
  const unsigned short conv_note[12] =
    { 0x16B, 0x181, 0x198, 0x1B0, 0x1CA, 0x1E5, 0x202, 0x220, 0x241, 0x263,
0x287, 0x2AE };

  int i, j, k, t = 0;

  // '<CUD-FM-File>' - signed ?
  f->readString (header.id, 16);
  header.version = f->readInt (1);
  header.size = f->readInt (2);
  header.packed = f->readInt (1);
  f->readString ((char *) header.reserved, 12);
  if (memcmp (header.id, "<CUD-FM-File>" "\x1A\xDE\xE0", 16))
  {
    fp.close (f);
    return false;
  }

  unsigned char *module = new unsigned char[0x10000];

  // packed ?
  if (header.packed)
  {
    cff_unpacker *unpacker = new cff_unpacker;

    unsigned char *packed_module = new unsigned char[header.size + 4];

    memset (packed_module, 0, header.size + 4);

    f->readString ((char *) packed_module, header.size);
    fp.close (f);

    if (!unpacker->unpack (packed_module, module))
    {
      delete unpacker;
      delete packed_module;
      delete module;
      return false;
    }

    delete unpacker;
    delete packed_module;

    if (memcmp (&module[0x5E1], "CUD-FM-File - SEND A POSTCARD -", 31))
    {
      delete module;
      return false;
    }
  }
  else
  {
    f->readString ((char *) module, header.size);
    fp.close (f);
  }

  // init CmodPlayer
  realloc_instruments (47);
  realloc_order (64);
  realloc_patterns (36, 64, 9);
  init_notetable (conv_note);
  init_trackord ();

  // load instruments
  for (i = 0; i < 47; i++)
  {
    memcpy (&instruments[i], &module[i * 32], sizeof (cff_instrument));

    for (j = 0; j < 11; j++)
      inst[i].data[conv_inst[j]] = instruments[i].data[j];

    instruments[i].name[20] = 0;
  }

  // number of patterns
  nop = module[0x5E0];

  // load title & author
  memcpy (song_title, &module[0x614], 20);
  memcpy (song_author, &module[0x600], 20);

  // load order
  memcpy (order, &module[0x628], 64);

  // load tracks
  for (i = 0; i < nop; i++)
  {
    unsigned char old_event_byte2[9];

    memset (old_event_byte2, 0, 9);

    for (j = 0; j < 9; j++)
    {
      for (k = 0; k < 64; k++)
      {
        cff_event *event =
          (cff_event *) & module[0x669 + ((i * 64 + k) * 9 + j) * 3];

        // convert note
        if (event->byte0 == 0x6D)
          tracks[t][k].note = 127;
        else if (event->byte0)
          tracks[t][k].note = event->byte0;

        if (event->byte2)
          old_event_byte2[j] = event->byte2;

        // convert effect
        switch (event->byte1)
        {
        case 'I':              // set instrument
          tracks[t][k].inst = event->byte2 + 1;
          tracks[t][k].param1 = tracks[t][k].param2 = 0;
          break;

        case 'H':              // set tempo
          tracks[t][k].command = 7;
          if (event->byte2 < 16)
          {
            tracks[t][k].param1 = 0x07;
            tracks[t][k].param2 = 0x0D;
          }
          break;

        case 'A':              // set speed
          tracks[t][k].command = 19;
          tracks[t][k].param1 = event->byte2 >> 4;
          tracks[t][k].param2 = event->byte2 & 15;
          break;

        case 'L':              // pattern break
          tracks[t][k].command = 13;
          tracks[t][k].param1 = event->byte2 >> 4;
          tracks[t][k].param2 = event->byte2 & 15;
          break;

        case 'K':              // order jump
          tracks[t][k].command = 11;
          tracks[t][k].param1 = event->byte2 >> 4;
          tracks[t][k].param2 = event->byte2 & 15;
          break;

        case 'M':              // set vibrato/tremolo
          tracks[t][k].command = 27;
          tracks[t][k].param1 = event->byte2 >> 4;
          tracks[t][k].param2 = event->byte2 & 15;
          break;

        case 'C':              // set modulator volume
          tracks[t][k].command = 21;
          tracks[t][k].param1 = (0x3F - event->byte2) >> 4;
          tracks[t][k].param2 = (0x3F - event->byte2) & 15;
          break;

        case 'G':              // set carrier volume
          tracks[t][k].command = 22;
          tracks[t][k].param1 = (0x3F - event->byte2) >> 4;
          tracks[t][k].param2 = (0x3F - event->byte2) & 15;
          break;

        case 'B':              // set carrier waveform
          tracks[t][k].command = 25;
          tracks[t][k].param1 = event->byte2;
          tracks[t][k].param2 = 0x0F;
          break;

        case 'E':              // fine frequency slide down
          tracks[t][k].command = 24;
          tracks[t][k].param1 = old_event_byte2[j] >> 4;
          tracks[t][k].param2 = old_event_byte2[j] & 15;
          break;

        case 'F':              // fine frequency slide up
          tracks[t][k].command = 23;
          tracks[t][k].param1 = old_event_byte2[j] >> 4;
          tracks[t][k].param2 = old_event_byte2[j] & 15;
          break;

        case 'D':              // fine volume slide
          tracks[t][k].command = 14;
          if (old_event_byte2[j] & 15)
          {
            // slide down
            tracks[t][k].param1 = 5;
            tracks[t][k].param2 = old_event_byte2[j] & 15;
          }
          else
          {
            // slide up
            tracks[t][k].param1 = 4;
            tracks[t][k].param2 = old_event_byte2[j] >> 4;
          }
          break;

        case 'J':              // arpeggio
          tracks[t][k].param1 = old_event_byte2[j] >> 4;
          tracks[t][k].param2 = old_event_byte2[j] & 15;
          break;
        }
      }

      t++;
    }
  }

  delete[]module;

  // order loop
  restartpos = 0;

  // order length
  for (i = 0; i < 64; i++)
  {
    if (order[i] >= 0x80)
    {
      length = i;
      break;
    }
  }

  // default tempo
  bpm = 0x7D;

  rewind (0);

  return true;
}

void
CcffLoader::rewind (int subsong)
{
  CmodPlayer::rewind (subsong);

  // default instruments
  for (int i = 0; i < 9; i++)
  {
    channel[i].inst = i;

    channel[i].vol1 = 63 - (inst[i].data[10] & 63);
    channel[i].vol2 = 63 - (inst[i].data[9] & 63);
  }
}

std::string CcffLoader::gettype ()
{
  if (header.packed)
    return std::string ("BoomTracker 4, packed");
  else
    return std::string ("BoomTracker 4");
}

std::string CcffLoader::gettitle ()
{
  return std::string (song_title, 20);
}

std::string CcffLoader::getauthor ()
{
  return std::string (song_author, 20);
}

std::string CcffLoader::getinstrument (unsigned int n)
{
  return std::string (instruments[n].name);
}

unsigned int
CcffLoader::getinstruments ()
{
  return 47;
}

/* -------- Private Methods ------------------------------- */

#ifdef _WIN32
#pragma warning(disable:4244)
#pragma warning(disable:4018)
#endif

/*
  Lempel-Ziv-Tyr ;-)
*/
long
CcffLoader::cff_unpacker::unpack (unsigned char *ibuf, unsigned char *obuf)
{
  if (memcmp (ibuf, "YsComp" "\x07" "CUD1997" "\x1A\x04", 16))
    return 0;

  input = ibuf + 16;
  output = obuf;

  output_length = 0;

  heap = (unsigned char *) malloc (0x10000);
  dictionary = (unsigned char **) malloc (sizeof (unsigned char *) * 0x8000);

  memset (heap, 0, 0x10000);
  memset (dictionary, 0, 0x8000);

  cleanup ();
  if (!startup ())
    goto out;

  // LZW
  while (1)
  {
    new_code = get_code ();

    // 0x00: end of data
    if (new_code == 0)
      break;

    // 0x01: end of block
    if (new_code == 1)
    {
      cleanup ();
      if (!startup ())
        goto out;

      continue;
    }

    // 0x02: expand code length
    if (new_code == 2)
    {
      code_length++;

      continue;
    }

    // 0x03: RLE
    if (new_code == 3)
    {
      unsigned char
        old_code_length = code_length;

      code_length = 2;

      unsigned char
        repeat_length = get_code () + 1;

      code_length = 4 << get_code ();

      unsigned long
        repeat_counter = get_code ();

      if (output_length + repeat_counter * repeat_length > 0x10000)
      {
        output_length = 0;
        goto out;
      }

      for (unsigned int i = 0; i < repeat_counter * repeat_length; i++)
        output[output_length++] = output[output_length - repeat_length];

      code_length = old_code_length;

      if (!startup ())
        goto out;

      continue;
    }

    if (new_code >= (0x104 + dictionary_length))
    {
      // dictionary <- old.code.string + old.code.char
      the_string[++the_string[0]] = the_string[1];
    }
    else
    {
      // dictionary <- old.code.string + new.code.char
      unsigned char
        temp_string[256];

      translate_code (new_code, temp_string);

      the_string[++the_string[0]] = temp_string[1];
    }

    expand_dictionary (the_string);

    // output <- new.code.string
    translate_code (new_code, the_string);

    if (output_length + the_string[0] > 0x10000)
    {
      output_length = 0;
      goto out;
    }

    for (int i = 0; i < the_string[0]; i++)
      output[output_length++] = the_string[i + 1];

    old_code = new_code;
  }

out:
  free (heap);
  free (dictionary);
  return output_length;
}

unsigned long
CcffLoader::cff_unpacker::get_code ()
{
  unsigned long
    code;

  while (bits_left < code_length)
  {
    bits_buffer |= ((*input++) << bits_left);
    bits_left += 8;
  }

  code = bits_buffer & ((1 << code_length) - 1);

  bits_buffer >>= code_length;
  bits_left -= code_length;

  return code;
}

void
CcffLoader::cff_unpacker::translate_code (unsigned long code,
                                          unsigned char *string)
{
  unsigned char
    translated_string[256];

  if (code >= 0x104)
  {
    memcpy (translated_string, dictionary[code - 0x104],
            (*(dictionary[code - 0x104])) + 1);
  }
  else
  {
    translated_string[0] = 1;
    translated_string[1] = (code - 4) & 0xFF;
  }

  memcpy (string, translated_string, 256);
}

void
CcffLoader::cff_unpacker::cleanup ()
{
  code_length = 9;

  bits_buffer = 0;
  bits_left = 0;

  heap_length = 0;
  dictionary_length = 0;
}

int
CcffLoader::cff_unpacker::startup ()
{
  old_code = get_code ();

  translate_code (old_code, the_string);

  if (output_length + the_string[0] > 0x10000)
  {
    output_length = 0;
    return 0;
  }

  for (int i = 0; i < the_string[0]; i++)
    output[output_length++] = the_string[i + 1];

  return 1;
}

void
CcffLoader::cff_unpacker::expand_dictionary (unsigned char *string)
{
  if (string[0] >= 0xF0)
    return;

  memcpy (&heap[heap_length], string, string[0] + 1);

  dictionary[dictionary_length] = &heap[heap_length];

  dictionary_length++;

  heap_length += (string[0] + 1);
}

#ifdef _WIN32
#pragma warning(default:4244)
#pragma warning(default:4018)
#endif