From f381fed0b380f5b57767db51bcf8eea6cc742426 Mon Sep 17 00:00:00 2001 From: Asdow <20314541+Asdow@users.noreply.github.com> Date: Sat, 21 Jan 2023 15:12:49 +0200 Subject: [PATCH] Improve vobject error messages Error messages will now print the video object's file name when throwing the error, giving us an immediate starting point for debugging. Especially useful when those intermittent assertion errors happen. --- Standard Gaming Platform/vobject.cpp | 47 +++++++++++++++++----------- Standard Gaming Platform/vobject.h | 40 +++++++++++------------ 2 files changed, 46 insertions(+), 41 deletions(-) diff --git a/Standard Gaming Platform/vobject.cpp b/Standard Gaming Platform/vobject.cpp index 67bb59ce97..d8ade50c90 100644 --- a/Standard Gaming Platform/vobject.cpp +++ b/Standard Gaming Platform/vobject.cpp @@ -1,12 +1,12 @@ - #include "DirectDraw Calls.h" - #include - #include "debug.h" - #include "video.h" - #include "himage.h" - #include "vobject.h" - #include "wcheck.h" - #include "vobject_blitters.h" - #include "sgp.h" +#include "DirectDraw Calls.h" +#include +#include "debug.h" +#include "video.h" +#include "himage.h" +#include "vobject.h" +#include "wcheck.h" +#include "vobject_blitters.h" +#include "sgp.h" #include @@ -589,6 +589,7 @@ HVOBJECT CreateVideoObject( VOBJECT_DESC *VObjectDesc ) hVObject->usNumberOf16BPPObjects = 1; hVObject->ubBitDepth = hImage->ubBitDepth; + strncpy(hVObject->ImageFile, hImage->ImageFile, SGPFILENAME_LEN); if ( VObjectDesc->fCreateFlags & VOBJECT_CREATE_FROMFILE ) { @@ -627,6 +628,7 @@ HVOBJECT CreateVideoObject( VOBJECT_DESC *VObjectDesc ) hVObject->usNumberOf16BPPObjects = 1; hVObject->ubBitDepth = hImage->ubBitDepth; + strncpy(hVObject->ImageFile, hImage->ImageFile, SGPFILENAME_LEN); if ( VObjectDesc->fCreateFlags & VOBJECT_CREATE_FROMFILE ) { @@ -656,6 +658,7 @@ HVOBJECT CreateVideoObject( VOBJECT_DESC *VObjectDesc ) hVObject->pETRLEObject = TempETRLEData.pETRLEObject; hVObject->pPixData = TempETRLEData.pPixData; hVObject->uiSizePixData = TempETRLEData.uiSizePixData; + strncpy(hVObject->ImageFile, hImage->ImageFile, SGPFILENAME_LEN); // Set palette from himage if ( hImage->ubBitDepth == 8 ) @@ -897,9 +900,10 @@ UINT32 count; // // ******************************************************************* -// High level blit function encapsolates ALL effects and BPP +// High level blit function encapsulates ALL effects and BPP BOOLEAN BltVideoObjectToBuffer( UINT16 *pBuffer, UINT32 uiDestPitchBYTES, HVOBJECT hSrcVObject, UINT16 usIndex, INT32 iDestX, INT32 iDestY, INT32 fBltFlags, blt_fx *pBltFx ) { + CHAR8 errorText[512]; // Sometimes an exception is thrown in that method. //BF __try { @@ -920,7 +924,8 @@ BOOLEAN BltVideoObjectToBuffer( UINT16 *pBuffer, UINT32 uiDestPitchBYTES, HVOBJE switch( hSrcVObject->ubBitDepth ) { case 32: - SGP_THROW_IFFALSE(usIndex < hSrcVObject->usNumberOf16BPPObjects, L"index larger that number images"); + sprintf(errorText, "Video object index is larger than the number of images. Filename: %s", hSrcVObject->ImageFile); + SGP_THROW_IFFALSE(usIndex < hSrcVObject->usNumberOf16BPPObjects, errorText); image = &hSrcVObject->p16BPPObject[usIndex]; Blt32BPPTo16BPPTrans( pBuffer, uiDestPitchBYTES, (UINT32*)image->p16BPPData, image->usWidth * sizeof(UINT32), @@ -929,7 +934,8 @@ BOOLEAN BltVideoObjectToBuffer( UINT16 *pBuffer, UINT32 uiDestPitchBYTES, HVOBJE break; case 16: - SGP_THROW_IFFALSE(usIndex < hSrcVObject->usNumberOf16BPPObjects, L"index larger that number images"); + sprintf(errorText, "Video object index is larger than the number of images. Filename: %s", hSrcVObject->ImageFile); + SGP_THROW_IFFALSE(usIndex < hSrcVObject->usNumberOf16BPPObjects, errorText); image = &hSrcVObject->p16BPPObject[usIndex]; if ( fBltFlags & VO_BLT_SRCTRANSPARENCY ) { @@ -949,8 +955,8 @@ BOOLEAN BltVideoObjectToBuffer( UINT16 *pBuffer, UINT32 uiDestPitchBYTES, HVOBJE break; case 8: - - SGP_THROW_IFFALSE( hSrcVObject->usNumberOfObjects > usIndex, L"Video object index is larger than the number of subimages"); + sprintf(errorText, "Video object index is larger than the number of sub images. Filename: %s", hSrcVObject->ImageFile); + SGP_THROW_IFFALSE( hSrcVObject->usNumberOfObjects > usIndex, errorText); // Switch based on flags given do { @@ -1561,9 +1567,10 @@ BOOLEAN BltVideoObjectOutline(UINT32 uiDestVSurface, HVOBJECT hSrcVObject, UINT1 BOOLEAN BltVideoObjectOutlineShadowFromIndex(UINT32 uiDestVSurface, UINT32 uiSrcVObject, UINT16 usIndex, INT32 iDestX, INT32 iDestY ) { - UINT16 *pBuffer; - UINT32 uiPitch; - HVOBJECT hSrcVObject; + CHAR8 errorText[512]; + UINT16 *pBuffer; + UINT32 uiPitch; + HVOBJECT hSrcVObject; // Lock video surface pBuffer = (UINT16*)LockVideoSurface( uiDestVSurface, &uiPitch ); @@ -1592,14 +1599,16 @@ BOOLEAN BltVideoObjectOutlineShadowFromIndex(UINT32 uiDestVSurface, UINT32 uiSrc } else if(hSrcVObject->ubBitDepth == 16) { - SGP_THROW_IFFALSE(usIndex < hSrcVObject->usNumberOf16BPPObjects, L"index larger that number images"); + sprintf(errorText, "Video object index is larger than the number of images. Filename: %s", hSrcVObject->ImageFile); + SGP_THROW_IFFALSE(usIndex < hSrcVObject->usNumberOf16BPPObjects, errorText); SixteenBPPObjectInfo &image = hSrcVObject->p16BPPObject[0]; Blt16BPPTo16BPPTransShadow(pBuffer, uiPitch, image.p16BPPData, image.usWidth * sizeof(UINT16), iDestX, iDestY, 0, 0, image.usWidth, image.usHeight, 0x1F); } else if(hSrcVObject->ubBitDepth == 32) { - SGP_THROW_IFFALSE(usIndex < hSrcVObject->usNumberOf16BPPObjects, L"index larger that number images"); + sprintf(errorText, "Video object index is larger than the number of images. Filename: %s", hSrcVObject->ImageFile); + SGP_THROW_IFFALSE(usIndex < hSrcVObject->usNumberOf16BPPObjects, errorText); SixteenBPPObjectInfo &image = hSrcVObject->p16BPPObject[0]; Blt32BPPTo16BPPTransShadow(pBuffer, uiPitch, (UINT32*)image.p16BPPData, image.usWidth * sizeof(UINT32), iDestX, iDestY, 0, 0, image.usWidth, image.usHeight); diff --git a/Standard Gaming Platform/vobject.h b/Standard Gaming Platform/vobject.h index 98e1ca2079..0cdd555331 100644 --- a/Standard Gaming Platform/vobject.h +++ b/Standard Gaming Platform/vobject.h @@ -84,30 +84,26 @@ typedef struct // The video object contains different data based on it's type, compressed or not typedef struct TAG_HVOBJECT { - UINT32 fFlags; // Special flags - UINT32 uiSizePixData; // ETRLE data size - SGPPaletteEntry *pPaletteEntry; // 8BPP Palette - COLORVAL TransparentColor; // Defaults to 0,0,0 - UINT16 *p16BPPPalette; // A 16BPP palette used for 8->16 blits + UINT32 fFlags; // Special flags + UINT32 uiSizePixData; // ETRLE data size + SGPPaletteEntry *pPaletteEntry; // 8BPP Palette + COLORVAL TransparentColor; // Defaults to 0,0,0 + UINT16 *p16BPPPalette; // A 16BPP palette used for 8->16 blits - PTR pPixData; // ETRLE pixel data - ETRLEObject *pETRLEObject; // Object offset data etc + PTR pPixData; // ETRLE pixel data + ETRLEObject *pETRLEObject; // Object offset data etc SixteenBPPObjectInfo *p16BPPObject; - UINT16 *pShades[HVOBJECT_SHADE_TABLES]; // Shading tables - UINT16 *pShadeCurrent; - UINT16 *pGlow; // glow highlight table - UINT8 *pShade8; // 8-bit shading index table - UINT8 *pGlow8; // 8-bit glow table - ZStripInfo **ppZStripInfo; // Z-value strip info arrays - - UINT16 usNumberOf16BPPObjects; - UINT16 usNumberOfObjects; // Total number of objects - UINT8 ubBitDepth; // BPP - - // Reserved for added room and 32-byte boundaries - BYTE bReserved[ 1 ]; - - + UINT16 *pShades[HVOBJECT_SHADE_TABLES]; // Shading tables + UINT16 *pShadeCurrent; + UINT16 *pGlow; // glow highlight table + UINT8 *pShade8; // 8-bit shading index table + UINT8 *pGlow8; // 8-bit glow table + ZStripInfo **ppZStripInfo; // Z-value strip info arrays + + UINT16 usNumberOf16BPPObjects; + UINT16 usNumberOfObjects; // Total number of objects + UINT8 ubBitDepth; // BPP + SGPFILENAME ImageFile; } SGPVObject, *HVOBJECT;