Add player for A2M (versions 1-14) and A2T (versions 1-14) by dmitrysmagin · Pull Request #207 · adplug/adplug

dmitrysmagin · 2024-02-26T07:40:35Z

Hi.
After years of converting FreePascal to C I was able to commit this code to adplug...

This is a direct translation of the player routine from the sources of the Adlib Tracker 2 (http://adlibtracker.net/). A2M and tiny modules A2T are supported (versions 1 - 14).

However, this player doesn't replace the original a2m.cpp, but picks up all modules that a2m.cpp can't handle.
Ideally, I'd like to remove old a2m.cpp in future since it doesn't support some effects and panning even for versions 1-8.

Now about packers:

depack.c
https://ibsensoftware.com/products_aPLib.html
https://ibsensoftware.com/files/aPLib-1.1.1.zip

sixpack.c
https://www.sac.sk/download/pack/ddjcompr.zip
https://github.com/70MM13/Step5Archive/blob/main/resources/sixpack/sixpack.c

unlzh.c
http://fileformats.archiveteam.org/wiki/Ar_(Haruhiko_Okumura)
http://cd.textfiles.com/sourcecode/msdos/arc_lbr/ar002.zip

unlzw.c and unlzss.c
Those unpackers were written in hand-optimized assembly in Adlib Tracker 2, so I did
a backward conversion to C.
It seems that they are customized and don't correspond to any existing C implementation.

I've left the names 'depack.c' and 'sixpack.c' because those are original names used by their authors. Note that the old 0.26 algo for aPlib is used which is incompatible with the recent aPlib.
As for 'unlzh.c', it's a combination of multiple original files with some custom tweaking which might make the algo incompatible with the original lzh.
All original copyrights and license details are kept intact along with some notes from the authors.

Yes, the author of Adlib Tracker 2 is notoriously known for using a new pack/unpack routine for every new a2m version...

UPDATE 2024-03-06: Added unlzw.c and unlzwss.c unpackers.

dmitrysmagin · 2024-03-14T10:54:19Z

@mywave82, @Malvineous ?

dmitrysmagin · 2024-04-03T12:49:12Z

@mywave82, @Malvineous ?

mywave82 · 2024-04-03T20:13:20Z

Sorry for slow response, been extra busy last months.

CI currently does not compile, so that needs to be resolved.

depack.c: from readme.txt:

aPLib is freeware. If you use aPLib in a product, an acknowledgement would be
appreciated, e.g. by adding something like the following to the documentation:

    This product uses the aPLib compression library,
    Copyright (c) 1998-2014 Joergen Ibsen, All Rights Reserved.
    For more information, please visit: http://www.ibsensoftware.com/

You may not redistribute aPLib without all of the files.

Probably nice to reach out to the author, since we only use one of the files.

sixpack.c: no special copyright requirement present, published as entry in a magazine competition.

unlzh.c: no special copyright requirement present,

dmitrysmagin · 2024-04-05T10:56:05Z

I've sent a message to contact@ibsensoftware.com asking for permission to use depack.c as-is.
Let's hope the author is checking his mail regularly.

jibsen · 2024-04-10T17:16:30Z

Thanks for taking the time to reach out, you are welcome to use the aPLib decompression code here.

dmitrysmagin · 2024-04-15T13:20:07Z

Thanks!
@mywave82 are we ok now?
sixpack.c seems to be written 35 years ago and is already used in older player a2p.cpp without much modifications,
unlzh.c is public domain too and ~35 years as well, so
I don't see problems with merging new a2m-v2.cpp.

mywave82 · 2024-04-15T19:08:58Z

Thanks! @mywave82 are we ok now? sixpack.c seems to be written 35 years ago and is already used in older player a2p.cpp without much modifications, unlzh.c is public domain too and ~35 years as well, so I don't see problems with merging new a2m-v2.cpp.

Still need to fix the CI that fails.

Enet4

I figured I'd leave some comments on this PR, as I am interested in this A2M loader and I'm seeing that it might get further traction in the near future. Can't speak much about the errors in CI, as I'm not very familiar with the full project.

- add a2m-v2 impl - replace A2M loader in main application - add the necessary C dependencies - tweak CMakeLists to include dependencies and compile C code Code adapted from adplug/adplug#207

dmitrysmagin · 2024-05-02T07:59:19Z

Now using static_assert() everywhere, and dropped redundant one.
Extra benefit -- static_assert() is parsed by code editors and might be highlighted in case of assert failing.

.ref files are stored in testref directory, not testmus

…plicating all the code.

…ich can guard against this.

…flow in playertest, most of them had problem in stresstest.

dmitrysmagin · 2024-05-04T16:31:45Z

@mywave82 , thanks for you patch, I was about to make smth very similar. I'll see if it can be improved to look more elegant...

mywave82 · 2024-05-05T20:01:53Z

https://ci.appveyor.com/project/AdPlug/adplug/builds/49753291

Appears that MSVC does not like the ... in the switch case blocks
(and a forrest of unsigned/signed comparisons)

dmitrysmagin · 2024-05-05T20:17:25Z

It's a shame for MSVC, it seems that gcc and clang support '...' in case clauses...
Okay, this might be replaced with multiple case statements in certain places and chained if-else in others.

…2-sq

…zed. Cleanest fix is likely to use calloc() for the window buffer so that the result always is consistent.

mywave82 · 2024-05-22T19:23:27Z

Looking through the code, and the few parts that probably would be endian sensitive is not in "danger" at the moment, since the memcpy() are commented out.

We are probably ready to merge :-)

dmitrysmagin · 2024-05-22T19:27:35Z

Let's go for it! Better squash commits or leave as is?

- add the required C bitpacking libraries into `deps/` - add a2m-v2 impl - replace A2M loader in main application - add the necessary C dependencies - tweak CMakeLists to include dependencies and compile C code Code adapted from adplug/adplug#207

barracuda156 · 2025-04-12T14:32:15Z

@dmitrysmagin Could you please take a look at these errors? #247
Quite a number of static asserts in a2m-v2.h fail.

Add .vscode, *.exe and doc/libadplug.html into .gitignore

af54304

dmitrysmagin mentioned this pull request Feb 26, 2024

Support for new A2M file versions? #14

Closed

binarymaster added the enhancement label Feb 26, 2024

dmitrysmagin force-pushed the a2m-v2-sq branch 2 times, most recently from 75eb3bd to 2c4e5d6 Compare February 28, 2024 06:43

dmitrysmagin added 2 commits February 29, 2024 18:25

Add a2m/a2t player with unpackers depack.c, sixpack.c and unlzh.c

237e21b

Add testing a2m/a2t modules

593f15f

dmitrysmagin force-pushed the a2m-v2-sq branch from 2c4e5d6 to 593f15f Compare February 29, 2024 15:25

dmitrysmagin changed the title ~~Add player for A2M (versions 9-14) and A2T (versions 1-14)~~ Add player for A2M (versions 1-14) and A2T (versions 1-14) Mar 6, 2024

Add lzw/lzss unpackers, fix songend when pattern jump

01cf1db

dmitrysmagin force-pushed the a2m-v2-sq branch from 41ef747 to 01cf1db Compare March 6, 2024 19:33

Show a2m/a2t version in gettype()

58cc442

Fix comment about a2m/a2t versions: should be 1 - 14

e0bea24

dmitrysmagin force-pushed the a2m-v2-sq branch from 5923c9d to e0bea24 Compare April 4, 2024 06:07

Enet4 reviewed Apr 25, 2024

View reviewed changes

Comment thread src/a2m-v2.h Outdated

Comment thread src/a2m-v2.h Outdated

Use static_assert instead of C_ASSERT, drop irrelevant one.

07a6f7f

mywave82 added 5 commits May 3, 2024 09:13

Update Makefile.am

9747a01

.ref files are stored in testref directory, not testmus

Initialize last_order, and make a2t_play() use rewind() instead of du…

49a0de9

…plicating all the code.

Buffer-size was too small, and use snprintf() instead of sprintf() wh…

7e89608

…ich can guard against this.

Fix memory leaks

b5e89e3

Add protection of buffer-sizes when decompressing. sixpack() did over…

fcc4d65

…flow in playertest, most of them had problem in stresstest.

dmitrysmagin and others added 2 commits May 4, 2024 20:21

Fix typo in sizeof() in a2t_import()

04068f4

Update various project files (building AppVeyor CI failes without this)

658159c

dmitrysmagin and others added 14 commits May 5, 2024 23:20

Fix warnings for signed/unsigned comparisons

6852b03

Merge branch 'a2m-v2-sq' of github.com:dmitrysmagin/adplug into a2m-v…

943b123

…2-sq

valgrind shows that sixpack depacker uses memory that is not initiali…

cbdf8a8

…zed. Cleanest fix is likely to use calloc() for the window buffer so that the result always is consistent.

Replace ... in case statements with MSVC compatible syntax

d918cf7

Fix wrong 'for' indices in generate_custom_vibrato()

572c28f

Small fix for unsigned/signed comparison

eb6bbd5

Update adplug.vcxproj

5c4cd63

Don't init arrays inside class to please MSVC

d57295a

Properly init/deinit vibrato_table and arpeggio_table

8bde378

Create vibrato_table and arpeggio_table in C++ way

ff9381c

Fix crash when setting volume for non-existing instrument (corridor.a2m)

f44b1b9

Update MSVC6 and Watcom makefiles (not tested though)

26fc5da

Rework allocating/freeing of arpeggio and vibrato tables

d8c8cb0

Fix tests for previous commit

fa2701b

mywave82 and others added 3 commits May 22, 2024 21:33

adlibemu.c was added two times to the project file.

cf89062

Update playertest.cpp: Move closer to existing AT2 test

fc302c3

Update adplug.qpg: Add missing header files

8f44595

binarymaster merged commit 855e091 into adplug:master May 31, 2024

Enet4 mentioned this pull request Jun 1, 2024

Add extended A2M/A2T file support (v1 to v14) SudoMaker/adlib2vgm#6

Merged

dmitrysmagin deleted the a2m-v2-sq branch August 29, 2024 17:00

Uh oh!

Conversation

dmitrysmagin commented Feb 26, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

dmitrysmagin commented Mar 14, 2024

Uh oh!

dmitrysmagin commented Apr 3, 2024

Uh oh!

mywave82 commented Apr 3, 2024

Uh oh!

dmitrysmagin commented Apr 5, 2024

Uh oh!

jibsen commented Apr 10, 2024

Uh oh!

dmitrysmagin commented Apr 15, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mywave82 commented Apr 15, 2024

Uh oh!

Enet4 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

dmitrysmagin commented May 2, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

dmitrysmagin commented May 4, 2024

Uh oh!

mywave82 commented May 5, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

dmitrysmagin commented May 5, 2024

Uh oh!

mywave82 commented May 22, 2024

Uh oh!

dmitrysmagin commented May 22, 2024

Uh oh!

barracuda156 commented Apr 12, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

dmitrysmagin commented Feb 26, 2024 •

edited

Loading

dmitrysmagin commented Apr 15, 2024 •

edited

Loading

dmitrysmagin commented May 2, 2024 •

edited

Loading

mywave82 commented May 5, 2024 •

edited

Loading