include/realmedia/rmarendr.h

   1 /****************************************************************************
   2  *
   3  *  $Id: rmarendr.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 Rendering Interfaces.
  15  *
  16  */
  17
  18 #ifndef _RMARENDR_H_
  19 #define _RMARENDR_H_
  20
  21 /*
  22  * Forward declarations of some interfaces defined or used here-in.
  23  */
  24 typedef _INTERFACE      IRMARenderer                IRMARenderer;
  25 typedef _INTERFACE      IRMAStream                  IRMAStream;
  26 typedef _INTERFACE      IRMAStreamSource            IRMAStreamSource;
  27 typedef _INTERFACE      IRMAPlayer                  IRMAPlayer;
  28 typedef _INTERFACE      IRMAClientEngine            IRMAClientEngine;
  29
  30
  31 /****************************************************************************
  32  *
  33  *  Interface:
  34  *
  35  *      IRMARenderer
  36  *
  37  *  Purpose:
  38  *
  39  *      Interface implemented by all renderers. Parts of this interface are
  40  *      called by the client engine to provide data packets to the
  41  *      individual renderers.
  42  *
  43  *  IID_IRMARenderer:
  44  *
  45  *      {00000300-0901-11d1-8B06-00A024406D59}
  46  *
  47  */
  48 DEFINE_GUID(IID_IRMARenderer, 0x00000300, 0x901, 0x11d1, 0x8b, 0x6, 0x0,
  49                         0xa0, 0x24, 0x40, 0x6d, 0x59);
  50
  51 #undef  INTERFACE
  52 #define INTERFACE   IRMARenderer
  53
  54 typedef ULONG32 RMA_DISPLAY_TYPE;
  55
  56 #define RMA_DISPLAY_NONE                    0x00000000
  57 #define RMA_DISPLAY_WINDOW                  0x00000001
  58 #define RMA_DISPLAY_SUPPORTS_RESIZE         0x00000002
  59 #define RMA_DISPLAY_SUPPORTS_FULLSCREEN     0x00000004
  60 #define RMA_DISPLAY_SUPPORTS_VIDCONTROLS    0x00000008
  61
  62
  63 DECLARE_INTERFACE_(IRMARenderer, IUnknown)
  64 {
  65     /*
  66      * IUnknown methods
  67      */
  68     STDMETHOD(QueryInterface)   (THIS_
  69                                 REFIID riid,
  70                                 void** ppvObj) PURE;
  71
  72     STDMETHOD_(ULONG,AddRef)    (THIS) PURE;
  73
  74     STDMETHOD_(ULONG,Release)   (THIS) PURE;
  75
  76     /*
  77      * IRMARenderer methods
  78      */
  79
  80     /************************************************************************
  81      *  Method:
  82      *      IRMARenderer::GetRendererInfo
  83      *  Purpose:
  84      *      Returns information vital to the instantiation of rendering
  85      *      plugins.
  86      */
  87     STDMETHOD(GetRendererInfo)  (THIS_
  88                                 REF(const char**)/*OUT*/ pStreamMimeTypes,
  89                                 REF(UINT32)      /*OUT*/ unInitialGranularity
  90                                 ) PURE;
  91
  92     /************************************************************************
  93      *  Method:
  94      *      IRMARenderer::StartStream
  95      *  Purpose:
  96      *      Called by client engine to inform the renderer of the stream it
  97      *      will be rendering. The stream interface can provide access to
  98      *      its source or player. This method also provides access to the
  99      *      primary client controller interface.
 100      *
 101      */
 102     STDMETHOD(StartStream)      (THIS_
 103                                 IRMAStream*         pStream,
 104                                 IRMAPlayer*         pPlayer) PURE;
 105
 106     /************************************************************************
 107      *  Method:
 108      *      IRMARenderer::EndStream
 109      *  Purpose:
 110      *      Called by client engine to inform the renderer that the stream
 111      *      is was rendering is closed.
 112      *
 113      */
 114     STDMETHOD(EndStream)        (THIS) PURE;
 115
 116     /************************************************************************
 117      *  Method:
 118      *          IRMARenderer::OnHeader
 119      *  Purpose:
 120      *          Called by client engine when a header for this renderer is
 121      *          available. The header will arrive before any packets.
 122      *
 123      */
 124     STDMETHOD(OnHeader)         (THIS_
 125                                 IRMAValues*         pHeader) PURE;
 126
 127     /************************************************************************
 128      *  Method:
 129      *      IRMARenderer::OnPacket
 130      *  Purpose:
 131      *      Called by client engine when a packet for this renderer is
 132      *      due.
 133      *
 134      */
 135     STDMETHOD(OnPacket)         (THIS_
 136                                 IRMAPacket*         pPacket,
 137                                 LONG32              lTimeOffset) PURE;
 138
 139     /************************************************************************
 140      *  Method:
 141      *      IRMARenderer::OnTimeSync
 142      *  Purpose:
 143      *      Called by client engine to inform the renderer of the current
 144      *      time relative to the streams synchronized time-line. The
 145      *      renderer should use this time value to update its display or
 146      *      render it's stream data accordingly.
 147      *
 148      */
 149     STDMETHOD(OnTimeSync)       (THIS_
 150                                 ULONG32             ulTime) PURE;
 151
 152     /************************************************************************
 153      *  Method:
 154      *      IRMARenderer::OnPreSeek
 155      *  Purpose:
 156      *      Called by client engine to inform the renderer that a seek is
 157      *      about to occur. The render is informed the last time for the
 158      *      stream's time line before the seek, as well as the first new
 159      *      time for the stream's time line after the seek will be completed.
 160      *
 161      */
 162     STDMETHOD(OnPreSeek)        (THIS_
 163                                 ULONG32             ulOldTime,
 164                                 ULONG32             ulNewTime) PURE;
 165
 166     /************************************************************************
 167      *  Method:
 168      *      IRMARenderer::OnPostSeek
 169      *  Purpose:
 170      *      Called by client engine to inform the renderer that a seek has
 171      *      just occurred. The render is informed the last time for the
 172      *      stream's time line before the seek, as well as the first new
 173      *      time for the stream's time line after the seek.
 174      *
 175      */
 176     STDMETHOD(OnPostSeek)       (THIS_
 177                                 ULONG32             ulOldTime,
 178                                 ULONG32             ulNewTime) PURE;
 179
 180     /************************************************************************
 181      *  Method:
 182      *      IRMARenderer::OnPause
 183      *  Purpose:
 184      *      Called by client engine to inform the renderer that a pause has
 185      *      just occurred. The render is informed the last time for the
 186      *      stream's time line before the pause.
 187      *
 188      */
 189     STDMETHOD(OnPause)          (THIS_
 190                                 ULONG32             ulTime) PURE;
 191
 192     /************************************************************************
 193      *  Method:
 194      *      IRMARenderer::OnBegin
 195      *  Purpose:
 196      *      Called by client engine to inform the renderer that a begin or
 197      *      resume has just occurred. The render is informed the first time
 198      *      for the stream's time line after the resume.
 199      *
 200      */
 201     STDMETHOD(OnBegin)          (THIS_
 202                                 ULONG32             ulTime) PURE;
 203
 204     /************************************************************************
 205      *  Method:
 206      *      IRMARenderer::OnBuffering
 207      *  Purpose:
 208      *      Called by client engine to inform the renderer that buffering
 209      *      of data is occuring. The render is informed of the reason for
 210      *      the buffering (start-up of stream, seek has occurred, network
 211      *      congestion, etc.), as well as percentage complete of the
 212      *      buffering process.
 213      *
 214      */
 215     STDMETHOD(OnBuffering)      (THIS_
 216                                 ULONG32             ulFlags,
 217                                 UINT16              unPercentComplete) PURE;
 218
 219     /************************************************************************
 220      *  Method:
 221      *      IRMARenderer::GetDisplayType
 222      *  Purpose:
 223      *      Called by client engine to ask the renderer for it's preferred
 224      *      display type. When layout information is not present, the
 225      *      renderer will be asked for it's prefered display type. Depending
 226      *      on the display type a buffer of additional information may be
 227      *      needed. This buffer could contain information about preferred
 228      *      window size.
 229      *
 230      */
 231     STDMETHOD(GetDisplayType)   (THIS_
 232                                 REF(RMA_DISPLAY_TYPE)   ulFlags,
 233                                 REF(IRMABuffer*)        pBuffer) PURE;
 234
 235     /************************************************************************
 236      *  Method:
 237      *      IRMARenderer::OnEndofPackets
 238      *  Purpose:
 239      *      Called by client engine to inform the renderer that all the
 240      *      packets have been delivered. However, if the user seeks before
 241      *      EndStream() is called, renderer may start getting packets again
 242      *      and the client engine will eventually call this function again.
 243      */
 244     STDMETHOD(OnEndofPackets)   (THIS) PURE;
 245 };
 246
 247 #endif /* _RMARENDR_H_ */