cl_video.h

   1
   2 #ifndef CL_VIDEO_H
   3 #define CL_VIDEO_H
   4
   5 #include "cl_dyntexture.h"
   6
   7 // yields DYNAMIC_TEXTURE_PATH_PREFIX CLVIDEOPREFIX video name for a path
   8 #define CLVIDEOPREFIX   CLDYNTEXTUREPREFIX "video/"
   9 #define CLTHRESHOLD             2.0
  10
  11 #define MENUOWNER               1
  12
  13 typedef enum clvideostate_e
  14 {
  15         CLVIDEO_UNUSED,
  16         CLVIDEO_PLAY,
  17         CLVIDEO_LOOP,
  18         CLVIDEO_PAUSE,
  19         CLVIDEO_FIRSTFRAME,
  20         CLVIDEO_RESETONWAKEUP,
  21         CLVIDEO_STATECOUNT
  22 } clvideostate_t;
  23
  24 #define CLVIDEO_MAX_SUBTITLES 512
  25
  26 extern cvar_t cl_video_subtitles;
  27 extern cvar_t cl_video_subtitles_lines;
  28 extern cvar_t cl_video_subtitles_textsize;
  29 extern cvar_t cl_video_scale;
  30 extern cvar_t cl_video_scale_vpos;
  31 extern cvar_t cl_video_stipple;
  32 extern cvar_t cl_video_brightness;
  33 extern cvar_t cl_video_keepaspectratio;
  34
  35 typedef struct clvideo_s
  36 {
  37         int             ownertag;
  38         clvideostate_t state;
  39
  40         // private stuff
  41         void    *stream;
  42
  43         double  starttime;
  44         int             framenum;
  45         double  framerate;
  46
  47         void    *imagedata;
  48
  49         cachepic_t cpif;
  50
  51         // VorteX: subtitles array
  52         int             subtitles;
  53         char    *subtitle_text[CLVIDEO_MAX_SUBTITLES];
  54         float   subtitle_start[CLVIDEO_MAX_SUBTITLES];
  55         float   subtitle_end[CLVIDEO_MAX_SUBTITLES];
  56
  57         // this functions gets filled by video format module
  58         void (*close) (void *stream);
  59         unsigned int (*getwidth) (void *stream);
  60         unsigned int (*getheight) (void *stream);
  61         double (*getframerate) (void *stream);
  62         int (*decodeframe) (void *stream, void *imagedata, unsigned int Rmask, unsigned int Gmask, unsigned int Bmask, unsigned int bytesperpixel, int imagebytesperrow);
  63
  64         // if a video is suspended, it is automatically paused (else we'd still have to process the frames)
  65         // used to determine whether the video's resources should be freed or not
  66     double  lasttime;
  67         // when lasttime - realtime > THRESHOLD, all but the stream is freed
  68         qboolean suspended;
  69
  70         char    filename[MAX_QPATH];
  71 } clvideo_t;
  72
  73 clvideo_t*      CL_OpenVideo( const char *filename, const char *name, int owner, const char *subtitlesfile );
  74 clvideo_t*      CL_GetVideoByName( const char *name );
  75 void            CL_SetVideoState( clvideo_t *video, clvideostate_t state );
  76 void            CL_RestartVideo( clvideo_t *video );
  77
  78 void            CL_CloseVideo( clvideo_t * video );
  79 void            CL_PurgeOwner( int owner );
  80
  81 void            CL_Video_Frame( void ); // update all videos
  82 void            CL_Video_Init( void );
  83 void            CL_Video_Shutdown( void );
  84
  85 // old interface
  86 extern int cl_videoplaying;
  87
  88 void CL_DrawVideo( void );
  89 void CL_VideoStart( char *filename, const char *subtitlesfile );
  90 void CL_VideoStop( void );
  91
  92 // new function used for fullscreen videos
  93 // TODO: Andreas Kirsch: move this subsystem somewhere else (preferably host) since the cl_video system shouldnt do such work like managing key events..
  94 void CL_Video_KeyEvent( int key, int ascii, qboolean down );
  95
  96 #endif