include/realmedia/rmapckts.h

   1 /****************************************************************************
   2  *
   3  *  $Id: rmapckts.h 7 2003-05-30 02:18:02Z gabest $
   4  *
   5  *  Copyright (C) 1995-1999 RealNetworks, Inc. All rights reserved.
   6  *
   7  *  http://www.real.com/devzone
   8  *
   9  *  This program contains proprietary
  10  *  information of Progressive Networks, Inc, and is licensed
  11  *  subject to restrictions on use and distribution.
  12  *
  13  *
  14  *  RealMedia Architecture Packet and Header Interface.
  15  *
  16  */
  17
  18 #ifndef _RMAPCKTS_H_
  19 #define _RMAPCKTS_H_
  20
  21 // Define IRMAUtilities
  22
  23 /* ASMFlags in IRMAPacket */
  24 #define RMA_ASM_SWITCH_ON        0x01
  25 #define RMA_ASM_SWITCH_OFF       0x02
  26
  27
  28 /****************************************************************************
  29  *
  30  *  Interface:
  31  *
  32  *      IRMABuffer
  33  *
  34  *  Purpose:
  35  *
  36  *      Basic opaque data storage buffer. Used in interfaces where
  37  *      object ownership is best managed through COM style reference
  38  *      counting.
  39  *
  40  *  IID_IRMABuffer:
  41  *
  42  *      {00001300-0901-11d1-8B06-00A024406D59}
  43  *
  44  */
  45 DEFINE_GUID(IID_IRMABuffer, 0x00001300, 0x901, 0x11d1, 0x8b, 0x6, 0x0,
  46                         0xa0, 0x24, 0x40, 0x6d, 0x59);
  47
  48 /*
  49  *  The IRMACommonClassFactory supports creating an instance
  50  *  of this object.
  51  */
  52 #define CLSID_IRMABuffer IID_IRMABuffer
  53
  54 #undef  INTERFACE
  55 #define INTERFACE   IRMABuffer
  56
  57 DECLARE_INTERFACE_(IRMABuffer, IUnknown)
  58 {
  59     /*
  60      *  IUnknown methods
  61      */
  62     STDMETHOD(QueryInterface)   (THIS_
  63                                 REFIID riid,
  64                                 void** ppvObj) PURE;
  65
  66     STDMETHOD_(ULONG,AddRef)    (THIS) PURE;
  67
  68     STDMETHOD_(ULONG,Release)   (THIS) PURE;
  69
  70     /*
  71      *  IRMABuffer methods
  72      */
  73     STDMETHOD(Get)              (THIS_
  74                                 REF(UCHAR*)     pData,
  75                                 REF(ULONG32)    ulLength) PURE;
  76
  77     STDMETHOD(Set)              (THIS_
  78                                 const UCHAR*    pData,
  79                                 ULONG32         ulLength) PURE;
  80
  81     STDMETHOD(SetSize)          (THIS_
  82                                 ULONG32         ulLength) PURE;
  83
  84     STDMETHOD_(ULONG32,GetSize) (THIS) PURE;
  85
  86     STDMETHOD_(UCHAR*,GetBuffer)(THIS) PURE;
  87 };
  88
  89
  90 /****************************************************************************
  91  *
  92  *  Interface:
  93  *
  94  *      IRMAPacket
  95  *
  96  *  Purpose:
  97  *
  98  *      Basic data packet in the RealMedia system.
  99  *
 100  *  IID_IRMAPacket:
 101  *
 102  *      {00001301-0901-11d1-8B06-00A024406D59}
 103  *
 104  */
 105 DEFINE_GUID(IID_IRMAPacket, 0x00001301, 0x901, 0x11d1, 0x8b, 0x6, 0x0,
 106                         0xa0, 0x24, 0x40, 0x6d, 0x59);
 107
 108 /*
 109  *  The IRMACommonClassFactory supports creating an instance
 110  *  of this object.
 111  */
 112 #define CLSID_IRMAPacket IID_IRMAPacket
 113
 114 #undef  INTERFACE
 115 #define INTERFACE   IRMAPacket
 116
 117 DECLARE_INTERFACE_(IRMAPacket, IUnknown)
 118 {
 119     /*
 120      *  IUnknown methods
 121      */
 122     STDMETHOD(QueryInterface)   (THIS_
 123                                 REFIID riid,
 124                                 void** ppvObj) PURE;
 125
 126     STDMETHOD_(ULONG,AddRef)    (THIS) PURE;
 127
 128     STDMETHOD_(ULONG,Release)   (THIS) PURE;
 129
 130     /*
 131      *  IRMAPacket methods
 132      */
 133     STDMETHOD(Get)                      (THIS_
 134                                         REF(IRMABuffer*)    pBuffer,
 135                                         REF(UINT32)         ulTime,
 136                                         REF(UINT16)         unStreamNumber,
 137                                         REF(UINT8)          unASMFlags,
 138                                         REF(UINT16)         unASMRuleNumber
 139                                         ) PURE;
 140
 141     STDMETHOD_(IRMABuffer*,GetBuffer)   (THIS) PURE;
 142
 143     STDMETHOD_(ULONG32,GetTime)         (THIS) PURE;
 144
 145     STDMETHOD_(UINT16,GetStreamNumber)  (THIS) PURE;
 146
 147     STDMETHOD_(UINT8,GetASMFlags)       (THIS) PURE;
 148
 149     STDMETHOD_(UINT16,GetASMRuleNumber) (THIS) PURE;
 150
 151     STDMETHOD_(BOOL,IsLost)             (THIS) PURE;
 152
 153     STDMETHOD(SetAsLost)                (THIS) PURE;
 154
 155     STDMETHOD(Set)                      (THIS_
 156                                         IRMABuffer*         pBuffer,
 157                                         UINT32              ulTime,
 158                                         UINT16              uStreamNumber,
 159                                         UINT8               unASMFlags,
 160                                         UINT16              unASMRuleNumber
 161                                         ) PURE;
 162 };
 163
 164
 165 /****************************************************************************
 166  *
 167  *  Interface:
 168  *
 169  *      IRMAPacket
 170  *
 171  *  Purpose:
 172  *
 173  *      RTP data packet in the RealMedia system.
 174  *
 175  *  IID_IRMARTPPacket:
 176  *
 177  *      {0169A731-1ED0-11d4-952B-00902742C923}
 178  *
 179  */
 180 DEFINE_GUID(IID_IRMARTPPacket, 0x169a731, 0x1ed0, 0x11d4, 0x95, 0x2b, 0x0,
 181             0x90, 0x27, 0x42, 0xc9, 0x23);
 182
 183 /*
 184  *  The IRMACommonClassFactory supports creating an instance
 185  *  of this object.
 186  */
 187 #define CLSID_IRMARTPPacket IID_IRMARTPPacket
 188
 189 #undef  INTERFACE
 190 #define INTERFACE   IRMARTPPacket
 191
 192 DECLARE_INTERFACE_(IRMARTPPacket, IRMAPacket)
 193 {
 194     /*
 195      *  IUnknown methods
 196      */
 197     STDMETHOD(QueryInterface)   (THIS_
 198                                 REFIID riid,
 199                                 void** ppvObj) PURE;
 200
 201     STDMETHOD_(ULONG,AddRef)    (THIS) PURE;
 202
 203     STDMETHOD_(ULONG,Release)   (THIS) PURE;
 204
 205     /*
 206      *  IRMAPacket methods
 207      */
 208     STDMETHOD(Get)                      (THIS_
 209                                         REF(IRMABuffer*)    pBuffer,
 210                                         REF(UINT32)         ulTime,
 211                                         REF(UINT16)         unStreamNumber,
 212                                         REF(UINT8)          unASMFlags,
 213                                         REF(UINT16)         unASMRuleNumber
 214                                         ) PURE;
 215
 216     STDMETHOD_(IRMABuffer*,GetBuffer)   (THIS) PURE;
 217
 218     STDMETHOD_(ULONG32,GetTime)         (THIS) PURE;
 219
 220     STDMETHOD_(UINT16,GetStreamNumber)  (THIS) PURE;
 221
 222     STDMETHOD_(UINT8,GetASMFlags)       (THIS) PURE;
 223
 224     STDMETHOD_(UINT16,GetASMRuleNumber) (THIS) PURE;
 225
 226     STDMETHOD_(BOOL,IsLost)             (THIS) PURE;
 227
 228     STDMETHOD(SetAsLost)                (THIS) PURE;
 229
 230     STDMETHOD(Set)                      (THIS_
 231                                         IRMABuffer*         pBuffer,
 232                                         UINT32              ulTime,
 233                                         UINT16              uStreamNumber,
 234                                         UINT8               unASMFlags,
 235                                         UINT16              unASMRuleNumber
 236                                         ) PURE;
 237
 238     /*
 239      *  IRMARTPPacket methods
 240      */
 241     STDMETHOD_(ULONG32,GetRTPTime)      (THIS) PURE;
 242
 243     STDMETHOD(GetRTP)                   (THIS_
 244                                         REF(IRMABuffer*)    pBuffer,
 245                                         REF(UINT32)         ulTime,
 246                                         REF(UINT32)         ulRTPTime,
 247                                         REF(UINT16)         unStreamNumber,
 248                                         REF(UINT8)          unASMFlags,
 249                                         REF(UINT16)         unASMRuleNumber
 250                                         ) PURE;
 251
 252     STDMETHOD(SetRTP)                   (THIS_
 253                                         IRMABuffer*         pBuffer,
 254                                         UINT32              ulTime,
 255                                         UINT32              ulRTPTime,
 256                                         UINT16              uStreamNumber,
 257                                         UINT8               unASMFlags,
 258                                         UINT16              unASMRuleNumber
 259                                         ) PURE;
 260 };
 261
 262
 263 /****************************************************************************
 264  *
 265  *  Interface:
 266  *
 267  *      IRMAValues
 268  *
 269  *  Purpose:
 270  *
 271  *      This is an interface to a generic name-value pair facility.  This
 272  *      is used in various places (such as stream headers).
 273  *
 274  *  IID_IRMAValues:
 275  *
 276  *      {00001302-0901-11d1-8B06-00A024406D59}
 277  *
 278  */
 279 DEFINE_GUID(IID_IRMAValues, 0x00001302, 0x901, 0x11d1, 0x8b, 0x6, 0x0,
 280                         0xa0, 0x24, 0x40, 0x6d, 0x59);
 281
 282 /*
 283  *  The IRMACommonClassFactory supports creating an instance
 284  *  of this object.
 285  */
 286 #define CLSID_IRMAValues IID_IRMAValues
 287
 288 #undef  INTERFACE
 289 #define INTERFACE   IRMAValues
 290
 291 DECLARE_INTERFACE_(IRMAValues, IUnknown)
 292 {
 293     /*
 294      *  IUnknown methods
 295      */
 296     STDMETHOD(QueryInterface)   (THIS_
 297                                 REFIID riid,
 298                                 void** ppvObj) PURE;
 299
 300     STDMETHOD_(ULONG,AddRef)    (THIS) PURE;
 301
 302     STDMETHOD_(ULONG,Release)   (THIS) PURE;
 303
 304     /*
 305      *  IRMAValues methods
 306      */
 307
 308     /*
 309      * Note: That strings returned as references should be copied or
 310      *       used immediately because their lifetime is only as long as the
 311      *       IRMAValues's objects lifetime.
 312      *
 313      * Note: Your iterator will be reset once you give up control to the
 314      *       RMA core (i.e. you exit whatever function gave you a time slice).
 315      */
 316
 317     STDMETHOD(SetPropertyULONG32)       (THIS_
 318                                         const char*      pPropertyName,
 319                                         ULONG32          uPropertyValue) PURE;
 320
 321     STDMETHOD(GetPropertyULONG32)       (THIS_
 322                                         const char*      pPropertyName,
 323                                         REF(ULONG32)     uPropertyName) PURE;
 324
 325     STDMETHOD(GetFirstPropertyULONG32)  (THIS_
 326                                         REF(const char*) pPropertyName,
 327                                         REF(ULONG32)     uPropertyValue) PURE;
 328
 329     STDMETHOD(GetNextPropertyULONG32)   (THIS_
 330                                         REF(const char*) pPropertyName,
 331                                         REF(ULONG32)     uPropertyValue) PURE;
 332
 333     STDMETHOD(SetPropertyBuffer)        (THIS_
 334                                         const char*      pPropertyName,
 335                                         IRMABuffer*      pPropertyValue) PURE;
 336
 337     STDMETHOD(GetPropertyBuffer)        (THIS_
 338                                         const char*      pPropertyName,
 339                                         REF(IRMABuffer*) pPropertyValue) PURE;
 340
 341     STDMETHOD(GetFirstPropertyBuffer)   (THIS_
 342                                         REF(const char*) pPropertyName,
 343                                         REF(IRMABuffer*) pPropertyValue) PURE;
 344
 345     STDMETHOD(GetNextPropertyBuffer)    (THIS_
 346                                         REF(const char*) pPropertyName,
 347                                         REF(IRMABuffer*) pPropertyValue) PURE;
 348
 349     STDMETHOD(SetPropertyCString)       (THIS_
 350                                         const char*      pPropertyName,
 351                                         IRMABuffer*      pPropertyValue) PURE;
 352
 353     STDMETHOD(GetPropertyCString)       (THIS_
 354                                         const char*      pPropertyName,
 355                                         REF(IRMABuffer*) pPropertyValue) PURE;
 356
 357     STDMETHOD(GetFirstPropertyCString)  (THIS_
 358                                         REF(const char*) pPropertyName,
 359                                         REF(IRMABuffer*) pPropertyValue) PURE;
 360
 361     STDMETHOD(GetNextPropertyCString)   (THIS_
 362                                         REF(const char*) pPropertyName,
 363                                         REF(IRMABuffer*) pPropertyValue) PURE;
 364 };
 365
 366
 367 /****************************************************************************
 368  *
 369  *  Interface:
 370  *
 371  *      IRMAValuesRemove
 372  *
 373  *  Purpose:
 374  *
 375  *      This interface is to add Remove methods to a class that supports
 376  *      IRMAValues.  All classes that support this interface will also
 377  *      support IRMAValues.
 378  *
 379  *
 380  *
 381  *  IID_IRMAValuesRemove:
 382  *
 383  *      {00001303-0901-11d1-8B06-00A024406D59}
 384  *
 385  */
 386 DEFINE_GUID(IID_IRMAValuesRemove, 0x00001303, 0x901, 0x11d1, 0x8b, 0x6, 0x0,
 387                         0xa0, 0x24, 0x40, 0x6d, 0x59);
 388
 389 /*
 390  *  The IRMACommonClassFactory does not support creating an instance
 391  *  of this object.
 392  */
 393
 394 #undef  INTERFACE
 395 #define INTERFACE   IRMAValuesRemove
 396
 397 DECLARE_INTERFACE_(IRMAValuesRemove, IUnknown)
 398 {
 399     /*
 400      *  IUnknown methods
 401      */
 402     STDMETHOD(QueryInterface)   (THIS_
 403                                 REFIID riid,
 404                                 void** ppvObj) PURE;
 405
 406     STDMETHOD_(ULONG,AddRef)    (THIS) PURE;
 407
 408     STDMETHOD_(ULONG,Release)   (THIS) PURE;
 409
 410     /*
 411      * IRMAValuesRemove methods
 412      */
 413
 414      /************************************************************************
 415      *  Method:
 416      *      IRMAKeyValuesRemove::Remove
 417      *  Purpose:
 418      *      Remove all items matching pKey.  (If you know what datatype you saved
 419      *      the key as, use the specific method.)
 420      */
 421     STDMETHOD(Remove)        (const char* pKey) PURE;
 422
 423      /************************************************************************
 424      *  Method:
 425      *      IRMAKeyValuesRemove::RemoveULONG32
 426      *  Purpose:
 427      *      Remove all ULONG32 items matching pKey.
 428      */
 429     STDMETHOD(RemoveULONG32) (const char* pKey) PURE;
 430
 431      /************************************************************************
 432      *  Method:
 433      *      IRMAKeyValuesRemove::RemoveBuffer
 434      *  Purpose:
 435      *      Remove all Buffer items matching pKey.
 436      */
 437     STDMETHOD(RemoveBuffer)  (const char* pKey) PURE;
 438
 439      /************************************************************************
 440      *  Method:
 441      *      IRMAKeyValuesRemove::RemoveCString
 442      *  Purpose:
 443      *      Remove all CString items matching pKey.
 444      */
 445     STDMETHOD(RemoveCString) (const char* pKey) PURE;
 446 };
 447
 448 #endif /* _RMAPCKTS_H_ */
 449