include/realmedia/rmadtcvt.h

   1 /****************************************************************************
   2  *
   3  *  $Id: rmadtcvt.h 7 2003-05-30 02:18:02Z gabest $
   4  *
   5  *  Copyright (C) 1995-2000 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 Stream Data Conversion Interfaces.
  15  *
  16  */
  17
  18
  19 #ifndef _RMADTCVT_H
  20 #define _RMADTCVT_H
  21
  22 typedef _INTERFACE      IRMADataConvertSystemObject
  23                                                 IRMADataConvertSystemObject;
  24 typedef _INTERFACE      IRMADataConvert               IRMADataConvert;
  25 typedef _INTERFACE      IRMADataConvertResponse       IRMADataConvertResponse;
  26 typedef _INTERFACE      IRMADataRevert                IRMADataRevert;
  27 typedef _INTERFACE      IRMADataRevertResponse        IRMADataRevertResponse;
  28
  29 /****************************************************************************
  30  *
  31  *  Interface:
  32  *
  33  *      IRMADataConvertSystemObject
  34  *
  35  *  Purpose:
  36  *
  37  *      Object that allows Controller to communicate with a specific
  38  *      Data Convert plugin session (similar to IRMAFileSystemObject)
  39  *
  40  *  Implemented by:
  41  *
  42  *      Server side plugin.
  43  *
  44  *  IID_IMADataConvertSystemObject:
  45  *
  46  *      {00003900-0901-11d1-8B06-00A024406D59}
  47  *
  48  */
  49 DEFINE_GUID(IID_IRMADataConvertSystemObject,
  50     0x00003900, 0x901, 0x11d1, 0x8b, 0x6, 0x0, 0xa0, 0x24, 0x40, 0x6d, 0x59);
  51
  52 #undef  INTERFACE
  53 #define INTERFACE   IRMADataConvertSystemObject
  54
  55 DECLARE_INTERFACE_(IRMADataConvertSystemObject, IUnknown)
  56 {
  57     /*
  58      *  IUnknown methods
  59      */
  60     STDMETHOD(QueryInterface)           (THIS_
  61                                         REFIID riid,
  62                                         void** ppvObj) PURE;
  63
  64     STDMETHOD_(ULONG,AddRef)            (THIS) PURE;
  65
  66     STDMETHOD_(ULONG,Release)           (THIS) PURE;
  67
  68     /*
  69      * IRMADataConvertSystemObject
  70      */
  71
  72     /***********************************************************************
  73      * Method: GetDataConvertInfo
  74      *
  75      * Purpose:
  76      *  Returns information needed for proper instantiation of data
  77      *  convert plugin.  pShortName should be a short, human readable
  78      *  name in the form of "company-dcname".  For example:
  79      *  pShortName = "rn-dataconvert"
  80      */
  81     STDMETHOD(GetDataConvertInfo) (THIS_ REF(const char*) pShortName) PURE;
  82
  83     /***********************************************************************
  84      * Method: InitDataConvertSystem
  85      *
  86      * Purpose:
  87      *  Pass in options from config file from under DataConvertMount
  88      *  for this specific plugin.
  89      */
  90     STDMETHOD(InitDataConvertSystem) (THIS_ IRMAValues* pOptions) PURE;
  91
  92     /***********************************************************************
  93      * Method: CreateDataConvert
  94      *
  95      * Purpose:
  96      *  Purpose:
  97      *   System is requesting an IRMADataConvert object for this mount
  98      *   point.
  99      */
 100     STDMETHOD(CreateDataConvert) (THIS_ IUnknown** /*OUT*/ ppConvObj) PURE;
 101 };
 102
 103
 104 /****************************************************************************
 105  *
 106  *  Interface:
 107  *
 108  *      IRMADataConvert
 109  *
 110  *  Purpose:
 111  *
 112  *      Per connection object to handle the actual data and header
 113  *      conversions.
 114  *
 115  *  Implemented by:
 116  *
 117  *      Server side plugin.
 118  *
 119  *  IID_IMADataConvert:
 120  *
 121  *      {00003901-0901-11d1-8B06-00A024406D59}
 122  *
 123  */
 124 DEFINE_GUID(IID_IRMADataConvert,
 125     0x00003901, 0x901, 0x11d1, 0x8b, 0x6, 0x0, 0xa0, 0x24, 0x40, 0x6d, 0x59);
 126
 127 #undef  INTERFACE
 128 #define INTERFACE   IRMADataConvert
 129
 130 DECLARE_INTERFACE_(IRMADataConvert, IUnknown)
 131 {
 132     /*
 133      *  IUnknown methods
 134      */
 135     STDMETHOD(QueryInterface)           (THIS_
 136                                         REFIID riid,
 137                                         void** ppvObj) PURE;
 138
 139     STDMETHOD_(ULONG,AddRef)            (THIS) PURE;
 140
 141     STDMETHOD_(ULONG,Release)           (THIS) PURE;
 142
 143     /*
 144      *  IRMADataConvert
 145      */
 146
 147     /*
 148      * NOTE: for each of ConvertFileHeader, ConvertStreamHeader,
 149      *    ConvertData, you can call the appropriate done method on
 150      *    the response object with a result of PNR_OK and a NULL buffer
 151      *    and the system will use the original header/packet.  Do this
 152      *    if you aren't going to change things in the header/packet.
 153      */
 154     /************************************************************************
 155      * Method: DataConvertInit
 156      *
 157      *Purpose:
 158      *  Basic initialization, mainly just to pass in response object.
 159      */
 160     STDMETHOD(DataConvertInit) (THIS_ IRMADataConvertResponse* pResponse) PURE;
 161
 162     /************************************************************************
 163      * Method: ConvertFileHeader
 164      *
 165      * Purpose:
 166      *  Pass in file headers for data conversion.
 167      */
 168     STDMETHOD(ConvertFileHeader) (THIS_ IRMAValues* pFileHeader) PURE;
 169
 170     /************************************************************************
 171      * Method: ConvertStreamHeader
 172      *
 173      * Purpose:
 174      *  Pass in stream headers for data conversion.
 175      */
 176     STDMETHOD(ConvertStreamHeader) (THIS_ IRMAValues* pStreamHeader) PURE;
 177
 178     /************************************************************************
 179      * Method: GetConversionMimeType
 180      *
 181      * Purpose:
 182      *  Tell the server what converstion type you are using for the
 183      *  session.
 184      */
 185     STDMETHOD(GetConversionMimeType)
 186         (THIS_ REF(const char*) pConversionType) PURE;
 187
 188     /************************************************************************
 189      * Method: ConvertData
 190      *
 191      * Purpose:
 192      *  Pass in data to be converted.
 193      */
 194     STDMETHOD(ConvertData) (THIS_ IRMAPacket* pPacket) PURE;
 195
 196     /************************************************************************
 197      * Method: ControlBufferReady
 198      *
 199      * Purpose:
 200      *  Pass in a control channel buffer sent from the IRMADataRevert
 201      *  on the other side (player).
 202      */
 203     STDMETHOD(ControlBufferReady) (THIS_ IRMABuffer* pBuffer) PURE;
 204
 205     /************************************************************************
 206      * Method: SetMulticastTransportConverter
 207      *
 208      * Purpose:
 209      *  In this case the IRMADataConvert is only handling the header
 210      *  conversions per player and this call is handing you the data
 211      *  converter which is doing the data.  This will a different
 212      *  instance of the same object.
 213      */
 214     STDMETHOD(SetMulticastTransportConverter) (THIS_
 215             IRMADataConvert* pConverter) PURE;
 216
 217
 218     /************************************************************************
 219      * Method: AddMulticastControlConverter
 220      *
 221      * Purpose:
 222      *  In this case the IRMADataConvert is only handling the data
 223      *  conversions for all of the players (but only once because it's
 224      *  multicast).  This call is handing you one of a possible many
 225      *  IRMADataConvert objects which will be handling the header
 226      *  conversions.
 227      */
 228     STDMETHOD(AddMulticastControlConverter) (THIS_
 229             IRMADataConvert* pConverter) PURE;
 230
 231     /************************************************************************
 232      * Method: Done
 233      *
 234      * Purpose:
 235      *  Let IRMADataConvert know that it is done. This is mainly to clear
 236      *  circular refs between multicast transport and controllers.
 237      */
 238     STDMETHOD(Done)                     (THIS) PURE;
 239
 240 };
 241
 242 /****************************************************************************
 243  *
 244  *  Interface:
 245  *
 246  *      IRMADataConvertResponse
 247  *
 248  *  Purpose:
 249  *
 250  *      Response object for IRMADataConvert.
 251  *
 252  *  Implemented by:
 253  *
 254  *      Server Core.
 255  *
 256  *  IID_IMADataConvertResponse:
 257  *
 258  *      {00003902-0901-11d1-8B06-00A024406D59}
 259  *
 260  */
 261 DEFINE_GUID(IID_IRMADataConvertResponse,
 262     0x00003902, 0x901, 0x11d1, 0x8b, 0x6, 0x0, 0xa0, 0x24, 0x40, 0x6d, 0x59);
 263
 264 #undef  INTERFACE
 265 #define INTERFACE   IRMADataConvertResponse
 266
 267 DECLARE_INTERFACE_(IRMADataConvertResponse, 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      *  IRMADataConvertResponse
 282      */
 283
 284     /*
 285      * NOTE: for each of ConvertFileHeader, ConvertStreamHeader,
 286      *    ConvertData, you can call the appropriate done method on
 287      *    the response object with a result of PNR_OK and a NULL buffer
 288      *    and the system will use the original header/packet.  Do this
 289      *    if you aren't going to change things in the header/packet.
 290      */
 291     /************************************************************************
 292      * Method: DataConvertInitDone
 293      *
 294      * Purpose:
 295      *  Async notification that the IRMADataConvert is done with
 296      *  intialization.
 297      */
 298     STDMETHOD(DataConvertInitDone) (THIS_ PN_RESULT status) PURE;
 299
 300     /************************************************************************
 301      * Method: ConvertedFileHeaderReady
 302      *
 303      * Purpose:
 304      *  Async notification that the IRMADataCovert is done converting the
 305      *  file header.
 306      */
 307     STDMETHOD(ConvertedFileHeaderReady) (THIS_
 308                             PN_RESULT status, IRMAValues* pFileHeader) PURE;
 309
 310     /************************************************************************
 311      * Method: ConvertedStreamHeaderReady
 312      *
 313      * Purpose:
 314      *  Async notification that the IRMADataConvert is done converting the
 315      *  stream header.
 316      */
 317     STDMETHOD(ConvertedStreamHeaderReady) (THIS_
 318                             PN_RESULT status, IRMAValues* pStreamHeader) PURE;
 319
 320     /************************************************************************
 321      * Method: ConvertedDataReady
 322      *
 323      * Purpose:
 324      *  Async notification that the IRMADataConvert is done converting
 325      *  the stream data packet.
 326      */
 327     STDMETHOD(ConvertedDataReady) (THIS_ PN_RESULT status,
 328                                         IRMAPacket* pPacket) PURE;
 329
 330     /************************************************************************
 331      * Method: SendControlBuffer
 332      *
 333      * Purpose:
 334      *  Provided to allow IRMADataConvert to send an arbitrary buffer
 335      *  to the IRMADataRevert on the other side (player).
 336      */
 337     STDMETHOD(SendControlBuffer) (THIS_ IRMABuffer* pBuffer) PURE;
 338
 339 };
 340
 341 /****************************************************************************
 342  *
 343  *  Interface:
 344  *
 345  *      IRMADataRevert
 346  *
 347  *  Purpose:
 348  *
 349  *      Revert data coming from coresponding IRMADataConvert on server.
 350  *
 351  *  Implemented by:
 352  *
 353  *      Player side plugin.
 354  *
 355  *  IID_IMADataRevert:
 356  *
 357  *      {00003903-0901-11d1-8B06-00A024406D59}
 358  *
 359  */
 360 DEFINE_GUID(IID_IRMADataRevert,
 361     0x00003903, 0x901, 0x11d1, 0x8b, 0x6, 0x0, 0xa0, 0x24, 0x40, 0x6d, 0x59);
 362
 363 #undef  INTERFACE
 364 #define INTERFACE   IRMADataRevert
 365
 366 DECLARE_INTERFACE_(IRMADataRevert, IUnknown)
 367 {
 368     /*
 369      *  IUnknown methods
 370      */
 371     STDMETHOD(QueryInterface)           (THIS_
 372                                         REFIID riid,
 373                                         void** ppvObj) PURE;
 374
 375     STDMETHOD_(ULONG,AddRef)            (THIS) PURE;
 376
 377     STDMETHOD_(ULONG,Release)           (THIS) PURE;
 378
 379     /*
 380      *  IRMADataRevert
 381      */
 382
 383     /************************************************************************
 384      * Method: DataRevertInit
 385      *
 386      * Purpose:
 387      *  Basic inialization of IRMADataRevert.  Mainly just to pass in
 388      *  response object.
 389      */
 390     STDMETHOD(DataRevertInit) (THIS_ IRMADataRevertResponse* pResponse) PURE;
 391
 392     /************************************************************************
 393      * Method: GetDataRevertInfo
 394      *
 395      * Purpose:
 396      *  Allow IRMADataRevert to notify player core about which data
 397      *  conversion mime types it is willing to handle.
 398      */
 399     STDMETHOD(GetDataRevertInfo) (THIS_ REF(const char**)
 400                                         ppConversionMimeTypes) PURE;
 401
 402     /************************************************************************
 403      * Method: RevertFileHeader
 404      *
 405      * Purpose:
 406      *  Pass in converted FileHeader to allow IRMADataRevert to revert
 407      *  the header.
 408      */
 409     STDMETHOD(RevertFileHeader) (THIS_ IRMAValues* pFileHeader) PURE;
 410
 411     /************************************************************************
 412      * Method: RevertStreamHeader
 413      *
 414      * Purpose:
 415      *  Pass in converted StreamHeader to allow IRMADataRevert to revert
 416      *  the header.
 417      */
 418     STDMETHOD(RevertStreamHeader)(THIS_ IRMAValues* pStreamHeader) PURE;
 419
 420     /************************************************************************
 421      * Method: RevertData
 422      *
 423      * Purpose:
 424      *  Pass in converted stream data to allow IRMADataRevert to
 425      *  revert the data.
 426      */
 427     STDMETHOD(RevertData) (THIS_ IRMAPacket* pPacket) PURE;
 428
 429     /************************************************************************
 430      * Method: ControlBufferReady
 431      *
 432      * Purpose:
 433      *  Pass in control channel buffer received from corresponding
 434      *  IRMADataConvert on server side.
 435      */
 436     STDMETHOD(ControlBufferReady) (THIS_ IRMABuffer* pBuffer) PURE;
 437
 438 };
 439
 440 /****************************************************************************
 441  *
 442  *  Interface:
 443  *
 444  *      IRMADataRevertResponse
 445  *
 446  *  Purpose:
 447  *
 448  *      Response ojbect for IRMADataRevert.
 449  *
 450  *  Implemented by:
 451  *
 452  *      Player core.
 453  *
 454  *  IID_IMADataRevertResponse:
 455  *
 456  *      {00003904-0901-11d1-8B06-00A024406D59}
 457  *
 458  */
 459 DEFINE_GUID(IID_IRMADataRevertResponse,
 460     0x00003904, 0x901, 0x11d1, 0x8b, 0x6, 0x0, 0xa0, 0x24, 0x40, 0x6d, 0x59);
 461
 462 #undef  INTERFACE
 463 #define INTERFACE   IRMADataRevertResponse
 464
 465 DECLARE_INTERFACE_(IRMADataRevertResponse, IUnknown)
 466 {
 467     /*
 468      *  IUnknown methods
 469      */
 470     STDMETHOD(QueryInterface)           (THIS_
 471                                         REFIID riid,
 472                                         void** ppvObj) PURE;
 473
 474     STDMETHOD_(ULONG,AddRef)            (THIS) PURE;
 475
 476     STDMETHOD_(ULONG,Release)           (THIS) PURE;
 477
 478     /*
 479      *  IRMADataRevertResponse
 480      */
 481
 482     /************************************************************************
 483      * Method: DataRevertInitDone
 484      *
 485      * Purpose:
 486      *  Async notification that the IRMADataRevert is done intializing
 487      *  and can begin processing headers.
 488      */
 489     STDMETHOD(DataRevertInitDone) (THIS_ PN_RESULT status) PURE;
 490
 491     /************************************************************************
 492      * Method: RevertedFileHeaderReady
 493      *
 494      * Purpose:
 495      *  Async notification that the IRMADataRevert is done reverting the
 496      *  file headers.
 497      */
 498     STDMETHOD(RevertedFileHeaderReady)  (THIS_
 499                                 PN_RESULT status, IRMAValues* pHeader) PURE;
 500
 501     /************************************************************************
 502      * Method: RevertedStreamHeaderReady
 503      *
 504      * Purpose:
 505      *  Async notification that the IRMADataRevert is done reverting the
 506      *  stream headers.
 507      */
 508     STDMETHOD(RevertedStreamHeaderReady) (THIS_
 509                                 PN_RESULT status, IRMAValues* pHeader) PURE;
 510
 511     /************************************************************************
 512      * Method: RevertedDataReady
 513      *
 514      * Purpose:
 515      *  Async notification that the IRMADataRevert is done reverting the
 516      *  stream data.
 517      */
 518     STDMETHOD(RevertedDataReady) (THIS_ PN_RESULT status,
 519                                         IRMAPacket* pPacket) PURE;
 520
 521     /************************************************************************
 522      * Method: SendControlBuffer
 523      *
 524      * Purpose:
 525      *  Provided to allow IRMADataRevert to send an arbitrary control
 526      *  buffer to the IRMADataConvert on the other side (server).
 527      */
 528     STDMETHOD(SendControlBuffer) (THIS_ IRMABuffer* pBuffer) PURE;
 529
 530 };
 531
 532
 533 #endif