include/control.idl

   1 /*
   2  * Copyright (C) 2002 Lionel Ulmer
   3  * Copyright (C) 2004 Alexandre Julliard
   4  *
   5  * This library is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU Lesser General Public
   7  * License as published by the Free Software Foundation; either
   8  * version 2.1 of the License, or (at your option) any later version.
   9  *
  10  * This library is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * Lesser General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU Lesser General Public
  16  * License along with this library; if not, write to the Free Software
  17  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
  18  */
  19
  20 cpp_quote("#if 0")  /* FIXME: these files are not included on Windows */
  21 import "shldisp.idl";
  22 import "strmif.idl";
  23 cpp_quote("#endif")
  24
  25 interface IMediaControl;
  26 interface IBasicAudio;
  27 interface IBasicVideo;
  28 interface IVideoWindow;
  29 interface IMediaEvent;
  30 interface IMediaEventEx;
  31 interface IMediaPosition;
  32
  33 typedef long OAFilterState;
  34 typedef LONG_PTR OAHWND;
  35 typedef LONG_PTR OAEVENT;
  36
  37 /*****************************************************************************
  38  * IMediaControl interface
  39  */
  40 [
  41     object,
  42     uuid(56a868b1-0ad4-11ce-b03a-0020af0ba770),
  43     pointer_default(unique)
  44 ]
  45 interface IMediaControl : IDispatch
  46 {
  47     HRESULT Run();
  48     HRESULT Pause();
  49     HRESULT Stop();
  50     HRESULT GetState( [in] LONG msTimeout, [out] OAFilterState *pfs );
  51     HRESULT RenderFile( [in] BSTR strFilename );
  52     HRESULT AddSourceFilter( [in] BSTR strFilename, [out] IDispatch **ppUnk );
  53     [propget] HRESULT FilterCollection( [out] IDispatch **ppUnk );
  54     [propget] HRESULT RegFilterCollection( [out] IDispatch **ppUnk );
  55     HRESULT StopWhenReady();
  56 }
  57
  58
  59 /*****************************************************************************
  60  * IBasicAudio interface
  61  */
  62 [
  63     object,
  64     uuid(56a868b3-0ad4-11ce-b03a-0020af0ba770),
  65     pointer_default(unique)
  66 ]
  67 interface IBasicAudio : IDispatch
  68 {
  69     [propput] HRESULT Volume( [in] long lVolume );
  70     [propget] HRESULT Volume( [out] long *plVolume );
  71     [propput] HRESULT Balance( [in] long lBalance );
  72     [propget] HRESULT Balance( [out] long *plBalance );
  73 }
  74
  75
  76 /*****************************************************************************
  77  * IVideoWindow interface
  78  */
  79 [
  80     object,
  81     uuid(56a868b4-0ad4-11ce-b03a-0020af0ba770),
  82     pointer_default(unique)
  83 ]
  84 interface IVideoWindow : IDispatch
  85 {
  86     [propput] HRESULT Caption( [in] BSTR strCaption );
  87     [propget] HRESULT Caption( [out] BSTR *strCaption );
  88     [propput] HRESULT WindowStyle( [in] long WindowStyle );
  89     [propget] HRESULT WindowStyle( [out] long *WindowStyle );
  90     [propput] HRESULT WindowStyleEx( [in] long WindowStyleEx );
  91     [propget] HRESULT WindowStyleEx( [out] long *WindowStyleEx );
  92     [propput] HRESULT AutoShow( [in] long AutoShow );
  93     [propget] HRESULT AutoShow( [out] long *AutoShow );
  94     [propput] HRESULT WindowState( [in] long WindowState );
  95     [propget] HRESULT WindowState( [out] long *WindowState );
  96     [propput] HRESULT BackgroundPalette( [in] long BackgroundPalette );
  97     [propget] HRESULT BackgroundPalette( [out] long *pBackgroundPalette );
  98     [propput] HRESULT Visible( [in] long Visible );
  99     [propget] HRESULT Visible( [out] long *pVisible );
 100     [propput] HRESULT Left( [in] long Left );
 101     [propget] HRESULT Left( [out] long *pLeft );
 102     [propput] HRESULT Width( [in] long Width );
 103     [propget] HRESULT Width( [out] long *pWidth );
 104     [propput] HRESULT Top( [in] long Top );
 105     [propget] HRESULT Top( [out] long *pTop );
 106     [propput] HRESULT Height( [in] long Height );
 107     [propget] HRESULT Height( [out] long *pHeight );
 108     [propput] HRESULT Owner( [in] OAHWND Owner );
 109     [propget] HRESULT Owner( [out] OAHWND *Owner );
 110     [propput] HRESULT MessageDrain( [in] OAHWND Drain );
 111     [propget] HRESULT MessageDrain( [out] OAHWND *Drain );
 112     [propget] HRESULT BorderColor( [out] long *Color );
 113     [propput] HRESULT BorderColor( [in] long Color );
 114     [propget] HRESULT FullScreenMode( [out] long *FullScreenMode );
 115     [propput] HRESULT FullScreenMode( [in] long FullScreenMode );
 116     HRESULT SetWindowForeground( [in] long Focus );
 117     HRESULT NotifyOwnerMessage( [in] OAHWND hwnd, [in] long uMsg, [in] LONG_PTR wParam, [in] LONG_PTR lParam );
 118     HRESULT SetWindowPosition( [in] long Left, [in] long Top, [in] long Width, [in] long Height );
 119     HRESULT GetWindowPosition( [out] long *pLeft, [out] long *pTop, [out] long *pWidth, [out] long *pHeight );
 120     HRESULT GetMinIdealImageSize( [out] long *pWidth, [out] long *pHeight );
 121     HRESULT GetMaxIdealImageSize( [out] long *pWidth, [out] long *pHeight );
 122     HRESULT GetRestorePosition( [out] long *pLeft, [out] long *pTop, [out] long *pWidth, [out] long *pHeight );
 123     HRESULT HideCursor( [in] long HideCursor );
 124     HRESULT IsCursorHidden( [out] long *CursorHidden );
 125 }
 126
 127
 128 /*****************************************************************************
 129  * IBasicVideo interface
 130  */
 131 [
 132     object,
 133     uuid(56a868b5-0ad4-11ce-b03a-0020af0ba770),
 134     pointer_default(unique)
 135 ]
 136 interface IBasicVideo : IDispatch
 137 {
 138     [propget] HRESULT AvgTimePerFrame( [out] REFTIME *pAvgTimePerFrame );
 139     [propget] HRESULT BitRate( [out] long *pBitRate );
 140     [propget] HRESULT BitErrorRate( [out] long *pBitErrorRate );
 141     [propget] HRESULT VideoWidth( [out] long *pVideoWidth );
 142     [propget] HRESULT VideoHeight( [out] long *pVideoHeight );
 143     [propput] HRESULT SourceLeft( [in] long SourceLeft );
 144     [propget] HRESULT SourceLeft( [out] long *pSourceLeft );
 145     [propput] HRESULT SourceWidth( [in] long SourceWidth );
 146     [propget] HRESULT SourceWidth( [out] long *pSourceWidth );
 147     [propput] HRESULT SourceTop( [in] long SourceTop );
 148     [propget] HRESULT SourceTop( [out] long *pSourceTop );
 149     [propput] HRESULT SourceHeight( [in] long SourceHeight );
 150     [propget] HRESULT SourceHeight( [out] long *pSourceHeight );
 151     [propput] HRESULT DestinationLeft( [in] long DestinationLeft );
 152     [propget] HRESULT DestinationLeft( [out] long *pDestinationLeft );
 153     [propput] HRESULT DestinationWidth( [in] long DestinationWidth );
 154     [propget] HRESULT DestinationWidth( [out] long *pDestinationWidth );
 155     [propput] HRESULT DestinationTop( [in] long DestinationTop );
 156     [propget] HRESULT DestinationTop( [out] long *pDestinationTop );
 157     [propput] HRESULT DestinationHeight( [in] long DestinationHeight );
 158     [propget] HRESULT DestinationHeight( [out] long *pDestinationHeight );
 159     HRESULT SetSourcePosition( [in] long Left, [in] long Top, [in] long Width, [in] long Height );
 160     HRESULT GetSourcePosition( [out] long *pLeft, [out] long *pTop, [out] long *pWidth, [out] long *pHeight );
 161     HRESULT SetDefaultSourcePosition();
 162     HRESULT SetDestinationPosition( [in] long Left, [in] long Top, [in] long Width, [in] long Height );
 163     HRESULT GetDestinationPosition( [out] long *pLeft, [out] long *pTop, [out] long *pWidth, [out] long *pHeight );
 164     HRESULT SetDefaultDestinationPosition();
 165     HRESULT GetVideoSize( [out] long *pWidth, [out] long *pHeight );
 166     HRESULT GetVideoPaletteEntries( [in] long StartIndex,
 167                                     [in] long Entries,
 168                                     [out] long *pRetrieved,
 169                                     [out, size_is(Entries), length_is(*pRetrieved)] long *pPalette );
 170     HRESULT GetCurrentImage( [in, out] long *pBufferSize,
 171                              [out, size_is(*pBufferSize), length_is(*pBufferSize)] long *pDIBImage );
 172     HRESULT IsUsingDefaultSource();
 173     HRESULT IsUsingDefaultDestination();
 174 }
 175
 176
 177 /*****************************************************************************
 178  * IMediaEvent interface
 179  */
 180 [
 181     object,
 182     uuid(56a868b6-0ad4-11ce-b03a-0020af0ba770),
 183     pointer_default(unique)
 184 ]
 185 interface IMediaEvent : IDispatch
 186 {
 187     HRESULT GetEventHandle( [out] OAEVENT *hEvent );
 188     HRESULT GetEvent( [out] long *lEventCode, [out] LONG_PTR *lParam1, [out] LONG_PTR *lParam2, [in] long msTimeout );
 189     HRESULT WaitForCompletion( [in] long msTimeout, [out] long *pEvCode );
 190     HRESULT CancelDefaultHandling( [in] long lEvCode );
 191     HRESULT RestoreDefaultHandling( [in] long lEvCode );
 192     HRESULT FreeEventParams( [in] long lEvCode, [in] LONG_PTR lParam1, [in] LONG_PTR lParam2 );
 193 }
 194
 195
 196 /*****************************************************************************
 197  * IMediaEventEx interface
 198  */
 199 [
 200     object,
 201     uuid(56a868c0-0ad4-11ce-b03a-0020af0ba770),
 202     pointer_default(unique)
 203 ]
 204 interface IMediaEventEx : IMediaEvent
 205 {
 206     HRESULT SetNotifyWindow( [in] OAHWND hwnd, [in] long lMsg, [in] LONG_PTR lInstanceData );
 207     HRESULT SetNotifyFlags( [in] long lNoNotifyFlags );
 208     HRESULT GetNotifyFlags( [out] long *lplNoNotifyFlags );
 209 }
 210
 211
 212 /*****************************************************************************
 213  * IMediaPosition interface
 214  */
 215 [
 216     object,
 217     uuid(56a868b2-0ad4-11ce-b03a-0020af0ba770),
 218     pointer_default(unique)
 219 ]
 220 interface IMediaPosition : IDispatch
 221 {
 222     HRESULT get_Duration( [out] REFTIME *plength );
 223     HRESULT put_CurrentPosition( [in] REFTIME llTime );
 224     HRESULT get_CurrentPosition( [out] REFTIME *pllTime );
 225     HRESULT get_StopTime( [out] REFTIME *pllTime );
 226     HRESULT put_StopTime( [in] REFTIME llTime );
 227     HRESULT get_PrerollTime( [out] REFTIME *pllTime );
 228     HRESULT put_PrerollTime( [in] REFTIME llTime );
 229     HRESULT put_Rate( [in] double dRate );
 230     HRESULT get_Rate( [out] double *pdRate );
 231     HRESULT CanSeekForward( [out] LONG *pCanSeekForward );
 232     HRESULT CanSeekBackward( [out] LONG *pCanSeekBackward );
 233 }