1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
|
/****************************************************************************
*
* $Id: rmaplugn.h 7 2003-05-30 02:18:02Z gabest $
*
* Copyright (C) 1995-1999 RealNetworks, Inc. All rights reserved.
*
* http://www.real.com/devzone
*
* This program contains proprietary
* information of Progressive Networks, Inc, and is licensed
* subject to restrictions on use and distribution.
*
*
* Plugin init / inspector interfaces
*
*/
#ifndef _RMAPLUGN_H_
#define _RMAPLUGN_H_
/*
* Forward declarations of some interfaces defined or used here-in.
*/
typedef _INTERFACE IUnknown IUnknown;
typedef _INTERFACE IRMAPlugin IRMAPlugin;
typedef _INTERFACE IRMAPluginEnumerator IRMAPluginEnumerator;
typedef _INTERFACE IRMAPluginChallenger IRMAPluginChallenger;
typedef _INTERFACE IRMABuffer IRMABuffer;
typedef _INTERFACE IRMAValues IRMAValues;
/****************************************************************************
*
* Function:
*
* RMACreateInstance()
*
* Purpose:
*
* Function implemented by all plugin DLL's to create an instance of
* any of the objects supported by the DLL. This method is similar to
* Window's CoCreateInstance() in its purpose, except that it only
* creates objects from this plugin DLL.
*
* NOTE: Aggregation is never used. Therefore an outer unknown is
* not passed to this function, and you do not need to code for this
* situation.
*
*/
#ifdef _MACINTOSH
#pragma export on
#endif
STDAPI RMACreateInstance
(
IUnknown** /*OUT*/ ppIUnknown
);
#ifdef _MACINTOSH
#pragma export off
#endif
/****************************************************************************
*
* Function:
*
* RMAShutdown()
*
* Purpose:
*
* Function implemented by all plugin DLL's to free any *global*
* resources. This method is called just before the DLL is unloaded.
*
*/
#ifdef _MACINTOSH
#pragma export on
#endif
STDAPI RMAShutdown(void);
#ifdef _MACINTOSH
#pragma export off
#endif
/****************************************************************************
*
* Interface:
*
* IRMAPlugin
*
* Purpose:
*
* Interface exposed by a plugin DLL to allow inspection of objects
* supported by the plugin DLL.
*
* IID_IRMAPlugin:
*
* {00000C00-0901-11d1-8B06-00A024406D59}
*
*/
DEFINE_GUID(IID_IRMAPlugin, 0x00000C00, 0x901, 0x11d1, 0x8b, 0x6, 0x0,
0xa0, 0x24, 0x40, 0x6d, 0x59);
#undef INTERFACE
#define INTERFACE IRMAPlugin
DECLARE_INTERFACE_(IRMAPlugin, IUnknown)
{
/*
* IUnknown methods
*/
STDMETHOD(QueryInterface) (THIS_
REFIID riid,
void** ppvObj) PURE;
STDMETHOD_(ULONG,AddRef) (THIS) PURE;
STDMETHOD_(ULONG,Release) (THIS) PURE;
/*
* IRMAPlugin methods
*/
/************************************************************************
* Method:
* IRMAPlugin::GetPluginInfo
* Purpose:
* Returns the basic information about this plugin. Including:
*
* bMultipleLoad Whether or not this plugin can be instantiated
* multiple times. All File Formats must set
* this value to TRUE. The only other type of
* plugin that can specify bMultipleLoad=TRUE is
* a filesystem plugin. Any plugin that sets
* this flag to TRUE must not use global variables
* of any type.
*
* Setting this flag to TRUE implies that you
* accept that your plugin may be instantiated
* multiple times (possibly in different
* address spaces). Plugins are instantiated
* multiple times only in the server (for
* performance reasons).
*
* An example of a plugin, that must set this
* flag to FALSE is a filesystem plugin that
* uses a single TCP connection to communicate
* with a database.
*
* pDescription which is used in about UIs (can be NULL)
* pCopyright which is used in about UIs (can be NULL)
* pMoreInfoURL which is used in about UIs (can be NULL)
* ulVersionNumber The version of this plugin.
*/
STDMETHOD(GetPluginInfo) (THIS_
REF(BOOL) /*OUT*/ bMultipleLoad,
REF(const char*) /*OUT*/ pDescription,
REF(const char*) /*OUT*/ pCopyright,
REF(const char*) /*OUT*/ pMoreInfoURL,
REF(ULONG32) /*OUT*/ ulVersionNumber) PURE;
/************************************************************************
* Method:
* IRMAPlugin::InitPlugin
* Purpose:
* Initializes the plugin for use. This interface must always be
* called before any other method is called. This is primarily needed
* so that the plugin can have access to the context for creation of
* IRMABuffers and IMalloc.
*/
STDMETHOD(InitPlugin) (THIS_
IUnknown* /*IN*/ pContext) PURE;
};
/****************************************************************************
*
* Interface:
*
* IRMAPluginEnumerator
*
* Purpose:
*
* provide methods to enumerate through all the plugins installed
*
* IID_IRMAPluginEnumerator:
*
* {00000C01-0901-11d1-8B06-00A024406D59}
*
*/
DEFINE_GUID(IID_IRMAPluginEnumerator, 0x00000C01, 0x901, 0x11d1, 0x8b, 0x6, 0x0,
0xa0, 0x24, 0x40, 0x6d, 0x59);
#undef INTERFACE
#define INTERFACE IRMAPluginEnumerator
DECLARE_INTERFACE_(IRMAPluginEnumerator, IUnknown)
{
/*
* IUnknown methods
*/
STDMETHOD(QueryInterface) (THIS_
REFIID riid,
void** ppvObj) PURE;
STDMETHOD_(ULONG,AddRef) (THIS) PURE;
STDMETHOD_(ULONG,Release) (THIS) PURE;
/*
* IRMAPluginEnumerator methods
*/
/************************************************************************
* Method:
* IRMAPluginEnumerator::GetNumOfPlugins
*
* Purpose:
* return the number of plugins available
*
*/
STDMETHOD_(ULONG32,GetNumOfPlugins) (THIS) PURE;
/************************************************************************
* Method:
* IRMAPluginEnumerator::GetPlugin
* Purpose:
* Return an instance (IUnknown) of the plugin
*
*/
STDMETHOD(GetPlugin) (THIS_
ULONG32 /*IN*/ ulIndex,
REF(IUnknown*) /*OUT*/ pPlugin) PURE;
};
/****************************************************************************
*
* Interface:
*
* IRMAPluginGroupEnumerator
*
* Purpose:
*
* Provide a way to enumerate through all of the plugins which
* implement a specific interface.
*
* IID_IRMAPluginGroupEnumerator:
*
* {00000C02-0901-11d1-8B06-00A024406D59}
*
*/
DEFINE_GUID(IID_IRMAPluginGroupEnumerator, 0x00000C02, 0x901, 0x11d1, 0x8b, 0x6, 0x0,
0xa0, 0x24, 0x40, 0x6d, 0x59);
#undef INTERFACE
#define INTERFACE IRMAPluginGroupEnumerator
#define CLSID_IRMAPluginGroupEnumerator IID_IRMAPluginGroupEnumerator
DECLARE_INTERFACE_(IRMAPluginGroupEnumerator, IUnknown)
{
/*
* IUnknown methods
*/
/*
* IRMAPluginGroupEnumerator methods
*/
STDMETHOD(QueryInterface) (THIS_
REFIID riid,
void** ppvObj) PURE;
STDMETHOD_(ULONG,AddRef) (THIS) PURE;
STDMETHOD_(ULONG,Release) (THIS) PURE;
/******************************************************************
* Method:
* IRMAPluginGroupEnumerator::Init
*
* Purpose:
* tell the group enumerator which interface to group the plugins
* into, this method must be called before the other methods can
* be called.
*
*/
STDMETHOD(Init) (THIS_
REFIID iid) PURE;
/******************************************************************
* Method:
* IRMAPluginGroupEnumerator::GetNumOfPlugins
*
* Purpose:
* return the number of plugins available that support a
particular
* interface.
*
*/
STDMETHOD_(ULONG32,GetNumOfPlugins) (THIS) PURE;
/******************************************************************
* Method:
* IRMAPluginGroupEnumerator::GetPlugin
* Purpose:
* Return an instance (IUnknown) of the plugin
*
*/
STDMETHOD(GetPlugin) (THIS_
UINT32 /*IN*/ ulIndex,
REF(IUnknown*) /*OUT*/ pPlugin) PURE;
};
/****************************************************************************
*
* Interface:
*
* IRMAPluginReloader
*
* Purpose:
*
* Tells the client core to reload all plugins.
*
* IID_IRMAPluginReloader:
*
* {00000C03-0901-11d1-8B06-00A024406D59}
*
*/
DEFINE_GUID(IID_IRMAPluginReloader, 0x00000C03, 0x901, 0x11d1, 0x8b, 0x6, 0x0,
0xa0, 0x24, 0x40, 0x6d, 0x59);
#undef INTERFACE
#define INTERFACE IRMAPluginReloader
DECLARE_INTERFACE_(IRMAPluginReloader, IUnknown)
{
/*
* IUnknown methods
*/
STDMETHOD(QueryInterface) (THIS_
REFIID riid,
void** ppvObj) PURE;
STDMETHOD_(ULONG,AddRef) (THIS) PURE;
STDMETHOD_(ULONG,Release) (THIS) PURE;
/*
* IRMAPluginReloader methods
*/
/************************************************************************
* Method:
* IRMAPluginReloader::ReloadPlugins
* Purpose:
* Causes the client core to reload all plugins.
*
*/
STDMETHOD(ReloadPlugins) (THIS) PURE;
};
/****************************************************************************
*
* Interface:
*
* IRMAPluginFactory
*
* Purpose:
*
* This interface is implemented by a plugin in order to have more then
* one "RMA plugin" in a single DLL. I.e., a plugin author could
* use this interface to have 3 different file format plugins in
* a single DLL.
*
* IID_IRMAPluginFactory:
*
* {00000C04-0901-11d1-8B06-00A024406D59}
*
*/
DEFINE_GUID(IID_IRMAPluginFactory, 0x00000C04, 0x901, 0x11d1, 0x8b, 0x6, 0x0,
0xa0, 0x24, 0x40, 0x6d, 0x59);
#undef INTERFACE
#define INTERFACE IRMAPluginFactory
DECLARE_INTERFACE_(IRMAPluginFactory, IUnknown)
{
/*
* IUnknown methods
*/
STDMETHOD(QueryInterface) (THIS_
REFIID riid,
void** ppvObj) PURE;
STDMETHOD_(ULONG,AddRef) (THIS) PURE;
STDMETHOD_(ULONG,Release) (THIS) PURE;
/*
* IRMAPluginFactory methods
*/
/*****************************************************************
* Method:
* IRMAPluginFactory::GetNumPlugins
* Purpose:
* Report the number of Plugins within the DLL.
*
* Parameters:
*/
STDMETHOD_(UINT16, GetNumPlugins) (THIS) PURE;
/*****************************************************************
* Method:
* IRMAPluginFactory::GetPlugin
* Purpose:
* Returns an IUnknown interface to the requested plugin.
*
* Parameters:
*/
STDMETHOD(GetPlugin) (THIS_
UINT16 uIndex,
IUnknown** pPlugin) PURE;
};
/****************************************************************************
*
* Interface:
*
* IRMAGenericPlugin
*
* Purpose:
*
* Interface exposed by a plugin DLL to inform the client / server core
* that your plugin wishes to have InitPlugin called immediately.
*
* IID_IRMAGenericPlugin:
*
* {00000C09-0901-11d1-8B06-00A024406D59}
*
*/
DEFINE_GUID(IID_IRMAGenericPlugin, 0x00000C09, 0x901, 0x11d1, 0x8b, 0x6, 0x0,
0xa0, 0x24, 0x40, 0x6d, 0x59);
#undef INTERFACE
#define INTERFACE IRMAGenericPlugin
DECLARE_INTERFACE_(IRMAGenericPlugin, IUnknown)
{
/*
* IUnknown methods
*/
STDMETHOD(QueryInterface) (THIS_
REFIID riid,
void** ppvObj) PURE;
STDMETHOD_(ULONG,AddRef) (THIS) PURE;
STDMETHOD_(ULONG,Release) (THIS) PURE;
/*
* IRMAGenericPlugin methods
*/
STDMETHOD(IsGeneric) (THIS_
REF(BOOL) /*OUT*/ bIsGeneric) PURE;
};
DEFINE_GUID(IID_IRMAPluginHandler, 0x00000200, 0xb4c8, 0x11d0, 0x99, 0x95, 0x0, 0xa0, 0x24, 0x8d, 0xa5, 0xf0);
DEFINE_GUID(IID_IRMAPlugin2Handler, 0x00000201, 0xb4c8, 0x11d0, 0x99, 0x95, 0x0, 0xa0, 0x24, 0x8d, 0xa5, 0xf0);
#undef INTERFACE
#define INTERFACE IRMAPlugin2Handler
DECLARE_INTERFACE_(IRMAPlugin2Handler, IUnknown)
{
/*
* IUnknown methods
*/
STDMETHOD(QueryInterface) (THIS_
REFIID riid,
void** ppvObj) PURE;
STDMETHOD_(ULONG,AddRef) (THIS) PURE;
STDMETHOD_(ULONG,Release) (THIS) PURE;
/*
* IRMAPlugin2Handler Methods
*/
/************************************************************************
* Method:
* IRMAPlugin2Handler::Init
*
* Purpose:
* Specifies the context and sets the pluginhandler in motion.
*
*/
STDMETHOD(Init) (THIS_ IUnknown* pContext) PURE;
/************************************************************************
* Method:
* IRMAPlugin2Handler::GetNumPlugins2
*
* Purpose:
* Gets the info of a particular plugin.
*
*/
STDMETHOD_(ULONG32,GetNumOfPlugins2) (THIS) PURE;
/************************************************************************
* Method:
* IRMAPlugin2Handler::GetPluginInfo
*
* Purpose:
* Gets the info of a particular plugin.
*
*/
STDMETHOD(GetPluginInfo) (THIS_
UINT32 unIndex,
REF(IRMAValues*) /*OUT*/ Values) PURE;
/************************************************************************
* Method:
* IRMAPlugin2Handler::FlushCache()
*
* Purpose:
* Flushes the LRU cache -- Unloads all DLLs from memory
* which currenltly have a refcount of 0.
*/
STDMETHOD(FlushCache) (THIS) PURE;
/************************************************************************
* Method:
* IRMAPlugin2Handler::SetCacheSize
*
* Purpose:
* This function sets the size of the Cache. The cache is
* initally set to 1000KB. To disable the cache simply set
* the size to 0.If the cache is disabled a DLL will be
* unloaded whenever it's refcount becomes zero. Which MAY
* cause performance problems.
*/
STDMETHOD(SetCacheSize) (THIS_ ULONG32 nSizeKB) PURE;
/************************************************************************
* Method:
* IRMAPlugin2Handler::GetInstance
*
* Purpose:
*
* This function will return a plugin instance given a plugin index.
*
*/
STDMETHOD(GetInstance) (THIS_ UINT32 index, REF(IUnknown*) pUnknown) PURE;
/************************************************************************
* Method:
* IRMAPlugin2Handler::FindIndexUsingValues
*
* Purpose:
* Finds a plugin which matches the set of values given. An index
* is returned which can be used to either get the values (using
* GetPluginInfo) or an instance can be created using GetPluing().
*
*/
STDMETHOD(FindIndexUsingValues) (THIS_ IRMAValues*,
REF(UINT32) unIndex) PURE;
/************************************************************************
* Method:
* IRMAPlugin2Handler::FindPluginUsingValues
*
* Purpose:
* Finds a plugin which matches the set of values given. A Plugin
* instance is returned.
*
*/
STDMETHOD(FindPluginUsingValues) (THIS_ IRMAValues*,
REF(IUnknown*) pUnk) PURE;
/************************************************************************
* Method:
* IRMAPlugin2Handler::FindIndexUsingStrings
*
* Purpose:
* Finds a plugin which matches the set of values given. An index
* is returned which can be used to either get the values (using
* GetPluginInfo) or an instance can be created using GetPluing().
* NOTE: that a max of two values may be given.
*/
STDMETHOD(FindIndexUsingStrings) (THIS_ char* PropName1,
char* PropVal1,
char* PropName2,
char* PropVal2,
char* PropName3,
char* PropVal3,
REF(UINT32) unIndex) PURE;
/************************************************************************
* Method:
* IRMAPlugin2Handler::FindPluginUsingStrings
*
* Purpose:
* Finds a plugin which matches the set of values given. A Plugin
* instance is returned.
* NOTE: that a max of two values may be given.
*/
STDMETHOD(FindPluginUsingStrings) (THIS_ char* PropName1,
char* PropVal1,
char* PropName2,
char* PropVal2,
char* PropName3,
char* PropVal3,
REF(IUnknown*) pUnk) PURE;
/************************************************************************
* Method:
* IRMAPlugin2Handler::FindImplementationFromClassID
*
* Purpose:
* Finds a CommonClassFactory plugin which supports the
* ClassID given. An instance of the Class is returned.
*/
STDMETHOD(FindImplementationFromClassID)
(
THIS_
REFGUID GUIDClassID,
REF(IUnknown*) pIUnknownInstance
) PURE;
/************************************************************************
* Method:
* IRMAPlugin2Handler::Close
*
* Purpose:
* A function which performs all of the functions of delete.
*
*
*/
STDMETHOD(Close) (THIS) PURE;
/************************************************************************
* Method:
* IRMAPlugin2Handler::SetRequiredPlugins
*
* Purpose:
* This function sets the required plugin list
*
*
*/
STDMETHOD(SetRequiredPlugins) (THIS_ const char** ppszRequiredPlugins) PURE;
};
#endif /* _RMAPLUGN_H_ */
|