include/realmedia/rmasrc.h

   1 /****************************************************************************
   2  *
   3  *  $Id: rmasrc.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 information of RealNetworks, Inc,
  10  *  and is licensed subject to restrictions on use and distribution.
  11  *
  12  *
  13  *  RealMedia Architecture Packet Source Interfaces.
  14  *
  15  */
  16
  17 #ifndef _RMASRC_H_
  18 #define _RMASRC_H_
  19
  20 /*
  21  * Forward declarations of some interfaces defined or used here-in.
  22  */
  23 typedef _INTERFACE      IRMARawSourceObject             IRMARawSourceObject;
  24 typedef _INTERFACE      IRMARawSinkObject               IRMARawSinkObject;
  25 typedef _INTERFACE      IRMASourceFinderObject          IRMASourceFinderObject;
  26 typedef _INTERFACE      IRMASourceFinderResponse        IRMASourceFinderResponse;
  27 typedef _INTERFACE      IRMARequest                     IRMARequest;
  28
  29 /****************************************************************************
  30  *
  31  *  Interface:
  32  *
  33  *      IRMARawSourceObject
  34  *
  35  *  Purpose:
  36  *
  37  *      Object that serves packets to sinks
  38  *
  39  *  IID_IRMARawSourceObject:
  40  *
  41  *      {00001000-0901-11d1-8B06-00A024406D59}
  42  *
  43  */
  44 DEFINE_GUID(IID_IRMARawSourceObject, 0x00001000, 0x901, 0x11d1, 0x8b, 0x6, 0x0,
  45                         0xa0, 0x24, 0x40, 0x6d, 0x59);
  46
  47 #undef  INTERFACE
  48 #define INTERFACE   IRMARawSourceObject
  49
  50 DECLARE_INTERFACE_(IRMARawSourceObject, IUnknown)
  51 {
  52         /*
  53          *      IUnknown methods
  54          */
  55     STDMETHOD(QueryInterface)           (THIS_
  56                                         REFIID riid,
  57                                         void** ppvObj) PURE;
  58
  59     STDMETHOD_(ULONG,AddRef)            (THIS) PURE;
  60
  61     STDMETHOD_(ULONG,Release)           (THIS) PURE;
  62
  63         /*
  64          *      IRMARawSourceObject methods
  65          */
  66
  67     /************************************************************************
  68      *  Method:
  69      *      IRMARawSourceObject::Init
  70      *  Purpose:
  71      *      Initializes the connection between the source and the sink
  72      */
  73     STDMETHOD(Init)             (THIS_
  74                                 IUnknown* pUnknown) PURE;
  75
  76     STDMETHOD(Done)             (THIS) PURE;
  77
  78     STDMETHOD(GetFileHeader)    (THIS) PURE;
  79
  80     STDMETHOD(GetStreamHeader)  (THIS_
  81                                 UINT16 unStreamNumber) PURE;
  82
  83     STDMETHOD(StartPackets)     (THIS_
  84                                 UINT16 unStreamNumber) PURE;
  85
  86     STDMETHOD(StopPackets)      (THIS_
  87                                 UINT16 unStreamNumber) PURE;
  88 };
  89
  90 /****************************************************************************
  91  *
  92  *  Interface:
  93  *
  94  *      IRMARawSinkObject
  95  *
  96  *  Purpose:
  97  *
  98  *      Object that receives raw packets from a source
  99  *
 100  *  IID_IRMARawSinkObject:
 101  *
 102  *      {00001001-0901-11d1-8B06-00A024406D59}
 103  *
 104  */
 105 DEFINE_GUID(IID_IRMARawSinkObject, 0x00001001, 0x901, 0x11d1, 0x8b, 0x6, 0x0,
 106                         0xa0, 0x24, 0x40, 0x6d, 0x59);
 107
 108 #undef  INTERFACE
 109 #define INTERFACE   IRMARawSinkObject
 110
 111 DECLARE_INTERFACE_(IRMARawSinkObject, IUnknown)
 112 {
 113         /*
 114          *      IUnknown methods
 115          */
 116     STDMETHOD(QueryInterface)           (THIS_
 117                                         REFIID riid,
 118                                         void** ppvObj) PURE;
 119
 120     STDMETHOD_(ULONG,AddRef)            (THIS) PURE;
 121
 122     STDMETHOD_(ULONG,Release)           (THIS) PURE;
 123
 124         /*
 125          *      IRMARawSinkObject methods
 126          */
 127
 128     /************************************************************************
 129      *  Method:
 130      *      IRMARawSinkObject::InitDone
 131      *  Purpose:
 132      *      Callback after source object has initialized the connection
 133      */
 134     STDMETHOD(InitDone)                 (THIS_
 135                                         PN_RESULT       status) PURE;
 136
 137     STDMETHOD(FileHeaderReady)          (THIS_
 138                                         PN_RESULT       status,
 139                                         IRMAValues*     pHeader) PURE;
 140
 141     STDMETHOD(StreamHeaderReady)        (THIS_
 142                                         PN_RESULT       status,
 143                                         IRMAValues*     pHeader) PURE;
 144
 145     STDMETHOD(PacketReady)              (THIS_
 146                                         PN_RESULT       status,
 147                                         IRMAPacket*     pPacket) PURE;
 148
 149     STDMETHOD(StreamDone)               (THIS_
 150                                         UINT16          unStreamNumber) PURE;
 151
 152 };
 153
 154 /****************************************************************************
 155  *
 156  *  Interface:
 157  *
 158  *      IRMASourceFinderObject
 159  *
 160  *  Purpose:
 161  *
 162  *      Object that allows a sink to search for a raw packet source
 163  *
 164  *  IID_IRMASourceFinderObject:
 165  *
 166  *      {00001002-0901-11d1-8B06-00A024406D59}
 167  *
 168  */
 169 DEFINE_GUID(IID_IRMASourceFinderObject, 0x00001002, 0x901, 0x11d1, 0x8b, 0x6, 0x0,
 170                         0xa0, 0x24, 0x40, 0x6d, 0x59);
 171
 172 #define CLSID_IRMASourceFinderObject    IID_IRMASourceFinderObject
 173
 174 #undef  INTERFACE
 175 #define INTERFACE   IRMASourceFinderObject
 176
 177 #define CLSID_IRMASourceFinderObject IID_IRMASourceFinderObject
 178
 179 DECLARE_INTERFACE_(IRMASourceFinderObject, IUnknown)
 180 {
 181         /*
 182          *      IUnknown methods
 183          */
 184     STDMETHOD(QueryInterface)           (THIS_
 185                                         REFIID riid,
 186                                         void** ppvObj) PURE;
 187
 188     STDMETHOD_(ULONG,AddRef)            (THIS) PURE;
 189
 190     STDMETHOD_(ULONG,Release)           (THIS) PURE;
 191
 192         /*
 193          *      IRMASourceFinderObject methods
 194          */
 195
 196     STDMETHOD(Init)             (THIS_
 197                                 IUnknown*       pUnknown) PURE;
 198
 199     STDMETHOD(Find)             (THIS_
 200                                 IRMARequest*    pRequest) PURE;
 201
 202     STDMETHOD(Done)             (THIS) PURE;
 203
 204 };
 205
 206 /****************************************************************************
 207  *
 208  *  Interface:
 209  *
 210  *      IRMASourceFinderResponse
 211  *
 212  *  Purpose:
 213  *
 214  *      Object that returns a raw packet source to a sink
 215  *
 216  *  IID_IRMASourceFinderResponse:
 217  *
 218  *      {00001003-0901-11d1-8B06-00A024406D59}
 219  *
 220  */
 221 DEFINE_GUID(IID_IRMASourceFinderResponse, 0x00001003, 0x901, 0x11d1,
 222             0x8b, 0x6, 0x0, 0xa0, 0x24, 0x40, 0x6d, 0x59);
 223
 224
 225 #undef  INTERFACE
 226 #define INTERFACE   IRMASourceFinderResponse
 227
 228 DECLARE_INTERFACE_(IRMASourceFinderResponse, IUnknown)
 229 {
 230         /*
 231          *      IUnknown methods
 232          */
 233     STDMETHOD(QueryInterface)           (THIS_
 234                                         REFIID riid,
 235                                         void** ppvObj) PURE;
 236
 237     STDMETHOD_(ULONG,AddRef)            (THIS) PURE;
 238
 239     STDMETHOD_(ULONG,Release)           (THIS) PURE;
 240
 241         /*
 242          *      IRMASourceFinderResponse methods
 243          */
 244
 245     STDMETHOD(InitDone)                 (THIS_
 246                                         PN_RESULT       status) PURE;
 247
 248     STDMETHOD(FindDone)                 (THIS_
 249                                         PN_RESULT       status,
 250                                         IUnknown*       pUnknown) PURE;
 251
 252 };
 253
 254 #endif /* _RMASRC_H_ */