]> de.git.xonotic.org Git - xonotic/darkplaces.git/blobdiff - cl_video.c
add DeviceLost and DeviceRestored functions to R_Modules system
[xonotic/darkplaces.git] / cl_video.c
index 8d44d9ae32fae036baa4e32b7c01d26622909b00..afba2119b5a968068258cc641b3c919f72ef2248 100644 (file)
@@ -1,8 +1,18 @@
 
 #include "quakedef.h"
+#include "cl_dyntexture.h"
 #include "cl_video.h"
 #include "dpvsimpledecode.h"
 
+// cvars
+cvar_t cl_video_subtitles = {CVAR_SAVE, "cl_video_subtitles", "0", "show subtitles for videos (if they are presented)"};
+cvar_t cl_video_subtitles_lines = {CVAR_SAVE, "cl_video_subtitles_lines", "4", "how many lines to occupy for subtitles"};
+cvar_t cl_video_subtitles_textsize = {CVAR_SAVE, "cl_video_subtitles_textsize", "16", "textsize for subtitles"};
+cvar_t cl_video_scale = {CVAR_SAVE, "cl_video_scale", "1", "scale of video, 1 = fullscreen, 0.75 - 3/4 of screen etc."};
+cvar_t cl_video_scale_vpos = {CVAR_SAVE, "cl_video_scale_vpos", "0", "vertial align of scaled video, -1 is top, 1 is bottom"};
+cvar_t cl_video_stipple = {CVAR_SAVE, "cl_video_stipple", "0", "draw interlacing-like effect on videos, similar to scr_stipple but static and used only with video playing."};
+cvar_t cl_video_brightness = {CVAR_SAVE, "cl_video_brightness", "1", "brightness of video, 1 = fullbright, 0.75 - 3/4 etc."};
+
 // constants (and semi-constants)
 static int  cl_videormask;
 static int  cl_videobmask;
@@ -34,15 +44,32 @@ static qboolean OpenStream( clvideo_t * video )
        return true;
 }
 
+static void VideoUpdateCallback(rtexture_t *rt, void *data) {
+       clvideo_t *video = (clvideo_t *) data;
+       R_UpdateTexture( video->cpif.tex, (unsigned char *)video->imagedata, 0, 0, video->cpif.width, video->cpif.height );
+}
+
+static void LinkVideoTexture( clvideo_t *video ) {
+       video->cpif.tex = R_LoadTexture2D( cl_videotexturepool, video->cpif.name,
+               video->cpif.width, video->cpif.height, NULL, TEXTYPE_BGRA, TEXF_PERSISTENT | TEXF_ALLOWUPDATES, -1, NULL );
+       R_MakeTextureDynamic( video->cpif.tex, VideoUpdateCallback, video );
+       CL_LinkDynTexture( video->cpif.name, video->cpif.tex );
+}
+
+static void UnlinkVideoTexture( clvideo_t *video ) {
+       CL_UnlinkDynTexture( video->cpif.name );
+       // free the texture
+       R_FreeTexture( video->cpif.tex );
+       // free the image data
+       Mem_Free( video->imagedata );
+}
+
 static void SuspendVideo( clvideo_t * video )
 {
        if( video->suspended )
                return;
        video->suspended = true;
-       // free the texture
-       R_FreeTexture( video->cpif.tex );
-       // free the image data
-       Mem_Free( video->imagedata );
+       UnlinkVideoTexture( video );
        // if we are in firstframe mode, also close the stream
        if( video->state == CLVIDEO_FIRSTFRAME )
                dpvsimpledecode_close( video->stream );
@@ -60,9 +87,8 @@ static qboolean WakeVideo( clvideo_t * video )
                        return false;
                }
 
-       video->imagedata = Mem_Alloc( cls.mempool, video->cpif.width * video->cpif.height * cl_videobytesperpixel );
-       video->cpif.tex = R_LoadTexture2D( cl_videotexturepool, video->cpif.name,
-               video->cpif.width, video->cpif.height, NULL, TEXTYPE_RGBA, 0, NULL );
+       video->imagedata = Mem_Alloc( cls.permanentmempool, video->cpif.width * video->cpif.height * cl_videobytesperpixel );
+       LinkVideoTexture( video );
 
        // update starttime
        video->starttime += realtime - video->lasttime;
@@ -70,13 +96,100 @@ static qboolean WakeVideo( clvideo_t * video )
        return true;
 }
 
-static clvideo_t* OpenVideo( clvideo_t *video, const char *filename, const char *name, int owner )
+static void LoadSubtitles( clvideo_t *video, const char *subtitlesfile )
+{
+       char *subtitle_text;
+       const char *data;
+       float subtime, sublen;
+       int numsubs = 0;
+
+       if (gamemode == GAME_BLOODOMNICIDE)
+       {
+               char overridename[MAX_QPATH];
+               cvar_t *langcvar;
+
+               langcvar = Cvar_FindVar("language");
+               subtitle_text = NULL;
+               if (langcvar)
+               {
+                       dpsnprintf(overridename, sizeof(overridename), "script/locale/%s/%s", langcvar->string, subtitlesfile);
+                       subtitle_text = (char *)FS_LoadFile(overridename, cls.permanentmempool, false, NULL);
+               }
+               if (!subtitle_text)
+                       subtitle_text = (char *)FS_LoadFile(subtitlesfile, cls.permanentmempool, false, NULL);
+       }
+       else
+       {
+               subtitle_text = (char *)FS_LoadFile(subtitlesfile, cls.permanentmempool, false, NULL);
+       }
+       if (!subtitle_text)
+       {
+               Con_DPrintf( "LoadSubtitles: can't open subtitle file '%s'!\n", subtitlesfile );
+               return;
+       }
+
+       // parse subtitle_text
+       // line is: x y "text" where
+       //    x - start time
+       //    y - seconds last (if 0 - last thru next sub, if negative - last to next sub - this amount of seconds)
+
+       data = subtitle_text;
+       for (;;)
+       {
+               if (!COM_ParseToken_QuakeC(&data, false))
+                       break;
+               subtime = atof( com_token );
+               if (!COM_ParseToken_QuakeC(&data, false))
+                       break;
+               sublen = atof( com_token );
+               if (!COM_ParseToken_QuakeC(&data, false))
+                       break;
+               if (!com_token[0])
+                       continue;
+               // check limits
+               if (video->subtitles == CLVIDEO_MAX_SUBTITLES)
+               {
+                       Con_Printf("WARNING: CLVIDEO_MAX_SUBTITLES = %i reached when reading subtitles from '%s'\n", CLVIDEO_MAX_SUBTITLES, subtitlesfile);
+                       break;  
+               }
+               // add a sub
+               video->subtitle_text[numsubs] = (char *) Mem_Alloc(cls.permanentmempool, strlen(com_token) + 1);
+               memcpy(video->subtitle_text[numsubs], com_token, strlen(com_token) + 1);
+               video->subtitle_start[numsubs] = subtime;
+               video->subtitle_end[numsubs] = sublen;
+               if (numsubs > 0) // make true len for prev sub, autofix overlapping subtitles
+               {
+                       if (video->subtitle_end[numsubs-1] <= 0)
+                               video->subtitle_end[numsubs-1] = max(video->subtitle_start[numsubs-1], video->subtitle_start[numsubs] + video->subtitle_end[numsubs-1]);
+                       else
+                               video->subtitle_end[numsubs-1] = min(video->subtitle_start[numsubs-1] + video->subtitle_end[numsubs-1], video->subtitle_start[numsubs]);
+               }
+               numsubs++;
+               // todo: check timing for consistency?
+       }
+       if (numsubs > 0) // make true len for prev sub, autofix overlapping subtitles
+       {
+               if (video->subtitle_end[numsubs-1] <= 0)
+                       video->subtitle_end[numsubs-1] = 99999999; // fixme: make it end when video ends?
+               else
+                       video->subtitle_end[numsubs-1] = video->subtitle_start[numsubs-1] + video->subtitle_end[numsubs-1];
+       }
+       Z_Free( subtitle_text );
+       video->subtitles = numsubs;
+/*
+       Con_Printf( "video->subtitles: %i\n", video->subtitles );
+       for (numsubs = 0; numsubs < video->subtitles; numsubs++)
+               Con_Printf( "  %03.2f %03.2f : %s\n", video->subtitle_start[numsubs], video->subtitle_end[numsubs], video->subtitle_text[numsubs] );
+*/
+}
+
+static clvideo_t* OpenVideo( clvideo_t *video, const char *filename, const char *name, int owner, const char *subtitlesfile )
 {
-       strncpy( video->filename, filename, MAX_QPATH );
+       strlcpy( video->filename, filename, sizeof(video->filename) );
        video->ownertag = owner;
        if( strncmp( name, CLVIDEOPREFIX, sizeof( CLVIDEOPREFIX ) - 1 ) )
                return NULL;
-       strncpy( video->cpif.name, name, MAX_QPATH );
+       strlcpy( video->cpif.name, name, sizeof(video->cpif.name) );
 
        if( !OpenStream( video ) )
                return NULL;
@@ -85,30 +198,39 @@ static clvideo_t* OpenVideo( clvideo_t *video, const char *filename, const char
        video->framenum = -1;
        video->framerate = dpvsimpledecode_getframerate( video->stream );
        video->lasttime = realtime;
+       video->subtitles = 0;
 
        video->cpif.width = dpvsimpledecode_getwidth( video->stream );
        video->cpif.height = dpvsimpledecode_getheight( video->stream );
-       video->cpif.tex = R_LoadTexture2D( cl_videotexturepool, video->cpif.name,
-               video->cpif.width, video->cpif.height, NULL, TEXTYPE_RGBA, 0, NULL );
+       video->imagedata = Mem_Alloc( cls.permanentmempool, video->cpif.width * video->cpif.height * cl_videobytesperpixel );
+       LinkVideoTexture( video );
 
-    video->imagedata = Mem_Alloc( cls.mempool, video->cpif.width * video->cpif.height * cl_videobytesperpixel );
+       // VorteX: load simple subtitle_text file
+       if (subtitlesfile[0])
+               LoadSubtitles( video, subtitlesfile );
 
        return video;
 }
 
-clvideo_t* CL_OpenVideo( const char *filename, const char *name, int owner )
+clvideo_t* CL_OpenVideo( const char *filename, const char *name, int owner, const char *subtitlesfile )
 {
        clvideo_t *video;
+       // sanity check
+       if( !name || !*name || strncmp( name, CLVIDEOPREFIX, sizeof( CLVIDEOPREFIX ) - 1 ) != 0 ) {
+               Con_DPrintf( "CL_OpenVideo: Bad video texture name '%s'!\n", name );
+               return NULL;
+       }
 
        video = FindUnusedVid();
        if( !video ) {
-               Con_Printf( "unable to open video \"%s\" - video limit reached\n", filename );
+               Con_Printf( "CL_OpenVideo: unable to open video \"%s\" - video limit reached\n", filename );
                return NULL;
        }
-       video = OpenVideo( video, filename, name, owner );
+       video = OpenVideo( video, filename, name, owner, subtitlesfile );
        // expand the active range to include the new entry
-       if (video)
+       if (video) {
                cl_num_videos = max(cl_num_videos, (int)(video - cl_videos) + 1);
+       }
        return video;
 }
 
@@ -169,14 +291,20 @@ void CL_RestartVideo( clvideo_t *video )
 
 void CL_CloseVideo( clvideo_t * video )
 {
+       int i;
+
        if( !video || video->state == CLVIDEO_UNUSED )
                return;
 
        if( !video->suspended || video->state != CLVIDEO_FIRSTFRAME )
                dpvsimpledecode_close( video->stream );
-       if( !video->suspended ) {
-               Mem_Free( video->imagedata );
-               R_FreeTexture( video->cpif.tex );
+       if( !video->suspended )
+               UnlinkVideoTexture( video );
+       if (video->subtitles)
+       {
+               for (i = 0; i < video->subtitles; i++)
+                       Z_Free( video->subtitle_text[i] );
+               video->subtitles = 0;
        }
 
        video->state = CLVIDEO_UNUSED;
@@ -189,7 +317,7 @@ static void VideoFrame( clvideo_t *video )
        if( video->state == CLVIDEO_FIRSTFRAME )
                destframe = 0;
        else
-               destframe = (realtime - video->starttime) * video->framerate;
+               destframe = (int)((realtime - video->starttime) * video->framerate);
        if( destframe < 0 )
                destframe = 0;
        if( video->framenum < destframe ) {
@@ -205,11 +333,11 @@ static void VideoFrame( clvideo_t *video )
                                return;
                        }
                } while( video->framenum < destframe );
-               R_UpdateTexture( video->cpif.tex, (unsigned char *)video->imagedata );
+               R_MarkDirtyTexture( video->cpif.tex );
        }
 }
 
-void CL_VideoFrame( void ) // update all videos
+void CL_Video_Frame( void ) // update all videos
 {
        int i;
        clvideo_t *video;
@@ -251,21 +379,135 @@ void CL_PurgeOwner( int owner )
                        CL_CloseVideo( &cl_videos[ i ] );
 }
 
+typedef struct
+{
+       dp_font_t *font;
+       float x;
+       float y;
+       float width;
+       float height;
+       float alignment; // 0 = left, 0.5 = center, 1 = right
+       float fontsize;
+       float textalpha;
+}
+cl_video_subtitle_info_t;
+
+float CL_DrawVideo_WordWidthFunc(void *passthrough, const char *w, size_t *length, float maxWidth)
+{
+       cl_video_subtitle_info_t *si = (cl_video_subtitle_info_t *) passthrough;
+
+       if(w == NULL)
+               return si->fontsize * si->font->maxwidth;
+       if(maxWidth >= 0)
+               return DrawQ_TextWidth_UntilWidth(w, length, si->fontsize, si->fontsize, false, si->font, -maxWidth); // -maxWidth: we want at least one char
+       else if(maxWidth == -1)
+               return DrawQ_TextWidth(w, *length, si->fontsize, si->fontsize, false, si->font);
+       else
+               return 0;
+}
+
+int CL_DrawVideo_DisplaySubtitleLine(void *passthrough, const char *line, size_t length, float width, qboolean isContinuation)
+{
+       cl_video_subtitle_info_t *si = (cl_video_subtitle_info_t *) passthrough;
+
+       int x = (int) (si->x + (si->width - width) * si->alignment);
+       if (length > 0)
+               DrawQ_String(x, si->y, line, length, si->fontsize, si->fontsize, 1.0, 1.0, 1.0, si->textalpha, 0, NULL, false, si->font);
+       si->y += si->fontsize;
+       return 1;
+}
+
 int cl_videoplaying = false; // old, but still supported
 
 void CL_DrawVideo(void)
 {
-       if (cl_videoplaying)
-               DrawQ_Pic(0, 0, &CL_GetVideoBySlot( 0 )->cpif, vid_conwidth.integer, vid_conheight.integer, 1, 1, 1, 1, 0);
+       clvideo_t *video;
+       float videotime;
+       cl_video_subtitle_info_t si;
+       int i;
+
+       if (!cl_videoplaying)
+               return;
+
+       video = CL_GetVideoBySlot( 0 );
+
+       // fix cvars
+       if (cl_video_scale.value <= 0 || cl_video_scale.value > 1)
+               Cvar_SetValueQuick( &cl_video_scale, 1);
+       if (cl_video_brightness.value <= 0 || cl_video_brightness.value > 10)
+               Cvar_SetValueQuick( &cl_video_brightness, 1);
+
+       // draw black bg in case stipple is active or video is scaled
+       if (cl_video_stipple.integer || cl_video_scale.value != 1)
+               DrawQ_Fill(0, 0, vid_conwidth.integer, vid_conheight.integer, 0, 0, 0, 1, 0);
+
+       // enable video-only polygon stipple (of global stipple is not active)
+       if (qglPolygonStipple && !scr_stipple.integer && cl_video_stipple.integer)
+       {
+               GLubyte stipple[128];
+               int i, s, width, parts;
+       
+               s = cl_video_stipple.integer;
+               parts = (s & 007);
+               width = (s & 070) >> 3;
+               qglEnable(GL_POLYGON_STIPPLE);CHECKGLERROR // 0x0B42
+               for(i = 0; i < 128; ++i)
+               {
+                       int line = i/4;
+                       stipple[i] = ((line >> width) & ((1 << parts) - 1)) ? 0x00 : 0xFF;
+               }
+               qglPolygonStipple(stipple);CHECKGLERROR
+       }
+
+       // draw video
+       if (cl_video_scale.value == 1)
+               DrawQ_Pic(0, 0, &video->cpif, vid_conwidth.integer, vid_conheight.integer, cl_video_brightness.value, cl_video_brightness.value, cl_video_brightness.value, 1, 0);
+       else
+       {
+               int px = (int)(vid_conwidth.integer * (1 - cl_video_scale.value) * 0.5);
+               int py = (int)(vid_conheight.integer * (1 - cl_video_scale.value) * ((bound(-1, cl_video_scale_vpos.value, 1) + 1) / 2));
+               int sx = (int)(vid_conwidth.integer * cl_video_scale.value);
+               int sy = (int)(vid_conheight.integer * cl_video_scale.value);
+               DrawQ_Pic(px, py, &video->cpif, sx , sy, cl_video_brightness.value, cl_video_brightness.value, cl_video_brightness.value, 1, 0);
+       }
+
+       // disable video-only stipple
+       if (qglPolygonStipple && !scr_stipple.integer && cl_video_stipple.integer)
+               qglDisable(GL_POLYGON_STIPPLE);CHECKGLERROR
+
+       // VorteX: draw subtitle_text
+       if (!video->subtitles || !cl_video_subtitles.integer)
+               return;
+
+       // find current subtitle
+       videotime = realtime - video->starttime;
+       for (i = 0; i < video->subtitles; i++)
+       {
+               if (videotime >= video->subtitle_start[i] && videotime <= video->subtitle_end[i])
+               {
+                       // found, draw it
+                       si.font = FONT_NOTIFY;
+                       si.x = vid_conwidth.integer * 0.1;
+                       si.y = vid_conheight.integer - (max(1, cl_video_subtitles_lines.value) * cl_video_subtitles_textsize.value);
+                       si.width = vid_conwidth.integer * 0.8;
+                       si.height = max(1, cl_video_subtitles_lines.integer) * cl_video_subtitles_textsize.value;
+                       si.alignment = 0.5;
+                       si.fontsize = cl_video_subtitles_textsize.value;
+                       si.textalpha = min(1, (videotime - video->subtitle_start[i])/0.5) * min(1, ((video->subtitle_end[i] - videotime)/0.3)); // fade in and fade out
+                       COM_Wordwrap(video->subtitle_text[i], strlen(video->subtitle_text[i]), 0, si.width, CL_DrawVideo_WordWidthFunc, &si, CL_DrawVideo_DisplaySubtitleLine, &si);
+                       break;
+               }
+       }
 }
 
-void CL_VideoStart(char *filename)
+void CL_VideoStart(char *filename, const char *subtitlesfile)
 {
        Host_StartVideo();
 
        if( cl_videos->state != CLVIDEO_UNUSED )
                CL_CloseVideo( cl_videos );
-       if( !OpenVideo( cl_videos, filename, va( CLVIDEOPREFIX "%s", filename ), 0 ) )
+       // already contains video/
+       if( !OpenVideo( cl_videos, filename, va( CLDYNTEXTUREPREFIX "%s", filename ), 0, subtitlesfile ) )
                return;
        // expand the active range to include the new entry
        cl_num_videos = max(cl_num_videos, 1);
@@ -276,6 +518,16 @@ void CL_VideoStart(char *filename)
        CL_RestartVideo( cl_videos );
 }
 
+void CL_Video_KeyEvent( int key, int ascii, qboolean down ) 
+{
+       // only react to up events, to allow the user to delay the abortion point if it suddenly becomes interesting..
+       if( !down ) {
+               if( key == K_ESCAPE || key == K_ENTER || key == K_SPACE ) {
+                       CL_VideoStop();
+               }
+       }
+}
+
 void CL_VideoStop(void)
 {
        cl_videoplaying = false;
@@ -285,18 +537,24 @@ void CL_VideoStop(void)
 
 static void CL_PlayVideo_f(void)
 {
-       char name[MAX_QPATH];
+       char name[MAX_QPATH], subtitlesfile[MAX_QPATH];
 
        Host_StartVideo();
 
-       if (Cmd_Argc() != 2)
+       if (Cmd_Argc() < 2)
        {
-               Con_Print("usage: playvideo <videoname>\nplays video named video/<videoname>.dpv\n");
+               Con_Print("usage: playvideo <videoname> [custom_subtitles_file]\nplays video named video/<videoname>.dpv\nif custom subtitles file is not presented\nit tries video/<videoname>.sub");
                return;
        }
 
-       sprintf(name, "video/%s.dpv", Cmd_Argv(1));
-       CL_VideoStart(name);
+       dpsnprintf(name, sizeof(name), "video/%s.dpv", Cmd_Argv(1));
+       if ( Cmd_Argc() > 2)
+               CL_VideoStart(name, Cmd_Argv(2));
+       else
+       {
+               dpsnprintf(subtitlesfile, sizeof(subtitlesfile), "video/%s.dpsubs", Cmd_Argv(1));
+               CL_VideoStart(name, subtitlesfile);
+       }
 }
 
 static void CL_StopVideo_f(void)
@@ -313,12 +571,12 @@ static void cl_video_start( void )
 
        for( video = cl_videos, i = 0 ; i < cl_num_videos ; i++, video++ )
                if( video->state != CLVIDEO_UNUSED && !video->suspended )
-                       video->cpif.tex = R_LoadTexture2D( cl_videotexturepool, video->cpif.name,
-                               video->cpif.width, video->cpif.height, NULL, TEXTYPE_RGBA, 0, NULL );
+                       LinkVideoTexture( video );
 }
 
 static void cl_video_shutdown( void )
 {
+       // TODO: unlink video textures?
        R_FreeTexturePool( &cl_videotexturepool );
 }
 
@@ -328,15 +586,32 @@ static void cl_video_newmap( void )
 
 void CL_Video_Init( void )
 {
+       union
+       {
+               unsigned char b[4];
+               unsigned int i;
+       }
+       bgra;
+
        cl_num_videos = 0;
        cl_videobytesperpixel = 4;
-       cl_videormask = BigLong(0xFF000000);
-       cl_videogmask = BigLong(0x00FF0000);
-       cl_videobmask = BigLong(0x0000FF00);
+
+       // set masks in an endian-independent way (as they really represent bytes)
+       bgra.i = 0;bgra.b[0] = 0xFF;cl_videobmask = bgra.i;
+       bgra.i = 0;bgra.b[1] = 0xFF;cl_videogmask = bgra.i;
+       bgra.i = 0;bgra.b[2] = 0xFF;cl_videormask = bgra.i;
 
        Cmd_AddCommand( "playvideo", CL_PlayVideo_f, "play a .dpv video file" );
        Cmd_AddCommand( "stopvideo", CL_StopVideo_f, "stop playing a .dpv video file" );
 
-       R_RegisterModule( "CL_Video", cl_video_start, cl_video_shutdown, cl_video_newmap );
+       Cvar_RegisterVariable(&cl_video_subtitles);
+       Cvar_RegisterVariable(&cl_video_subtitles_lines);
+       Cvar_RegisterVariable(&cl_video_subtitles_textsize);
+       Cvar_RegisterVariable(&cl_video_scale);
+       Cvar_RegisterVariable(&cl_video_scale_vpos);
+       Cvar_RegisterVariable(&cl_video_brightness);
+       Cvar_RegisterVariable(&cl_video_stipple);
+
+       R_RegisterModule( "CL_Video", cl_video_start, cl_video_shutdown, cl_video_newmap, NULL, NULL );
 }