amd64 support, compiler warning fixes, don't use software rendering

[taylor/freespace2.git] / src / bmpman / bmpman.cpp

/*
 * Copyright (C) Volition, Inc. 1999.  All rights reserved.
 *
 * All source code herein is the property of Volition, Inc. You may not sell 
 * or otherwise commercially exploit the source or things you created based on
 * the source.
 */

/*
 * $Logfile: /Freespace2/code/Bmpman/BmpMan.cpp $
 * $Revision$
 * $Date$
 * $Author$
 *
 * Code to load and manage all bitmaps for the game
 *
 * $Log$
 * Revision 1.11  2004/07/04 11:31:43  taylor
 * amd64 support, compiler warning fixes, don't use software rendering
 *
 * Revision 1.10  2003/05/28 06:02:04  taylor
 * fix transparency in green weapon blobs
 *
 * Revision 1.9  2002/06/09 04:41:15  relnev
 * added copyright header
 *
 * Revision 1.8  2002/06/05 04:03:32  relnev
 * finished cfilesystem.
 *
 * removed some old code.
 *
 * fixed mouse save off-by-one.
 *
 * sound cleanups.
 *
 * Revision 1.7  2002/06/03 09:25:37  relnev
 * implement mouse cursor and screen save/restore
 *
 * Revision 1.6  2002/05/30 23:07:08  relnev
 * shh
 *
 * Revision 1.5  2002/05/30 21:44:48  relnev
 * implemented some missing texture stuff.
 *
 * enable bitmap polys for opengl.
 *
 * work around greenness in bitmaps.
 *
 * Revision 1.4  2002/05/28 17:03:29  theoddone33
 * fs2 gets to the main game loop now
 *
 * Revision 1.3  2002/05/28 08:52:03  relnev
 * implemented two assembly stubs.
 *
 * cleaned up a few warnings.
 *
 * added a little demo hackery to make it progress a little farther.
 *
 * Revision 1.2  2002/05/07 03:16:43  theoddone33
 * The Great Newline Fix
 *
 * Revision 1.1.1.1  2002/05/03 03:28:08  root
 * Initial import.
 *
 * 
 * 37    9/13/99 11:26p Andsager
 * Add debug code to check for poorly sized anis
 * 
 * 36    9/05/99 11:19p Dave
 * Made d3d texture cache much more safe. Fixed training scoring bug where
 * it would backout scores without ever having applied them in the first
 * place.
 * 
 * 35    8/20/99 2:09p Dave
 * PXO banner cycling.
 * 
 * 34    8/10/99 6:54p Dave
 * Mad optimizations. Added paging to the nebula effect.
 * 
 * 33    8/06/99 1:52p Dave
 * Bumped up MAX_BITMAPS for the demo.
 * 
 * 32    8/02/99 1:49p Dave
 * Fixed low-mem animation problem. Whee!
 * 
 * 31    7/16/99 1:49p Dave
 * 8 bit aabitmaps. yay.
 * 
 * 30    7/13/99 1:15p Dave
 * 32 bit support. Whee!
 * 
 * 29    6/29/99 10:35a Dave
 * Interface polygon bitmaps! Whee!
 * 
 * 28    6/16/99 4:06p Dave
 * New pilot info popup. Added new draw-bitmap-as-poly function.
 * 
 * 27    5/05/99 9:02p Dave
 * Fixed D3D aabitmap rendering. Spiffed up nebula effect a bit (added
 * rotations, tweaked values, made bitmap selection more random). Fixed
 * D3D beam weapon clipping problem. Added D3d frame dumping.
 * 
 * 26    4/27/99 12:16a Dave
 * Fixed beam weapon muzzle glow problem. Fixed premature timeout on the
 * pxo server list screen. Fixed secondary firing for hosts on a
 * standalone. Fixed wacky multiplayer weapon "shuddering" problem.
 * 
 * 25    4/09/99 2:21p Dave
 * Multiplayer beta stuff. CD checking.
 * 
 * 24    4/08/99 10:42a Johnson
 * Don't try to swizzle a texture to transparent in Fred.
 * 
 * 23    3/31/99 8:24p Dave
 * Beefed up all kinds of stuff, incluging beam weapons, nebula effects
 * and background nebulae. Added per-ship non-dimming pixel colors.
 * 
 * 22    3/20/99 3:46p Dave
 * Added support for model-based background nebulae. Added 3 new
 * sexpressions.
 * 
 * 21    2/11/99 3:08p Dave
 * PXO refresh button. Very preliminary squad war support.
 * 
 * 20    2/08/99 5:07p Dave
 * FS2 chat server support. FS2 specific validated missions.
 * 
 * 19    2/05/99 12:52p Dave
 * Fixed Glide nondarkening textures.
 * 
 * 18    2/04/99 6:29p Dave
 * First full working rev of FS2 PXO support.  Fixed Glide lighting
 * problems.
 * 
 * 17    2/03/99 11:44a Dave
 * Fixed d3d transparent textures.
 * 
 * 16    1/15/99 11:29a Neilk
 * Fixed D3D screen/texture pixel formatting problem. 
 * 
 * 15    1/14/99 12:48a Dave
 * Todo list bug fixes. Made a pass at putting briefing icons back into
 * FRED. Sort of works :(
 * 
 * 14    1/12/99 12:53a Dave
 * More work on beam weapons - made collision detection very efficient -
 * collide against all object types properly - made 3 movement types
 * smooth. Put in test code to check for possible non-darkening pixels on
 * object textures.
 * 
 * 13    1/08/99 2:08p Dave
 * Fixed software rendering for pofview. Super early support for AWACS and
 * beam weapons.
 * 
 * 12    1/06/99 2:24p Dave
 * Stubs and release build fixes.
 * 
 * 11    12/14/98 4:01p Dave
 * Got multi_data stuff working well with new xfer stuff. 
 * 
 * 10    12/06/98 2:36p Dave
 * Drastically improved nebula fogging.
 * 
 * 9     12/01/98 5:53p Dave
 * Simplified the way pixel data is swizzled. Fixed tga bitmaps to work
 * properly in D3D and Glide.
 * 
 * 8     12/01/98 4:46p Dave
 * Put in targa bitmap support (16 bit).
 * 
 * 7     12/01/98 10:32a Johnson
 * Fixed direct3d font problems. Fixed sun bitmap problem. Fixed direct3d
 * starfield problem.
 * 
 * 6     12/01/98 8:06a Dave
 * Temporary checkin to fix some texture transparency problems in d3d.
 * 
 * 5     11/30/98 5:31p Dave
 * Fixed up Fred support for software mode.
 * 
 * 4     11/30/98 1:07p Dave
 * 16 bit conversion, first run.
 * 
 * 3     10/22/98 6:14p Dave
 * Optimized some #includes in Anim folder. Put in the beginnings of
 * parse/localization support for externalized strings and tstrings.tbl
 * 
 * 2     10/07/98 10:52a Dave
 * Initial checkin.
 * 
 * 1     10/07/98 10:48a Dave
 * 
 * 106   5/23/98 4:43p John
 * Took out debugging sleep
 * 
 * 105   5/23/98 4:14p John
 * Added code to preload textures to video card for AGP.   Added in code
 * to page in some bitmaps that weren't getting paged in at level start.
 * 
 * 104   5/20/98 12:59p John
 * Turned optimizations on for debug builds.   Also turning on automatic
 * function inlining.  Turned off the unreachable code warning.
 * 
 * 103   5/20/98 10:20a Hoffoss
 * Fixed warning in the code.
 * 
 * 102   5/19/98 3:45p John
 * fixed bug causing lowmem to drop half of the frames. Also halved fps
 * during lowmem.
 * 
 * 101   5/14/98 3:38p John
 * Added in more non-darkening colors for Adam.  Had to fix some bugs in
 * BmpMan and Ani stuff to get this to work.
 * 
 * 100   4/22/98 9:13p John
 * Added code to replace frames of animations in vram if so desired.
 * 
 * 99    4/17/98 6:56a John
 * Fixed bug where RLE'd user bitmaps caused data to not get freed.
 * (Turned off RLE for use bitmaps).   Made lossy animations reduce
 * resolution by a factor of 2 in low memory conditions.
 * 
 * 98    4/16/98 6:31p Hoffoss
 * Added function to get filename of a bitmap handle, which we don't have
 * yet and I need.
 * 
 * 97    4/01/98 9:27p John
 * Fixed debug info in bmpman.
 * 
 * 96    4/01/98 5:34p John
 * Made only the used POFs page in for a level.   Reduced some interp
 * arrays.    Made custom detail level work differently.
 * 
 * 95    3/31/98 9:55a Lawrance
 * JOHN: get xparency working for user bitmaps
 * 
 * 94    3/30/98 4:02p John
 * Made machines with < 32 MB of RAM use every other frame of certain
 * bitmaps.   Put in code to keep track of how much RAM we've malloc'd.
 * 
 * 93    3/29/98 4:05p John
 * New paging code that loads everything necessary at level startup.
 * 
 * 92    3/27/98 11:20a John
 * commented back in some debug code.
 * 
 * 91    3/26/98 5:21p John
 * Added new code to preload all bitmaps at the start of a level.
 * Commented it out, though.
 * 
 * 90    3/26/98 4:56p Jasen
 * AL: Allow find_block_of() to allocate a series of bitmaps from index 0
 * 
 * 89    3/26/98 10:21a John
 * Made no palette-mapped bitmaps use 0,255,0 as transparent.
 * 
 * 88    3/24/98 5:39p John
 * Added debug code to show bitmap fragmentation.  Made user bitmaps
 * allocate from top of array.
 * 
 * 87    3/22/98 3:28p John
 * Added in stippled alpha for lower details.  Made medium detail use
 * engine glow.
 * 
 * 86    3/11/98 1:55p John
 * Fixed warnings
 * 
 * 85    3/06/98 4:09p John
 * Changed the way we do bitmap RLE'ing... this speds up HUD bitmaps by
 * about 2x
 * 
 * 84    3/02/98 6:00p John
 * Moved MAX_BITMAPS into BmpMan.h so the stuff in the graphics code that
 * is dependent on it won't break if it changes.   Made ModelCache slots
 * be equal to MAX_OBJECTS which is what it is.
 * 
 * 83    3/02/98 9:51a John
 * Added code to print the number of bitmap slots in use between levels.
 * 
 * 82    2/16/98 3:54p John
 * Changed a bunch of mprintfs to catagorize to BmpInfo
 * 
 * 81    2/13/98 5:00p John
 * Made user bitmaps not get wrote to level cache file.
 * 
 * 80    2/06/98 8:25p John
 * Added code for new bitmaps since last frame
 * 
 * 79    2/06/98 8:10p John
 * Added code to show amout of texture usage each frame.
 * 
 * 78    2/05/98 9:21p John
 * Some new Direct3D code.   Added code to monitor a ton of stuff in the
 * game.
 * 
 * 77    1/29/98 11:48a John
 * Added new counter measure rendering as model code.   Made weapons be
 * able to have impact explosion.
 * 
 * 76    1/28/98 6:19p Dave
 * Reduced standalone memory usage ~8 megs. Put in support for handling
 * multiplayer submenu handling for endgame, etc.
 * 
 * 75    1/17/98 12:55p John
 * Fixed bug that I just created that loaded all ani frames.
 * 
 * 74    1/17/98 12:33p John
 * Made the game_busy function be called a constant amount of times per
 * level load, making the bar prediction easier.
 * 
 * 73    1/17/98 12:14p John
 * Added loading... bar to freespace.
 * 
 * 72    1/11/98 3:20p John
 * Made so that if no .clt exists, it will load all the bitmaps
 * 
 * 71    1/11/98 3:06p John
 * Made bitmap loading stop when cache gets full.
 * 
 * 70    1/11/98 2:45p John
 * Changed .lst to .clt
 * 
 * 69    1/11/98 2:14p John
 * Changed a lot of stuff that had to do with bitmap loading.   Made cfile
 * not do callbacks, I put that in global code.   Made only bitmaps that
 * need to load for a level load.
 * 
 * 67    1/09/98 4:07p John
 * Made all bitmap functions return a bitmap "Handle" not number.  This
 * helps to find bm_release errors.
 * 
 * 66    1/09/98 1:38p John
 * Fixed some bugs from previous comment
 * 
 * 65    1/09/98 1:32p John
 * Added some debugging code to track down a weird error.  Namely I fill
 * in the be structure with bogus values when someone frees it.
 * 
 * 64    12/28/97 2:00p John
 * put in another assert checking for invalid lock/unlock sequencing
 * 
 * 63    12/24/97 2:02p John
 * Changed palette translation to be a little faster for unoptimized
 * builds
 * 
 * 62    12/18/97 8:59p Dave
 * Finished putting in basic support for weapon select and ship select in
 * multiplayer.
 * 
 * 61    12/15/97 10:27p John
 * fixed bug where 2 bm_loads of same file both open the header.
 * 
 * 60    12/08/97 2:17p John
 * fixed bug with bmpman and cf_callback.
 * made cf_callback in Freespace set small font back when done.
 * 
 * 59    12/03/97 5:01p Lawrance
 * bump up MAX_BITMAPS to 1500.  People have reached 1000 bitmaps while
 * playing multiple missions.
 * 
 * 58    12/02/97 3:59p John
 * Added first rev of thruster glow, along with variable levels of
 * translucency, which retquired some restructing of palman.
 * 
 * 57    11/30/97 3:57p John
 * Made fixed 32-bpp translucency.  Made BmpMan always map translucent
 * color into 255 even if you aren't supposed to remap and make it's
 * palette black.
 * 
 * 56    10/05/97 10:39a John
 * fixed bug with palette on unmapped bitmaps.  Made unmapped bitmaps get
 * marked with xparent.
 * 
 * 55    9/23/97 11:46a Lawrance
 * fixed bug with rle'ing with spans get big
 * 
 * 54    9/23/97 10:45a John
 * made so you can tell bitblt code to rle a bitmap by passing flag to
 * gr_set_bitmap
 * 
 * 53    9/19/97 10:18a John
 * fixed bug with aa animations being re-rle'd every 
 * frame.
 * 
 * 
 * 52    9/09/97 10:08a Sandeep
 * Fixed Compiler Level 4 warnings
 * 
 * 51    9/08/97 2:02p John
 * fixed typo in nprintf
 * 
 * 50    9/08/97 1:56p John
 * fixed some memory housekeeping bugs 
 * 
 * 49    9/03/97 4:19p John
 * changed bmpman to only accept ani and pcx's.  made passing .pcx or .ani
 * to bm_load functions not needed.   Made bmpman keep track of palettes
 * for bitmaps not mapped into game palettes.
 * 
 * 48    8/29/97 7:35p Lawrance
 * check if .ani animation is already loaded in bm_load_animation()
 * 
 * 47    8/25/97 11:14p Lawrance
 * added support for .ani files in bm_load_animation()
 * 
 * 46    8/17/97 2:42p Lawrance
 * only flag PCX files as xparent if they have xparent pixels in them
 * 
 * 45    8/15/97 9:57a Lawrance
 * support multiple xparent entries for PCX files
 * 
 * 44    8/05/97 10:18a Lawrance
 * my_rand() being used temporarily instead of rand()
 * 
 * 43    8/01/97 4:30p John
 * 
 * 42    7/29/97 8:34a John
 * took out png stuff
 * 
 * 41    7/18/97 3:27p Lawrance
 * have pcx files use (0,255,0) for transparency
 * 
 * 40    7/16/97 3:07p John
 * 
 * 39    7/10/97 8:34a John
 * Added code to read TGA files.
 * 
 * 38    6/20/97 1:50p John
 * added rle code to bmpman.  made gr8_aabitmap use it.
 * 
 * 37    6/18/97 12:07p John
 * fixed some color bugs
 * 
 * 36    6/17/97 8:58p Lawrance
 * fixed bug with not nulling bm.data with USER bitmaps
 * 
 * 35    6/12/97 2:44a Lawrance
 * changed bm_unlock() to take an index into bm_bitmaps().  Added
 * ref_count to bitmap_entry struct
 * 
 * 34    5/20/97 10:36a John
 * Fixed problem with user bitmaps and direct3d caching.
 * 
 * 33    5/14/97 1:59p John
 * fixed a palette bug with vclips.
 * 
 * 32    3/24/97 4:43p John
 * speed up chunked collision detection by only checking cubes the vector
 * goes through.
 * 
 * 31    3/24/97 3:25p John
 * Cleaned up and restructured model_collide code and fvi code.  In fvi
 * made code that finds uvs work..  Added bm_get_pixel to BmpMan.
 * 
 * 30    3/11/97 2:49p Allender
 * 
 * 29    2/18/97 9:43a Lawrance
 * added Assert() in bm_release
 * 
 * 28    1/22/97 4:29p John
 * maybe fixed bug with code that counts total bytes of texture ram used.
 * 
 * 27    1/22/97 4:19p Lawrance
 * added flags to bm_create to allow transparency
 * 
 * 26    1/21/97 5:24p John
 * fixed another bug with bm_release.
 * 
 * 25    1/21/97 5:12p John
 * fixed bug with case
 * 
 * 24    1/21/97 5:02p John
 * Added code for 8bpp user bitmaps.
 * 
 * 23    1/09/97 11:35a John
 * Added some 2d functions to get/put screen images.
 * 
 * 22    11/26/96 6:50p John
 * Added some more hicolor primitives.  Made windowed mode run as current
 * bpp, if bpp is 8,16,or 32.
 * 
 * 21    11/26/96 9:44a Allender
 * Allow for use of different bitmap palettes
 * 
 * 20    11/25/96 10:36a Allender
 * started working on 32 bpp support.  Added 15 bpp.
 * 
 * 19    11/18/96 1:51p Allender
 * fix up manager code to reread bitmaps if needed in newer bit depth
 * 
 * 18    11/15/96 4:24p Allender
 * more bmpman stuff -- only free bitmap slots when releasing copied
 * texture -- otherwise, only release the data for the bitmap
 * 
 * 17    11/15/96 3:33p Allender
 * added support for converting to 16 bit textures when requested with
 * bm_load.  Added some other management functions
 * 
 * 16    11/13/96 4:51p Allender
 * started overhaul of bitmap manager.  bm_load no longer actually load
 * the data, only the info for the bitmap.  Locking the bitmap now forces
 * load when no data present (or will if bpp changes)
 *
 * $NoKeywords: $
 */

#include <ctype.h>
#include "pstypes.h"
#include "pcxutils.h"
#include "bmpman.h"
#include "palman.h"
#include "2d.h"
#include "animplay.h"
#include "timer.h"
#include "systemvars.h"
#include "key.h"
#include "packunpack.h"
#include "cfile.h"
#include "grinternal.h"
#include "tgautils.h"
#include "ship.h"

#ifndef NDEBUG
#define BMPMAN_NDEBUG
#endif

// keep this defined to use per-ship nondarkening pixels
#define BMPMAN_SPECIAL_NONDARK

int bm_inited = 0;

#define BM_TYPE_NONE            0
#define BM_TYPE_PCX                     1
#define BM_TYPE_USER            2
#define BM_TYPE_ANI                     3               // in-house ANI format
#define BM_TYPE_TGA                     4               // 16 bit targa

typedef union bm_extra_info     {
        struct {
                // Stuff needed for animations
                int             first_frame;                                                            // used for animations -- points to index of first frame
                ubyte           num_frames;                                                                     // used for animation -- number of frames in the animation
                ubyte           fps;                                                                                    // used for animation -- frames per second
        } ani;
        struct {
                // Stuff needed for user bitmaps
                void            *data;                                                                  // For user bitmaps, this is where the data comes from
                ubyte           bpp;                                                                    // For user bitmaps, this is what format the data is
                ubyte           flags;                                                                  // Flags passed to bm_create
        } user;
} bm_extra_info;

typedef struct bitmap_entry     {
        // identification
        char            filename[MAX_FILENAME_LEN];                     // filename for this bitmap

        uint            signature;                                                                      // a unique signature identifying the data
        uint            palette_checksum;                                                       // checksum used to be sure bitmap is in current palette
        int             handle;                                                                         // Handle = id*MAX_BITMAPS + bitmapnum
        int             last_used;                                                                      // When this bitmap was last used

        ubyte           type;                                                                                   // PCX, USER, ANI, etc
        signed char     ref_count;                                                              // Number of locks on bitmap.  Can't unload unless ref_count is 0.

        // Stuff to keep track of usage
        ubyte           preloaded;                                                                      // If set, then this was loaded from the lst file
        ubyte           used_flags;                                                                     // What flags it was accessed thru

        // Bitmap info
        bitmap  bm;

        // Data for animations and user bitmaps
        bm_extra_info   info;           

#ifdef BMPMAN_NDEBUG
        // bookeeping
        ubyte           used_last_frame;                                                        // If set, then it was used last frame
        ubyte           used_this_frame;                                                        // If set, then it was used this frame
        int             data_size;                                                                      // How much data this bitmap uses
        int             used_count;                                                                     // How many times it was accessed
#endif
} bitmap_entry;

uint Bm_next_signature = 0x1234;

bitmap_entry bm_bitmaps[MAX_BITMAPS];

int bm_texture_ram = 0;

// Bm_max_ram - How much RAM bmpman can use for textures.
// Set to <1 to make it use all it wants.
int Bm_max_ram = 0;             //16*1024*1024;                 // Only use 16 MB for textures

int bm_next_handle = 1;

int Bm_paging = 0;

static int Bm_low_mem = 0;                      

// 16 bit pixel formats
int Bm_pixel_format = BM_PIXEL_FORMAT_ARGB;

// get and put functions for 16 bit pixels - neat bit slinging, huh?
#define BM_SET_R_ARGB(p, r)     { p[1] &= ~(0x7c); p[1] |= ((r & 0x1f) << 2); }
#define BM_SET_G_ARGB(p, g)     { p[0] &= ~(0xe0); p[1] &= ~(0x03); p[0] |= ((g & 0x07) << 5); p[1] |= ((g & 0x18) >> 3); }
#define BM_SET_B_ARGB(p, b)     { p[0] &= ~(0x1f); p[0] |= b & 0x1f; }
#define BM_SET_A_ARGB(p, a)     { p[1] &= ~(0x80); p[1] |= ((a & 0x01) << 7); }

#define BM_SET_R_D3D(p, r)              { *p |= (ushort)(( (int)r / Gr_current_red->scale ) << Gr_current_red->shift); }
#define BM_SET_G_D3D(p, g)              { *p |= (ushort)(( (int)g / Gr_current_green->scale ) << Gr_current_green->shift); }
#define BM_SET_B_D3D(p, b)              { *p |= (ushort)(( (int)b / Gr_current_blue->scale ) << Gr_current_blue->shift); }
#define BM_SET_A_D3D(p, a)              { if(a == 0){ *p = (ushort)Gr_current_green->mask; } }

#define BM_SET_R(p, r)  { switch(Bm_pixel_format){ case BM_PIXEL_FORMAT_ARGB: BM_SET_R_ARGB(((char*)p), r); break; case BM_PIXEL_FORMAT_D3D: BM_SET_R_D3D(p, r); break; default: Int3(); } }
#define BM_SET_G(p, g)  { switch(Bm_pixel_format){ case BM_PIXEL_FORMAT_ARGB: BM_SET_G_ARGB(((char*)p), g); break; case BM_PIXEL_FORMAT_D3D: BM_SET_G_D3D(p, g); break; default: Int3(); } }
#define BM_SET_B(p, b)  { switch(Bm_pixel_format){ case BM_PIXEL_FORMAT_ARGB: BM_SET_B_ARGB(((char*)p), b); break; case BM_PIXEL_FORMAT_D3D: BM_SET_B_D3D(p, b); break;  default: Int3(); } }
#define BM_SET_A(p, a)  { switch(Bm_pixel_format){ case BM_PIXEL_FORMAT_ARGB: BM_SET_A_ARGB(((char*)p), a); break; case BM_PIXEL_FORMAT_D3D: BM_SET_A_D3D(p, a); break;  default: Int3(); } }

// ===========================================
// Mode: 0 = High memory
//       1 = Low memory ( every other frame of ani's)
//       2 = Debug low memory ( only use first frame of each ani )
void bm_set_low_mem( int mode )
{
        Assert( (mode >= 0)  && (mode<=2 ));
        Bm_low_mem = mode;
}


static int bm_get_next_handle()
{
        int n = bm_next_handle;
        bm_next_handle++;
        if ( bm_next_handle > 30000 )   {
                bm_next_handle = 1;
        }
        return n;
}

// Frees a bitmaps data if it should, and
// Returns true if bitmap n can free it's data.
static void bm_free_data(int n)
{
        bitmap_entry    *be;
        bitmap                  *bmp;

        Assert( n >= 0 && n < MAX_BITMAPS );

        be = &bm_bitmaps[n];
        bmp = &be->bm;

        // If there isn't a bitmap in this structure, don't
        // do anything but clear out the bitmap info
        if ( be->type==BM_TYPE_NONE) 
                goto SkipFree;

        // If this bitmap doesn't have any data to free, skip
        // the freeing it part of this.
        if ( bmp->data == 0 ) 
                goto SkipFree;

        // Don't free up memory for user defined bitmaps, since
        // BmpMan isn't the one in charge of allocating/deallocing them.
        if ( ( be->type==BM_TYPE_USER ) )       
                goto SkipFree;

        // Free up the data now!

        //      mprintf(( "Bitmap %d freed %d bytes\n", n, bm_bitmaps[n].data_size ));
        #ifdef BMPMAN_NDEBUG
                bm_texture_ram -= be->data_size;
        #endif
        free((void *)bmp->data);

SkipFree:

        // Clear out & reset the bitmap data structure
        bmp->flags = 0;
        bmp->bpp = 0;
        bmp->data = 0;
        bmp->palette = NULL;
        #ifdef BMPMAN_NDEBUG
                be->data_size = 0;
        #endif
        be->signature = Bm_next_signature++; 
}


#ifdef BMPMAN_NDEBUG

int Bm_ram_freed = 0;

static void bm_free_some_ram( int n, int size )
{
/*
        if ( Bm_max_ram < 1 ) return;
        if ( bm_texture_ram + size < Bm_max_ram ) return;

        int current_time = timer_get_milliseconds();

        while( bm_texture_ram + size > Bm_max_ram )     {
                Bm_ram_freed++;

                // Need to free some RAM up!
                int i, oldest=-1, best_val=0;
                for (i = 0; i < MAX_BITMAPS; i++)       {
                        if ( (bm_bitmaps[i].type != BM_TYPE_NONE) && (bm_bitmaps[i].first_frame!=bm_bitmaps[n].first_frame) && (bm_bitmaps[i].ref_count==0) && (bm_bitmaps[i].data_size>0) )    {
                                int page_func = ( current_time-bm_bitmaps[i].last_used)*bm_bitmaps[i].data_size;
                                if ( (oldest==-1) || (page_func>best_val) )     {
                                        oldest=i;
                                        best_val = page_func;
                                }
                        }
                }

                if ( oldest > -1 )      {
                        //mprintf(( "Freeing bitmap '%s'\n", bm_bitmaps[oldest].filename ));
                        for (i=0; i<bm_bitmaps[oldest].num_frames; i++ )        {
                                bm_free_data(bm_bitmaps[oldest].first_frame+i);
                        }
                } else {
                        //mprintf(( "Couldn't free enough! %d\n", bm_texture_ram ));
                        break;
                }
        }       
*/
}

#endif

static void *bm_malloc( int n, int size )
{
        Assert( n >= 0 && n < MAX_BITMAPS );
//      mprintf(( "Bitmap %d allocated %d bytes\n", n, size ));
        #ifdef BMPMAN_NDEBUG
        bm_free_some_ram( n, size );
        Assert( bm_bitmaps[n].data_size == 0 );
        bm_bitmaps[n].data_size += size;
        bm_texture_ram += size;
        #endif
        return malloc(size);
}

void bm_close()
{
        int i;
        if ( bm_inited )        {
                for (i=0; i<MAX_BITMAPS; i++ )  {
                        bm_free_data(i);                        // clears flags, bbp, data, etc
                }
                bm_inited = 0;
        }
}


void bm_init()
{
        int i;

        mprintf(( "Size of bitmap info = %d KB\n", sizeof( bm_bitmaps )/1024 ));
        mprintf(( "Size of bitmap extra info = %d bytes\n", sizeof( bm_extra_info ) ));
        
        if (!bm_inited) {
                bm_inited = 1;
                atexit(bm_close);
        }
        
        for (i=0; i<MAX_BITMAPS; i++ ) {
                bm_bitmaps[i].filename[0] = '\0';
                bm_bitmaps[i].type = BM_TYPE_NONE;
                bm_bitmaps[i].info.user.data = NULL;
                bm_bitmaps[i].bm.data = 0;
                bm_bitmaps[i].bm.palette = NULL;
                #ifdef BMPMAN_NDEBUG
                        bm_bitmaps[i].data_size = 0;
                        bm_bitmaps[i].used_count = 0;
                        bm_bitmaps[i].used_last_frame = 0;
                        bm_bitmaps[i].used_this_frame = 0;
                #endif
                bm_free_data(i);        // clears flags, bbp, data, etc
        }


}

#ifdef BMPMAN_NDEBUG

// Returns number of bytes of bitmaps locked this frame
// ntotal = number of bytes of bitmaps locked this frame
// nnew = number of bytes of bitmaps locked this frame that weren't locked last frame
void bm_get_frame_usage(int *ntotal, int *nnew)
{
        int i;
        
        *ntotal = 0;
        *nnew = 0;

        for (i=0; i<MAX_BITMAPS; i++ ) {
                if ( (bm_bitmaps[i].type != BM_TYPE_NONE) && (bm_bitmaps[i].used_this_frame))   {
                        if ( !bm_bitmaps[i].used_last_frame )   {
                                *nnew += bm_bitmaps[i].bm.w*bm_bitmaps[i].bm.h; 
                        }
                        *ntotal += bm_bitmaps[i].bm.w*bm_bitmaps[i].bm.h;
                }
                bm_bitmaps[i].used_last_frame = bm_bitmaps[i].used_this_frame;
                bm_bitmaps[i].used_this_frame = 0;
        }

}
#else
void bm_get_frame_usage(int *ntotal, int *nnew)
{
}
#endif

// given a loaded bitmap with valid info, calculate sections
void bm_calc_sections(bitmap *be)
{
        int idx;

        // number of x and y sections
        be->sections.num_x = (ubyte)(be->w / MAX_BMAP_SECTION_SIZE);
        if((be->sections.num_x * MAX_BMAP_SECTION_SIZE) < be->w){
                be->sections.num_x++;
        }
        be->sections.num_y = (ubyte)(be->h / MAX_BMAP_SECTION_SIZE);
        if((be->sections.num_y * MAX_BMAP_SECTION_SIZE) < be->h){
                be->sections.num_y++;
        }

        // calculate the offsets for each section
        for(idx=0; idx<be->sections.num_x; idx++){
                be->sections.sx[idx] = (ushort)(MAX_BMAP_SECTION_SIZE * idx);
        }
        for(idx=0; idx<be->sections.num_y; idx++){
                be->sections.sy[idx] = (ushort)(MAX_BMAP_SECTION_SIZE * idx);
        }
}

// Creates a bitmap that exists in RAM somewhere, instead
// of coming from a disk file.  You pass in a pointer to a
// block of 32 (or 8)-bit-per-pixel data.  Right now, the only
// bpp you can pass in is 32 or 8.  On success, it returns the
// bitmap number.  You cannot free that RAM until bm_release
// is called on that bitmap.
int bm_create( int bpp, int w, int h, void * data, int flags )
{
        int i, n, first_slot = MAX_BITMAPS;

        // Assert((bpp==32)||(bpp==8));
        if(bpp != 16){
                Assert(flags & BMP_AABITMAP);
        } else {
                Assert(bpp == 16);
        }

        if ( !bm_inited ) bm_init();

        for (i = MAX_BITMAPS-1; i >= 0; i-- ) {
                if ( bm_bitmaps[i].type == BM_TYPE_NONE )       {
                        first_slot = i;
                        break;
                }
        }

        n = first_slot;
        Assert( n > -1 );

        // Out of bitmap slots
        if ( n == -1 ) return -1;

        memset( &bm_bitmaps[n], 0, sizeof(bitmap_entry) );

        sprintf( bm_bitmaps[n].filename, "TMP%dx%d", w, h );
        bm_bitmaps[n].type = BM_TYPE_USER;
        bm_bitmaps[n].palette_checksum = 0;

        bm_bitmaps[n].bm.w = short(w);
        bm_bitmaps[n].bm.h = short(h);
        bm_bitmaps[n].bm.rowsize = short(w);
        bm_bitmaps[n].bm.bpp = (unsigned char)(bpp);
        bm_bitmaps[n].bm.flags = 0;
        bm_bitmaps[n].bm.flags |= flags;
        bm_bitmaps[n].bm.data = 0;
        bm_bitmaps[n].bm.palette = NULL;

        bm_bitmaps[n].info.user.bpp = ubyte(bpp);
        bm_bitmaps[n].info.user.data = data;
        bm_bitmaps[n].info.user.flags = ubyte(flags);

        bm_bitmaps[n].signature = Bm_next_signature++;

        bm_bitmaps[n].handle = bm_get_next_handle()*MAX_BITMAPS + n;
        bm_bitmaps[n].last_used = -1;

        // fill in section info
        bm_calc_sections(&bm_bitmaps[n].bm);
        
        return bm_bitmaps[n].handle;
}

// sub helper function. Given a raw filename and an extension, try and find the bitmap
// returns -1 if it could not be found
//          0 if it was found as a file
//          1 if it already exists, fills in handle
int Bm_ignore_duplicates = 0;
int bm_load_sub(char *real_filename, char *ext, int *handle)
{       
        int i;
        char filename[MAX_FILENAME_LEN] = "";
        
        strcpy( filename, real_filename );
        strcat( filename, ext );        
        for (i=0; i<(int)strlen(filename); i++ ){
                filename[i] = char(tolower(filename[i]));
        }               

        // try to find given filename to see if it has been loaded before
        if(!Bm_ignore_duplicates){
                for (i = 0; i < MAX_BITMAPS; i++) {
                        if ( (bm_bitmaps[i].type != BM_TYPE_NONE) && !stricmp(filename, bm_bitmaps[i].filename) ) {
                                nprintf (("BmpMan", "Found bitmap %s -- number %d\n", filename, i));
                                *handle = bm_bitmaps[i].handle;
                                return 1;
                        }
                }       
        }

        // try and find the file
        /*
        CFILE *test = cfopen(filename, "rb");
        if(test != NULL){
                cfclose(test);
                return 0;
        }
        */

        // could not be found
        return 0;
}

// This loads a bitmap so we can draw with it later.
// It returns a negative number if it couldn't load
// the bitmap.   On success, it returns the bitmap
// number.  Function doesn't acutally load the data, only
// width, height, and possibly flags.
int bm_load( char * real_filename )
{
        int i, n, first_slot = MAX_BITMAPS;
        int w, h, bpp;
        char filename[MAX_FILENAME_LEN];
        int tga = 0;
        int handle;
        int found = 0;

        if ( !bm_inited ) bm_init();

        // nice little trick for keeping standalone memory usage way low - always return a bogus bitmap 
        if(Game_mode & GM_STANDALONE_SERVER){
                strcpy(filename,"test128");
        }

        // make sure no one passed an extension
        strcpy( filename, real_filename );
        char *p = strchr( filename, '.' );
        if ( p ) {
                mprintf(( "Someone passed an extension to bm_load for file '%s'\n", real_filename ));
                //Int3();
                *p = 0;
        }
         
        // try and find the pcx file            
        switch(bm_load_sub(filename, ".pcx", &handle)){
        // error
        case -1:
                break;

        // found as a file
        case 0:
                found = 1;
                strcat(filename, ".pcx");
                break;

        // found as pre-existing
        case 1:
                found = 1;
                return handle;          
        }

        if(!found){
                // try and find the tga file
                switch(bm_load_sub(filename, ".tga", &handle)){
                // error
                case -1:                        
                        return -1;
                        break;

                // found as a file
                case 0:                 
                        strcat(filename, ".tga");
                        tga = 1;
                        break;

                // found as pre-existing
                case 1:                                         
                        return handle;                                  
                }
        }

        // if its a tga file
        if(tga){
                int tga_error=targa_read_header( filename, &w, &h, &bpp, NULL );
                if ( tga_error != TARGA_ERROR_NONE )    {
                        mprintf(( "Couldn't open '%s'\n", filename ));
                        return -1;
                }
        }
        // if its a pcx file
        else {
                int pcx_error=pcx_read_header( filename, &w, &h, NULL );                
                if ( pcx_error != PCX_ERROR_NONE )      {
                        mprintf(( "Couldn't open '%s'\n", filename ));
                        return -1;
                }
        }

        // Error( LOCATION, "Unknown bitmap type %s\n", filename );
                
        // Find an open slot
        for (i = 0; i < MAX_BITMAPS; i++) {
                if ( (bm_bitmaps[i].type == BM_TYPE_NONE) && (first_slot == MAX_BITMAPS) ){
                        first_slot = i;
                }
        }

        n = first_slot;
        Assert( n < MAX_BITMAPS );      

        if ( n == MAX_BITMAPS ) return -1;      

        // ensure fields are cleared out from previous bitmap
//      Assert(bm_bitmaps[n].bm.data == 0);
//      Assert(bm_bitmaps[n].bm.palette == NULL);
//      Assert(bm_bitmaps[n].ref_count == 0 );
//      Assert(bm_bitmaps[n].user_data == NULL);
        memset( &bm_bitmaps[n], 0, sizeof(bitmap_entry) );
        
        // Mark the slot as filled, because cf_read might load a new bitmap
        // into this slot.
        bm_bitmaps[n].type = tga ? (ubyte)BM_TYPE_TGA : (ubyte)BM_TYPE_PCX;
        bm_bitmaps[n].signature = Bm_next_signature++;
        Assert ( strlen(filename) < MAX_FILENAME_LEN );
        strncpy(bm_bitmaps[n].filename, filename, MAX_FILENAME_LEN-1 );
        bm_bitmaps[n].bm.w = short(w);
        bm_bitmaps[n].bm.rowsize = short(w);
        bm_bitmaps[n].bm.h = short(h);
        bm_bitmaps[n].bm.bpp = 0;
        bm_bitmaps[n].bm.flags = 0;
        bm_bitmaps[n].bm.data = 0;
        bm_bitmaps[n].bm.palette = NULL;

        bm_bitmaps[n].palette_checksum = 0;
        bm_bitmaps[n].handle = bm_get_next_handle()*MAX_BITMAPS + n;
        bm_bitmaps[n].last_used = -1;

        // fill in section info
        bm_calc_sections(&bm_bitmaps[n].bm);

        return bm_bitmaps[n].handle;
}

// special load function. basically allows you to load a bitmap which already exists (by filename). 
// this is useful because in some cases we need to have a bitmap which is locked in screen format
// _and_ texture format, such as pilot pics and squad logos
int bm_load_duplicate(char *filename)
{
        int ret;

        // ignore duplicates
        Bm_ignore_duplicates = 1;
        
        // load
        ret = bm_load(filename);

        // back to normal
        Bm_ignore_duplicates = 0;

        return ret;
}

DCF(bm_frag,"Shows BmpMan fragmentation")
{
        if ( Dc_command )       {

                gr_clear();

                int x=0, y=0;
                int xs=2, ys=2;
                int w=4, h=4;

                for (int i=0; i<MAX_BITMAPS; i++ )      {
                        switch( bm_bitmaps[i].type )    {
                        case BM_TYPE_NONE:
                                gr_set_color(128,128,128);
                                break;
                        case BM_TYPE_PCX:
                                gr_set_color(255,0,0);
                                break;
                        case BM_TYPE_USER:
                                gr_set_color(0,255,0);
                                break;
                        case BM_TYPE_ANI:
                                gr_set_color(0,0,255);
                                break;
                        }

                        gr_rect( x+xs, y+ys, w, h );
                        x += w+xs+xs;
                        if ( x > 639 )  {
                                x = 0;
                                y += h + ys + ys;
                        }

                }

                gr_flip();
                key_getch();
        }
}

static int find_block_of(int n)
{
        int i, cnt, nstart;

        cnt=0;
        nstart = 0;
        for (i=0; i<MAX_BITMAPS; i++ )  {
                if ( bm_bitmaps[i].type == BM_TYPE_NONE )       {
                        if (cnt==0) nstart = i;
                        cnt++;
                } else
                        cnt=0;
                if ( cnt == n ) return nstart;
        }

        // Error( LOCATION, "Couldn't find block of %d frames\n", n );
        return -1;
}

// ------------------------------------------------------------------
// bm_load_animation()
//
//      input:          filename                =>              filename of animation
//                                      nframes         =>              OUTPUT parameter:       number of frames in the animation
//                                      fps                     =>              OUTPUT/OPTIONAL parameter: intended fps for the animation
//
// returns:             bitmap number of first frame in the animation
//
int bm_load_animation( char *real_filename, int *nframes, int *fps, int can_drop_frames)
{
        int     i, n;
        anim    the_anim;
        CFILE   *fp;
        char filename[MAX_FILENAME_LEN];

        if ( !bm_inited ) bm_init();

        strcpy( filename, real_filename );
        char *p = strchr( filename, '.' );
        if ( p ) {
                mprintf(( "Someone passed an extension to bm_load_animation for file '%s'\n", real_filename ));
                //Int3();
                *p = 0;
        }
        strcat( filename, ".ani" );

        if ( (fp = cfopen(filename, "rb")) == NULL ) {
//              Error(LOCATION,"Could not open filename %s in bm_load_ani()\n", filename);
                return -1;
        }

        int reduced = 0;
#ifndef NDEBUG
        // for debug of ANI sizes
        strcpy(the_anim.name, real_filename);
#endif
        anim_read_header(&the_anim, fp);
        if ( can_drop_frames )  {
                if ( Bm_low_mem == 1 )  {
                        reduced = 1;
                        the_anim.total_frames = ( the_anim.total_frames+1)/2;
                } else if ( Bm_low_mem == 2 )   {
                        the_anim.total_frames = 1;      
                }
        }
        cfclose(fp);

        *nframes = the_anim.total_frames;
        if ( fps != NULL )      {
                if ( reduced )  {
                        *fps = the_anim.fps / 2;
                } else {
                        *fps = the_anim.fps;
                }
        }

        // first check to see if this ani already has it's frames loaded
        for (i = 0; i < MAX_BITMAPS; i++) {
                if ( (bm_bitmaps[i].type == BM_TYPE_ANI) && !stricmp(filename, bm_bitmaps[i].filename) ) {
                        break;
                }
        }
        
        if ( i < MAX_BITMAPS ) {
                // in low memory modes this can happen
                if(!Bm_low_mem){
                        Assert(bm_bitmaps[i].info.ani.num_frames == *nframes);
                }
                return bm_bitmaps[i].handle;
        }

        n = find_block_of(*nframes);
        if(n < 0){
                return -1;
        }
        // Assert( n >= 0 );

        int first_handle = bm_get_next_handle();

        Assert ( strlen(filename) < MAX_FILENAME_LEN );
        for ( i = 0; i < *nframes; i++ ) {
                memset( &bm_bitmaps[n+i], 0, sizeof(bitmap_entry) );
                bm_bitmaps[n+i].info.ani.first_frame = n;
                bm_bitmaps[n+i].info.ani.num_frames = ubyte(the_anim.total_frames);
                bm_bitmaps[n+i].info.ani.fps = ubyte(the_anim.fps);
                bm_bitmaps[n+i].bm.w = short(the_anim.width);
                bm_bitmaps[n+i].bm.rowsize = short(the_anim.width);
                bm_bitmaps[n+i].bm.h = short(the_anim.height);
                if ( reduced )  {
                        bm_bitmaps[n+i].bm.w /= 2;
                        bm_bitmaps[n+i].bm.rowsize /= 2;
                        bm_bitmaps[n+i].bm.h /= 2;
                }
                bm_bitmaps[n+i].bm.flags = 0;
                bm_bitmaps[n+i].bm.bpp = 0;
                bm_bitmaps[n+i].bm.data = 0;
                bm_bitmaps[n+i].bm.palette = NULL;
                bm_bitmaps[n+i].type = BM_TYPE_ANI;
                bm_bitmaps[n+i].palette_checksum = 0;
                bm_bitmaps[n+i].signature = Bm_next_signature++;
                bm_bitmaps[n+i].handle = first_handle*MAX_BITMAPS + n+i;
                bm_bitmaps[n+i].last_used = -1;

                // fill in section info
                bm_calc_sections(&bm_bitmaps[n+i].bm);

                if ( i == 0 )   {
                        sprintf( bm_bitmaps[n+i].filename, "%s", filename );
                } else {
                        sprintf( bm_bitmaps[n+i].filename, "%s[%d]", filename, i );
                }
        }

        return bm_bitmaps[n].handle;
}

// Gets info.   w,h,or flags,nframes or fps can be NULL if you don't care.
void bm_get_info( int handle, int *w, int * h, ubyte * flags, int *nframes, int *fps, bitmap_section_info **sections )
{
        bitmap * bmp;

        if ( !bm_inited ) return;

        int bitmapnum = handle % MAX_BITMAPS;
        Assert( bm_bitmaps[bitmapnum].handle == handle );               // INVALID BITMAP HANDLE!       
        
        if ( (bm_bitmaps[bitmapnum].type == BM_TYPE_NONE) || (bm_bitmaps[bitmapnum].handle != handle) ) {
                if (w) *w = 0;
                if (h) *h = 0;
                if (flags) *flags = 0;
                if (nframes) *nframes=0;
                if (fps) *fps=0;
                if (sections != NULL) *sections = NULL;
                return;
        }

        bmp = &(bm_bitmaps[bitmapnum].bm);

        if (w) *w = bmp->w;
        if (h) *h = bmp->h;
        if (flags) *flags = bmp->flags;
        if ( bm_bitmaps[bitmapnum].type == BM_TYPE_ANI )        {
                if (nframes) {
                        *nframes = bm_bitmaps[bitmapnum].info.ani.num_frames;
                } 
                if (fps) {
                        *fps= bm_bitmaps[bitmapnum].info.ani.fps;
                }
        } else {
                if (nframes) {
                        *nframes = 1;
                } 
                if (fps) {
                        *fps= 0;
                }
        }
        if(sections != NULL){
                *sections = &bm_bitmaps[bitmapnum].bm.sections;
        }
}

uint bm_get_signature( int handle )
{
        if ( !bm_inited ) bm_init();

        int bitmapnum = handle % MAX_BITMAPS;
        Assert( bm_bitmaps[bitmapnum].handle == handle );               // INVALID BITMAP HANDLE

        return bm_bitmaps[bitmapnum].signature;
}

extern int palman_is_nondarkening(int r,int g, int b);
static void bm_convert_format( int bitmapnum, bitmap *bmp, ubyte bpp, ubyte flags )
{       
        int idx;        
        int r, g, b, a;

        if(Fred_running || Pofview_running || Is_standalone){
                Assert(bmp->bpp == 8);

                return;
        } else {
                if(flags & BMP_AABITMAP){
                        Assert(bmp->bpp == 8);
                } else {
                        Assert(bmp->bpp == 16);
                }
        }

        // maybe swizzle to be an xparent texture
        if(!(bmp->flags & BMP_TEX_XPARENT) && (flags & BMP_TEX_XPARENT)){
                for(idx=0; idx<bmp->w*bmp->h; idx++){                   
                        
                        // if the pixel is transparent
                        if ( ((ushort*)bmp->data)[idx] == Gr_t_green.mask)      {
                                switch(Bm_pixel_format){
                                // 1555, all we need to do is zero the whole thing
                                case BM_PIXEL_FORMAT_ARGB:
                                case BM_PIXEL_FORMAT_ARGB_D3D:
                                        ((ushort*)bmp->data)[idx] = 0;
                                        break;
                                // d3d format
                                case BM_PIXEL_FORMAT_D3D:                                                                       
                                        r = g = b = a = 0;
                                        r /= Gr_t_red.scale;
                                        g /= Gr_t_green.scale;
                                        b /= Gr_t_blue.scale;
                                        a /= Gr_t_alpha.scale;
                                        ((ushort*)bmp->data)[idx] = (unsigned short)((a<<Gr_t_alpha.shift) | (r << Gr_t_red.shift) | (g << Gr_t_green.shift) |  (b << Gr_t_blue.shift));
                                        break;
                                default:
                                        Int3();
                                }
                        }
                }

                bmp->flags |= BMP_TEX_XPARENT;
        }       
}

// basically, map the bitmap into the current palette. used to be done for all pcx's, now just for
// Fred, since its the only thing that uses the software tmapper
void bm_swizzle_8bit_for_fred(bitmap_entry *be, bitmap *bmp, ubyte *data, ubyte *palette)
{               
        int pcx_xparent_index = -1;
        int i;
        int r, g, b;
        ubyte palxlat[256];

        for (i=0; i<256; i++ ) {
                r = palette[i*3];
                g = palette[i*3+1];
                b = palette[i*3+2];
                if ( g == 255 && r == 0 && b == 0 ) {
                        palxlat[i] = 255;
                        pcx_xparent_index = i;
                } else {                        
                        palxlat[i] = (ubyte)(palette_find( r, g, b ));                  
                }
        }               
        for (i=0; i<bmp->w * bmp->h; i++ ) {            
                ubyte c = palxlat[data[i]];                     
                data[i] = c;            
        }                       
        be->palette_checksum = gr_palette_checksum;     
}

void bm_lock_pcx( int handle, int bitmapnum, bitmap_entry *be, bitmap *bmp, ubyte bpp, ubyte flags )
{       
        ubyte *data, *palette;
        ubyte pal[768];
        palette = NULL;

        // Unload any existing data
        bm_free_data( bitmapnum );      

        // allocate bitmap data
        if(bpp == 8){
                // Assert(Fred_running || Pofview_running || Is_standalone);            
                        data = (ubyte *)bm_malloc(bitmapnum, bmp->w * bmp->h );
                #ifdef BMPMAN_NDEBUG
                        Assert( be->data_size == bmp->w * bmp->h );
                #endif
                palette = pal;
                bmp->data = (ptr_u)data;
                bmp->bpp = 8;
                bmp->palette = gr_palette;
                memset( data, 0, bmp->w * bmp->h);
        } else {
                data = (ubyte*)bm_malloc(bitmapnum, bmp->w * bmp->h * 2);       
                bmp->bpp = 16;
                bmp->data = (ptr_u)data;
                bmp->palette = NULL;
                memset( data, 0, bmp->w * bmp->h * 2);
        }       

        Assert( &be->bm == bmp );
        #ifdef BMPMAN_NDEBUG
                Assert( be->data_size > 0 );
        #endif

        // some sanity checks on flags
        Assert(!((flags & BMP_AABITMAP) && (flags & BMP_TEX_ANY)));                                             // no aabitmap textures
        Assert(!((flags & BMP_TEX_XPARENT) && (flags & BMP_TEX_NONDARK)));                      // can't be a transparent texture and a nondarkening texture 
        Assert(!((flags & BMP_TEX_NONDARK) && (gr_screen.mode == GR_DIRECT3D)));        // D3D should never be trying to get nondarkening textures

        if(bpp == 8){
                int pcx_error=pcx_read_bitmap_8bpp( be->filename, data, palette );
                if ( pcx_error != PCX_ERROR_NONE )      {
                        // Error( LOCATION, "Couldn't open '%s'\n", be->filename );
                        //Error( LOCATION, "Couldn't open '%s'\n", filename );
                        //return -1;
                }

                // now swizzle the thing into the proper format
                if(Fred_running || Pofview_running){
                        bm_swizzle_8bit_for_fred(be, bmp, data, palette);
                }
        } else {        
                int pcx_error;

                // load types
                if(flags & BMP_AABITMAP){
                        pcx_error = pcx_read_bitmap_16bpp_aabitmap( be->filename, data );
                } else if(flags & BMP_TEX_NONDARK){
                        pcx_error = pcx_read_bitmap_16bpp_nondark( be->filename, data );
                } else {
                        pcx_error = pcx_read_bitmap_16bpp( be->filename, data );
                }
                if ( pcx_error != PCX_ERROR_NONE )      {
                        // Error( LOCATION, "Couldn't open '%s'\n", be->filename );
                        //Error( LOCATION, "Couldn't open '%s'\n", filename );
                        //return -1;
                }
        }

        #ifdef BMPMAN_NDEBUG
        Assert( be->data_size > 0 );
        #endif          
        
        bmp->flags = 0; 
        bm_convert_format( bitmapnum, bmp, bpp, flags );
}

void bm_lock_ani( int handle, int bitmapnum, bitmap_entry *be, bitmap *bmp, ubyte bpp, ubyte flags )
{       
        anim                            *the_anim;
        anim_instance   *the_anim_instance;
        bitmap                  *bm;
        ubyte                           *frame_data;
        int                             size, i;
        int                             first_frame, nframes;   

        first_frame = be->info.ani.first_frame;
        nframes = bm_bitmaps[first_frame].info.ani.num_frames;

        if ( (the_anim = anim_load(bm_bitmaps[first_frame].filename)) == NULL ) {
                // Error(LOCATION, "Error opening %s in bm_lock\n", be->filename);
        }

        if ( (the_anim_instance = init_anim_instance(the_anim, bpp)) == NULL ) {
                // Error(LOCATION, "Error opening %s in bm_lock\n", be->filename);
                anim_free(the_anim);
        }

        int can_drop_frames = 0;

        if ( the_anim->total_frames != bm_bitmaps[first_frame].info.ani.num_frames )    {
                can_drop_frames = 1;
        }
        bm = &bm_bitmaps[first_frame].bm;
        if(bpp == 16){
                size = bm->w * bm->h * 2;
        } else {
                size = bm->w * bm->h;
        }
                
        for ( i=0; i<nframes; i++ )     {
                be = &bm_bitmaps[first_frame+i];
                bm = &bm_bitmaps[first_frame+i].bm;

                // Unload any existing data
                bm_free_data( first_frame+i );

                bm->flags = 0;
                // briefing editor in Fred2 uses aabitmaps (ani's) - force to 8 bit
                if(Fred_running || Is_standalone){
                        bm->bpp = 8;
                } else {
                        bm->bpp = bpp;
                }
                bm->data = (ptr_u)bm_malloc(first_frame + i, size);

                frame_data = anim_get_next_raw_buffer(the_anim_instance, 0 ,flags & BMP_AABITMAP ? 1 : 0, bm->bpp);

                if ( frame_data == NULL ) {
                        // Error(LOCATION,"Fatal error locking .ani file: %s\n", be->filename);
                }               
                
                ubyte *dptr, *sptr;

                sptr = frame_data;
                dptr = (ubyte *)bm->data;

                if ( (bm->w!=the_anim->width) || (bm->h!=the_anim->height) )    {
                        // Scale it down
                        // Int3();                      // not ready yet - should only be ingame
        
                        // 8 bit
                        if(bpp == 8){
                                int w,h;
                                fix u, utmp, v, du, dv;

                                u = v = 0;

                                du = ( the_anim->width*F1_0 ) / bm->w;
                                dv = ( the_anim->height*F1_0 ) / bm->h;
                                                                                                
                                for (h = 0; h < bm->h; h++) {
                                        ubyte *drow = &dptr[bm->w * h];
                                        ubyte *srow = &sptr[f2i(v)*the_anim->width];

                                        utmp = u;

                                        for (w = 0; w < bm->w; w++) {
                                                *drow++ = srow[f2i(utmp)];
                                                utmp += du;
                                        }
                                        v += dv;
                                }                       
                        }
                        // 16 bpp
                        else {
                                int w,h;
                                fix u, utmp, v, du, dv;

                                u = v = 0;

                                du = ( the_anim->width*F1_0 ) / bm->w;
                                dv = ( the_anim->height*F1_0 ) / bm->h;
                                                                                                
                                for (h = 0; h < bm->h; h++) {
                                        ushort *drow = &((ushort*)dptr)[bm->w * h];
                                        ushort *srow = &((ushort*)sptr)[f2i(v)*the_anim->width];

                                        utmp = u;

                                        for (w = 0; w < bm->w; w++) {
                                                *drow++ = srow[f2i(utmp)];
                                                utmp += du;
                                        }
                                        v += dv;
                                }                       
                        }                       
                } else {
                        // 1-to-1 mapping
                        memcpy(dptr, sptr, size);
                }               

                bm_convert_format( first_frame+i, bm, bpp, flags );

                // Skip a frame
                if ( (i < nframes-1)  && can_drop_frames )      {
                        frame_data = anim_get_next_raw_buffer(the_anim_instance, 0, flags & BMP_AABITMAP ? 1 : 0, bm->bpp);
                }

                //mprintf(( "Checksum = %d\n", be->palette_checksum ));
        }

        free_anim_instance(the_anim_instance);
        anim_free(the_anim);
}


void bm_lock_user( int handle, int bitmapnum, bitmap_entry *be, bitmap *bmp, ubyte bpp, ubyte flags )
{
        // int idx;     
        // ushort bit_16;

        // Unload any existing data
        bm_free_data( bitmapnum );      

        switch( be->info.user.bpp )     {
        case 16:                        // user 16 bit bitmap
                bmp->bpp = bpp;
                bmp->flags = be->info.user.flags;               
                bmp->data = (ptr_u)be->info.user.data;                                                          
                break;  
        
        case 8:                 // Going from 8 bpp to something (probably only for aabitmaps)
                /*
                Assert(flags & BMP_AABITMAP);
                bmp->bpp = 16;
                bmp->data = (uint)malloc(bmp->w * bmp->h * 2);
                bmp->flags = be->info.user.flags;
                bmp->palette = NULL;

                // go through and map the pixels
                for(idx=0; idx<bmp->w * bmp->h; idx++){                 
                        bit_16 = (ushort)((ubyte*)be->info.user.data)[idx];                     
                        Assert(bit_16 <= 255);

                        // stuff the final result
                        memcpy((char*)bmp->data + (idx * 2), &bit_16, sizeof(ushort));
                }
                */              
                Assert(flags & BMP_AABITMAP);
                bmp->bpp = bpp;
                bmp->flags = be->info.user.flags;               
                bmp->data = (ptr_u)be->info.user.data;                                                          
                break;
                
        // default:
                // Error( LOCATION, "Unhandled user bitmap conversion from %d to %d bpp", be->info.user.bpp, bmp->bpp );
        }

        bm_convert_format( bitmapnum, bmp, bpp, flags );
}

void bm_lock_tga( int handle, int bitmapnum, bitmap_entry *be, bitmap *bmp, ubyte bpp, ubyte flags )
{
        ubyte *data;    

        // Unload any existing data
        bm_free_data( bitmapnum );      

        if(Fred_running || Is_standalone){
                Assert(bpp == 8);
        } else {
                Assert(bpp == 16);
        }

        // should never try to make an aabitmap out of a targa
        Assert(!(flags & BMP_AABITMAP));

        // allocate bitmap data 
        if(bpp == 16){
                data = (ubyte*)bm_malloc(bitmapnum, bmp->w * bmp->h * 2);       
        } else {
                data = (ubyte*)bm_malloc(bitmapnum, bmp->w * bmp->h);   
        }
        bmp->bpp = bpp;
        bmp->data = (ptr_u)data;
        bmp->palette = NULL;
        if(bpp == 16){
                memset( data, 0, bmp->w * bmp->h * 2);  
        } else {
                memset( data, 0, bmp->w * bmp->h );     
        }

        Assert( &be->bm == bmp );
        #ifdef BMPMAN_NDEBUG
        Assert( be->data_size > 0 );
        #endif
        
        int tga_error=targa_read_bitmap( be->filename, data, NULL, (bpp == 16) ? 2 : 1);
        if ( tga_error != TARGA_ERROR_NONE )    {
                // Error( LOCATION, "Couldn't open '%s'\n", be->filename );
                //Error( LOCATION, "Couldn't open '%s'\n", filename );
                //return -1;
        }

        #ifdef BMPMAN_NDEBUG
        Assert( be->data_size > 0 );
        #endif          
        
        bmp->flags = 0; 
        bm_convert_format( bitmapnum, bmp, bpp, flags );
}

MONITOR( NumBitmapPage );
MONITOR( SizeBitmapPage );

// This locks down a bitmap and returns a pointer to a bitmap
// that can be accessed until you call bm_unlock.   Only lock
// a bitmap when you need it!  This will convert it into the 
// appropriate format also.
bitmap * bm_lock( int handle, ubyte bpp, ubyte flags )
{
        bitmap                  *bmp;
        bitmap_entry    *be;


        if ( !bm_inited ) bm_init();

        int bitmapnum = handle % MAX_BITMAPS;
        Assert( bm_bitmaps[bitmapnum].handle == handle );               // INVALID BITMAP HANDLE

//      flags &= (~BMP_RLE);

        // if we're on a standalone server, aways for it to lock to 8 bits
        if(Is_standalone){
                bpp = 8;
                flags = 0;
        } 
        // otherwise do it as normal
        else {
                if(Fred_running || Pofview_running){
                        Assert( bpp == 8 );
                        Assert( (bm_bitmaps[bitmapnum].type == BM_TYPE_PCX) || (bm_bitmaps[bitmapnum].type == BM_TYPE_ANI) || (bm_bitmaps[bitmapnum].type == BM_TYPE_TGA));
                } else {
                        if(flags & BMP_AABITMAP){
                                Assert( bpp == 8 );
                        } else {
                                Assert( bpp == 16 );
                        }
                }
        }

        be = &bm_bitmaps[bitmapnum];
        bmp = &be->bm;

        // If you hit this assert, chances are that someone freed the
        // wrong bitmap and now someone is trying to use that bitmap.
        // See John.
        Assert( be->type != BM_TYPE_NONE );             

        // Increment ref count for bitmap since lock was made on it.
        Assert(be->ref_count >= 0);
        be->ref_count++;                                        // Lock it before we page in data; this prevents a callback from freeing this
                                                                                        // as it gets read in

        // Mark this bitmap as used this frame
        #ifdef BMPMAN_NDEBUG
        if ( be->used_this_frame < 255 )        {
                be->used_this_frame++;
        }
        #endif

        // if bitmap hasn't been loaded yet, then load it from disk
        // reread the bitmap from disk under certain conditions
        int pal_changed = 0;
        int rle_changed = 0;
        int fake_xparent_changed = 0;   
        if ( (bmp->data == 0) || (bpp != bmp->bpp) || pal_changed || rle_changed || fake_xparent_changed ) {
                Assert(be->ref_count == 1);

                if ( be->type != BM_TYPE_USER ) {
                        if ( bmp->data == 0 ) {
                                nprintf (("BmpMan","Loading %s for the first time.\n", be->filename));
                        } else if ( bpp != bmp->bpp ) {
                                nprintf (("BmpMan","Reloading %s from bitdepth %d to bitdepth %d\n", be->filename, bmp->bpp, bpp));
                        } else if ( pal_changed ) {
                                nprintf (("BmpMan","Reloading %s to remap palette\n", be->filename));
                        } else if ( rle_changed )       {
                                nprintf (("BmpMan","Reloading %s to change RLE.\n", be->filename));
                        } else if ( fake_xparent_changed )      {
                                nprintf (("BmpMan","Reloading %s to change fake xparency.\n", be->filename));
                        }
                }

                MONITOR_INC( NumBitmapPage, 1 );
                MONITOR_INC( SizeBitmapPage, bmp->w*bmp->h );

                if ( !Bm_paging )       {
                        if ( be->type != BM_TYPE_USER ) {
                                char flag_text[64];
                                strcpy( flag_text, "--" );                                                      
                                nprintf(( "Paging", "Loading %s (%dx%dx%dx%s)\n", be->filename, bmp->w, bmp->h, bpp, flag_text ));
                        }
                }

                // select proper format
                if(flags & BMP_AABITMAP){
                        BM_SELECT_ALPHA_TEX_FORMAT();
                } else if(flags & BMP_TEX_ANY){
                        BM_SELECT_TEX_FORMAT();                                 
                } else {
                        BM_SELECT_SCREEN_FORMAT();
                }

                switch ( be->type ) {
                case BM_TYPE_PCX:
                        bm_lock_pcx( handle, bitmapnum, be, bmp, bpp, flags );
                        break;

                case BM_TYPE_ANI: 
                        bm_lock_ani( handle, bitmapnum, be, bmp, bpp, flags );
                        break;

                case BM_TYPE_USER:      
                        bm_lock_user( handle, bitmapnum, be, bmp, bpp, flags );
                        break;

                case BM_TYPE_TGA:
                        bm_lock_tga( handle, bitmapnum, be, bmp, bpp, flags );
                        break;

                default:
                        Warning(LOCATION, "Unsupported type in bm_lock -- %d\n", be->type );
                        return NULL;
                }               

                // always go back to screen format
                BM_SELECT_SCREEN_FORMAT();
        }

        if ( be->type == BM_TYPE_ANI ) {
                int i,first = bm_bitmaps[bitmapnum].info.ani.first_frame;

                for ( i=0; i< bm_bitmaps[first].info.ani.num_frames; i++ )      {
                        // Mark all the bitmaps in this bitmap or animation as recently used
                        bm_bitmaps[first+i].last_used = timer_get_milliseconds();

                        // Mark all the bitmaps in this bitmap or animation as used for the usage tracker.
                        #ifdef BMPMAN_NDEBUG
                                bm_bitmaps[first+i].used_count++;
                        #endif
                        bm_bitmaps[first+i].used_flags = flags;
                }
        } else {
                // Mark all the bitmaps in this bitmap or animation as recently used
                be->last_used = timer_get_milliseconds();

                // Mark all the bitmaps in this bitmap or animation as used for the usage tracker.
                #ifdef BMPMAN_NDEBUG
                        be->used_count++;
                #endif
                be->used_flags = flags;
        }

        return bmp;
}

// Unlocks a bitmap
//
// Decrements the ref_count member of the bitmap_entry struct.  A bitmap can only be unloaded
// when the ref_count is 0.
//
void bm_unlock( int handle )
{
        bitmap_entry    *be;
        bitmap                  *bmp;

        int bitmapnum = handle % MAX_BITMAPS;
        Assert( bm_bitmaps[bitmapnum].handle == handle );       // INVALID BITMAP HANDLE

        Assert(bitmapnum >= 0 && bitmapnum < MAX_BITMAPS);
        if ( !bm_inited ) bm_init();

        be = &bm_bitmaps[bitmapnum];
        bmp = &be->bm;

        be->ref_count--;
        Assert(be->ref_count >= 0);             // Trying to unlock data more times than lock was called!!!

}


void bm_update()
{
}

char *bm_get_filename(int handle)
{
        int n;

        n = handle % MAX_BITMAPS;
        Assert(bm_bitmaps[n].handle == handle);         // INVALID BITMAP HANDLE
        return bm_bitmaps[n].filename;
}

void bm_get_palette(int handle, ubyte *pal, char *name)
{
        char *filename;
        int w,h;

        int n= handle % MAX_BITMAPS;
        Assert( bm_bitmaps[n].handle == handle );               // INVALID BITMAP HANDLE

        filename = bm_bitmaps[n].filename;

        if (name)       {
                strcpy( name, filename );
        }

        int pcx_error=pcx_read_header( filename, &w, &h, pal );
        if ( pcx_error != PCX_ERROR_NONE ){
                // Error(LOCATION, "Couldn't open '%s'\n", filename );
        }
}

// --------------------------------------------------------------------------------------
// bm_release()  - unloads the bitmap's data and entire slot, so bitmap 'n' won't be valid anymore
//
// parameters:          n               =>              index into bm_bitmaps ( index returned from bm_load() or bm_create() )
//
// returns:                     nothing

// opengl hack
void opengl_free_texture_with_handle(int handle);
void bm_release(int handle)
{
        bitmap_entry    *be;

        int n = handle % MAX_BITMAPS;

        Assert(n >= 0 && n < MAX_BITMAPS);
        be = &bm_bitmaps[n];

        if ( bm_bitmaps[n].type == BM_TYPE_NONE ) {
                return; // Already been released?
        }

        if ( bm_bitmaps[n].type != BM_TYPE_USER )       {
                return;
        }

        Assert( be->handle == handle );         // INVALID BITMAP HANDLE

        // If it is locked, cannot free it.
        if (be->ref_count != 0) {
                nprintf(("BmpMan", "tried to unload %s that has a lock count of %d.. not unloading\n", be->filename, be->ref_count));
                return;
        }

// until opengl mode gets a proper texture manager, this will have to do
#ifdef PLAT_UNIX
        opengl_free_texture_with_handle(handle);
#endif

        bm_free_data(n);

        if ( bm_bitmaps[n].type == BM_TYPE_USER )       {
                bm_bitmaps[n].info.user.data = NULL;
                bm_bitmaps[n].info.user.bpp = 0;
        }


        bm_bitmaps[n].type = BM_TYPE_NONE;

        // Fill in bogus structures!

        // For debugging:
        strcpy( bm_bitmaps[n].filename, "IVE_BEEN_RELEASED!" );
        bm_bitmaps[n].signature = 0xDEADBEEF;                                                                   // a unique signature identifying the data
        bm_bitmaps[n].palette_checksum = 0xDEADBEEF;                                                    // checksum used to be sure bitmap is in current palette

        // bookeeping
        #ifdef BMPMAN_NDEBUG
        bm_bitmaps[n].data_size = -1;                                                                   // How much data this bitmap uses
        #endif
        bm_bitmaps[n].ref_count = -1;                                                                   // Number of locks on bitmap.  Can't unload unless ref_count is 0.

        // Bitmap info
        bm_bitmaps[n].bm.w = bm_bitmaps[n].bm.h = -1;
        
        // Stuff needed for animations
        // Stuff needed for user bitmaps
        memset( &bm_bitmaps[n].info, 0, sizeof(bm_extra_info) );

        bm_bitmaps[n].handle = -1;
}






// --------------------------------------------------------------------------------------
// bm_unload()  - unloads the data, but not the bitmap info.
//
// parameters:          n               =>              index into bm_bitmaps ( index returned from bm_load() or bm_create() )
//
// returns:                     0               =>              unload failed
//                                              1               =>              unload successful
//
int bm_unload( int handle )
{
        bitmap_entry    *be;
        bitmap                  *bmp;

        int n = handle % MAX_BITMAPS;

        Assert(n >= 0 && n < MAX_BITMAPS);
        be = &bm_bitmaps[n];
        bmp = &be->bm;

        if ( be->type == BM_TYPE_NONE ) {
                return 0;               // Already been released
        }

        Assert( be->handle == handle );         // INVALID BITMAP HANDLE!

        // If it is locked, cannot free it.
        if (be->ref_count != 0) {
                nprintf(("BmpMan", "tried to unload %s that has a lock count of %d.. not unloading\n", be->filename, be->ref_count));
                return 0;
        }

        nprintf(("BmpMan", "unloading %s.  %dx%dx%d\n", be->filename, bmp->w, bmp->h, bmp->bpp));
        bm_free_data(n);                // clears flags, bbp, data, etc

        return 1;
}


// unload all used bitmaps
void bm_unload_all()
{
        int i;

        for (i = 0; i < MAX_BITMAPS; i++)       {
                if ( bm_bitmaps[i].type != BM_TYPE_NONE )       {
                        bm_unload(bm_bitmaps[i].handle);
                }
        }
}


DCF(bmpman,"Shows/changes bitmap caching parameters and usage")
{
        if ( Dc_command )       {
                dc_get_arg(ARG_STRING);
                if ( !strcmp( Dc_arg, "flush" ))        {
                        dc_printf( "Total RAM usage before flush: %d bytes\n", bm_texture_ram );
                        int i;
                        for (i = 0; i < MAX_BITMAPS; i++)       {
                                if ( bm_bitmaps[i].type != BM_TYPE_NONE )       {
                                        bm_free_data(i);
                                }
                        }
                        dc_printf( "Total RAM after flush: %d bytes\n", bm_texture_ram );
                } else if ( !strcmp( Dc_arg, "ram" ))   {
                        dc_get_arg(ARG_INT);
                        Bm_max_ram = Dc_arg_int*1024*1024;
                } else {
                        // print usage, not stats
                        Dc_help = 1;
                }
        }

        if ( Dc_help )  {
                dc_printf( "Usage: BmpMan keyword\nWhere keyword can be in the following forms:\n" );
                dc_printf( "BmpMan flush    Unloads all bitmaps.\n" );
                dc_printf( "BmpMan ram x    Sets max mem usage to x MB. (Set to 0 to have no limit.)\n" );
                dc_printf( "\nUse '? BmpMan' to see status of Bitmap manager.\n" );
                Dc_status = 0;  // don't print status if help is printed.  Too messy.
        }

        if ( Dc_status )        {
                dc_printf( "Total RAM usage: %d bytes\n", bm_texture_ram );


                if ( Bm_max_ram > 1024*1024 )
                        dc_printf( "Max RAM allowed: %.1f MB\n", i2fl(Bm_max_ram)/(1024.0f*1024.0f) );
                else if ( Bm_max_ram > 1024 )
                        dc_printf( "Max RAM allowed: %.1f KB\n", i2fl(Bm_max_ram)/(1024.0f) );
                else if ( Bm_max_ram > 0 )
                        dc_printf( "Max RAM allowed: %d bytes\n", Bm_max_ram );
                else
                        dc_printf( "No RAM limit\n" );


        }
}

// Marks a texture as being used for this level
void bm_page_in_texture( int bitmapnum, int nframes )
{
        int i;
        for (i=0; i<nframes;i++ )       {
                int n = bitmapnum % MAX_BITMAPS;

                bm_bitmaps[n+i].preloaded = 1;

                if ( D3D_enabled )      {
                        bm_bitmaps[n+i].used_flags = BMP_TEX_OTHER;
                } else {                        
                        bm_bitmaps[n+i].used_flags = 0;
                }
        }
}

// Marks a texture as being used for this level
// If num_frames is passed, assume this is an animation
void bm_page_in_nondarkening_texture( int bitmapnum, int nframes )
{
        int i;
        for (i=0; i<nframes;i++ )       {
                int n = bitmapnum % MAX_BITMAPS;

                bm_bitmaps[n+i].preloaded = 4;

                if ( D3D_enabled )      {                       
                        bm_bitmaps[n+i].used_flags = BMP_TEX_NONDARK;
                } else {
                        bm_bitmaps[n+i].used_flags = 0;
                }
        }
}

// marks a texture as being a transparent textyre used for this level
// Marks a texture as being used for this level
// If num_frames is passed, assume this is an animation
void bm_page_in_xparent_texture( int bitmapnum, int nframes)
{
        int i;
        for (i=0; i<nframes;i++ )       {
                int n = bitmapnum % MAX_BITMAPS;

                bm_bitmaps[n+i].preloaded = 3;

                if ( D3D_enabled )      {
                        // bm_bitmaps[n+i].used_flags = BMP_NO_PALETTE_MAP;
                        bm_bitmaps[n+i].used_flags = BMP_TEX_XPARENT;
                } else {
                        bm_bitmaps[n+i].used_flags = 0;
                }
        }
}

// Marks an aabitmap as being used for this level
void bm_page_in_aabitmap( int bitmapnum, int nframes )
{
        int i;

        for (i=0; i<nframes;i++ )       {
                int n = bitmapnum % MAX_BITMAPS;

                bm_bitmaps[n+i].preloaded = 2;
        
                if ( D3D_enabled )      {
                        bm_bitmaps[n+i].used_flags = BMP_AABITMAP;
                } else {
                        bm_bitmaps[n+i].used_flags = 0;
                }
        }
}



// Tell the bitmap manager to start keeping track of what bitmaps are used where.
void bm_page_in_start()
{
        int i;

        Bm_paging = 1;

        // Mark all as inited
        for (i = 0; i < MAX_BITMAPS; i++)       {
                if ( bm_bitmaps[i].type != BM_TYPE_NONE )       {
                        bm_unload(bm_bitmaps[i].handle);
                }
                bm_bitmaps[i].preloaded = 0;
                #ifdef BMPMAN_NDEBUG
                        bm_bitmaps[i].used_count = 0;
                #endif
                bm_bitmaps[i].used_flags = 0;
        }

}

#ifndef PLAT_UNIX
extern void gr_d3d_preload_init();
extern int gr_d3d_preload(int bitmap_num, int is_aabitmap );
#endif
extern void gr_opengl_preload_init();
extern int gr_opengl_preload(int bitmap_num, int is_aabitmap );

void bm_page_in_stop()
{       
        int i;  
        int ship_info_index;

        nprintf(( "BmpInfo","BMPMAN: Loading all used bitmaps.\n" ));

        // Load all the ones that are supposed to be loaded for this level.
        int n = 0;

        #ifdef BMPMAN_NDEBUG
        Bm_ram_freed = 0;
        #endif

        int d3d_preloading = 1;

#ifndef PLAT_UNIX
        if (gr_screen.mode == GR_DIRECT3D) {
                gr_d3d_preload_init();
        } else
#endif  
        if (gr_screen.mode == GR_OPENGL) {
                gr_opengl_preload_init();
        }

        for (i = 0; i < MAX_BITMAPS; i++)       {
                if ( bm_bitmaps[i].type != BM_TYPE_NONE )       {
                        if ( bm_bitmaps[i].preloaded )  {
#ifdef BMPMAN_SPECIAL_NONDARK
                                // if this is a texture, check to see if a ship uses it
                                ship_info_index = ship_get_texture(bm_bitmaps[i].handle);
                                // use the colors from this ship
                                if((ship_info_index >= 0) && (Ship_info[ship_info_index].num_nondark_colors > 0)){
                                        // mprintf(("Using custom pixels for %s\n", Ship_info[ship_info_index].name));
                                        palman_set_nondarkening(Ship_info[ship_info_index].nondark_colors, Ship_info[ship_info_index].num_nondark_colors);
                                }
                                // use the colors from the default table
                                else {
                                        // mprintf(("Using default pixels\n"));
                                        palman_set_nondarkening(Palman_non_darkening_default, Palman_num_nondarkening_default);
                                }
#endif

                                // if preloaded == 3, load it as an xparent texture                             
                                if(bm_bitmaps[i].used_flags == BMP_AABITMAP){
                                        bm_lock( bm_bitmaps[i].handle, 8, bm_bitmaps[i].used_flags );
                                } else {
                                        bm_lock( bm_bitmaps[i].handle, 16, bm_bitmaps[i].used_flags );
                                }
                                bm_unlock( bm_bitmaps[i].handle );

                                if ( d3d_preloading )   {
#ifndef PLAT_UNIX
                                        if (gr_screen.mode == GR_DIRECT3D) {
                                                if ( !gr_d3d_preload(bm_bitmaps[i].handle, (bm_bitmaps[i].preloaded==2) ) )     {
                                                        mprintf(( "Out of VRAM.  Done preloading.\n" ));
                                                        d3d_preloading = 0;
                                                }
                                        } else 
#endif                                  
                                        if (gr_screen.mode == GR_OPENGL) {
                                                if ( !gr_opengl_preload(bm_bitmaps[i].handle, (bm_bitmaps[i].preloaded==2) ) )  {
                                                        mprintf(( "Out of VRAM.  Done preloading.\n" ));
                                                        d3d_preloading = 0;
                                                }
                                        }
                                }
                                
                                n++;
                                #ifdef BMPMAN_NDEBUG
                                if ( Bm_ram_freed )     {
                                        nprintf(( "BmpInfo","BMPMAN: Not enough cache memory to load all level bitmaps\n" ));
                                        break;
                                }
                                #endif
                        } 
                }
                game_busy();
        }
        nprintf(( "BmpInfo","BMPMAN: Loaded %d bitmaps that are marked as used for this level.\n", n ));

        int total_bitmaps = 0;
        for (i = 0; i < MAX_BITMAPS; i++)       {
                if ( bm_bitmaps[i].type != BM_TYPE_NONE )       {
                        total_bitmaps++;
                }
                if ( bm_bitmaps[i].type == BM_TYPE_USER )       {
                        mprintf(( "User bitmap '%s'\n", bm_bitmaps[i].filename ));
                }
        }       

        mprintf(( "Bmpman: %d/%d bitmap slots in use.\n", total_bitmaps, MAX_BITMAPS ));
        //mprintf(( "Bmpman: Usage went from %d KB to %d KB.\n", usage_before/1024, usage_after/1024 ));

        Bm_paging = 0;
}

int bm_get_cache_slot( int bitmap_id, int separate_ani_frames )
{
        int n = bitmap_id % MAX_BITMAPS;

        Assert( bm_bitmaps[n].handle == bitmap_id );            // INVALID BITMAP HANDLE

        bitmap_entry    *be = &bm_bitmaps[n];

        if ( (!separate_ani_frames) && (be->type == BM_TYPE_ANI) )      {
                return be->info.ani.first_frame;
        } 

        return n;

}

// convert a 24 bit value to a 16 bit value
void bm_24_to_16(int bit_24, ushort *bit_16)
{
        ubyte *pixel = (ubyte*)&bit_24;
        ubyte alpha = 1;

        bm_set_components((ubyte*)bit_16, (ubyte*)&pixel[0], (ubyte*)&pixel[1], (ubyte*)&pixel[2], &alpha);     
}

extern int D3D_32bit;

void (*bm_set_components)(ubyte *pixel, ubyte *r, ubyte *g, ubyte *b, ubyte *a) = NULL;

void bm_set_components_argb(ubyte *pixel, ubyte *rv, ubyte *gv, ubyte *bv, ubyte *av)
{
        // rgba 
        *((ushort*)pixel) |= (ushort)(( (int)*rv / Gr_current_red->scale ) << Gr_current_red->shift);
        *((ushort*)pixel) |= (ushort)(( (int)*gv / Gr_current_green->scale ) << Gr_current_green->shift);
        *((ushort*)pixel) |= (ushort)(( (int)*bv / Gr_current_blue->scale ) << Gr_current_blue->shift);
        *((ushort*)pixel) &= ~(0x8000);
        if (*((ushort*)pixel) == (ushort)Gr_current_green->mask) {
                *((ushort*)pixel) = 0;
        } else {
                if(*av){
                        *((ushort*)pixel) |= 0x8000;
                }
        }
}

void bm_set_components_d3d(ubyte *pixel, ubyte *rv, ubyte *gv, ubyte *bv, ubyte *av)
{
        // rgba 
        *((ushort*)pixel) |= (ushort)(( (int)*rv / Gr_current_red->scale ) << Gr_current_red->shift);
        *((ushort*)pixel) |= (ushort)(( (int)*gv / Gr_current_green->scale ) << Gr_current_green->shift);
        *((ushort*)pixel) |= (ushort)(( (int)*bv / Gr_current_blue->scale ) << Gr_current_blue->shift);
        if(*av == 0){ 
                *((ushort*)pixel) = (ushort)Gr_current_green->mask;
        }
}

void bm_set_components_argb_d3d_16_screen(ubyte *pixel, ubyte *rv, ubyte *gv, ubyte *bv, ubyte *av)
{
        *((ushort*)pixel) |= (ushort)(( (int)*rv / Gr_current_red->scale ) << Gr_current_red->shift);
        *((ushort*)pixel) |= (ushort)(( (int)*gv / Gr_current_green->scale ) << Gr_current_green->shift);
        *((ushort*)pixel) |= (ushort)(( (int)*bv / Gr_current_blue->scale ) << Gr_current_blue->shift);
        if(*av == 0){                           
                *((ushort*)pixel) = (ushort)Gr_current_green->mask;
        }                       
}

void bm_set_components_argb_d3d_32_screen(ubyte *pixel, ubyte *rv, ubyte *gv, ubyte *bv, ubyte *av)
{
        *((uint*)pixel) |= (uint)(( (int)*rv / Gr_current_red->scale ) << Gr_current_red->shift);
        *((uint*)pixel) |= (uint)(( (int)*gv / Gr_current_green->scale ) << Gr_current_green->shift);
        *((uint*)pixel) |= (uint)(( (int)*bv / Gr_current_blue->scale ) << Gr_current_blue->shift);
        if(*av == 0){                           
                *((uint*)pixel) = (uint)Gr_current_green->mask;         
        }
}

void bm_set_components_argb_d3d_16_tex(ubyte *pixel, ubyte *rv, ubyte *gv, ubyte *bv, ubyte *av)
{
        *((ushort*)pixel) |= (ushort)(( (int)*rv / Gr_current_red->scale ) << Gr_current_red->shift);
        *((ushort*)pixel) |= (ushort)(( (int)*gv / Gr_current_green->scale ) << Gr_current_green->shift);
        *((ushort*)pixel) |= (ushort)(( (int)*bv / Gr_current_blue->scale ) << Gr_current_blue->shift);
        *((ushort*)pixel) &= ~(Gr_current_alpha->mask);
        if(*av){
                *((ushort*)pixel) |= (ushort)(Gr_current_alpha->mask);
        } else {
                *((ushort*)pixel) = 0;
        }
}

void bm_set_components_argb_d3d_32_tex(ubyte *pixel, ubyte *rv, ubyte *gv, ubyte *bv, ubyte *av)
{
        *((ushort*)pixel) |= (ushort)(( (int)*rv / Gr_current_red->scale ) << Gr_current_red->shift);
        *((ushort*)pixel) |= (ushort)(( (int)*gv / Gr_current_green->scale ) << Gr_current_green->shift);
        *((ushort*)pixel) |= (ushort)(( (int)*bv / Gr_current_blue->scale ) << Gr_current_blue->shift);
        *((ushort*)pixel) &= ~(Gr_current_alpha->mask);
        if(*av){
                *((ushort*)pixel) |= (ushort)(Gr_current_alpha->mask);
        } else {
                *((ushort*)pixel) = 0;
        }
}

// for selecting pixel formats
void BM_SELECT_SCREEN_FORMAT()
{
        Gr_current_red = &Gr_red;
        Gr_current_green = &Gr_green;
        Gr_current_blue = &Gr_blue;
        Gr_current_alpha = &Gr_alpha;

        // setup pointers
        if(gr_screen.mode == GR_GLIDE){
#ifndef PLAT_UNIX
                bm_set_components = bm_set_components_argb;
#endif
        } else if(gr_screen.mode == GR_DIRECT3D){
                if(Bm_pixel_format == BM_PIXEL_FORMAT_D3D){
                        bm_set_components = bm_set_components_d3d;
                } else {
                        if(D3D_32bit){
                                bm_set_components = bm_set_components_argb_d3d_32_screen;
                        } else {
                                bm_set_components = bm_set_components_argb_d3d_16_screen;
                        }
                }
        } else if(gr_screen.mode == GR_SOFTWARE){
                bm_set_components = bm_set_components_argb;
        } else if(gr_screen.mode == GR_OPENGL){
                bm_set_components = bm_set_components_argb_d3d_32_screen;
        }
}

void BM_SELECT_TEX_FORMAT()
{
        Gr_current_red = &Gr_t_red; 
        Gr_current_green = &Gr_t_green; 
        Gr_current_blue = &Gr_t_blue; 
        Gr_current_alpha = &Gr_t_alpha;

        // setup pointers
        if(gr_screen.mode == GR_GLIDE){
                bm_set_components = bm_set_components_argb;
        } else if(gr_screen.mode == GR_DIRECT3D){
                if(Bm_pixel_format == BM_PIXEL_FORMAT_D3D){
                        bm_set_components = bm_set_components_d3d;
                } else {
                        if(D3D_32bit){
                                bm_set_components = bm_set_components_argb_d3d_32_tex;
                        } else {
                                bm_set_components = bm_set_components_argb_d3d_16_tex;
                        }
                }
        } else if(gr_screen.mode == GR_SOFTWARE){
                bm_set_components = bm_set_components_argb;
        } else if(gr_screen.mode == GR_OPENGL){
                bm_set_components = bm_set_components_argb_d3d_32_tex;
        }
}

void BM_SELECT_ALPHA_TEX_FORMAT()
{
        Gr_current_red = &Gr_ta_red; 
        Gr_current_green = &Gr_ta_green; 
        Gr_current_blue = &Gr_ta_blue; 
        Gr_current_alpha = &Gr_ta_alpha;

        // setup pointers
        if(gr_screen.mode == GR_GLIDE){
                bm_set_components = bm_set_components_argb;
        } else if(gr_screen.mode == GR_DIRECT3D){
                if(Bm_pixel_format == BM_PIXEL_FORMAT_D3D){
                        bm_set_components = bm_set_components_d3d;
                } else {
                        if(D3D_32bit){
                                bm_set_components = bm_set_components_argb_d3d_32_tex;
                        } else {
                                bm_set_components = bm_set_components_argb_d3d_16_tex;
                        }
                }
        } else if(gr_screen.mode == GR_SOFTWARE){
                bm_set_components = bm_set_components_argb;
        } else if(gr_screen.mode == GR_OPENGL){
                bm_set_components = bm_set_components_argb_d3d_32_tex;
        }
}

// set the rgba components of a pixel, any of the parameters can be -1
/*
void bm_set_components(ubyte *pixel, ubyte *rv, ubyte *gv, ubyte *bv, ubyte *av)
{
        int bit_32 = 0;

        // pick a byte size - 32 bits only if 32 bit mode d3d and screen format
        if(D3D_32bit && (Gr_current_red == &Gr_red)){
                bit_32 = 1;
        }       
        
        if(bit_32){
                *((uint*)pixel) |= (uint)(( (int)*rv / Gr_current_red->scale ) << Gr_current_red->shift);
        } else {
                *((ushort*)pixel) |= (ushort)(( (int)*rv / Gr_current_red->scale ) << Gr_current_red->shift);
        }               
        if(bit_32){
                *((uint*)pixel) |= (uint)(( (int)*gv / Gr_current_green->scale ) << Gr_current_green->shift);
        } else {
                *((ushort*)pixel) |= (ushort)(( (int)*gv / Gr_current_green->scale ) << Gr_current_green->shift);
        }               
        if(bit_32){
                *((uint*)pixel) |= (uint)(( (int)*bv / Gr_current_blue->scale ) << Gr_current_blue->shift);
        } else {
                *((ushort*)pixel) |= (ushort)(( (int)*bv / Gr_current_blue->scale ) << Gr_current_blue->shift);
        }
        
        // NOTE - this is a semi-hack. For direct3d we don't use an alpha bit, so if *av == 0, we just set the whole pixel to be Gr_green.mask
        //        ergo, we need to do this _last_
        switch(Bm_pixel_format){
        // glide has an alpha channel so we have to unset ir or set it each time
        case BM_PIXEL_FORMAT_ARGB:
                Assert(!bit_32);
                *((ushort*)pixel) &= ~(0x8000);
                if(*av){
                        *((ushort*)pixel) |= 0x8000;
                }
                break;
        
        // this d3d format has no alpha channel, so only make it "transparent", never make it "non-transparent"
        case BM_PIXEL_FORMAT_D3D:                       
                Assert(!bit_32);
                if(*av == 0){ 
                        *((ushort*)pixel) = (ushort)Gr_current_green->mask;
                }
                break;

        // nice 1555 texture format
        case BM_PIXEL_FORMAT_ARGB_D3D:                                          
                // if we're writing to normal texture format
                if(Gr_current_red == &Gr_t_red){                                        
                        Assert(!bit_32);
                        *((ushort*)pixel) &= ~(Gr_current_alpha->mask);
                        if(*av){
                                *((ushort*)pixel) |= (ushort)(Gr_current_alpha->mask);
                        } else {
                                *((ushort*)pixel) = 0;
                        }
                }
                // otherwise if we're writing to screen format, still do it the green mask way
                else {                  
                        if(*av == 0){
                                if(bit_32){
                                        *((uint*)pixel) = (uint)Gr_current_green->mask;
                                } else {
                                        *((ushort*)pixel) = (ushort)Gr_current_green->mask;
                                }
                        }
                }                       
                break;
        }       
}
*/

// get the rgba components of a pixel, any of the parameters can be NULL
void bm_get_components(ubyte *pixel, ubyte *r, ubyte *g, ubyte *b, ubyte *a)
{
        int bit_32 = 0;

        // pick a byte size - 32 bits only if 32 bit mode d3d and screen format
        if(D3D_32bit && (Gr_current_red == &Gr_red)){
                bit_32 = 1;
        }

        if(r != NULL){
                if(bit_32){
                        *r = ubyte(( (*((uint*)pixel) & Gr_current_red->mask)>>Gr_current_red->shift)*Gr_current_red->scale);
                } else {
                        *r = ubyte(( ( ((ushort*)pixel)[0] & Gr_current_red->mask)>>Gr_current_red->shift)*Gr_current_red->scale);
                }
        }
        if(g != NULL){
                if(bit_32){
                        *g = ubyte(( (*((uint*)pixel) & Gr_current_green->mask) >>Gr_current_green->shift)*Gr_current_green->scale);
                } else {
                        *g = ubyte(( ( ((ushort*)pixel)[0] & Gr_current_green->mask) >>Gr_current_green->shift)*Gr_current_green->scale);
                }
        }
        if(b != NULL){
                if(bit_32){
                        *b = ubyte(( (*((uint*)pixel) & Gr_current_blue->mask)>>Gr_current_blue->shift)*Gr_current_blue->scale);
                } else {
                        *b = ubyte(( ( ((ushort*)pixel)[0] & Gr_current_blue->mask)>>Gr_current_blue->shift)*Gr_current_blue->scale);
                }
        }

        // get the alpha value
        if(a != NULL){          
                *a = 1;

                switch(Bm_pixel_format){
                // glide has an alpha channel so we have to unset ir or set it each time
                case BM_PIXEL_FORMAT_ARGB:                      
                        Assert(!bit_32);
                        if(!( ((ushort*)pixel)[0] & 0x8000)){
                                *a = 0;
                        } 
                        break;

                // this d3d format has no alpha channel, so only make it "transparent", never make it "non-transparent"
                case BM_PIXEL_FORMAT_D3D:
                        Assert(!bit_32);
                        if( *((ushort*)pixel) == Gr_current_green->mask){ 
                                *a = 0;
                        }
                        break;

                // nice 1555 texture format mode
                case BM_PIXEL_FORMAT_ARGB_D3D:  
                        // if we're writing to a normal texture, use nice alpha bits
                        if(Gr_current_red == &Gr_t_red){                                
                                Assert(!bit_32);

                                if(!(*((ushort*)pixel) & Gr_current_alpha->mask)){
                                        *a = 0;
                                }
                        }
                        // otherwise do it as normal
                        else {
                                if(bit_32){
                                        if(*((int*)pixel) == Gr_current_green->mask){ 
                                                *a = 0;
                                        }
                                } else {
                                        if(*((ushort*)pixel) == Gr_current_green->mask){ 
                                                *a = 0;
                                        }
                                }
                        }
                }
        }
}

// get filename
void bm_get_filename(int bitmapnum, char *filename)
{
        int n = bitmapnum % MAX_BITMAPS;

        // return filename
        strcpy(filename, bm_bitmaps[n].filename);
}

// given a bitmap and a section, return the size (w, h)
void bm_get_section_size(int bitmapnum, int sx, int sy, int *w, int *h)
{
        int bw, bh;
        bitmap_section_info *sections;

        // bogus input?
        Assert((w != NULL) && (h != NULL));
        if((w == NULL) || (h == NULL)){
                return;
        }

        // get bitmap info
        bm_get_info(bitmapnum, &bw, &bh, NULL, NULL, NULL, &sections);

        // determine the width and height of this section
        *w = sx < (sections->num_x - 1) ? MAX_BMAP_SECTION_SIZE : bw - sections->sx[sx];
        *h = sy < (sections->num_y - 1) ? MAX_BMAP_SECTION_SIZE : bh - sections->sy[sy];                                                                                
}