loader.c File Reference

#include "dmloader_private.h"

Include dependency graph for loader.c:

Go to the source code of this file.

Classes
struct	cache_entry
struct	loader

Functions
	WINE_DEFAULT_DEBUG_CHANNEL (dmloader)
static HRESULT	get_system_default_gm_path (WCHAR *path, UINT max_len)
static struct loader *	impl_from_IDirectMusicLoader8 (IDirectMusicLoader8 *iface)
static int	index_from_class (REFCLSID class)
static BOOL	is_cache_enabled (struct loader *This, REFCLSID class)
static void	get_search_path (struct loader *This, REFGUID class, WCHAR *path)
static HRESULT	DMUSIC_CopyDescriptor (DMUS_OBJECTDESC *pDst, DMUS_OBJECTDESC *pSrc)
static HRESULT WINAPI	loader_QueryInterface (IDirectMusicLoader8 *iface, REFIID riid, void **ppobj)
static ULONG WINAPI	loader_AddRef (IDirectMusicLoader8 *iface)
static ULONG WINAPI	loader_Release (IDirectMusicLoader8 *iface)
static struct cache_entry *	find_cache_object (struct loader *This, DMUS_OBJECTDESC *desc)
static HRESULT WINAPI	loader_GetObject (IDirectMusicLoader8 *iface, DMUS_OBJECTDESC *pDesc, REFIID riid, void **ppv)
static HRESULT WINAPI	loader_SetObject (IDirectMusicLoader8 *iface, DMUS_OBJECTDESC *pDesc)
static HRESULT WINAPI	loader_SetSearchDirectory (IDirectMusicLoader8 *iface, REFGUID class, WCHAR *path, BOOL clear)
static HRESULT WINAPI	loader_ScanDirectory (IDirectMusicLoader8 *iface, REFGUID rguidClass, WCHAR *pwzFileExtension, WCHAR *pwzScanFileName)
static HRESULT WINAPI	loader_CacheObject (IDirectMusicLoader8 *iface, IDirectMusicObject *object)
static HRESULT WINAPI	loader_ReleaseObject (IDirectMusicLoader8 *iface, IDirectMusicObject *object)
static HRESULT WINAPI	loader_ClearCache (IDirectMusicLoader8 *iface, REFGUID class)
static HRESULT WINAPI	loader_EnableCache (IDirectMusicLoader8 *iface, REFGUID class, BOOL enable)
static HRESULT WINAPI	loader_EnumObject (IDirectMusicLoader8 *iface, REFGUID rguidClass, DWORD dwIndex, DMUS_OBJECTDESC *pDesc)
static void WINAPI	loader_CollectGarbage (IDirectMusicLoader8 *iface)
static HRESULT WINAPI	loader_ReleaseObjectByUnknown (IDirectMusicLoader8 *iface, IUnknown *pObject)
static HRESULT WINAPI	loader_LoadObjectFromFile (IDirectMusicLoader8 *iface, REFGUID rguidClassID, REFIID iidInterfaceID, WCHAR *pwzFilePath, void **ppObject)
static HRESULT	get_default_gm_path (WCHAR *path, DWORD max_len)
HRESULT	create_dmloader (REFIID lpcGUID, void **ppobj)

Variables
static const WCHAR *	system_default_gm_paths []
static const GUID *	classes []
static const IDirectMusicLoader8Vtbl	loader_vtbl

Function Documentation

create_dmloader()

HRESULT create_dmloader	(	REFIID	lpcGUID,
		void **	ppobj
	)

Definition at line 910 of file loader.c.

{
    struct loader *obj;
    DMUS_OBJECTDESC Desc;
    HRESULT hr;
 
    TRACE("(%s, %p)\n", debugstr_dmguid(lpcGUID), ppobj);
 
    *ppobj = NULL;
    if (!(obj = calloc(1, sizeof(*obj)))) return E_OUTOFMEMORY;
    obj->IDirectMusicLoader8_iface.lpVtbl = &loader_vtbl;
    obj->ref = 1;
    list_init(&obj->cache);
    /* Caching is enabled by default for all classes */
    obj->cache_class = ~0;
 
    /* set default DLS collection (via SetObject... so that loading via DMUS_OBJ_OBJECT is possible) */
    DM_STRUCT_INIT(&Desc);
    Desc.dwValidData = DMUS_OBJ_CLASS | DMUS_OBJ_FILENAME | DMUS_OBJ_FULLPATH | DMUS_OBJ_OBJECT;
    Desc.guidClass = CLSID_DirectMusicCollection;
    Desc.guidObject = GUID_DefaultGMCollection;
    if (SUCCEEDED(hr = get_default_gm_path(Desc.wszFileName, ARRAY_SIZE(Desc.wszFileName))))
        hr = IDirectMusicLoader_SetObject(&obj->IDirectMusicLoader8_iface, &Desc);
    if (FAILED(hr)) WARN("Failed to load the default collection, hr %#lx\n", hr);
 
    hr = IDirectMusicLoader_QueryInterface(&obj->IDirectMusicLoader8_iface, lpcGUID, ppobj);
    IDirectMusicLoader_Release(&obj->IDirectMusicLoader8_iface);
    return hr;
}

DMUSIC_CopyDescriptor()

static HRESULT DMUSIC_CopyDescriptor ( DMUS_OBJECTDESC *  pDst, DMUS_OBJECTDESC *  pSrc  )

static

Definition at line 114 of file loader.c.

{
    if (TRACE_ON(dmloader))
        dump_DMUS_OBJECTDESC(pSrc);
 
    /* copy field by field */
    if (pSrc->dwValidData & DMUS_OBJ_CLASS) pDst->guidClass = pSrc->guidClass;
    if (pSrc->dwValidData & DMUS_OBJ_OBJECT) pDst->guidObject = pSrc->guidObject;
    if (pSrc->dwValidData & DMUS_OBJ_DATE) pDst->ftDate = pSrc->ftDate;
    if (pSrc->dwValidData & DMUS_OBJ_VERSION) pDst->vVersion = pSrc->vVersion;
    if (pSrc->dwValidData & DMUS_OBJ_NAME) lstrcpyW (pDst->wszName, pSrc->wszName);
    if (pSrc->dwValidData & DMUS_OBJ_CATEGORY) lstrcpyW (pDst->wszCategory, pSrc->wszCategory);
    if (pSrc->dwValidData & DMUS_OBJ_FILENAME) lstrcpyW (pDst->wszFileName, pSrc->wszFileName);
    if (pSrc->dwValidData & DMUS_OBJ_STREAM) IStream_Clone (pSrc->pStream, &pDst->pStream);
    if (pSrc->dwValidData & DMUS_OBJ_MEMORY) {
        pDst->pbMemData = pSrc->pbMemData;
        pDst->llMemLength = pSrc->llMemLength;
    }
    /* set flags */
    pDst->dwValidData |= pSrc->dwValidData;
    return S_OK;
}

Referenced by loader_GetObject(), and loader_SetObject().

find_cache_object()

static struct cache_entry * find_cache_object ( struct loader *  This, DMUS_OBJECTDESC *  desc  )

static

Definition at line 183 of file loader.c.

{
    struct cache_entry *existing;
 
    /*
     * The Object is looked up in the following order.
     * 1. DMUS_OBJ_OBJECT
     * 2. DMUS_OBJ_STREAM
     * 3. DMUS_OBJ_MEMORY
     * 4. DMUS_OBJ_FILENAME and DMUS_OBJ_FULLPATH
     * 5. DMUS_OBJ_NAME and DMUS_OBJ_CATEGORY
     * 6. DMUS_OBJ_NAME
     * 7. DMUS_OBJ_FILENAME
     */
 
    if (desc->dwValidData & DMUS_OBJ_OBJECT) {
        LIST_FOR_EACH_ENTRY(existing, &This->cache, struct cache_entry, entry) {
            if (existing->Desc.dwValidData & DMUS_OBJ_OBJECT &&
                    IsEqualGUID(&desc->guidObject, &existing->Desc.guidObject) ) {
                TRACE("Found by DMUS_OBJ_OBJECT\n");
                return existing;
            }
        }
    }
 
    if (desc->dwValidData & DMUS_OBJ_STREAM)
        FIXME("Finding DMUS_OBJ_STREAM cached objects currently not supported.\n");
 
    if (desc->dwValidData & DMUS_OBJ_MEMORY) {
        LIST_FOR_EACH_ENTRY(existing, &This->cache, struct cache_entry, entry) {
            if (existing->Desc.dwValidData & DMUS_OBJ_MEMORY &&
                    desc->llMemLength == existing->Desc.llMemLength &&
                    (desc->pbMemData == existing->Desc.pbMemData ||
                    !memcmp(desc->pbMemData, existing->Desc.pbMemData, desc->llMemLength)) ) {
                TRACE("Found by DMUS_OBJ_MEMORY (%d)\n",
                    desc->pbMemData == existing->Desc.pbMemData);
                return existing;
            }
        }
    }
 
    if ((desc->dwValidData & (DMUS_OBJ_FILENAME | DMUS_OBJ_FULLPATH)) ==
            (DMUS_OBJ_FILENAME | DMUS_OBJ_FULLPATH)) {
        LIST_FOR_EACH_ENTRY(existing, &This->cache, struct cache_entry, entry) {
            if ((existing->Desc.dwValidData & (DMUS_OBJ_FILENAME | DMUS_OBJ_FULLPATH)) ==
                    (DMUS_OBJ_FILENAME | DMUS_OBJ_FULLPATH) &&
                    !wcsncmp(desc->wszFileName, existing->Desc.wszFileName, DMUS_MAX_FILENAME)) {
                TRACE("Found by DMUS_OBJ_FILENAME | DMUS_OBJ_FULLPATH\n");
                return existing;
            }
        }
    }
 
    if ((desc->dwValidData & (DMUS_OBJ_NAME | DMUS_OBJ_CATEGORY)) ==
            (DMUS_OBJ_NAME | DMUS_OBJ_CATEGORY)) {
        LIST_FOR_EACH_ENTRY(existing, &This->cache, struct cache_entry, entry) {
            if ((existing->Desc.dwValidData & (DMUS_OBJ_NAME | DMUS_OBJ_CATEGORY)) ==
                    (DMUS_OBJ_NAME | DMUS_OBJ_CATEGORY) &&
                    !wcsncmp(desc->wszName, existing->Desc.wszName, DMUS_MAX_NAME) &&
                    !wcsncmp(desc->wszCategory, existing->Desc.wszCategory, DMUS_MAX_CATEGORY)) {
                TRACE("Found by DMUS_OBJ_NAME | DMUS_OBJ_CATEGORY\n");
                return existing;
            }
        }
    }
 
    if ((desc->dwValidData & DMUS_OBJ_NAME) == DMUS_OBJ_NAME) {
        LIST_FOR_EACH_ENTRY(existing, &This->cache, struct cache_entry, entry) {
            if ((existing->Desc.dwValidData & DMUS_OBJ_NAME) == DMUS_OBJ_NAME &&
                    !wcsncmp(desc->wszName, existing->Desc.wszName, DMUS_MAX_NAME)) {
                TRACE("Found by DMUS_OBJ_NAME\n");
                return existing;
            }
        }
    }
 
    if ((desc->dwValidData & DMUS_OBJ_FILENAME) == DMUS_OBJ_FILENAME) {
        LIST_FOR_EACH_ENTRY(existing, &This->cache, struct cache_entry, entry) {
            if (((existing->Desc.dwValidData & DMUS_OBJ_FILENAME) == DMUS_OBJ_FILENAME) &&
                    !wcsncmp(desc->wszFileName, existing->Desc.wszFileName, DMUS_MAX_FILENAME)) {
                TRACE("Found by DMUS_OBJ_FILENAME\n");
                return existing;
            }
        }
    }
 
    return NULL;
}

Referenced by loader_CacheObject(), loader_GetObject(), and loader_ReleaseObject().

get_default_gm_path()

static HRESULT get_default_gm_path ( WCHAR *  path, DWORD  max_len  )

static

Definition at line 889 of file loader.c.

{
    DWORD ret;
    HKEY hkey;
 
    if (!(ret = RegOpenKeyExW(HKEY_LOCAL_MACHINE, L"Software\\Microsoft\\DirectMusic" , 0, KEY_READ, &hkey)))
    {
        DWORD type, size = max_len * sizeof(WCHAR);
        ret = RegQueryValueExW(hkey, L"GMFilePath", NULL, &type, (BYTE *)path, &size);
        RegCloseKey(hkey);
 
        if (!ret && GetFileAttributesW(path) != INVALID_FILE_ATTRIBUTES) return S_OK;
    }
 
    if (!ret) WARN("Failed to find %s, using system fallbacks\n", debugstr_w(path));
    else WARN("Failed to open GMFilePath registry key, using system fallbacks\n");
 
    return get_system_default_gm_path(path, max_len);
}

Referenced by create_dmloader().

get_search_path()

static void get_search_path ( struct loader *  This, REFGUID  class, WCHAR *  path  )

static

Definition at line 101 of file loader.c.

{
    int index = index_from_class(class);
 
    if (index < 0 || !This->search_paths[index])
        index = 0; /* Default to GUID_DirectMusicAllTypes */
 
    if (This->search_paths[index])
        lstrcpynW(path, This->search_paths[index], MAX_PATH);
    else
        path[0] = 0;
}

Referenced by loader_GetObject(), loader_LoadObjectFromFile(), loader_ScanDirectory(), and loader_SetObject().

get_system_default_gm_path()

static HRESULT get_system_default_gm_path ( WCHAR *  path, UINT  max_len  )

static

Definition at line 29 of file loader.c.

{
    UINT i;
 
    for (i = 0; i < ARRAY_SIZE(system_default_gm_paths); i++)
    {
        swprintf(path, max_len, L"\\??\\unix%s", system_default_gm_paths[i]);
        if (GetFileAttributesW(path) != INVALID_FILE_ATTRIBUTES) break;
    }
 
    if (i < ARRAY_SIZE(system_default_gm_paths))
    {
        WARN("Using system %s for the default collection\n", debugstr_w(path));
        return S_OK;
    }
 
    ERR("Unable to find system path, default collection will not be available\n");
    return DMUS_E_LOADER_FAILEDOPEN;
}

Referenced by get_default_gm_path(), and loader_SetObject().

impl_from_IDirectMusicLoader8()

static struct loader * impl_from_IDirectMusicLoader8 ( IDirectMusicLoader8 *  iface )

inlinestatic

Definition at line 80 of file loader.c.

{
    return CONTAINING_RECORD(iface, struct loader, IDirectMusicLoader8_iface);
}

Referenced by loader_AddRef(), loader_CacheObject(), loader_ClearCache(), loader_EnableCache(), loader_EnumObject(), loader_GetObject(), loader_LoadObjectFromFile(), loader_QueryInterface(), loader_Release(), loader_ReleaseObject(), loader_ReleaseObjectByUnknown(), loader_ScanDirectory(), loader_SetObject(), and loader_SetSearchDirectory().

index_from_class()

static int index_from_class ( REFCLSID  class )

static

Definition at line 85 of file loader.c.

{
    int i;
 
    for (i = 0; i < ARRAY_SIZE(classes); i++)
        if (IsEqualGUID(class, classes[i]))
            return i;
 
    return -1;
}

Referenced by get_search_path(), is_cache_enabled(), loader_EnableCache(), loader_ScanDirectory(), and loader_SetSearchDirectory().

is_cache_enabled()

static BOOL is_cache_enabled ( struct loader *  This, REFCLSID  class  )

inlinestatic

Definition at line 96 of file loader.c.

{
    return !!(This->cache_class & 1 << index_from_class(class));
}

Referenced by loader_EnableCache(), and loader_GetObject().

loader_AddRef()

static ULONG WINAPI loader_AddRef ( IDirectMusicLoader8 *  iface )

static

Definition at line 154 of file loader.c.

{
    struct loader *This = impl_from_IDirectMusicLoader8(iface);
    ULONG ref = InterlockedIncrement(&This->ref);
 
    TRACE("(%p)->(): new ref = %lu\n", iface, ref);
 
    return ref;
}

loader_CacheObject()

static HRESULT WINAPI loader_CacheObject ( IDirectMusicLoader8 *  iface, IDirectMusicObject *  object  )

static

Definition at line 673 of file loader.c.

{
    struct loader *This = impl_from_IDirectMusicLoader8(iface);
    DMUS_OBJECTDESC desc;
    struct cache_entry *entry;
 
    TRACE("(%p, %p)\n", This, object);
 
    DM_STRUCT_INIT(&desc);
    IDirectMusicObject_GetDescriptor(object, &desc);
 
    /* Iterate through the list and check if we have an alias (without object), corresponding
        to the descriptor of the input object */
    entry = find_cache_object(This, &desc);
    if (entry) {
        if ((entry->Desc.dwValidData & DMUS_OBJ_LOADED) && entry->pObject) {
            TRACE("Object already loaded.\n");
            return S_FALSE;
        }
 
        entry->Desc.dwValidData |= DMUS_OBJ_LOADED;
        entry->pObject = object;
        IDirectMusicObject_AddRef(entry->pObject);
        return S_OK;
    }
 
    return DMUS_E_LOADER_OBJECTNOTFOUND;
}

loader_ClearCache()

static HRESULT WINAPI loader_ClearCache ( IDirectMusicLoader8 *  iface, REFGUID  class  )

static

Definition at line 734 of file loader.c.

{
    struct loader *This = impl_from_IDirectMusicLoader8(iface);
    struct cache_entry *obj, *obj2;
 
    TRACE("(%p, %s)\n", This, debugstr_dmguid(class));
 
    LIST_FOR_EACH_ENTRY_SAFE(obj, obj2, &This->cache, struct cache_entry, entry) {
        if ((IsEqualGUID(class, &GUID_DirectMusicAllTypes) || IsEqualGUID(class, &obj->Desc.guidClass)) &&
            (obj->Desc.dwValidData & DMUS_OBJ_LOADED)) {
            /* basically, wrap to ReleaseObject for each object found */
            IDirectMusicLoader8_ReleaseObject(iface, obj->pObject);
            list_remove(&obj->entry);
            free(obj);
        }
    }
 
    return S_OK;
}

loader_CollectGarbage()

static void WINAPI loader_CollectGarbage ( IDirectMusicLoader8 *  iface )

static

Definition at line 812 of file loader.c.

{
    FIXME("(%p)->(): stub\n", iface);
}

loader_EnableCache()

static HRESULT WINAPI loader_EnableCache ( IDirectMusicLoader8 *  iface, REFGUID  class, BOOL  enable  )

static

Definition at line 754 of file loader.c.

{
    struct loader *This = impl_from_IDirectMusicLoader8(iface);
    BOOL current;
 
    TRACE("(%p, %s, %d)\n", This, debugstr_dmguid(class), enable);
 
    current = is_cache_enabled(This, class);
 
    if (IsEqualGUID(class, &GUID_DirectMusicAllTypes))
        This->cache_class = enable ? ~0 : 0;
    else {
        int idx = index_from_class(class);
        if (idx == -1) return S_FALSE;
        if (enable)
            This->cache_class |= 1 << idx;
        else
            This->cache_class &= ~(1 << idx);
    }
 
    if (!enable)
        IDirectMusicLoader8_ClearCache(iface, class);
 
    if (current == enable)
        return S_FALSE;
 
    return S_OK;
}

loader_EnumObject()

static HRESULT WINAPI loader_EnumObject ( IDirectMusicLoader8 *  iface, REFGUID  rguidClass, DWORD  dwIndex, DMUS_OBJECTDESC *  pDesc  )

static

Definition at line 784 of file loader.c.

{
    struct loader *This = impl_from_IDirectMusicLoader8(iface);
    DWORD dwCount = 0;
        struct cache_entry *pObjectEntry;
    TRACE("(%p, %s, %ld, %p)\n", This, debugstr_dmguid(rguidClass), dwIndex, pDesc);
 
    DM_STRUCT_INIT(pDesc);
 
        LIST_FOR_EACH_ENTRY(pObjectEntry, &This->cache, struct cache_entry, entry) {
        if (IsEqualGUID (rguidClass, &GUID_DirectMusicAllTypes) || IsEqualGUID (rguidClass, &pObjectEntry->Desc.guidClass)) {
            if (dwCount == dwIndex) {
                *pDesc = pObjectEntry->Desc;
                /* we aren't supposed to reveal this info */
                pDesc->dwValidData &= ~(DMUS_OBJ_MEMORY | DMUS_OBJ_STREAM);
                pDesc->pbMemData = NULL;
                pDesc->llMemLength = 0;
                pDesc->pStream = NULL;
                return S_OK;
            }
            dwCount++;
        }
    }
    
    TRACE(": not found\n"); 
    return S_FALSE;
}

loader_GetObject()

static HRESULT WINAPI loader_GetObject ( IDirectMusicLoader8 *  iface, DMUS_OBJECTDESC *  pDesc, REFIID  riid, void **  ppv  )

static

Definition at line 272 of file loader.c.

{
    static const DWORD source_flags = DMUS_OBJ_STREAM | DMUS_OBJ_FILENAME | DMUS_OBJ_URL;
    struct loader *This = impl_from_IDirectMusicLoader8(iface);
    HRESULT result = S_OK;
    HRESULT ret = S_OK; /* used at the end of function, to determine whether everything went OK */
        struct cache_entry *pExistingEntry, *pObjectEntry = NULL;
    LPSTREAM pStream;
    IPersistStream* pPersistStream = NULL;
 
    LPDIRECTMUSICOBJECT pObject;
    DMUS_OBJECTDESC GotDesc;
    BOOL bCache;
        IStream *loader_stream;
        HRESULT hr;
 
        TRACE("(%p)->(%p, %s, %p)\n", This, pDesc, debugstr_dmguid(riid), ppv);
 
    if (TRACE_ON(dmloader))
      dump_DMUS_OBJECTDESC(pDesc);
    
    /* sometimes it happens that guidClass is missing... which is a BadThingTM */
    if (!(pDesc->dwValidData & DMUS_OBJ_CLASS)) {
      ERR(": guidClass not valid but needed\n");
      *ppv = NULL;
      return DMUS_E_LOADER_NOCLASSID;
    }
 
    /* Iterate through the list of objects we know about; these are either loaded
     * (GetObject, LoadObjectFromFile) or set via SetObject; */
    TRACE(": looking if we have object in the cache or if it can be found via alias\n");
    pExistingEntry = find_cache_object(This, pDesc);
    if (pExistingEntry) {
        if (pExistingEntry->Desc.dwValidData & DMUS_OBJ_LOADED) {
            TRACE(": already loaded\n");
            return IDirectMusicObject_QueryInterface(pExistingEntry->pObject, riid, ppv);
        }
 
        TRACE(": not loaded yet\n");
        pObjectEntry = pExistingEntry;
    }
 
    /* basically, if we found alias, we use its descriptor to load...
       else we use info we were given */
    if (pObjectEntry) {
        TRACE(": found alias entry for requested object... using stored info\n");
        /* I think in certain cases it can happen that entry's descriptor lacks info about
           where to load from (e.g.: if we loaded from stream and then released object
           from cache; then only its CLSID, GUID and perhaps name are left); so just
           overwrite whatever info the entry has (since it ought to be 100% correct) */
        DMUSIC_CopyDescriptor (pDesc, &pObjectEntry->Desc);
        /*pDesc = &pObjectEntry->Desc; */ /* FIXME: is this OK? */
    } else {
        TRACE(": no cache/alias entry found for requested object\n");
    }
    
    if (pDesc->dwValidData & DMUS_OBJ_URL)
    {
        TRACE(": loading from URLs not supported yet\n");
        return DMUS_E_LOADER_FORMATNOTSUPPORTED;
    }
    else if (pDesc->dwValidData & DMUS_OBJ_FILENAME)
    {
        WCHAR file_name[MAX_PATH];
 
        if (pDesc->dwValidData & DMUS_OBJ_FULLPATH)
            lstrcpyW(file_name, pDesc->wszFileName);
        else
        {
            WCHAR *p;
            get_search_path(This, &pDesc->guidClass, file_name);
            p = file_name + lstrlenW(file_name);
            if (p > file_name && p[-1] != '\\') *p++ = '\\';
            lstrcpyW(p, pDesc->wszFileName);
        }
 
        TRACE(": loading from file (%s)\n", debugstr_w(file_name));
        if (FAILED(hr = file_stream_create(file_name, &pStream))) return hr;
    }
    else if (pDesc->dwValidData & DMUS_OBJ_MEMORY) {
        /* load object from resource */
        TRACE(": loading from resource\n");
        /* create stream and associate it with given resource */            
        result = DMUSIC_CreateDirectMusicLoaderResourceStream ((LPVOID*)&pStream);
        if (FAILED(result)) {
            ERR(": could not create resource stream\n");
            return result;
        }
                result = IDirectMusicLoaderResourceStream_Attach(pStream, pDesc->pbMemData, pDesc->llMemLength, 0);
                if (FAILED(result))
                {
            ERR(": could not attach stream to resource\n");
            IStream_Release (pStream);
            return result;
        }
    }
    else if (pDesc->dwValidData & DMUS_OBJ_STREAM)
    {
        pStream = pDesc->pStream;
        IStream_AddRef(pStream);
    }
    else
    {
        FIXME(": unknown/unsupported way of loading\n");
        return DMUS_E_LOADER_NOFILENAME;
    }
 
    if (FAILED(hr = loader_stream_create((IDirectMusicLoader *)iface, pStream, &loader_stream)))
        return hr;
    IStream_Release(pStream);
    pStream = loader_stream;
 
        /* create object */
    result = CoCreateInstance (&pDesc->guidClass, NULL, CLSCTX_INPROC_SERVER, &IID_IDirectMusicObject, (LPVOID*)&pObject);
    if (FAILED(result)) {
        IStream_Release(pStream);
        ERR(": could not create object\n");
        return result;
    }
    /* acquire PersistStream interface */
    result = IDirectMusicObject_QueryInterface (pObject, &IID_IPersistStream, (LPVOID*)&pPersistStream);
    if (FAILED(result)) {
        IStream_Release(pStream);
        IDirectMusicObject_Release(pObject);
        ERR("failed to Query\n");
        return result;
    }
    /* load */
    result = IPersistStream_Load (pPersistStream, pStream);
    if (result != S_OK) {
        IStream_Release(pStream);
        IPersistStream_Release(pPersistStream);
        IDirectMusicObject_Release(pObject);
        WARN(": failed to (completely) load object (%#lx)\n", result);
        return result;
    }
    /* get descriptor */
    DM_STRUCT_INIT(&GotDesc);
    result = IDirectMusicObject_GetDescriptor (pObject, &GotDesc);
    /* set filename (if we loaded via filename) */
    if (pDesc->dwValidData & DMUS_OBJ_FILENAME) {
        GotDesc.dwValidData |= (pDesc->dwValidData & (DMUS_OBJ_FILENAME | DMUS_OBJ_FULLPATH));
        lstrcpyW (GotDesc.wszFileName, pDesc->wszFileName);
    }
    if (FAILED(result)) {
        IStream_Release(pStream);
        IPersistStream_Release(pPersistStream);
        IDirectMusicObject_Release(pObject);
        ERR(": failed to get descriptor\n");
        return result;
    }
    /* release all loading related stuff */
    IStream_Release (pStream);
    IPersistStream_Release (pPersistStream);    
        
    /* add object to cache/overwrite existing info (if cache is enabled) */
    bCache = is_cache_enabled(This, &pDesc->guidClass);
    if (!bCache) TRACE(": caching disabled\n");
    else if ((pDesc->dwValidData & source_flags) == DMUS_OBJ_STREAM)
    {
        FIXME("Skipping cache for DMUS_OBJ_STREAM object\n");
        bCache = FALSE;
    }
    else
    {
        if (!pObjectEntry)
        {
            pObjectEntry = calloc(1, sizeof(*pObjectEntry));
            DM_STRUCT_INIT(&pObjectEntry->Desc);
            DMUSIC_CopyDescriptor (&pObjectEntry->Desc, &GotDesc);
            pObjectEntry->pObject = pObject;
            list_add_head(&This->cache, &pObjectEntry->entry);
        }
        else
        {
            DMUSIC_CopyDescriptor (&pObjectEntry->Desc, &GotDesc);
            pObjectEntry->pObject = pObject;
        }
        TRACE(": filled in cache entry\n");
    }
 
    result = IDirectMusicObject_QueryInterface (pObject, riid, ppv);
    if (!bCache) IDirectMusicObject_Release (pObject); /* since loader's reference is not needed */
    /* if there was trouble with loading, and if no other error occurred,
       we should return DMUS_S_PARTIALLOAD; else, error is returned */
    if (result == S_OK)
        return ret;
    else
        return result;
}

loader_LoadObjectFromFile()

static HRESULT WINAPI loader_LoadObjectFromFile ( IDirectMusicLoader8 *  iface, REFGUID  rguidClassID, REFIID  iidInterfaceID, WCHAR *  pwzFilePath, void **  ppObject  )

static

Definition at line 839 of file loader.c.

{
    struct loader *This = impl_from_IDirectMusicLoader8(iface);
    DMUS_OBJECTDESC ObjDesc;
    WCHAR wszLoaderSearchPath[MAX_PATH];
 
    TRACE("(%p, %s, %s, %s, %p): wrapping to loader_GetObject\n", This, debugstr_dmguid(rguidClassID), debugstr_dmguid(iidInterfaceID), debugstr_w(pwzFilePath), ppObject);
 
    DM_STRUCT_INIT(&ObjDesc);   
    ObjDesc.dwValidData = DMUS_OBJ_FILENAME | DMUS_OBJ_FULLPATH | DMUS_OBJ_CLASS; /* I believe I've read somewhere in MSDN that this function requires either full path or relative path */
    ObjDesc.guidClass = *rguidClassID;
    /* OK, MSDN says that search order is the following:
        - current directory (DONE)
        - windows search path (FIXME: how do I get that?)
        - loader's search path (DONE)
    */
        get_search_path(This, rguidClassID, wszLoaderSearchPath);
    /* search in current directory */
    if (!SearchPathW(NULL, pwzFilePath, NULL, ARRAY_SIZE(ObjDesc.wszFileName), ObjDesc.wszFileName, NULL) &&
    /* search in loader's search path */
        !SearchPathW(wszLoaderSearchPath, pwzFilePath, NULL, ARRAY_SIZE(ObjDesc.wszFileName), ObjDesc.wszFileName, NULL)) {
        /* cannot find file */
        TRACE(": cannot find file\n");
        return DMUS_E_LOADER_FAILEDOPEN;
    }
    
    TRACE(": full file path = %s\n", debugstr_w (ObjDesc.wszFileName));
    
    return IDirectMusicLoader_GetObject(iface, &ObjDesc, iidInterfaceID, ppObject);
}

loader_QueryInterface()

static HRESULT WINAPI loader_QueryInterface ( IDirectMusicLoader8 *  iface, REFIID  riid, void **  ppobj  )

static

Definition at line 137 of file loader.c.

{
    struct loader *This = impl_from_IDirectMusicLoader8(iface);
 
    TRACE("(%p, %s, %p)\n",This, debugstr_dmguid(riid), ppobj);
    if (IsEqualIID (riid, &IID_IUnknown) || 
        IsEqualIID (riid, &IID_IDirectMusicLoader) ||
        IsEqualIID (riid, &IID_IDirectMusicLoader8)) {
        IDirectMusicLoader_AddRef (iface);
        *ppobj = This;
        return S_OK;
    }
    
    WARN(": not found\n");
    return E_NOINTERFACE;
}

loader_Release()

static ULONG WINAPI loader_Release ( IDirectMusicLoader8 *  iface )

static

Definition at line 164 of file loader.c.

{
    struct loader *This = impl_from_IDirectMusicLoader8(iface);
    ULONG ref = InterlockedDecrement(&This->ref);
 
    TRACE("(%p)->(): new ref = %lu\n", iface, ref);
 
    if (!ref) {
        unsigned int i;
 
        IDirectMusicLoader8_ClearCache(iface, &GUID_DirectMusicAllTypes);
        for (i = 0; i < ARRAY_SIZE(classes); i++)
            free(This->search_paths[i]);
        free(This);
    }
 
    return ref;
}

loader_ReleaseObject()

static HRESULT WINAPI loader_ReleaseObject ( IDirectMusicLoader8 *  iface, IDirectMusicObject *  object  )

static

Definition at line 703 of file loader.c.

{
    struct loader *This = impl_from_IDirectMusicLoader8(iface);
    DMUS_OBJECTDESC desc;
    struct cache_entry *entry;
 
    TRACE("(%p, %p)\n", This, object);
 
    if (!object)
        return E_POINTER;
 
    DM_STRUCT_INIT(&desc);
    IDirectMusicObject_GetDescriptor(object, &desc);
 
    TRACE("Looking for the object in cache\n");
    entry = find_cache_object(This, &desc);
    if (entry) {
        dump_DMUS_OBJECTDESC(&entry->Desc);
 
        if (entry->pObject && entry->Desc.dwValidData & DMUS_OBJ_LOADED) {
            IDirectMusicObject_Release(entry->pObject);
            entry->pObject = NULL;
            entry->Desc.dwValidData &= ~DMUS_OBJ_LOADED;
            return S_OK;
        }
    }
 
    return S_FALSE;
}

loader_ReleaseObjectByUnknown()

static HRESULT WINAPI loader_ReleaseObjectByUnknown ( IDirectMusicLoader8 *  iface, IUnknown *  pObject  )

static

Definition at line 817 of file loader.c.

{
    struct loader *This = impl_from_IDirectMusicLoader8(iface);
    HRESULT result;
    LPDIRECTMUSICOBJECT pObjectInterface;
    
    TRACE("(%p, %p)\n", This, pObject);
    
    if (IsBadReadPtr (pObject, sizeof(*pObject))) {
        ERR(": pObject bad write pointer\n");
        return E_POINTER;
    }
    /* we simply get IDirectMusicObject interface */
    result = IUnknown_QueryInterface (pObject, &IID_IDirectMusicObject, (LPVOID*)&pObjectInterface);
    if (FAILED(result)) return result;
    /* and release it in old-fashioned way */
    result = IDirectMusicLoader8_ReleaseObject (iface, pObjectInterface);
    IDirectMusicObject_Release (pObjectInterface);
    
    return result;
}

loader_ScanDirectory()

static HRESULT WINAPI loader_ScanDirectory ( IDirectMusicLoader8 *  iface, REFGUID  rguidClass, WCHAR *  pwzFileExtension, WCHAR *  pwzScanFileName  )

static

Definition at line 614 of file loader.c.

{
    struct loader *This = impl_from_IDirectMusicLoader8(iface);
    WIN32_FIND_DATAW FileData;
    HANDLE hSearch;
    WCHAR wszSearchString[MAX_PATH];
    WCHAR *p;
    HRESULT result;
        TRACE("(%p, %s, %s, %s)\n", This, debugstr_dmguid(rguidClass), debugstr_w(pwzFileExtension),
                        debugstr_w(pwzScanFileName));
        if (index_from_class(rguidClass) <= 0) {
        ERR(": rguidClass invalid CLSID\n");
        return REGDB_E_CLASSNOTREG;
    }
 
        if (!pwzFileExtension)
                return S_FALSE;
 
    /* get search path for given class */
        get_search_path(This, rguidClass, wszSearchString);
 
    p = wszSearchString + lstrlenW(wszSearchString);
    if (p > wszSearchString && p[-1] != '\\') *p++ = '\\';
    *p++ = '*'; /* any file */
        if (lstrcmpW (pwzFileExtension, L"*"))
                *p++ = '.'; /* if we have actual extension, put a dot */
    lstrcpyW (p, pwzFileExtension);
 
    TRACE(": search string: %s\n", debugstr_w(wszSearchString));
 
    hSearch = FindFirstFileW (wszSearchString, &FileData);
    if (hSearch == INVALID_HANDLE_VALUE) {
        TRACE(": no files found\n");
        return S_FALSE;
    }
    
    do {
        DMUS_OBJECTDESC Desc;
        DM_STRUCT_INIT(&Desc);
        Desc.dwValidData = DMUS_OBJ_CLASS | DMUS_OBJ_FILENAME | DMUS_OBJ_DATE;
        Desc.guidClass = *rguidClass;
        lstrcpyW (Desc.wszFileName, FileData.cFileName);
        FileTimeToLocalFileTime (&FileData.ftCreationTime, &Desc.ftDate);
        IDirectMusicLoader8_SetObject (iface, &Desc);
        
        if (!FindNextFileW (hSearch, &FileData)) {
            if (GetLastError () == ERROR_NO_MORE_FILES) {
                TRACE(": search completed\n");
                result = S_OK;
            } else {
                ERR(": could not get next file\n");
                result = E_FAIL;
            }
            FindClose (hSearch);
            return result;
        }
    } while (1);
}

loader_SetObject()

static HRESULT WINAPI loader_SetObject ( IDirectMusicLoader8 *  iface, DMUS_OBJECTDESC *  pDesc  )

static

Definition at line 463 of file loader.c.

{
    struct loader *This = impl_from_IDirectMusicLoader8(iface);
    LPSTREAM pStream;
    LPDIRECTMUSICOBJECT pObject;
    DMUS_OBJECTDESC Desc;
        struct cache_entry *pObjectEntry, *pNewEntry;
        IStream *loader_stream;
        HRESULT hr;
 
    TRACE("(%p)->(%p)\n", This, pDesc);
 
    if (TRACE_ON(dmloader))
        dump_DMUS_OBJECTDESC(pDesc);
 
    if (pDesc->dwValidData & DMUS_OBJ_FILENAME)
    {
        WCHAR file_name[MAX_PATH];
 
        if (pDesc->dwValidData & DMUS_OBJ_FULLPATH)
            lstrcpyW(file_name, pDesc->wszFileName);
        else
        {
            WCHAR *p;
            get_search_path(This, &pDesc->guidClass, file_name);
            p = file_name + lstrlenW(file_name);
            if (p > file_name && p[-1] != '\\') *p++ = '\\';
            lstrcpyW(p, pDesc->wszFileName);
        }
 
        if (!wcsicmp(file_name, L"C:\\windows\\system32\\drivers\\gm.dls")
                && GetFileAttributesW(file_name) == INVALID_FILE_ATTRIBUTES)
        {
            hr = get_system_default_gm_path(file_name, ARRAY_SIZE(file_name));
            if (FAILED(hr)) return hr;
        }
 
        if (FAILED(hr = file_stream_create(file_name, &pStream))) return hr;
    }
    else if (pDesc->dwValidData & DMUS_OBJ_STREAM)
    {
        pStream = pDesc->pStream;
        IStream_AddRef(pStream);
    }
    else if (pDesc->dwValidData & DMUS_OBJ_MEMORY) {
        /* create stream */
        hr = DMUSIC_CreateDirectMusicLoaderResourceStream ((LPVOID*)&pStream);
        if (FAILED(hr)) {
            ERR(": could not create resource stream\n");
            return DMUS_E_LOADER_FAILEDOPEN;
        }
        /* attach stream */
                hr = IDirectMusicLoaderResourceStream_Attach(pStream, pDesc->pbMemData, pDesc->llMemLength, 0);
                if (FAILED(hr))
                {
            ERR(": could not attach stream to resource\n");
            IStream_Release (pStream);
            return DMUS_E_LOADER_FAILEDOPEN;
        }
    }
    else {
        ERR(": no way to get additional info\n");
        return DMUS_E_LOADER_FAILEDOPEN;
    }
 
    if (FAILED(hr = loader_stream_create((IDirectMusicLoader *)iface, pStream, &loader_stream)))
        return hr;
    IStream_Release(pStream);
    pStream = loader_stream;
 
        /* create object */
    hr = CoCreateInstance (&pDesc->guidClass, NULL, CLSCTX_INPROC_SERVER, &IID_IDirectMusicObject, (LPVOID*)&pObject);
        if (FAILED(hr)) {
        IStream_Release(pStream);
        ERR("Object creation of %s failed %#lx\n", debugstr_guid(&pDesc->guidClass),hr);
        return DMUS_E_LOADER_FAILEDOPEN;
        }
 
    DM_STRUCT_INIT(&Desc);
    if (FAILED(IDirectMusicObject_ParseDescriptor (pObject, pStream, &Desc))) {
        IStream_Release(pStream);
        IDirectMusicObject_Release(pObject);
        ERR(": couldn't parse descriptor\n");
        return DMUS_E_LOADER_FORMATNOTSUPPORTED;
    }
 
    /* copy elements from parsed descriptor into input descriptor; this sets new info, overwriting if necessary,
       but leaves info that's provided by input and not available from stream */    
    DMUSIC_CopyDescriptor (pDesc, &Desc);
    
    /* release everything */
    IDirectMusicObject_Release (pObject);
    IStream_Release (pStream);  
    
    /* sometimes it happens that twisted programs call SetObject for same object twice...
       in such cases, native loader returns S_OK and does nothing... a sound plan */
        LIST_FOR_EACH_ENTRY(pObjectEntry, &This->cache, struct cache_entry, entry) {
        if (!memcmp (&pObjectEntry->Desc, pDesc, sizeof(DMUS_OBJECTDESC))) {
            TRACE(": exactly same entry already exists\n");
            return S_OK;
        }
    }       
    
    /* add new entry */
    TRACE(": adding alias entry with following info:\n");
    if (TRACE_ON(dmloader))
        dump_DMUS_OBJECTDESC(pDesc);
    pNewEntry = calloc(1, sizeof(*pNewEntry));
    /* use this function instead of pure memcpy due to streams (memcpy just copies pointer), 
       which is basically used further by app that called SetDescriptor... better safety than exception */
    DMUSIC_CopyDescriptor (&pNewEntry->Desc, pDesc);
        list_add_head(&This->cache, &pNewEntry->entry);
 
    return S_OK;
}

loader_SetSearchDirectory()

static HRESULT WINAPI loader_SetSearchDirectory ( IDirectMusicLoader8 *  iface, REFGUID  class, WCHAR *  path, BOOL  clear  )

static

Definition at line 579 of file loader.c.

{
    struct loader *This = impl_from_IDirectMusicLoader8(iface);
    int index = index_from_class(class);
    DWORD attr;
 
    TRACE("(%p, %s, %s, %d)\n", This, debugstr_dmguid(class), debugstr_w(path), clear);
 
    if (!path)
        return E_POINTER;
 
    if (path[0]) {
        attr = GetFileAttributesW(path);
        if (attr == INVALID_FILE_ATTRIBUTES || !(attr & FILE_ATTRIBUTE_DIRECTORY))
            return DMUS_E_LOADER_BADPATH;
    }
 
    if (clear)
        FIXME("clear flag ignored\n");
 
    /* Ignore invalid GUIDs */
    if (index < 0)
        return S_OK;
 
    if (!This->search_paths[index])
        This->search_paths[index] = malloc(MAX_PATH);
    else if (!wcsncmp(This->search_paths[index], path, MAX_PATH))
        return S_FALSE;
 
    lstrcpynW(This->search_paths[index], path, MAX_PATH);
 
    return S_OK;
}

WINE_DEFAULT_DEBUG_CHANNEL()

WINE_DEFAULT_DEBUG_CHANNEL

(

dmloader

)

Variable Documentation

classes

const GUID* classes[]

static

Initial value:

= {
    &GUID_DirectMusicAllTypes,  
    &CLSID_DirectMusicAudioPathConfig,
    &CLSID_DirectMusicBand,
    &CLSID_DirectMusicContainer,
    &CLSID_DirectMusicCollection,
    &CLSID_DirectMusicChordMap,
    &CLSID_DirectMusicSegment,
    &CLSID_DirectMusicScript,
    &CLSID_DirectMusicSong,
    &CLSID_DirectMusicStyle,
    &CLSID_DirectMusicGraph,
    &CLSID_DirectSoundWave
}

Definition at line 49 of file loader.c.

Referenced by exec_global_code(), export_all(), find_class_data(), index_from_class(), loader_Release(), lookup_script_identifier(), MsiGetProductInfoExW(), opentype_layout_get_glyph_class(), RoGetServerActivatableClasses(), RoRegisterActivationFactories(), test_appsearch_reglocator(), test_comctl32_classes(), test_ntdll_wndprocs(), CQueryAssociations::TryBaseClass(), txt_export_all(), unregister_versioned_classes(), and WinMain().

loader_vtbl

const IDirectMusicLoader8Vtbl loader_vtbl

static

Initial value:

=
{
    loader_QueryInterface,
    loader_AddRef,
    loader_Release,
    loader_GetObject,
    loader_SetObject,
    loader_SetSearchDirectory,
    loader_ScanDirectory,
    loader_CacheObject,
    loader_ReleaseObject,
    loader_ClearCache,
    loader_EnableCache,
    loader_EnumObject,
    loader_CollectGarbage,
    loader_ReleaseObjectByUnknown,
    loader_LoadObjectFromFile,
}

Definition at line 870 of file loader.c.

Referenced by create_dmloader().

system_default_gm_paths

const WCHAR* system_default_gm_paths[]

static

Initial value:

=
{
    L"/usr/share/sounds/sf2/default-GM.sf2",
    L"/usr/share/soundfonts/default.sf2",
}

Definition at line 23 of file loader.c.

Referenced by get_system_default_gm_path().