rmalvpix.h
上传用户:xjjlds
上传日期:2015-12-05
资源大小:22823k
文件大小:15k
源码类别:

多媒体编程

开发平台:

Visual C++

  1. /****************************************************************************
  2.  *
  3.  *  rmalvpix.h
  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.  *  RealPix live encoder interfaces
  15.  *
  16.  */
  17. #ifndef _RMALVPIX_H
  18. #define _RMALVPIX_H
  19. /*
  20.  * PixInitInfo
  21.  *
  22.  * This struct contains initialization information
  23.  * and is passed in in the IRMALiveRealPix::StartEncoder()
  24.  * method. All of the members of this struct are input variables.
  25.  */
  26. typedef struct PNEXPORT_CLASS _PixInitInfo
  27. {
  28.     UINT32  m_ulStructLength;       /* length in bytes of this structure */
  29.     char   *m_pServerAddress;       /* name or ip address of server */
  30.     UINT32  m_ulServerPort;         /* pn-encoder port on server */
  31.     char   *m_pUsername;            /* username for authentication on server */
  32.     char   *m_pPassword;            /* password for authentication on server */
  33.     char   *m_pFilename;            /* filename which clients should open */
  34.     char   *m_pTitle;               /* title of live presentation */
  35.     char   *m_pAuthor;              /* author of live presentation */
  36.     char   *m_pCopyright;           /* copyright on live presentation */
  37.     UINT32  m_ulBitrate;            /* bitrate of realpix stream */
  38.     UINT32  m_ulMaxFps;             /* max frames per second of effects */
  39.     UINT32  m_ulDisplayWidth;       /* display width in pixels */
  40.     UINT32  m_ulDisplayHeight;      /* display height in pixels */
  41.     BOOL    m_bPreserveAspect;      /* preserve aspect ratio by default? */
  42.     char   *m_pDefaultURL;          /* default URL to send browser to when clicked */
  43.     UINT32  m_ulNumImageCodecs;     /* number of image codecs used in this stream */
  44.     char  **m_ppImageCodec;         /* string names of codecs */
  45.     UINT32  m_ulNumEffectPackages;  /* number of external effect packages used */
  46.     char  **m_ppEffectPackage;      /* string names of effect packages*/
  47. }
  48. PixInitInfo;
  49. /*
  50.  * PixImageInfo
  51.  *
  52.  * This struct contains all the information for images which
  53.  * should be sent down the stream. This struct is used in the 
  54.  * IRMALiveRealPix::InitImage() method.
  55.  */
  56. typedef struct PNEXPORT_CLASS _PixImageInfo
  57. {
  58.     UINT32  m_ulStructLength;      /* Input:  size of struct */
  59.     BYTE   *m_pImageBuffer;        /* Input:  buffer holding image data */
  60.     UINT32  m_ulImageBufferSize;   /* Input:  size of image buffer */
  61.     char   *m_pImageCodec;         /* Input:  image codec to be used */
  62.     UINT32  m_ulHandle;            /* Output: image handle */
  63.     UINT32  m_ulNumPackets;        /* Output: number of packets image will be sent */
  64.     UINT32  m_ulTimeToSend;        /* Output: milliseconds required to send image */
  65. }
  66. PixImageInfo;
  67. #define EFFECT_FILL           0
  68. #define EFFECT_FADEIN         1
  69. #define EFFECT_FADEOUT        2
  70. #define EFFECT_CROSSFADE      3
  71. #define EFFECT_WIPE           4
  72. #define EFFECT_VIEWCHANGE     5
  73. #define EFFECT_EXTERNAL       6
  74. #define EFFECT_ANIMATE        7
  75. #define WIPE_DIRECTION_UP     0
  76. #define WIPE_DIRECTION_DOWN   1
  77. #define WIPE_DIRECTION_LEFT   2
  78. #define WIPE_DIRECTION_RIGHT  3
  79. #define WIPE_TYPE_NORMAL      0
  80. #define WIPE_TYPE_PUSH        1
  81. /*
  82.  * PixEffectInfo
  83.  *
  84.  * This struct contains all the information about the effect which 
  85.  * the RealPix renderer should perform. This struct is used in the
  86.  * IRMALiveRealPix::SendEffect() method.
  87.  */
  88. typedef struct PNEXPORT_CLASS _PixEffectInfo
  89. {
  90.     UINT32  m_ulStructLength;      /* Input:  Length in bytes of this struct */
  91.     BYTE    m_ucEffectType;        /* Input:  Effect Type: EFFECT_FILL, EFFECT_FADEIN, etc. */
  92.     UINT32  m_ulStart;             /* Input:  Start time in milliseconds of effect */
  93.     UINT32  m_ulDuration;          /* Input:  Duration in milliseconds of effect */
  94.     UINT32  m_ulTarget;            /* Input:  Handle of image to perform effect on */
  95.     UINT32  m_ulSrcX;              /* Input:  Horizontal offset of source rectangle */
  96.     UINT32  m_ulSrcY;              /* Input:  Vertical offset of source rectangle */
  97.     UINT32  m_ulSrcW;              /* Input:  Width of source rectangle */
  98.     UINT32  m_ulSrcH;              /* Input:  Height of source rectangle */
  99.     UINT32  m_ulDstX;              /* Input:  Horizontal offset of destination rectangle */
  100.     UINT32  m_ulDstY;              /* Input:  Vertical offset of destination rectangle */
  101.     UINT32  m_ulDstW;              /* Input:  Width of destination rectangle */
  102.     UINT32  m_ulDstH;              /* Input:  Height of destination rectangle */
  103.     UINT32  m_ulMaxFps;            /* Input:  Max frames per second for this effect */
  104.     BOOL    m_bAspectFlag;         /* Input:  TRUE: preserve aspect on this effect; FALSE: don't preserve */
  105.     BYTE    m_ucRed;               /* Input:  Red component of fill or fadeout color */
  106.     BYTE    m_ucGreen;             /* Input:  Green component of fill or fadeout color */
  107.     BYTE    m_ucBlue;              /* Input:  Blue component of fill or fadeout color */
  108.     BYTE    m_ucWipeDirection;     /* Input:  WIPE_DIRECTION_xxx, where xxx is UP, DOWN, LEFT, or RIGHT */
  109.     BYTE    m_ucWipeType;          /* Input:  WIPE_TYPE_NORMAL or WIPE_TYPE_PUSH */
  110.     char   *m_pURL;                /* Input:  URL for this effect */
  111.     char   *m_pExtPackage;         /* Input:  Name of external effect package */
  112.     char   *m_pExtName;            /* Input:  Name of external effect within the package */
  113.     char   *m_pExtData;            /* Input   Opaque string data for external effect */
  114.     char   *m_pExtFile;            /* Input:  File contents of external effect data */
  115.     BOOL    m_bDiscardImage;       /* Input:  TRUE: discard image after doing effect; FALSE: don't discard */
  116.     BOOL    m_bDisplayImmediately; /* Input:  FALSE: obey start time; TRUE: do effect immediately */
  117. UINT32  m_ulHandle;            /* Output: Handle by which effect will be referred to */
  118. }
  119. PixEffectInfo;
  120. /*
  121.  * Forward declarations of some interfaces defined here.
  122.  */
  123. typedef _INTERFACE IRMALiveRealPix         IRMALiveRealPix;
  124. typedef _INTERFACE IRMALiveRealPixResponse IRMALiveRealPixResponse;
  125. typedef _INTERFACE IRMALiveRealPixResend   IRMALiveRealPixResend;
  126. /*
  127.  * Forward declarations of interfaces used here
  128.  */
  129. typedef _INTERFACE IRMAValues              IRMAValues;
  130. /*
  131.  * Declaration of the DLL entry point
  132.  */
  133. STDAPI CreateLiveRealPix(IRMALiveRealPix **);
  134. typedef PN_RESULT (PNEXPORT_PTR FPRMCREATELIVEREALPIX)(IRMALiveRealPix **ppLiveRealPix);
  135. /****************************************************************************
  136.  * 
  137.  *  Interface:
  138.  * 
  139.  *  IRMALivePix
  140.  * 
  141.  *  Purpose:
  142.  * 
  143.  *  Asynchronous interface that allows an application to encode live RealPix
  144.  * 
  145.  *  IID_IRMALiveRealPix:
  146.  * 
  147.  *  {E7ADF466-477D-11d2-AA0C-0060972D23A7}
  148.  *
  149.  */
  150. DEFINE_GUID(IID_IRMALiveRealPix,  0xe7adf466, 0x477d, 0x11d2, 0xaa, 0xc, 0x0,
  151.             0x60, 0x97, 0x2d, 0x23, 0xa7);
  152. #undef  INTERFACE
  153. #define INTERFACE   IRMALiveRealPix
  154. DECLARE_INTERFACE_(IRMALiveRealPix, IUnknown)
  155. {
  156.     /*
  157.      *  IUnknown methods
  158.      */
  159.     STDMETHOD(QueryInterface)      (THIS_ REFIID riid, void **ppvObj) PURE;
  160.     STDMETHOD_(ULONG,AddRef)     (THIS) PURE;
  161.     STDMETHOD_(ULONG,Release)    (THIS) PURE;
  162.     /*
  163.      *  IRMALiveRealPix methods
  164.      */
  165.     /*
  166.      * StartEncoder() must be called before anything else and a pointer to
  167.      * an IRMALiveRealPixResponse interface must be passed in. The encoder will
  168.      * respond to this call asynchronously with IRMALiveRealPixResponse::EncoderStarted().
  169.      */
  170.     STDMETHOD(StartEncoder)        (THIS_ PixInitInfo             *pInitInfo,
  171.                                           IRMALiveRealPixResponse *pResponse) PURE;
  172.     /*
  173.      * InitImage() is called to prep an image for being sent. It returns several useful
  174.      * pieces of information which the caller can make use of: the handle to refer to
  175.      * the image in SendImage(), the number of packets this image will be broken up into,
  176.      * and the time required to send this image in milliseconds. Note that InitImage()
  177.      * simply breaks the image up into packets - nothing has been sent to the server yet.
  178.      * This is not an asynchronous call - all processing has finished by the time this
  179.      * call returns.
  180.      */
  181.     STDMETHOD(InitImage)           (THIS_ PixImageInfo *pImageInfo) PURE;
  182.     /*
  183.      * SendImage() tranfers the all the packets for the image referred to by ulImageHandle
  184.      * into the packet send queue. Further calls to Process() will result in these
  185.      * packets being sent to the RealServer. When all the packets for this image have
  186.      * been sent, the encoder will respond with IRMALiveRealPixResponse::ImageSent().
  187.      */
  188.     STDMETHOD(SendImage)           (THIS_ UINT32 ulImageHandle) PURE;
  189.     /*
  190.      * SendEffect() creates an effect packet with the information contained in
  191.      * the PixEffectInfo struct and immediately adds this packet to the packet
  192.      * send queue. Further calls to Process() will result in this packet being 
  193.      * sent to the server. A handle is returned in the PixEffectInfo struct by
  194.      * which this effect can later be identified. When the effect has been
  195.      * sent to the server, the encoder will respond with
  196.      * IRMALiveRealPixResponse::EffectSent().
  197.      */
  198.     STDMETHOD(SendEffect)          (THIS_ PixEffectInfo *pEffectInfo) PURE;
  199.     /*
  200.      * StopEncoder() may be called at any time after calling StartEncoder().
  201.      * This tells the encoder that no more images of effects are going to
  202.      * be sent to the encoder. The encoder shuts down the connection to
  203.      * the server and responds with IRMALiveRealPixResponse::EncoderStopped().
  204.      */
  205.     STDMETHOD(StopEncoder)         (THIS) PURE;
  206.     /*
  207.      * GetTime() returns the time in milliseconds since the encoder library was initialized.
  208.      */
  209.     STDMETHOD_(UINT32, GetTime)    (THIS) PURE;
  210.     /*
  211.      * Process() must be called in order to give the library time to send
  212.      * packets to the server. It should be called very often in between SendImage()
  213.      * and ImageSent(), as well as between SendEffect() and EffectSent(). Other
  214.      * that these times, it should be called every 3-5 seconds.
  215.      */
  216.     STDMETHOD(Process)             (THIS) PURE;
  217. };
  218. /****************************************************************************
  219.  * 
  220.  *  Interface:
  221.  * 
  222.  *  IRMALiveRealPixResponse
  223.  * 
  224.  *  Purpose:
  225.  * 
  226.  *  Asynchronous response interface that allows an application to
  227.  *  encode live RealPix
  228.  * 
  229.  *  IID_IRMALiveRealPixResponse:
  230.  * 
  231.  *  {E7ADF46C-477D-11d2-AA0C-0060972D23A7}
  232.  *
  233.  */
  234. DEFINE_GUID(IID_IRMALiveRealPixResponse, 0xe7adf46c, 0x477d, 0x11d2, 0xaa, 0xc, 0x0,
  235.             0x60, 0x97, 0x2d, 0x23, 0xa7);
  236. #undef  INTERFACE
  237. #define INTERFACE   IRMALiveRealPixResponse
  238. DECLARE_INTERFACE_(IRMALiveRealPixResponse, IUnknown)
  239. {
  240.     /*
  241.      *  IUnknown methods
  242.      */
  243.     STDMETHOD(QueryInterface)      (THIS_ REFIID riid, void **ppvObj) PURE;
  244.     STDMETHOD_(ULONG,AddRef)     (THIS) PURE;
  245.     STDMETHOD_(ULONG,Release)    (THIS) PURE;
  246.     /*
  247.      *  IRMALiveRealPixResponse methods
  248.      */
  249.     /*
  250.      * EncoderStarted() is the asynchronous response to StartEncoder(). The status
  251.      * argument tells whether initializing the server was successful or not, and the pszHeaderString
  252.      * argument returns the text string returned by the RealServer.
  253.      */
  254.     STDMETHOD(EncoderStarted)      (THIS_ PN_RESULT status, const char *pszHeaderString) PURE;
  255.     /*
  256.      * ImageSent() is the asynchronous response to SendImage(). The ulImageHandle argument
  257.      * identifies which image has just completed sending to the server, and the status 
  258.      * argument tells whether or not the send was successful or not.
  259.      */
  260.     STDMETHOD(ImageSent)           (THIS_ PN_RESULT status, UINT32 ulImageHandle) PURE;
  261.     /*
  262.      * EffectSent() is the asynchronous response to SendEffect(). The ulEffectHandle argument
  263.      * identifies which effect has just completed sending to the server, and the status 
  264.      * argument tells whether or not the send was successful or not.
  265.      */
  266.     STDMETHOD(EffectSent)          (THIS_ PN_RESULT status, UINT32 ulEffectHandle) PURE;
  267.     /*
  268.      * EncoderStopped() is the asynchronous response to StopEncoder(). The status
  269.      * argument tells whether or not the stopping of the encoder was successful.
  270.      * If the status is PNR_OK, then the application can then shut down or turn
  271.      * around and call StartEncoder() again.
  272.      */
  273.     STDMETHOD(EncoderStopped)      (THIS_ PN_RESULT status) PURE;
  274.     /*
  275.      * ErrorOccurred() is called when the encoder receives an error from the RealServer.
  276.      * Depending upon the severity of the error, the RealServer may then shut down
  277.      * the encoder and an EncoderStopped() call would be made. Therefore, the
  278.      * application should be ready to handle an EncoderStopped() call at any time.
  279.      * If an error occurs, it's probably a good idea to call StopEncoder() and shut
  280.      * down the encoder from the application side anyway.
  281.      */
  282.     STDMETHOD(ErrorOccurred)       (THIS_ const UINT8   unSeverity,
  283.                                           const ULONG32 ulRMACode,
  284.                                           const ULONG32 ulUserCode,
  285.                                           const char   *pszUserString,
  286.                                           const char   *pszMoreInfoURL) PURE;
  287. };
  288. /****************************************************************************
  289.  * 
  290.  *  Interface:
  291.  * 
  292.  *  IRMALiveRealPixResend
  293.  * 
  294.  *  Purpose:
  295.  * 
  296.  *  Allows re-sending and releasing of images with IRMALiveRealPix
  297.  * 
  298.  *  IID_IRMALiveRealPixResend:
  299.  * 
  300.  *  {D814DA11-8B02-11D3-8AF3-00C0F030B4E5}
  301.  */
  302. DEFINE_GUID(IID_IRMALiveRealPixResend, 0xd814da11, 0x8b02, 0x11d3, 0x8a, 0xfe, 0x0,
  303.             0xc0, 0xf0, 0x30, 0xb4, 0xe5);
  304. #undef  INTERFACE
  305. #define INTERFACE   IRMALiveRealPixResend
  306. DECLARE_INTERFACE_(IRMALiveRealPixResend, IUnknown)
  307. {
  308.     /*
  309.      *  IUnknown methods
  310.      */
  311.     STDMETHOD(QueryInterface)      (THIS_ REFIID riid, void** ppvObj) PURE;
  312.     STDMETHOD_(ULONG,AddRef)     (THIS) PURE;
  313.     STDMETHOD_(ULONG,Release)    (THIS) PURE;
  314.     /*
  315.      *  IRMALiveRealPixResend methods
  316.      */
  317.     /*
  318.      * InitResend() informs the encoder that from now on, after an
  319.      * image is sent with SendImage() it should not be discarded 
  320.      * but held in the encoder until ReleaseImage() is called().
  321.      */
  322.     STDMETHOD(InitResend)   (THIS_ IRMAValues* pOptions) PURE;
  323.     /*
  324.      * ReleaseImage() informs the encoder that the application no longer
  325.      * intends to call SendImage() on the image referenced by ulImageHandle
  326.      * and that it can discard the image. Further calls to SendImage(x) will
  327.      * return PNR_UNKNOWN_IMAGE after ReleaseImage(x) has been called.
  328.      * ReleaseImage(x) will return PNR_UNKNOWN_IMAGE if x is an unknown handle.
  329.      */
  330.     STDMETHOD(ReleaseImage) (THIS_ UINT32 ulImageHandle) PURE;
  331.     /*
  332.      * DumpAllQueuedPackets() clears any packets currently waiting to be
  333.      * sent to the server. These packets were put on the send queue by
  334.      * either IRMALiveRealPix::SendImage() or IRMALiveRealPix::SendEffect().
  335.      */
  336.     STDMETHOD(DumpAllQueuedPackets) (THIS) PURE;
  337. };
  338. #endif