dlls/dmime/lyricstrack.c

   1 /* IDirectMusicLyricsTrack Implementation
   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 #include "dmime_private.h"
  21
  22 WINE_DEFAULT_DEBUG_CHANNEL(dmime);
  23
  24 /*****************************************************************************
  25  * IDirectMusicLyricsTrack implementation
  26  */
  27 typedef struct IDirectMusicLyricsTrack {
  28     IDirectMusicTrack8 IDirectMusicTrack8_iface;
  29     struct dmobject dmobj;  /* IPersistStream only */
  30     LONG ref;
  31 } IDirectMusicLyricsTrack;
  32
  33 /* IDirectMusicLyricsTrack IDirectMusicTrack8 part: */
  34 static inline IDirectMusicLyricsTrack *impl_from_IDirectMusicTrack8(IDirectMusicTrack8 *iface)
  35 {
  36     return CONTAINING_RECORD(iface, IDirectMusicLyricsTrack, IDirectMusicTrack8_iface);
  37 }
  38
  39 static inline IDirectMusicLyricsTrack *impl_from_IPersistStream(IPersistStream *iface)
  40 {
  41     return CONTAINING_RECORD(iface, IDirectMusicLyricsTrack, dmobj.IPersistStream_iface);
  42 }
  43
  44 static HRESULT WINAPI lyrics_track_QueryInterface(IDirectMusicTrack8 *iface, REFIID riid,
  45         void **ret_iface)
  46 {
  47     IDirectMusicLyricsTrack *This = impl_from_IDirectMusicTrack8(iface);
  48
  49     TRACE("(%p, %s, %p)\n", This, debugstr_dmguid(riid), ret_iface);
  50
  51     *ret_iface = NULL;
  52
  53     if (IsEqualIID(riid, &IID_IUnknown) || IsEqualIID(riid, &IID_IDirectMusicTrack) ||
  54             IsEqualIID(riid, &IID_IDirectMusicTrack8))
  55         *ret_iface = iface;
  56     else if (IsEqualIID(riid, &IID_IPersistStream))
  57         *ret_iface = &This->dmobj.IPersistStream_iface;
  58     else {
  59         WARN("(%p, %s, %p): not found\n", This, debugstr_dmguid(riid), ret_iface);
  60         return E_NOINTERFACE;
  61     }
  62
  63     IUnknown_AddRef((IUnknown*)*ret_iface);
  64     return S_OK;
  65 }
  66
  67 static ULONG WINAPI lyrics_track_AddRef(IDirectMusicTrack8 *iface)
  68 {
  69     IDirectMusicLyricsTrack *This = impl_from_IDirectMusicTrack8(iface);
  70     LONG ref = InterlockedIncrement(&This->ref);
  71
  72     TRACE("(%p) ref=%ld\n", This, ref);
  73
  74     return ref;
  75 }
  76
  77 static ULONG WINAPI lyrics_track_Release(IDirectMusicTrack8 *iface)
  78 {
  79     IDirectMusicLyricsTrack *This = impl_from_IDirectMusicTrack8(iface);
  80     LONG ref = InterlockedDecrement(&This->ref);
  81
  82     TRACE("(%p) ref=%ld\n", This, ref);
  83
  84     if (!ref) {
  85         free(This);
  86     }
  87
  88     return ref;
  89 }
  90
  91 static HRESULT WINAPI lyrics_track_Init(IDirectMusicTrack8 *iface, IDirectMusicSegment *pSegment)
  92 {
  93         IDirectMusicLyricsTrack *This = impl_from_IDirectMusicTrack8(iface);
  94         FIXME("(%p, %p): stub\n", This, pSegment);
  95         return S_OK;
  96 }
  97
  98 static HRESULT WINAPI lyrics_track_InitPlay(IDirectMusicTrack8 *iface,
  99         IDirectMusicSegmentState *pSegmentState, IDirectMusicPerformance *pPerformance,
 100         void **ppStateData, DWORD dwVirtualTrack8ID, DWORD dwFlags)
 101 {
 102         IDirectMusicLyricsTrack *This = impl_from_IDirectMusicTrack8(iface);
 103         FIXME("(%p, %p, %p, %p, %ld, %ld): stub\n", This, pSegmentState, pPerformance, ppStateData, dwVirtualTrack8ID, dwFlags);
 104         return S_OK;
 105 }
 106
 107 static HRESULT WINAPI lyrics_track_EndPlay(IDirectMusicTrack8 *iface, void *pStateData)
 108 {
 109         IDirectMusicLyricsTrack *This = impl_from_IDirectMusicTrack8(iface);
 110         FIXME("(%p, %p): stub\n", This, pStateData);
 111         return S_OK;
 112 }
 113
 114 static HRESULT WINAPI lyrics_track_Play(IDirectMusicTrack8 *iface, void *pStateData,
 115         MUSIC_TIME mtStart, MUSIC_TIME mtEnd, MUSIC_TIME mtOffset, DWORD dwFlags,
 116         IDirectMusicPerformance *pPerf, IDirectMusicSegmentState *pSegSt, DWORD dwVirtualID)
 117 {
 118         IDirectMusicLyricsTrack *This = impl_from_IDirectMusicTrack8(iface);
 119         FIXME("(%p, %p, %ld, %ld, %ld, %ld, %p, %p, %ld): stub\n", This, pStateData, mtStart, mtEnd, mtOffset, dwFlags, pPerf, pSegSt, dwVirtualID);
 120         return S_OK;
 121 }
 122
 123 static HRESULT WINAPI lyrics_track_GetParam(IDirectMusicTrack8 *iface, REFGUID type,
 124         MUSIC_TIME time, MUSIC_TIME *next, void *param)
 125 {
 126     IDirectMusicLyricsTrack *This = impl_from_IDirectMusicTrack8(iface);
 127
 128     TRACE("(%p, %s, %ld, %p, %p): not supported\n", This, debugstr_dmguid(type), time, next, param);
 129     return DMUS_E_GET_UNSUPPORTED;
 130 }
 131
 132 static HRESULT WINAPI lyrics_track_SetParam(IDirectMusicTrack8 *iface, REFGUID type,
 133         MUSIC_TIME time, void *param)
 134 {
 135     IDirectMusicLyricsTrack *This = impl_from_IDirectMusicTrack8(iface);
 136
 137     TRACE("(%p, %s, %ld, %p): not supported\n", This, debugstr_dmguid(type), time, param);
 138     return DMUS_E_SET_UNSUPPORTED;
 139 }
 140
 141 static HRESULT WINAPI lyrics_track_IsParamSupported(IDirectMusicTrack8 *iface, REFGUID  type)
 142 {
 143     IDirectMusicLyricsTrack *This = impl_from_IDirectMusicTrack8(iface);
 144
 145     TRACE("(%p, %s): param type not supported\n", This, debugstr_dmguid(type));
 146     return DMUS_E_TYPE_UNSUPPORTED;
 147 }
 148
 149 static HRESULT WINAPI lyrics_track_AddNotificationType(IDirectMusicTrack8 *iface, REFGUID notiftype)
 150 {
 151     IDirectMusicLyricsTrack *This = impl_from_IDirectMusicTrack8(iface);
 152
 153     TRACE("(%p, %s): method not implemented\n", This, debugstr_dmguid(notiftype));
 154     return E_NOTIMPL;
 155 }
 156
 157 static HRESULT WINAPI lyrics_track_RemoveNotificationType(IDirectMusicTrack8 *iface,
 158         REFGUID notiftype)
 159 {
 160     IDirectMusicLyricsTrack *This = impl_from_IDirectMusicTrack8(iface);
 161
 162     TRACE("(%p, %s): method not implemented\n", This, debugstr_dmguid(notiftype));
 163     return E_NOTIMPL;
 164 }
 165
 166 static HRESULT WINAPI lyrics_track_Clone(IDirectMusicTrack8 *iface, MUSIC_TIME mtStart,
 167         MUSIC_TIME mtEnd, IDirectMusicTrack **ppTrack)
 168 {
 169         IDirectMusicLyricsTrack *This = impl_from_IDirectMusicTrack8(iface);
 170         FIXME("(%p, %ld, %ld, %p): stub\n", This, mtStart, mtEnd, ppTrack);
 171         return S_OK;
 172 }
 173
 174 static HRESULT WINAPI lyrics_track_PlayEx(IDirectMusicTrack8 *iface, void *pStateData,
 175         REFERENCE_TIME rtStart, REFERENCE_TIME rtEnd, REFERENCE_TIME rtOffset, DWORD dwFlags,
 176         IDirectMusicPerformance *pPerf, IDirectMusicSegmentState *pSegSt, DWORD dwVirtualID)
 177 {
 178         IDirectMusicLyricsTrack *This = impl_from_IDirectMusicTrack8(iface);
 179         FIXME("(%p, %p, 0x%s, 0x%s, 0x%s, %ld, %p, %p, %ld): stub\n", This, pStateData, wine_dbgstr_longlong(rtStart),
 180             wine_dbgstr_longlong(rtEnd), wine_dbgstr_longlong(rtOffset), dwFlags, pPerf, pSegSt, dwVirtualID);
 181         return S_OK;
 182 }
 183
 184 static HRESULT WINAPI lyrics_track_GetParamEx(IDirectMusicTrack8 *iface, REFGUID rguidType,
 185         REFERENCE_TIME rtTime, REFERENCE_TIME *prtNext, void *pParam, void *pStateData,
 186         DWORD dwFlags)
 187 {
 188         IDirectMusicLyricsTrack *This = impl_from_IDirectMusicTrack8(iface);
 189         FIXME("(%p, %s, 0x%s, %p, %p, %p, %ld): stub\n", This, debugstr_dmguid(rguidType),
 190             wine_dbgstr_longlong(rtTime), prtNext, pParam, pStateData, dwFlags);
 191         return S_OK;
 192 }
 193
 194 static HRESULT WINAPI lyrics_track_SetParamEx(IDirectMusicTrack8 *iface, REFGUID rguidType,
 195         REFERENCE_TIME rtTime, void *pParam, void *pStateData, DWORD dwFlags)
 196 {
 197         IDirectMusicLyricsTrack *This = impl_from_IDirectMusicTrack8(iface);
 198         FIXME("(%p, %s, 0x%s, %p, %p, %ld): stub\n", This, debugstr_dmguid(rguidType),
 199             wine_dbgstr_longlong(rtTime), pParam, pStateData, dwFlags);
 200         return S_OK;
 201 }
 202
 203 static HRESULT WINAPI lyrics_track_Compose(IDirectMusicTrack8 *iface, IUnknown *context,
 204         DWORD trackgroup, IDirectMusicTrack **track)
 205 {
 206     IDirectMusicLyricsTrack *This = impl_from_IDirectMusicTrack8(iface);
 207
 208     TRACE("(%p, %p, %ld, %p): method not implemented\n", This, context, trackgroup, track);
 209     return E_NOTIMPL;
 210 }
 211
 212 static HRESULT WINAPI lyrics_track_Join(IDirectMusicTrack8 *iface, IDirectMusicTrack *newtrack,
 213         MUSIC_TIME join, IUnknown *context, DWORD trackgroup, IDirectMusicTrack **resulttrack)
 214 {
 215     IDirectMusicLyricsTrack *This = impl_from_IDirectMusicTrack8(iface);
 216     TRACE("(%p, %p, %ld, %p, %ld, %p): method not implemented\n", This, newtrack, join, context,
 217             trackgroup, resulttrack);
 218     return E_NOTIMPL;
 219 }
 220
 221 static const IDirectMusicTrack8Vtbl dmtrack8_vtbl = {
 222     lyrics_track_QueryInterface,
 223     lyrics_track_AddRef,
 224     lyrics_track_Release,
 225     lyrics_track_Init,
 226     lyrics_track_InitPlay,
 227     lyrics_track_EndPlay,
 228     lyrics_track_Play,
 229     lyrics_track_GetParam,
 230     lyrics_track_SetParam,
 231     lyrics_track_IsParamSupported,
 232     lyrics_track_AddNotificationType,
 233     lyrics_track_RemoveNotificationType,
 234     lyrics_track_Clone,
 235     lyrics_track_PlayEx,
 236     lyrics_track_GetParamEx,
 237     lyrics_track_SetParamEx,
 238     lyrics_track_Compose,
 239     lyrics_track_Join
 240 };
 241
 242 static HRESULT parse_lyrics_track_events(IDirectMusicLyricsTrack *This, IStream *stream,
 243                 struct chunk_entry *lyric)
 244 {
 245     struct chunk_entry chunk = {.parent = lyric};
 246     HRESULT hr;
 247     DMUS_IO_LYRICSTRACK_EVENTHEADER header;
 248     WCHAR name[256];
 249
 250     TRACE("Parsing segment form in %p: %s\n", stream, debugstr_chunk(lyric));
 251
 252     while ((hr = stream_next_chunk(stream, &chunk)) == S_OK) {
 253         if (chunk.id == FOURCC_LIST && chunk.type == DMUS_FOURCC_LYRICSTRACKEVENT_LIST) {
 254             struct chunk_entry child = {.parent = &chunk};
 255
 256             if (FAILED(hr = stream_next_chunk(stream, &child)))
 257                 return  hr;
 258
 259             if (child.id != DMUS_FOURCC_LYRICSTRACKEVENTHEADER_CHUNK)
 260                 return DMUS_E_UNSUPPORTED_STREAM;
 261
 262             if (FAILED(hr = stream_chunk_get_data(stream, &child, &header, child.size))) {
 263                 WARN("Failed to read data of %s\n", debugstr_chunk(&child));
 264                 return hr;
 265             }
 266
 267             TRACE("Found DMUS_IO_LYRICSTRACK_EVENTHEADER\n");
 268             TRACE("  - dwFlags %#lx\n", header.dwFlags);
 269             TRACE("  - dwTimingFlags %#lx\n", header.dwTimingFlags);
 270             TRACE("  - lTimeLogical %ld\n", header.lTimeLogical);
 271             TRACE("  - lTimePhysical %ld\n", header.lTimePhysical);
 272
 273             if (FAILED(hr = stream_next_chunk(stream, &child)))
 274                 return  hr;
 275
 276             if (child.id != DMUS_FOURCC_LYRICSTRACKEVENTTEXT_CHUNK)
 277                 return DMUS_E_UNSUPPORTED_STREAM;
 278
 279             if (FAILED(hr = stream_chunk_get_data(stream, &child, &name, child.size))) {
 280                 WARN("Failed to read data of %s\n", debugstr_chunk(&child));
 281                 return hr;
 282             }
 283
 284             TRACE("Found DMUS_FOURCC_LYRICSTRACKEVENTTEXT_CHUNK\n");
 285             TRACE("  - name %s\n", debugstr_w(name));
 286         }
 287     }
 288
 289     return SUCCEEDED(hr) ? S_OK : hr;
 290 }
 291
 292 static HRESULT parse_lyricstrack_list(IDirectMusicLyricsTrack *This, IStream *stream, struct chunk_entry *lyric)
 293 {
 294     HRESULT hr;
 295     struct chunk_entry chunk = {.parent = lyric};
 296
 297     TRACE("Parsing segment form in %p: %s\n", stream, debugstr_chunk(lyric));
 298
 299     if (FAILED(hr = stream_next_chunk(stream, &chunk)))
 300         return hr;
 301
 302     if (chunk.id == FOURCC_LIST && chunk.type == DMUS_FOURCC_LYRICSTRACKEVENTS_LIST)
 303         hr = parse_lyrics_track_events(This, stream, &chunk);
 304     else
 305         hr = DMUS_E_UNSUPPORTED_STREAM;
 306
 307     return SUCCEEDED(hr) ? S_OK : hr;
 308 }
 309
 310 static HRESULT WINAPI lyrics_IPersistStream_Load(IPersistStream *iface, IStream *stream)
 311 {
 312     IDirectMusicLyricsTrack *This = impl_from_IPersistStream(iface);
 313     HRESULT hr;
 314     struct chunk_entry chunk = {0};
 315
 316     TRACE("%p, %p\n", This, stream);
 317
 318     if (!stream)
 319         return E_POINTER;
 320
 321     if ((hr = stream_get_chunk(stream, &chunk)) != S_OK)
 322         return hr;
 323
 324     if (chunk.id == FOURCC_LIST && chunk.type == DMUS_FOURCC_LYRICSTRACK_LIST)
 325         hr = parse_lyricstrack_list(This, stream, &chunk);
 326     else
 327         hr = DMUS_E_UNSUPPORTED_STREAM;
 328
 329     return hr;
 330 }
 331
 332 static const IPersistStreamVtbl persiststream_vtbl = {
 333     dmobj_IPersistStream_QueryInterface,
 334     dmobj_IPersistStream_AddRef,
 335     dmobj_IPersistStream_Release,
 336     dmobj_IPersistStream_GetClassID,
 337     unimpl_IPersistStream_IsDirty,
 338     lyrics_IPersistStream_Load,
 339     unimpl_IPersistStream_Save,
 340     unimpl_IPersistStream_GetSizeMax
 341 };
 342
 343 /* for ClassFactory */
 344 HRESULT create_dmlyricstrack(REFIID lpcGUID, void **ppobj)
 345 {
 346     IDirectMusicLyricsTrack *track;
 347     HRESULT hr;
 348
 349     *ppobj = NULL;
 350     if (!(track = calloc(1, sizeof(*track)))) return E_OUTOFMEMORY;
 351     track->IDirectMusicTrack8_iface.lpVtbl = &dmtrack8_vtbl;
 352     track->ref = 1;
 353     dmobject_init(&track->dmobj, &CLSID_DirectMusicLyricsTrack,
 354                   (IUnknown *)&track->IDirectMusicTrack8_iface);
 355     track->dmobj.IPersistStream_iface.lpVtbl = &persiststream_vtbl;
 356
 357     hr = IDirectMusicTrack8_QueryInterface(&track->IDirectMusicTrack8_iface, lpcGUID, ppobj);
 358     IDirectMusicTrack8_Release(&track->IDirectMusicTrack8_iface);
 359
 360     return hr;
 361 }