dlls/dmband/dmutils.h

   1 /* Debug and Helper Functions
   2  *
   3  * Copyright (C) 2003-2004 Rok Mandeljc
   4  * Copyright (C) 2003-2004 Raphael Junqueira
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU Library General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA.
  19  */
  20
  21 #ifndef __WINE_DMUTILS_H
  22 #define __WINE_DMUTILS_H
  23
  24 /* for simpler reading */
  25 typedef struct _DMUS_PRIVATE_CHUNK {
  26         FOURCC fccID; /* FOURCC ID of the chunk */
  27         DWORD dwSize; /* size of the chunk */
  28 } DMUS_PRIVATE_CHUNK, *LPDMUS_PRIVATE_CHUNK;
  29
  30 #define ICOM_THIS_MULTI(impl,field,iface)  impl* const This=(impl*)((char*)(iface) - offsetof(impl,field))
  31
  32 /**
  33  * Parsing utilities
  34  */
  35 extern HRESULT IDirectMusicUtils_IPersistStream_ParseDescGeneric (DMUS_PRIVATE_CHUNK* pChunk, IStream* pStm, LPDMUS_OBJECTDESC pDesc);
  36 extern HRESULT IDirectMusicUtils_IPersistStream_ParseUNFOGeneric (DMUS_PRIVATE_CHUNK* pChunk, IStream* pStm, LPDMUS_OBJECTDESC pDesc);
  37 extern HRESULT IDirectMusicUtils_IPersistStream_ParseReference (LPPERSISTSTREAM iface, DMUS_PRIVATE_CHUNK* pChunk, IStream* pStm, IDirectMusicObject** ppObject);
  38
  39 /**
  40  * Debug utilities
  41  */
  42 /* used for generic dumping (copied from ddraw) */
  43 typedef struct {
  44     DWORD val;
  45     const char* name;
  46 } flag_info;
  47
  48 typedef struct {
  49     const GUID *guid;
  50     const char* name;
  51 } guid_info;
  52
  53 /* used for initialising structs */
  54 #define DM_STRUCT_INIT(x)                       \
  55         do {                                    \
  56                 memset((x), 0, sizeof(*(x)));   \
  57                 (x)->dwSize = sizeof(*x);       \
  58         } while (0)
  59
  60 #define FE(x) { x, #x }
  61 #define GE(x) { &x, #x }
  62
  63 /* check whether the given DWORD is even (return 0) or odd (return 1) */
  64 extern int even_or_odd (DWORD number);
  65 /* check whether chunkID is valid dmobject form chunk */
  66 extern BOOL IS_VALID_DMFORM (FOURCC chunkID);
  67 /* translate STREAM_SEEK flag to string */
  68 extern const char *resolve_STREAM_SEEK (DWORD flag);
  69 /* FOURCC to string conversion for debug messages */
  70 extern const char *debugstr_fourcc (DWORD fourcc);
  71 /* DMUS_VERSION struct to string conversion for debug messages */
  72 extern const char *debugstr_dmversion (LPDMUS_VERSION version);
  73 /* FILETIME struct to string conversion for debug messages */
  74 extern const char *debugstr_filetime (LPFILETIME time);
  75 /* returns name of given GUID */
  76 extern const char *debugstr_dmguid (const GUID *id);
  77 /* returns name of given error code */
  78 extern const char *debugstr_dmreturn (DWORD code);
  79 /* generic flags-dumping function */
  80 extern const char *debugstr_flags (DWORD flags, const flag_info* names, size_t num_names);
  81
  82 extern const char *debugstr_DMUS_OBJ_FLAGS (DWORD flagmask);
  83 extern const char *debugstr_DMUS_CONTAINER_FLAGS (DWORD flagmask);
  84 extern const char *debugstr_DMUS_CONTAINED_OBJF_FLAGS (DWORD flagmask);
  85 /* dump whole DMUS_OBJECTDESC struct */
  86 extern const char *debugstr_DMUS_OBJECTDESC (LPDMUS_OBJECTDESC pDesc);
  87 extern void        debug_DMUS_OBJECTDESC (LPDMUS_OBJECTDESC pDesc);
  88 extern const char *debugstr_DMUS_IO_CONTAINER_HEADER (LPDMUS_IO_CONTAINER_HEADER pHeader);
  89 extern const char *debugstr_DMUS_IO_CONTAINED_OBJECT_HEADER (LPDMUS_IO_CONTAINED_OBJECT_HEADER pHeader);
  90
  91 #endif /* __WINE_DMUTILS_H */