include/realmedia/rmaphook.h

   1 /****************************************************************************
   2  *
   3  *  $Id: rmaphook.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 Selective Record interface
  15  *
  16  */
  17
  18 #ifndef _RMAPHOOK_H_
  19 #define _RMAPHOOK_H_
  20
  21 /*
  22  * Forward declarations of some interfaces defined or used here-in.
  23  */
  24 typedef _INTERFACE      IRMAPacket                      IRMAPacket;
  25 typedef _INTERFACE      IRMAPacketHook                  IRMAPacketHook;
  26 typedef _INTERFACE      IRMAPacketHookManager           IRMAPacketHookManager;
  27 typedef _INTERFACE      IRMAPacketHookHelper            IRMAPacketHookHelper;
  28 typedef _INTERFACE      IRMAPacketHookHelperResponse    IRMAPacketHookHelperResponse;
  29
  30 /****************************************************************************
  31  *
  32  *  Interface:
  33  *
  34  *      IRMAPacketHook
  35  *
  36  *  Purpose:
  37  *
  38  *      Interface implemented by the top level client to support selective
  39  *      record
  40  *
  41  *  IID_IRMAPacketHook:
  42  *
  43  *      {00002000-0901-11d1-8B06-00A024406D59}
  44  *
  45  */
  46 DEFINE_GUID(IID_IRMAPacketHook, 0x00002000, 0x901, 0x11d1, 0x8b, 0x6, 0x0,
  47                         0xa0, 0x24, 0x40, 0x6d, 0x59);
  48
  49 DECLARE_INTERFACE_(IRMAPacketHook, IUnknown)
  50 {
  51     /*
  52      * IUnknown methods
  53      */
  54     STDMETHOD(QueryInterface)   (THIS_
  55                                 REFIID riid,
  56                                 void** ppvObj) PURE;
  57
  58     STDMETHOD_(ULONG,AddRef)    (THIS) PURE;
  59
  60     STDMETHOD_(ULONG,Release)   (THIS) PURE;
  61
  62     /*
  63      * IRMAPacketHook methods
  64      */
  65
  66     /************************************************************************
  67      *  Method:
  68      *      IRMAPacketHook::OnStart
  69      *  Purpose:
  70      *      Called by the core to notify the start of this packet hook session
  71      */
  72     STDMETHOD(OnStart)          (THIS) PURE;
  73
  74     /************************************************************************
  75      *  Method:
  76      *      IRMAPacketHook::OnEnd
  77      *  Purpose:
  78      *      Called by the core to notify the end of this packet hook session
  79      */
  80     STDMETHOD(OnEnd)            (THIS) PURE;
  81
  82     /************************************************************************
  83      *  Method:
  84      *      IRMAPacketHook::OnFileHeader
  85      *  Purpose:
  86      *      Called by the core to send file header information
  87      *
  88      */
  89     STDMETHOD(OnFileHeader)     (THIS_
  90                                 IRMAValues* pValues) PURE;
  91
  92     /************************************************************************
  93      *  Method:
  94      *      IRMAPacketHook::OnStreamHeader
  95      *  Purpose:
  96      *      Called by the core to send stream header information
  97      *
  98      */
  99     STDMETHOD(OnStreamHeader)   (THIS_
 100                                 IRMAValues* pValues) PURE;
 101
 102     /************************************************************************
 103      *  Method:
 104      *      IRMAPacketHook:OnPacket
 105      *  Purpose:
 106      *      Called by the core to send packet information.
 107      *
 108      */
 109     STDMETHOD(OnPacket)         (THIS_
 110                                 IRMAPacket* pPacket) PURE;
 111 };
 112
 113 /****************************************************************************
 114  *
 115  *  Interface:
 116  *
 117  *      IRMAPacketHookManager
 118  *
 119  *  Purpose:
 120  *
 121  *      Interface to the selective record
 122  *
 123  *  IID_IRMAPacketHookManager
 124  *
 125  *      {00002001-0901-11d1-8B06-00A024406D59}
 126  */
 127 DEFINE_GUID(IID_IRMAPacketHookManager, 0x00002001, 0x901, 0x11d1, 0x8b, 0x6, 0x0,
 128                         0xa0, 0x24, 0x40, 0x6d, 0x59);
 129
 130 #undef  INTERFACE
 131 #define INTERFACE   IRMAPacketHookManager
 132
 133 DECLARE_INTERFACE_(IRMAPacketHookManager, IUnknown)
 134 {
 135     /*
 136      * IUnknown methods
 137      */
 138     STDMETHOD(QueryInterface)   (THIS_
 139                                 REFIID riid,
 140                                 void** ppvObj) PURE;
 141
 142     STDMETHOD_(ULONG,AddRef)    (THIS) PURE;
 143
 144     STDMETHOD_(ULONG,Release)   (THIS) PURE;
 145
 146     /*
 147      * IRMAPacketHookManager methods
 148      */
 149
 150     /************************************************************************
 151      *  Method:
 152      *      IRMAPacketHookManager::InitHook
 153      *  Purpose:
 154      *      called by the top level client to pass the IRMAPacketHook object
 155      */
 156     STDMETHOD(InitHook)         (THIS_
 157                                 IRMAPacketHook* pPacketHook) PURE;
 158
 159     /************************************************************************
 160      *  Method:
 161      *      IRMAPacketHookManager::CloseHook
 162      *  Purpose:
 163      *      called by the top level client to close the hook connection
 164      */
 165     STDMETHOD(CloseHook)        (THIS) PURE;
 166
 167     /************************************************************************
 168      *  Method:
 169      *      IRMAPacketHookManager::StartHook
 170      *  Purpose:
 171      *      called by the top level client to start recording
 172      */
 173     STDMETHOD(StartHook)        (THIS) PURE;
 174
 175     /************************************************************************
 176      *  Method:
 177      *      IRMAPacketHookManager::StopHook
 178      *  Purpose:
 179      *      called by the top level client to stop recording
 180      */
 181     STDMETHOD(StopHook)         (THIS) PURE;
 182 };
 183
 184 /****************************************************************************
 185  *
 186  *  Interface:
 187  *
 188  *      IRMAPacketHookHelper
 189  *
 190  *  Purpose:
 191  *
 192  *      provide methods to prepare the packet for recording and send back the core
 193  *
 194  *  IID_IRMAPacketHookHelper:
 195  *
 196  *      {00002002-0901-11d1-8B06-00A024406D59}
 197  *
 198  */
 199
 200 DEFINE_GUID(IID_IRMAPacketHookHelper, 0x00002002, 0x901, 0x11d1, 0x8b, 0x6, 0x0,
 201                 0xa0, 0x24, 0x40, 0x6d, 0x59);
 202
 203 #undef  INTERFACE
 204 #define INTERFACE   IRMAPacketHookHelper
 205
 206 DECLARE_INTERFACE_(IRMAPacketHookHelper, IUnknown)
 207 {
 208     /*
 209      * IUnknown methods
 210      */
 211     STDMETHOD(QueryInterface)           (THIS_
 212                                         REFIID riid,
 213                                         void** ppvObj) PURE;
 214
 215     STDMETHOD_(ULONG,AddRef)            (THIS) PURE;
 216
 217     STDMETHOD_(ULONG,Release)           (THIS) PURE;
 218
 219     /*
 220      * IRMAPacketHookHelper methods
 221      */
 222
 223     /******************************************************************
 224      * Method:
 225      *     IRMAPacketHookHelper::StartHook
 226      *
 227      * Purpose:
 228      *     tell the renderer to start sending the record packets
 229      *
 230      */
 231     STDMETHOD(StartHook)                (THIS_
 232                                         ULONG32 ulStreamNumber,
 233                                         ULONG32 ulTimeOffset,
 234                                         IRMAPacketHookHelperResponse* pPacketHookHelperResponse) PURE;
 235
 236
 237     /******************************************************************
 238      * Method:
 239      *    IRMAPacketHookHelper::StopHook
 240      *
 241      * Purpose:
 242      *    tell the renderer to stop sending the record packets
 243      */
 244     STDMETHOD(StopHook)                 (THIS) PURE;
 245 };
 246
 247 /****************************************************************************
 248  *
 249  *  Interface:
 250  *
 251  *      IRMAPacketHookHelperResponse
 252  *
 253  *  Purpose:
 254  *
 255  *      Response interface to the IRMAPacketHookHelper at renderer
 256  *
 257  *  IID_IRMAPacketHookHelperResponse
 258  *
 259  *      {00002003-0901-11d1-8B06-00A024406D59}
 260  */
 261 DEFINE_GUID(IID_IRMAPacketHookHelperResponse, 0x00002003, 0x901, 0x11d1, 0x8b, 0x6, 0x0,
 262                         0xa0, 0x24, 0x40, 0x6d, 0x59);
 263
 264 #undef  INTERFACE
 265 #define INTERFACE   IRMAPacketHookHelperResponse
 266
 267 DECLARE_INTERFACE_(IRMAPacketHookHelperResponse, IUnknown)
 268 {
 269     /*
 270      * IUnknown methods
 271      */
 272     STDMETHOD(QueryInterface)   (THIS_
 273                                 REFIID riid,
 274                                 void** ppvObj) PURE;
 275
 276     STDMETHOD_(ULONG,AddRef)    (THIS) PURE;
 277
 278     STDMETHOD_(ULONG,Release)   (THIS) PURE;
 279
 280     /*
 281      * IRMAPacketHookHelperResponse methods
 282      */
 283
 284     /************************************************************************
 285      *  Method:
 286      *      IRMAPacketHookHelperResponse::OnPacket
 287      *  Purpose:
 288      *      called by the renderer to pass the packet for recording
 289      */
 290     STDMETHOD(OnPacket)         (THIS_
 291                                 IRMAPacket* pPacket) PURE;
 292
 293     /************************************************************************
 294      *  Method:
 295      *      IRMAPacketHookManager::OnEndOfPackets
 296      *  Purpose:
 297      *      called by the renderer to notify the end of this stream
 298      */
 299     STDMETHOD(OnEndOfPackets)   (THIS) PURE;
 300 };
 301
 302 #endif /* _RMAPHOOK_H_ */