dlls/dswave/dswave_private.h

   1 /* DirectMusic Wave Private Include
   2  *
   3  * Copyright (C) 2003-2004 Rok Mandeljc
   4  *
   5  * This program is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU Lesser General Public
   7  * License as published by the Free Software Foundation; either
   8  * version 2.1 of the License, or (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * Lesser General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU Lesser General Public
  16  * License along with this program; if not, write to the Free Software
  17  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
  18  */
  19
  20 #ifndef __WINE_DSWAVE_PRIVATE_H
  21 #define __WINE_DSWAVE_PRIVATE_H
  22
  23 #include <stdarg.h>
  24
  25 #define COBJMACROS
  26
  27 #include "windef.h"
  28 #include "winbase.h"
  29 #include "winnt.h"
  30 #include "wingdi.h"
  31 #include "winuser.h"
  32
  33 #include "wine/debug.h"
  34 #include "wine/list.h"
  35 #include "wine/unicode.h"
  36 #include "winreg.h"
  37 #include "objbase.h"
  38
  39 #include "dmusici.h"
  40 #include "dmusicf.h"
  41 #include "dmusics.h"
  42
  43 /*****************************************************************************
  44  * Interfaces
  45  */
  46 typedef struct IDirectMusicWaveImpl IDirectMusicWaveImpl;
  47
  48 /*****************************************************************************
  49  * ClassFactory
  50  */
  51 extern HRESULT WINAPI DMUSIC_CreateDirectMusicWaveImpl (LPCGUID lpcGUID, LPVOID* ppobj, LPUNKNOWN pUnkOuter);
  52
  53
  54 /*****************************************************************************
  55  * IDirectMusicWaveImpl implementation structure
  56  */
  57 struct IDirectMusicWaveImpl {
  58   /* IUnknown fields */
  59   const IUnknownVtbl *UnknownVtbl;
  60   const IDirectMusicSegment8Vtbl *SegmentVtbl;
  61   const IDirectMusicObjectVtbl *ObjectVtbl;
  62   const IPersistStreamVtbl *PersistStreamVtbl;
  63   LONG          ref;
  64
  65   /* IDirectMusicWaveImpl fields */
  66   LPDMUS_OBJECTDESC pDesc;
  67
  68 };
  69
  70 /**********************************************************************
  71  * Dll lifetime tracking declaration for dswave.dll
  72  */
  73 extern LONG DSWAVE_refCount;
  74 static inline void DSWAVE_LockModule(void) { InterlockedIncrement( &DSWAVE_refCount ); }
  75 static inline void DSWAVE_UnlockModule(void) { InterlockedDecrement( &DSWAVE_refCount ); }
  76
  77 /*****************************************************************************
  78  * Misc.
  79  */
  80 /* for simpler reading */
  81 typedef struct _DMUS_PRIVATE_CHUNK {
  82         FOURCC fccID; /* FOURCC ID of the chunk */
  83         DWORD dwSize; /* size of the chunk */
  84 } DMUS_PRIVATE_CHUNK, *LPDMUS_PRIVATE_CHUNK;
  85
  86 /* used for generic dumping (copied from ddraw) */
  87 typedef struct {
  88     DWORD val;
  89     const char* name;
  90 } flag_info;
  91
  92 typedef struct {
  93     const GUID *guid;
  94     const char* name;
  95 } guid_info;
  96
  97 /* used for initialising structs (primarily for DMUS_OBJECTDESC) */
  98 #define DM_STRUCT_INIT(x)                               \
  99         do {                                                            \
 100                 memset((x), 0, sizeof(*(x)));   \
 101                 (x)->dwSize = sizeof(*x);               \
 102         } while (0)
 103
 104 #define FE(x) { x, #x }
 105 #define GE(x) { &x, #x }
 106
 107 #define ICOM_THIS_MULTI(impl,field,iface) impl* const This=(impl*)((char*)(iface) - offsetof(impl,field))
 108
 109 /* check whether the given DWORD is even (return 0) or odd (return 1) */
 110 extern int even_or_odd (DWORD number);
 111 /* FOURCC to string conversion for debug messages */
 112 extern const char *debugstr_fourcc (DWORD fourcc);
 113 /* DMUS_VERSION struct to string conversion for debug messages */
 114 extern const char *debugstr_dmversion (const DMUS_VERSION *version);
 115 /* returns name of given GUID */
 116 extern const char *debugstr_dmguid (const GUID *id);
 117 /* returns name of given error code */
 118 extern const char *debugstr_dmreturn (DWORD code);
 119 /* generic flags-dumping function */
 120 extern const char *debugstr_flags (DWORD flags, const flag_info* names, size_t num_names);
 121 extern const char *debugstr_DMUS_OBJ_FLAGS (DWORD flagmask);
 122 /* dump whole DMUS_OBJECTDESC struct */
 123 extern const char *debugstr_DMUS_OBJECTDESC (LPDMUS_OBJECTDESC pDesc);
 124
 125 #endif  /* __WINE_DSWAVE_PRIVATE_H */