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
|
/****************************************************************************
*
* $Id: rmaformt.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.
*
*
* RealMedia Architecture Broadcast Format Plug-in Interfaces.
*
*/
#ifndef _RMAFORMT_H_
#define _RMAFORMT_H_
#include "rmafiles.h"
/*
* Forward declarations of some interfaces defined here-in.
*/
typedef _INTERFACE IRMAFileFormatObject IRMAFileFormatObject;
typedef _INTERFACE IRMABroadcastFormatObject IRMABroadcastFormatObject;
typedef _INTERFACE IRMAFormatResponse IRMAFormatResponse;
typedef _INTERFACE IRMAFileObject IRMAFileObject;
typedef _INTERFACE IRMANetworkServices IRMANetworkServices;
typedef _INTERFACE IRMAPacket IRMAPacket;
typedef _INTERFACE IRMAValues IRMAValues;
typedef _INTERFACE IRMAPacketTimeOffsetHandler IRMAPacketTimeOffsetHandler;
typedef _INTERFACE IRMAPacketTimeOffsetHandlerResponse
IRMAPacketTimeOffsetHandlerResponse;
typedef _INTERFACE IRMALiveFileFormatInfo IRMALiveFileFormatInfo;
/****************************************************************************
*
* Interface:
*
* IRMAFileFormatObject
*
* Purpose:
*
* Object that allows a Controller to communicate with a specific
* File Format plug-in session
*
* IID_IRMAFileFormatObject:
*
* {00000F00-0901-11d1-8B06-00A024406D59}
*
*/
DEFINE_GUID(IID_IRMAFileFormatObject, 0x00000F00, 0x901, 0x11d1, 0x8b, 0x6, 0x0,
0xa0, 0x24, 0x40, 0x6d, 0x59);
#undef INTERFACE
#define INTERFACE IRMAFileFormatObject
DECLARE_INTERFACE_(IRMAFileFormatObject, IUnknown)
{
/*
* IUnknown methods
*/
STDMETHOD(QueryInterface) (THIS_
REFIID riid,
void** ppvObj) PURE;
STDMETHOD_(ULONG,AddRef) (THIS) PURE;
STDMETHOD_(ULONG,Release) (THIS) PURE;
/*
* IRMAFileFormatObject methods
*/
/************************************************************************
* Method:
* IRMAFileFormatObject::GetFileFormatInfo
* Purpose:
* Returns information vital to the instantiation of file format
* plugins.
*/
STDMETHOD(GetFileFormatInfo)(THIS_
REF(const char**) /*OUT*/ pFileMimeTypes,
REF(const char**) /*OUT*/ pFileExtensions,
REF(const char**) /*OUT*/ pFileOpenNames
) PURE;
STDMETHOD(InitFileFormat)
(THIS_
IRMARequest* /*IN*/ pRequest,
IRMAFormatResponse* /*IN*/ pFormatResponse,
IRMAFileObject* /*IN*/ pFileObject) PURE;
STDMETHOD(GetFileHeader) (THIS) PURE;
STDMETHOD(GetStreamHeader) (THIS_
UINT16 unStreamNumber) PURE;
STDMETHOD(GetPacket) (THIS_
UINT16 unStreamNumber) PURE;
STDMETHOD(Seek) (THIS_
ULONG32 ulOffset) PURE;
STDMETHOD(Close) (THIS) PURE;
};
/****************************************************************************
*
* Interface:
*
* IRMABroadcastFormatObject
*
* Purpose:
*
* Object that allows a Controller to communicate with a specific
* Broadcast Format plug-in session
*
* IID_IRMABroadcastFormatObject:
*
* {00000F01-0901-11d1-8B06-00A024406D59}
*
*/
DEFINE_GUID(IID_IRMABroadcastFormatObject, 0x00000F01, 0x901, 0x11d1, 0x8b, 0x6, 0x0,
0xa0, 0x24, 0x40, 0x6d, 0x59);
#undef INTERFACE
#define INTERFACE IRMABroadcastFormatObject
DECLARE_INTERFACE_(IRMABroadcastFormatObject, IUnknown)
{
/*
* IUnknown methods
*/
STDMETHOD(QueryInterface) (THIS_
REFIID riid,
void** ppvObj) PURE;
STDMETHOD_(ULONG,AddRef) (THIS) PURE;
STDMETHOD_(ULONG,Release) (THIS) PURE;
/*
* IRMABroadcastFormatObject methods
*/
/************************************************************************
* Method:
* IRMABroadcastFormatObject::GetBroadcastFormatInfo
* Purpose:
* Returns information vital to the instantiation of broadcast format
* plugins.
*/
STDMETHOD(GetBroadcastFormatInfo)(THIS_
REF(const char*) /*OUT*/ pToken) PURE;
STDMETHOD(InitBroadcastFormat) (THIS_
const char* /*IN*/ pURL,
IRMAFormatResponse* /*IN*/ pFormatResponse
) PURE;
STDMETHOD(GetFileHeader) (THIS) PURE;
STDMETHOD(GetStreamHeader) (THIS_
UINT16 unStreamNumber) PURE;
STDMETHOD(StartPackets) (THIS_
UINT16 unStreamNumber) PURE;
STDMETHOD(StopPackets) (THIS_
UINT16 unStreamNumber) PURE;
};
/****************************************************************************
*
* Interface:
*
* IRMAFormatResponse
*
* Purpose:
*
* Object that allows a specific File Format Object to communicate
* with its user
*
* IID_IRMAFormatResponse:
*
* {00000F02-0901-11d1-8B06-00A024406D59}
*
*/
DEFINE_GUID(IID_IRMAFormatResponse, 0x00000F02, 0x901, 0x11d1, 0x8b, 0x6, 0x0,
0xa0, 0x24, 0x40, 0x6d, 0x59);
#undef INTERFACE
#define INTERFACE IRMAFormatResponse
DECLARE_INTERFACE_(IRMAFormatResponse, IUnknown)
{
/*
* IUnknown methods
*/
STDMETHOD(QueryInterface) (THIS_
REFIID riid,
void** ppvObj) PURE;
STDMETHOD_(ULONG,AddRef) (THIS) PURE;
STDMETHOD_(ULONG,Release) (THIS) PURE;
/*
* IRMAFormatResponse methods
*/
STDMETHOD(InitDone) (THIS_
PN_RESULT status) PURE;
STDMETHOD(PacketReady) (THIS_
PN_RESULT status,
IRMAPacket* pPacket) PURE;
STDMETHOD(SeekDone) (THIS_
PN_RESULT status) PURE;
STDMETHOD(FileHeaderReady) (THIS_
PN_RESULT status,
IRMAValues* pHeader) PURE;
STDMETHOD(StreamHeaderReady) (THIS_
PN_RESULT status,
IRMAValues* pHeader) PURE;
STDMETHOD(StreamDone) (THIS_
UINT16 unStreamNumber) PURE;
};
/****************************************************************************
*
* Interface:
*
* IRMAPacketFormat
*
* Purpose:
*
* Interface that modifies the behavior of an IRMAFileFormat by defining
* the packet format it will be creating.
*
* IID_IRMAPacketFormat:
*
* {00000F03-0901-11d1-8B06-00A024406D59}
*
*/
DEFINE_GUID(IID_IRMAPacketFormat, 0x00000F03, 0x901, 0x11d1, 0x8b, 0x6, 0x0,
0xa0, 0x24, 0x40, 0x6d, 0x59);
#undef INTERFACE
#define INTERFACE IRMAPacketFormat
DECLARE_INTERFACE_(IRMAPacketFormat, IUnknown)
{
/*
* IUnknown methods
*/
STDMETHOD(QueryInterface) (THIS_
REFIID riid,
void** ppvObj) PURE;
STDMETHOD_(ULONG,AddRef) (THIS) PURE;
STDMETHOD_(ULONG,Release) (THIS) PURE;
/*
* IRMAPacketFormat methods
*/
STDMETHOD(GetSupportedPacketFormats)
(THIS_
REF(const char**) pFormats) PURE;
STDMETHOD(SetPacketFormat) (THIS_
const char* pFormat) PURE;
};
/****************************************************************************
*
* Interface:
*
* IRMAPacketTimeOffsetHandler
*
* Purpose:
*
* Provides methods for handling the changing of a packets timestamp.
*
* IID_IRMAPacketTimeOffsetHandler:
*
* {00000F04-0901-11d1-8B06-00A024406D59}
*
*/
DEFINE_GUID(IID_IRMAPacketTimeOffsetHandler, 0x00000F04, 0x901, 0x11d1, 0x8b, 0x6, 0x0,
0xa0, 0x24, 0x40, 0x6d, 0x59);
DECLARE_INTERFACE_(IRMAPacketTimeOffsetHandler, IUnknown)
{
/*
* IUnknown methods
*/
STDMETHOD(QueryInterface) (THIS_
REFIID riid,
void** ppvObj) PURE;
STDMETHOD_(ULONG,AddRef) (THIS) PURE;
STDMETHOD_(ULONG,Release) (THIS) PURE;
/*
* IRMAPacketTimeOffsetHandler methods
*/
/************************************************************************
* Method:
* IRMAPacketTimeOffsetHandler::Init
* Purpose:
* Initialize the IRMAPacketTimeOffsetHandler and set the response.
* Implementors should look up the MimeType.
*/
STDMETHOD(Init) (THIS_
IRMAPacketTimeOffsetHandlerResponse* pResponse,
IRMAValues* pHeader,
IUnknown* pContext) PURE;
/************************************************************************
* Method:
* IRMAPacketTimeOffsetHandler::SetTimeOffset
* Purpose:
* Called to set the time offset. Uses a bool and a UINT32 instead
* of and INT32 so that the time offset wraps around after 47 days
* instead of 24. bPlus says whether to add or subtract.
*/
STDMETHOD(SetTimeOffset) (THIS_
UINT32 ulTimeOffset,
BOOL bPlus) PURE;
/************************************************************************
* Method:
* IRMAPacketTimeOffsetHandler::HandlePacket
* Purpose:
* give the IRMAPacketTimeOffsetHandler a packet to modify for the
* time offset.
*/
STDMETHOD(HandlePacket) (THIS_
IRMAPacket* pPacket) PURE;
};
/****************************************************************************
*
* Interface:
*
* IRMAPacketTimeOffsetHandlerResponse
*
* Purpose:
*
* Provides methods for the IRMAPacketTimeOffsetHandler to respond to.
*
* IID_IRMAPacketTimeOffsetHandlerResponse:
*
* {00000F05-0901-11d1-8B06-00A024406D59}
*
*/
DEFINE_GUID(IID_IRMAPacketTimeOffsetHandlerResponse, 0x00000F05, 0x901, 0x11d1, 0x8b, 0x6, 0x0,
0xa0, 0x24, 0x40, 0x6d, 0x59);
DECLARE_INTERFACE_(IRMAPacketTimeOffsetHandlerResponse, IUnknown)
{
/*
* IUnknown methods
*/
STDMETHOD(QueryInterface) (THIS_
REFIID riid,
void** ppvObj) PURE;
STDMETHOD_(ULONG,AddRef) (THIS) PURE;
STDMETHOD_(ULONG,Release) (THIS) PURE;
/*
* IRMAPacketTimeOffsetHandler methods
*/
/************************************************************************
* Method:
* IRMAPacketTimeOffsetHandler::PacketReady
* Purpose:
* Called by IRMAPacketTimeOffsetHandler to pass back the packet
* when it is done with it.
*/
STDMETHOD(TimeOffsetPacketReady) (THIS_
IRMAPacket* pPacket) PURE;
};
/****************************************************************************
*
* Interface:
*
* IRMALiveFileFormatInfo
*
* Purpose:
*
* Provides miscellaneous information needed to transmit a live stream.
* Optionally implemented by the file format object.
*
* IID_IRMALiveFileFormatInfo:
*
* {00000F06-0901-11d1-8B06-00A024406D59}
*
*/
DEFINE_GUID(IID_IRMALiveFileFormatInfo, 0x00000F06, 0x901, 0x11d1, 0x8b, 0x6, 0x0,
0xa0, 0x24, 0x40, 0x6d, 0x59);
#undef INTERFACE
#define INTERFACE IRMALiveFileFormatInfo
DECLARE_INTERFACE_(IRMALiveFileFormatInfo, IUnknown)
{
/*
* IUnknown methods
*/
STDMETHOD(QueryInterface) (THIS_
REFIID riid,
void** ppvObj) PURE;
STDMETHOD_(ULONG,AddRef) (THIS) PURE;
STDMETHOD_(ULONG,Release) (THIS) PURE;
/*
* IRMALiveFileFormatInfo methods
*/
/************************************************************************
* Method:
* IRMALiveFileFormatInfo::VerifyFileCompatibility
* Purpose:
* Compares two file headers and returns PNR_OK if these two
* files can be transmitted sequentially in a single live
* presentation.
*/
STDMETHOD(VerifyFileCompatibility) (THIS_
IRMAValues* pFileHeader1,
IRMAValues* pFileHeader2) PURE;
/************************************************************************
* Method:
* IRMALiveFileFormatInfo::VerifyStreamCompatibility
* Purpose:
* Compares two stream headers and returns PNR_OK if these two
* streams can be transmitted sequentially in a single live
* presentation.
*/
STDMETHOD(VerifyStreamCompatibility) (THIS_
IRMAValues* pStreamHeader1,
IRMAValues* pStreamHeader2) PURE;
/************************************************************************
* Method:
* IRMALiveFileFormatInfo::IsLiveResendRequired
* Purpose:
* Returns TRUE if this stream requires the latest packet to be
* resent periodically in a live presentation.
*/
STDMETHOD_(BOOL,IsLiveResendRequired) (THIS_
UINT16 unStreamNumber) PURE;
/************************************************************************
* Method:
* IRMALiveFileFormatInfo::GetResendBitrate
* Purpose:
* If periodic live resends are required for this stream, this
* method returns the rate at which we should resend packets. The
* resend rate is measured in bits per second.
*/
STDMETHOD(GetResendBitrate) (THIS_
UINT16 unStreamNumber,
REF(UINT32) ulBitrate) PURE;
/************************************************************************
* Method:
* IRMALiveFileFormatInfo::GetResendDuration
* Purpose:
* If periodic live resends are required for this stream, this
* method returns the number of milliseconds for which this packet
* should be resent.
*/
STDMETHOD(GetResendDuration) (THIS_
IRMAPacket* pPacket,
REF(UINT32) ulDuration) PURE;
/************************************************************************
* Method:
* IRMALiveFileFormatInfo::FormResendPacket
* Purpose:
* Forms a live resend packet based upon the original packet passed
* as the first parameter. This allows the file format plugin to
* make resend packets distinguishable from original packets.
*/
STDMETHOD(FormResendPacket) (THIS_
IRMAPacket* pOriginalPacket,
REF(IRMAPacket*) pResendPacket) PURE;
};
#endif /* _RMAFORMT_H_ */
|