TweetFollow Us on Twitter

Res Compression
Volume Number:9
Issue Number:1
Column Tag:Resources

Related Info: Resource Manager

Resource Compression

What it is, how it works, and how to use it in your own software

By Justin Gray, Alysis Software Corporation

Note: Source code files accompanying article are located on MacTech CD-ROM or source code disks.

With the release of System 7, Apple quietly introduced a powerful means of applying transparent compression to applications and other resource files that has yet to be matched by third-party schemes. While System 7 features like AppleEvents and Balloon help were highly-touted and well-documented, Apple’s resource compression scheme remains a tantalizing mystery to most Macintosh developers. In this article, we’ll explore exactly what resource compression is, how it works, and how to apply it to your own software.

What Resource Compression is

To deliver on the promise of System 7’s remarkable new features, Apple programmers had to write a significant volume of new code for both the Finder and System files. During the course of development, it became clear that the system and Finder would not be able to fit on a single high-density diskette without the application of some sort of compression. The compression applications available at the time could not be applied since they would only create archives, not compressed files that could be used in compressed form. What was needed was a compression/decompression scheme that would allow compressed files to operate while still compressed on disk and without degrading system performance. The solution was the resource compression system employed in the System File, the Finder, ResEdit, and TeachText.

Like any other coding - decoding system, resource compression consists of two basic components: a tool for compressing data, and decompression code which decodes the compressed data. While most third-party compression software comes in application form, resource compression exists in the form of an enhancement to the Resource Manager supported by decompression resources of type ‘dcmp’. After compiling the final version of his/her software, a developer uses a resource compressing application to shrink the individual resources in the application and paste in his/her ‘dcmp’ resource. When the end user launches the application, the Resource Manager handles the parsing of compressed resources and calls the appropriate decoders to transparently expand the compressed resources that it encounters.

The significant advantages to this approach are speed and compatibility. Since resources are decompressed into memory rather than to disk, their compressed contents can be accessed in a fraction of the time required by a system that decompresses to disk. Because the resources are compressed and decompressed individually, they can be accessed much more rapidly than if the entire file were expanded into memory. An application which takes up half the space on disk will require only half as much disk access to load into memory. If the decoding software can expand the compressed data more rapidly than the SCSI bus can transfer the same number of bytes, the application will actually launch faster in compressed form.

Since the decompression is done automatically by the Resource Manager and the appropriate ‘dcmp’ resource, compressed data can be accessed transparently by software that is unaware of compressed resources: the same trap calls that access ordinary resources also access compressed resources with no difference in passed parameters. Applications written before resource compression was made available will launch and run after being made smaller through resource compression. Adobe Photoshop and Aldus PageMaker 4 will each fit on and execute from 800K diskettes after being compressed by a commercially-available resource compression application.

Unfortunately resource compression applies only to resource forks. Apple does not currently provide an equally transparent scheme for manipulating compressed data forks, although several third-party publishers supply software which does. Resource compression is also currently a “one-way” compression scheme - the Resource Manager decompresses resources but does not add them to resource files in compressed form. And the compression tools which Apple uses internally are not currently available to developers. (This article will describe how to create one.) Despite these limitations, resource compression promises to deliver the most transparent and best performing means of making applications and system enhancements smaller for the forseeable future of 680x0-based Macintoshes.

How Resource Compression Works

Poking about in the System or Finder with ResEdit reveals very few visible cues that the files are compressed. Resources appear as they normally would and can be opened and edited or cut and pasted with no delays or unexplained changes in size. Because the resource manager handles compressed resources, they appear to any programs which use the resource manager as ordinary resources. The only discrepancy introduced by resource compression is the difference between the sum of the values returned by SizeResource and the total size of the resource fork. (These two numbers do not necessarily have a close correspondence even in files without compressed resources.)

The transparent decompression of these resources happens through a variation of the Resource Manager’s regular loading process. Normally, when a GetResource, Get1Resource or similar trap is executed, the Resource Manager (herein called RM) allocates a handle to a block of memory sufficiently large to hold the entire resource. It then calls the File Manager and reads the appropriate range of data from the resource fork of the file into the new handle. When the RM encounters a resource whose ‘compressed’ attribute is set, it calls an additional set of low-level routines.

Once the resource is loaded, the RM double-checks the status of the resource and exits if its header does not contain the appropriate tag bytes. If the resource passes this check, then the RM determines the kind of memory allocation required by the decompressor by checking the resource header flag bits. The RM then extracts a resource ID from the resource header, which it uses to load a system resource which employs the appropriate algorithm or algorithms to decompress the data contained in the resource. Herein is the exciting modularity of the resource compression scheme: each decompression algorithm used by the RM is held in a self-contained code resource of type ‘dcmp’. Adding new compression algorithms to the Macintosh is simply a matter of plugging new ‘dcmp’ resources into the system file or even into the file which contains compressed resources. The Macintosh System does the rest!

Once the RM is armed with a decoding routine, it allocates a buffer for use by the decoder and passes pointers to the buffer and the source and destination buffers of the decompression operation. Interestingly, the destination pointer begins before the source pointer and the difference between the two is less than the size of the decompressed resource: the decompressed data overruns the already-used compressed data as it is decoded.

The brilliance of this scheme is that it requires only a single buffer for both the compressed and decompressed data. In an ideal world the buffer would be precisely the size of the decompressed data - like Ouroboros, the mythical snake who girded the world in perpetual pursuit of its tail, the decompressed data would replace the already-used compressed data. It would grow ever closer to the unused compressed data but never overwrite it. In practice, however, compression algorithms do not provide uniform compression and may for brief instances produce output code that consumes more space than the input code that it replaces. The RM solution to this problem is to provide an expansion buffer between the decompressed and compressed data. The size of the buffer, recorded in the resource header, is equal to the maximum amount that the encoded data might grow toward the end of the decompression process. Once the data is decompressed, the handle is shrunk by the expansion buffer size, the memory buffer used by the decoder is released, and the handle is returned to the caller. Two types of ‘dcmps’ provide support for small and large expansion buffers.

Although this description is somewhat simplified, it serves to illustrate the tremendous power of Apple’s approach to handling compression. By compressing and decompressing resources at the RM level, Apple has succeeded in delivering a system that opens compressed resources more rapidly than uncompressed resources, provides rapid random access to compressed data, and provides complete transparency and backward compatibility to code which uses the RM to access data. Tapping into the power of the scheme involves nothing more difficult than running a resource compressor program and copying a dcmp resource with ResEdit.

How to Use Resource Compression in Your Own Software

While using existing resource compression tools to apply compression to applications, extensions and other resource files is trivial, building a resource compressor, designing compression algorithms, creating optimized assembly-language implementations of the codecs, and building the appropriate ‘dcmps’ code resources to allow the System to decode the compressed resources requires somewhat more effort. For those of you who are interested in tinkering with your own resource-based compression systems, here is an outline of the basic steps that you’ll have to take and some source code to get you started.

Selecting an algorithm

The first step in tapping into resource compression is to select and create a codec. The primary criteria for selecting your algorithm should be speed, efficient use of memory, and compression efficiency under limited-context conditions. Since a single ‘dcmps’ added to the system file will allow for decompression of resources in all files, size of the decompression object code is not a major consideration.

Most compression algorithms currently in commercial use employ a combination of two techniques: string-matching and frequency-based encoding of characters to variable-length bit fields. The string matching algorithm is applied first to reduce instances like the string “Resource Manager” in this article to single bytes. The second algorithm compares the frequency of the single bytes or short strings and then substitutes shorter bit-field elements for the more frequently occurring characters. Both types of algorithms are well-documented in computer journals and textbooks. Popular string-based compression algorithms include Limpel-Ziv and its derivatives. Popular frequency-based compression algorithms include Huffman coding, arithmetic coding and adaptive variations of both.

While non-adaptive frequency-based coding is fairly fast in both compressing and decompressing, string-based compression algorithms tend to operate more slowly, especially in compression. To reap the rewards of high-speed decompression, you should choose an algorithm that is inherently fast or invest some time in optimizing the performance of an already-implemented algorithm.

Since resource decompression is executed by the RM, your decoder should be frugal in its use of memory. The RM allocates buffers for decompressors in the system heap. While management of the system heap has improved considerably, the Memory Manager may not be able to free sufficient space for the more memory-hungry adaptive codecs.

Compression efficiency in a limited context environment is also of primary importance in selecting a compression algorithm. File-based compression schemes have an advantage over resource compression in that they operate on an entire file at a time, enabling the compression algorithm to acquire an extensive context or set of libraries with which to compress data efficiently. Because resources can be accessed independently, resource-based compression operates only within the context of a single resource. Many resources are quite small and will not compress well with Limpel-Ziv-derivative algorithms.

Creating a resource-compressing application

Once you’ve selected and implemented a compression algorithm that is fast, lean, and operates with limited context, you will want to incorporate the encoding portion of your codec in a resource-compressing application. Your application will need to open resource files, select resources for compression (some resources should not be compressed), compress the data contained in the selected resources, calculate and add header information to the resources, add them back to the resource fork, set the appropriate attributes for the resources and then set the appropriate attribute bits for the resource file. Except for the exact header format, described in the following structure, most of the documentation for this work can be found in Inside Macintosh.

Compressed Resource Header Format

[1]
typedef struct {
 long compressedResourceTag;
 long typeFlags;
 long uncompressedSize;
 char workingBufferFractionalSize;
 char expansionBufferSize;
 short  dcmpID;
} resourceHeader;

Here the compressedResourceTag should be 0xA89F6572. The typeFlags should be set to 0x120801. The workingBufferFractionalSize should be a fixed point fraction of the size of the uncompressed resource. The expansion buffer size should be a number from 0 to 255 which represents the greatest number of bytes that the compressed data might grow during the end of the compression process.

Once you’ve successfully compressed resources with your new application, you’ll be able to examine them in ResEdit. If your application has compressed and manipulated the resources properly, you will be able to see them in the resource map listing and get information about them. Trying to cut, copy or edit the resources will give you a “bent” resource error, -186. This simply means that the appropriate 'dcmp' resource has not been made available to the system.

Creating a decompression resource

There are several types of ‘dcmp’ resource used by the system software. The source code provided here will enable you to employ your decoder within the ‘small-expansion-buffer’ 'dcmp' format like the one used by System 7 for decompressing code resources. In combination with a good algorithm, you should be able to get significantly better compression ratios on code resources and others.

Creating the decompression resource consists of creating a code resource of type ‘dcmp’ which contains the header glue code in the following source code listing as well as the decoding portion of your codec. Since your ‘dcmp’ will be executing within a RM call, you should try to incorporate all of the code required into a single resource, rather than having a separate decoding resource loaded by your 'dcmp'.

[2]
‘dcmp’ Resource glue code listing

typedef struct {
 char unused[7];
 long dataSize;
 long workingBuffer;
 long destinationBuffer;
 long sourceBuffer;


} dcmpParameters;

main (){
 asm {
 debug
 link a6,#0 ; Grab a stack frame
 movem.ld0-d7/a0-a6,-(a7) ; Save all variables
 ; Get the input buffer
 move.l dcmpParameters.sourceBuffer(a6),a0   
 ; Get the output buffer
 move.l dcmpParameters.destinationBuffer(a6),a1     
 ; Get the working buffer
 move.l dcmpParameters.workingBuffer(a6),a2  
 move.l dcmpParameters.dataSize(a6),d0 ; How much data?

; Insert your decompression code here.

 movem.l(a7)+,d0-d7/a0-a6 ; Restore the registers
 unlk a6
 move.l (a7)+,8(a7); Move return address
 addq.l #8,a7    ; Discard the stack frame
 } /* end asm */
/* Return to Resource Mgr */
}

It is important to use the Custom Header selection from Think C for creating a 'dcmp' resource with this glue code. The register assignments used in this example were arbitrarily chosen.

Once your 'dcmp' is compiled, you can either add it to your compressed resource file or the active system file. Once the 'dcmp' is added to an open resource map, it will be executed by the RM whenever one of the corresponding compressed resources is accessed. Now double-clicking on one of the resources compressed by your application will yield the following message, “That resource is compressed. If you make changes, it will be saved uncompressed. Do you want to edit it anyway?” Pressing the Yes button will open the resource as if it were not compressed. All other accesses to the resource will open it transparently and return information about the resource as if it were not compressed. Congratulations -- You have successfully implemented a resource compression scheme.

For more information

Alysis Software Corporation

1231 31st Avenue

San Francisco, CA 94122

Voice: 415/566-2263 • Fax: 415/566-9692

AppleLink: ALYSIS

America Online: ALYSIS

CompuServe: 76500,3011

 

Community Search:
MacTech Search:

Software Updates via MacUpdate

WhatsApp 2.2136.10 - Desktop client for...
WhatsApp is the desktop client for WhatsApp Messenger, a cross-platform mobile messaging app which allows you to exchange messages without having to pay for SMS. WhatsApp Messenger is available for... Read more
Thunderbird 91.1.1 - Email client from M...
As of July 2012, Thunderbird has transitioned to a new governance model, with new features being developed by the broader free software and open source community, and security fixes and improvements... Read more
Direct Mail 5.9.1 - Create and send grea...
Direct Mail is an easy-to-use, fully-featured email marketing app purpose-built for macOS. Create, send, and track great looking email campaigns that get results. Start your newsletter by selecting... Read more
LibreOffice 7.2.1.2 - Free, open-source...
LibreOffice is an office suite (word processor, spreadsheet, presentations, drawing tool) compatible with other major office suites. The Document Foundation is coordinating development and... Read more
Steam 2.0 - Multiplayer and communicatio...
Steam is a digital distribution, digital rights management, multiplayer and communications platform developed by Valve Corporation. It is used to distribute a large number of games and related media... Read more
Adobe Acrobat DC 21.007.20091 - Powerful...
Acrobat DC is available only as a part of Adobe Creative Cloud, and can only be installed and/or updated through Adobe's Creative Cloud app. Adobe Acrobat DC with Adobe Document Cloud services is... Read more
Carbon Copy Cloner 6.0.3 - Easy-to-use b...
Carbon Copy Cloner backups are better than ordinary backups. Suppose the unthinkable happens while you're under deadline to finish a project: your Mac is unresponsive and all you hear is an ominous,... Read more
Adobe Animate 21.0.9 - Animation authori...
Adobe Animate is available as part of Adobe Creative Cloud for as little as $20.99/month (or $9.99/month if you're a previous Flash Professional customer). Adobe Animate (was Flash CC) lets you share... Read more
Vivaldi 4.2.2406.44 - An advanced browse...
Vivaldi is a browser for our friends. We live in our browsers. Choose one that has the features you need, a style that fits and values you can stand by. From the look and feel, to how you interact... Read more
Adobe Acrobat Reader 2021.007.20091 - Vi...
Adobe Acrobat Reader allows users to view PDF documents. You may not know what a PDF file is, but you've probably come across one at some point. PDF files are used by companies and even the IRS to... Read more

Latest Forum Discussions

See All

PUBG New State crosses 40 million pre-re...
PUBG New State has received over 40 million pre-registrations on both Android and iOS, Krafton has recently announced. The futuristic, sci-fi PUBG Mobiletitle is all set to launch later this year, in October. [Read more] | Read more »
A Mere Husk of a Human Being – The Touch...
In this week’s episode of The TouchArcade Show I continue to be more or less out of my mind due to the exhaustion of having a newborn baby. Yes, I’ve been through all this before with our previous child, but somehow this is kicking my ass even worse... | Read more »
TouchArcade Game of the Week: ‘Night in...
I have said this probably dozens of times over the years, but there are tons and tons of cool video games on non-mobile platforms that people gush about all the time, and I always tell myself “I’ll definitely get around to playing that myself on [... | Read more »
SwitchArcade Round-Up: ‘Ni no Kuni II’,...
Hello gentle readers, and welcome to the SwitchArcade Round-Up for September 17th, 2021. In today’s article, we finish our look at the new games of the week with the Friday releases. Some fairly big games in the list today, like Ni no Kuni II:... | Read more »
‘LEGO Star Wars Battles’ from TT Games a...
Last month, LEGO Star Wars Battles () was revealed for Apple Arcade. | Read more »
COD Mobile: The 5 best SMGs in the game
COD Mobile is often lauded for its vast array of weapons and elaborate customization. With every update, the guns get some kind of nerfs or buffs. Regardless of that, SMGs remain popular with players for close to mid-range combat. [Read more] | Read more »
SEGA Will Reveal a New Mobile RPG at Tok...
A few days ago, there was a bit of buzz around the listing of a new RPG under SEGA / Atlus for Tokyo Game Show 2021. Tokyo Game Show 2021 begins later this month and both SEGA and Atlus will have games and updates to showcase. SEGA will be revealing... | Read more »
‘Castlevania: Grimoire of Souls’ and ‘Te...
This week’s Apple Arcade roundup has updates to four amazing games on the service and the addition of two new games. The first new game is Castlevania: Grimoire of Souls () from Konami. | Read more »
‘Indies’ Lies’ is a New Roguelike Deck B...
For several years, as the popularity of MegaCrit’s roguelike deck-building game Slay the Spire grew amongst PC gamers, lots and lots of mobile gamers hoped that the game would one day arrive on their mobile devices, where it seemed like a natural... | Read more »
‘Steam Highwayman: Smog & Ambuscade’...
Cubus Games have released a number of interesting gamebooks on mobile for a number of years now, including titles such as Heavy Metal Thunder and The Frankenstein Wars. Now at the end of this month they’ll be adding another to their catalogue with a... | Read more »

Price Scanner via MacPrices.net

This is the final week for Apple’s 2021 Back...
Apple’s Back to School promotion for 2021 continues through September 27, 2021, making this the final full week to take advantage of these offers. As part of this promotion, Apple will include one... Read more
Verizon offers $100 discount on Apple’s new 8...
Verizon has Apple’s new 8.3-inch iPad mini and 9th-generation iPad on sale for $100 off MSRP with an Unlimited service plan. Discount is for 64GB and 256GB cellular-enabled models. The $100 sale... Read more
Apple’s new 9th generation iPad and 8.3-inch...
Amazon is offering preorder discounts on Apple’s new 9th generation iPad and 8.3″ iPad mini (64GB WiFi models) ranging up to $40 off MSRP. Delivery is expected starting September 24th: iPad: – 10″... Read more
Xfinity Mobile offers new Apple iPhone 13 mod...
Xfinity Mobile has Apple’s new iPhone 13 family of smartphones on sale and available for preorder for $300 off MSRP for customers opening a new line of service. No trade-in is required. Cost of the... Read more
Verizon offers free Apple iPhone 13 and iPhon...
Verizon is offering an $800 discount on Apple’s new iPhone 13 and $700 discount on the iPhone 13 mini for new and existing customers with a qualified trade-in. Price of the iPhone 13 will be spread... Read more
Apple Product Announcements, As Of Late, Have...
COMMENTARY: 09.17.21 – If you were left feeling a little, “meh” following Apple’s latest product launch, you’re not alone. On Tuesday — in a pre-recorded virtual event dubbed, “California Streaming... Read more
Verizon offers 25% discount on Apple MagSafe...
Verizon has Apple MagSafe Chargers on sale for 25% off MSRP from 9/16/21 to 9/30/21. Verizon service is not required to take advantage of these savings. With the discount, Verizon’s sale prices are... Read more
Verizon offers $1000 discount on new Apple iP...
Verizon is offering a $1000 discount on Apple’s new iPhone 13 Pro and iPhone 13 Pro Max for new and existing customers with a qualified trade-in. Price of the iPhone 13 Pro will be spread over 24 or... Read more
New at AT&T: Apple iPhone 13 and 13 mini...
We’ve already told you about AT&T’s $1000 discounts on the Apple iPhone 13 Pro and iPhone 13 Pro Max. AT&T now has Apple’s new iPhone 13 and iPhone 13 mini discounted to $700 off MSRP for new... Read more
‘Mac Potpourri’ Story On Apple And Folding Sm...
FEATURE: 09.16.21 – A certain writer has been seemingly thrust into the limelight thanks to an article published last month on MacPrices. The article — a commentary on how Apple must “‘flip’ the... Read more

Jobs Board

Geek Squad *Apple* Consultation Professiona...
**829606BR** **Job Title:** Geek Squad Apple Consultation Professional **Job Category:** Store Associates **Store Number or Department:** 001422-Tualatin-Store **Job Read more
Geek Squad Advanced Repair *Apple* Professi...
**831864BR** **Job Title:** Geek Squad Advanced Repair Apple Professional **Job Category:** Store Associates **Store Number or Department:** 000011-Northtown-Store Read more
Geek Squad *Apple* Consultation Professiona...
**831828BR** **Job Title:** Geek Squad Apple Consultation Professional **Job Category:** Store Associates **Store Number or Department:** 000028-Green Bay-Store Read more
Sr Infrastructure Engineer - *Apple* MacInt...
**Sr Infrastructure Engineer - Apple MacIntosh** **Description** At Bank of the West, our people are having a positive impact on the world. We're investing where we Read more
Senior Software Developer - *Apple* (iOS/tv...
**SUMMARY** Hulu's Apple team is seeking an experienced Senior Software Engineer with a passion for mobile applications to join our team in Seattle. Our highly Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.