background.c

Go to the documentation of this file.

/*
 * See Licensing and Copyright notice in naev.h
 */
#include "naev.h"
#include "background.h"
 
#include "array.h"
#include "camera.h"
#include "conf.h"
#include "log.h"
#include "gui.h"
#include "ndata.h"
#include "nebula.h"
#include "nlua.h"
#include "nlua_audio.h"
#include "nlua_bkg.h"
#include "nlua_colour.h"
#include "nlua_tex.h"
#include "nlua_camera.h"
#include "nlua_gfx.h"
#include "nluadef.h"
#include "nstring.h"
#include "nxml.h"
#include "opengl.h"
#include "pause.h"
#include "player.h"
#include "rng.h"
 
typedef struct background_image_s {
   unsigned int id; 
   glTexture *image; 
   double x; 
   double y; 
   double move; 
   double scale; 
   double angle; 
   glColour col; 
} background_image_t;
static background_image_t *bkg_image_arr_bk = NULL; 
static background_image_t *bkg_image_arr_ft = NULL; 
static unsigned int bkg_idgen = 0; 
static nlua_env bkg_cur_env = LUA_NOREF; 
static nlua_env bkg_def_env = LUA_NOREF; 
static int bkg_L_renderbg = LUA_NOREF; 
static int bkg_L_rendermg = LUA_NOREF; 
static int bkg_L_renderfg = LUA_NOREF; 
static int bkg_L_renderov = LUA_NOREF; 
/*
 * Background dust.
 */
#define STAR_BUF     250 
static gl_vbo *dust_vertexVBO = NULL; 
static unsigned int ndust = 0; 
static GLfloat dust_x = 0.; 
static GLfloat dust_y = 0.; 
/*
 * Prototypes.
 */
static void background_renderImages( background_image_t *bkg_arr );
static nlua_env background_create( const char *path );
static void background_clearCurrent (void);
static void background_clearImgArr( background_image_t **arr );
/* Sorting. */
static int bkg_compare( const void *p1, const void *p2 );
static void bkg_sort( background_image_t *arr );
 
void background_initDust( int n )
{
   GLfloat w, h, hw, hh;
   double size;
   GLfloat *dust_vertex;
 
   /* Calculate size. */
   size  = SCREEN_W*SCREEN_H+STAR_BUF*STAR_BUF;
   size /= pow2(conf.zoom_far);
 
   /* Calculate dust buffer. */
   w  = (SCREEN_W + 2.*STAR_BUF);
   w += (w / conf.zoom_far - 1.);
   h  = (SCREEN_H + 2.*STAR_BUF);
   h += (h / conf.zoom_far - 1.);
   hw = w / 2.;
   hh = h / 2.;
 
   /* Calculate dust. */
   size  *= n;
   ndust = (unsigned int)(size/(800.*600.));
 
   /* Create data. */
   dust_vertex = malloc( ndust * sizeof(GLfloat) * 3 );
 
   for (unsigned int i=0; i < ndust; i++) {
      /* Set the position. */
      dust_vertex[3*i+0] = RNGF()*w - hw;
      dust_vertex[3*i+1] = RNGF()*h - hh;
      /* Set the colour. */
      dust_vertex[3*i+2] = RNGF()*0.6 + 0.2;
   }
 
   /* Recreate VBO. */
   gl_vboDestroy( dust_vertexVBO );
   dust_vertexVBO = gl_vboCreateStatic(
         ndust * sizeof(GLfloat) * 3, dust_vertex );
 
   free(dust_vertex);
}
 
void background_moveDust( double x, double y )
{
   dust_x += (GLfloat) x;
   dust_y += (GLfloat) y;
}
 
void background_renderDust( const double dt )
{
   (void) dt;
   GLfloat h, w, m;
   double z, angle;
   mat4 projection;
   int points = 1;
 
   /* Do some scaling for now. */
   z = cam_getZoom();
   m = 1.;
   angle = 0.;
   projection = gl_view_matrix;
   mat4_translate( &projection, SCREEN_W/2., SCREEN_H/2., 0 );
   mat4_scale( &projection, z, z, 1 );
 
   /* Decide on shade mode. */
   if ((player.p != NULL) && !player_isFlag(PLAYER_DESTROYED) &&
         !player_isFlag(PLAYER_CREATING)) {
      double dx, dy, vmod;
 
      /* Get camera movement. */
      cam_getVel( &dx, &dy );
      vmod = hypot( dx, dy );
 
      if (pilot_isFlag(player.p,PILOT_HYPERSPACE)) { /* hyperspace fancy effects */
         /* lines get longer the closer we are to finishing the jump */
         m = MAX( 0, HYPERSPACE_DUST_BLUR-player.p->ptimer );
         if (m > 0.) {
            m *= HYPERSPACE_DUST_LENGTH / HYPERSPACE_DUST_BLUR;
            angle = atan2( dy, dx );
            points = 0;
         }
      }
      else if (dt_mod * vmod > 500. ) {
         angle = atan2( dy, dx );
         m = (dt_mod * vmod) / 25. - 20.;
         points = 0;
      }
   }
 
   /* Calculate some dimensions. */
   w  = (SCREEN_W + 2.*STAR_BUF);
   w += (w / conf.zoom_far - 1.);
   h  = (SCREEN_H + 2.*STAR_BUF);
   h += (h / conf.zoom_far - 1.);
 
   /* Common shader stuff. */
   glUseProgram(shaders.dust.program);
   gl_uniformMat4(shaders.dust.projection, &projection);
   glUniform2f(shaders.dust.offset_xy, dust_x, dust_y);
   if (points)
      glUniform3f(shaders.dust.dims, 2./gl_screen.scale, 0., 0.);
   else
      glUniform3f(shaders.dust.dims, MAX(1.,2.-m/20.)/gl_screen.scale, angle, m);
   glUniform3f(shaders.dust.screen, w, h, 1. / gl_screen.scale);
   glUniform1i(shaders.dust.use_lines, !points);
 
   /* Vertices. */
   glEnableVertexAttribArray( shaders.dust.vertex );
   glEnableVertexAttribArray( shaders.dust.brightness );
 
   /* Set up the vertices. */
   gl_vboActivateAttribOffset( dust_vertexVBO, shaders.dust.vertex, 0,
         2, GL_FLOAT, 3 * sizeof(GLfloat) );
   gl_vboActivateAttribOffset( dust_vertexVBO, shaders.dust.brightness, 2 * sizeof(GLfloat),
         1, GL_FLOAT, 3 * sizeof(GLfloat) );
   glDrawArrays( GL_POINTS, 0, ndust );
 
   /* Disable vertex array. */
   glDisableVertexAttribArray( shaders.dust.vertex );
   glDisableVertexAttribArray( shaders.dust.brightness );
 
   glUseProgram(0);
 
   /* Check for errors. */
   gl_checkErr();
}
 
void background_render( double dt )
{
   if (bkg_L_renderbg != LUA_NOREF) {
      lua_rawgeti( naevL, LUA_REGISTRYINDEX, bkg_L_renderbg );
      lua_pushnumber( naevL, dt ); /* Note that this is real_dt. */
      if (nlua_pcall( bkg_cur_env, 1, 0 )) {
         WARN( _("Background script 'renderbg' error:\n%s"), lua_tostring(naevL,-1));
         lua_pop( naevL, 1 );
      }
   }
 
   background_renderImages( bkg_image_arr_bk );
 
   if (bkg_L_rendermg != LUA_NOREF) {
      lua_rawgeti( naevL, LUA_REGISTRYINDEX, bkg_L_rendermg );
      lua_pushnumber( naevL, dt ); /* Note that this is real_dt. */
      if (nlua_pcall( bkg_cur_env, 1, 0 )) {
         WARN( _("Background script 'rendermg' error:\n%s"), lua_tostring(naevL,-1));
         lua_pop( naevL, 1 );
      }
   }
 
   background_renderDust(dt);
   background_renderImages( bkg_image_arr_ft );
 
   if (bkg_L_renderfg != LUA_NOREF) {
      lua_rawgeti( naevL, LUA_REGISTRYINDEX, bkg_L_renderfg );
      lua_pushnumber( naevL, dt ); /* Note that this is real_dt. */
      if (nlua_pcall( bkg_cur_env, 1, 0 )) {
         WARN( _("Background script 'renderfg' error:\n%s"), lua_tostring(naevL,-1));
         lua_pop( naevL, 1 );
      }
   }
}
 
void background_renderOverlay( double dt )
{
   if (bkg_L_renderov != LUA_NOREF) {
      lua_rawgeti( naevL, LUA_REGISTRYINDEX, bkg_L_renderov );
      lua_pushnumber( naevL, dt ); /* Note that this is real_dt. */
      if (nlua_pcall( bkg_cur_env, 1, 0 )) {
         WARN( _("Background script 'renderov' error:\n%s"), lua_tostring(naevL,-1));
         lua_pop( naevL, 1 );
      }
   }
}
 
static int bkg_compare( const void *p1, const void *p2 )
{
   background_image_t *bkg1, *bkg2;
 
   bkg1 = (background_image_t*) p1;
   bkg2 = (background_image_t*) p2;
 
   if (bkg1->move < bkg2->move)
      return -1;
   else if (bkg1->move > bkg2->move)
      return +1;
   return  0;
}
 
static void bkg_sort( background_image_t *arr )
{
   qsort( arr, array_size(arr), sizeof(background_image_t), bkg_compare );
}
 
unsigned int background_addImage( const glTexture *image, double x, double y,
      double move, double scale, double angle, const glColour *col, int foreground )
{
   background_image_t *bkg, **arr;
 
   if (foreground)
      arr = &bkg_image_arr_ft;
   else
      arr = &bkg_image_arr_bk;
 
   /* See if must create. */
   if (*arr == NULL)
      *arr = array_create( background_image_t );
 
   /* Create image. */
   bkg         = &array_grow( arr );
   bkg->id     = ++bkg_idgen;
   bkg->image  = gl_dupTexture(image);
   bkg->x      = x;
   bkg->y      = y;
   bkg->move   = move;
   bkg->scale  = scale;
   bkg->angle  = angle;
   bkg->col    = (col!=NULL) ? *col : cWhite;
 
   /* Sort if necessary. */
   bkg_sort( *arr );
 
   return bkg_idgen;
}
 
static void background_renderImages( background_image_t *bkg_arr )
{
   /* Skip rendering altogether if disabled. */
   if (conf.bg_brightness <= 0.)
      return;
 
   /* Render images in order. */
   for (int i=0; i<array_size(bkg_arr); i++) {
      double cx,cy, x,y, gx,gy, z, m;
      glColour col;
      background_image_t *bkg = &bkg_arr[i];
 
      cam_getPos( &cx, &cy );
      gui_getOffset( &gx, &gy );
      m = bkg->move;
      z = bkg->scale;
      x  = (bkg->x - cx) * m - z*bkg->image->sw/2. + gx + SCREEN_W/2.;
      y  = (bkg->y - cy) * m - z*bkg->image->sh/2. + gy + SCREEN_H/2.;
 
      col.r = bkg->col.r * conf.bg_brightness;
      col.g = bkg->col.g * conf.bg_brightness;
      col.b = bkg->col.b * conf.bg_brightness;
      col.a = bkg->col.a;
 
      gl_renderTexture( bkg->image, x, y, z*bkg->image->sw, z*bkg->image->sh, 0., 0., bkg->image->srw, bkg->image->srh, &col, bkg->angle );
   }
}
 
static nlua_env background_create( const char *name )
{
   size_t bufsize;
   char path[PATH_MAX];
   char *buf;
   nlua_env env;
 
   /* Create file name. */
   snprintf( path, sizeof(path), BACKGROUND_PATH"%s.lua", name );
 
   /* Create the Lua env. */
   env = nlua_newEnv();
   nlua_loadStandard(env);
   nlua_loadTex(env);
   nlua_loadCol(env);
   nlua_loadBackground(env);
   nlua_loadCamera(env);
   nlua_loadGFX(env);
 
   /* Open file. */
   buf = ndata_read( path, &bufsize );
   if (buf == NULL) {
      WARN( _("Background script '%s' not found."), path);
      nlua_freeEnv(env);
      return LUA_NOREF;
   }
 
   /* Load file. */
   if (nlua_dobufenv(env, buf, bufsize, path) != 0) {
      WARN( _("Error loading background file: %s\n"
            "%s\n"
            "Most likely Lua file has improper syntax, please check"),
            path, lua_tostring(naevL,-1));
      free(buf);
      nlua_freeEnv(env);
      return LUA_NOREF;
   }
   free(buf);
 
   return env;
}
 
int background_init (void)
{
   /* Load Lua. */
   bkg_def_env = background_create( "default" );
   return 0;
}
 
int background_load( const char *name )
{
   int ret;
   nlua_env env;
 
   /* Free if exists. */
   background_clear();
 
   /* Load default. */
   if (name == NULL)
      bkg_cur_env = bkg_def_env;
   /* Load new script. */
   else
      bkg_cur_env = background_create( name );
 
   /* Comfort. */
   env = bkg_cur_env;
   if (env == LUA_NOREF)
      return -1;
 
   /* Run Lua. */
   nlua_getenv(naevL, env,"background");
   ret = nlua_pcall(env, 0, 0);
   if (ret != 0) { /* error has occurred */
      const char *err = (lua_isstring(naevL,-1)) ? lua_tostring(naevL,-1) : NULL;
      WARN( _("Background -> 'background' : %s"),
            (err) ? err : _("unknown error"));
      lua_pop(naevL, 1);
   }
 
   /* See if there are render functions. */
   bkg_L_renderbg = nlua_refenv( env, "renderbg" );
   bkg_L_rendermg = nlua_refenv( env, "rendermg" );
   bkg_L_renderfg = nlua_refenv( env, "renderfg" );
   bkg_L_renderov = nlua_refenv( env, "renderov" );
 
   return ret;
}
 
static void background_clearCurrent (void)
{
   if (bkg_cur_env != bkg_def_env) {
      nlua_freeEnv( bkg_cur_env );
   }
   bkg_cur_env = LUA_NOREF;
 
   luaL_unref( naevL, LUA_REGISTRYINDEX, bkg_L_renderbg );
   luaL_unref( naevL, LUA_REGISTRYINDEX, bkg_L_rendermg );
   luaL_unref( naevL, LUA_REGISTRYINDEX, bkg_L_renderfg );
   luaL_unref( naevL, LUA_REGISTRYINDEX, bkg_L_renderov );
   bkg_L_renderbg = LUA_NOREF;
   bkg_L_rendermg = LUA_NOREF;
   bkg_L_renderfg = LUA_NOREF;
   bkg_L_renderov = LUA_NOREF;
}
 
void background_clear (void)
{
   /* Destroy current background script. */
   background_clearCurrent();
 
   /* Clear the backgrounds. */
   background_clearImgArr( &bkg_image_arr_bk );
   background_clearImgArr( &bkg_image_arr_ft );
}
 
static void background_clearImgArr( background_image_t **arr )
{
   for (int i=0; i<array_size(*arr); i++) {
      background_image_t *bkg = &((*arr)[i]);
      gl_freeTexture( bkg->image );
   }
 
   /* Erase it all. */
   array_erase( arr, array_begin(*arr), array_end(*arr) );
}
 
void background_free (void)
{
   /* Free the Lua. */
   background_clear();
   nlua_freeEnv( bkg_def_env );
   bkg_def_env = LUA_NOREF;
 
   /* Free the images. */
   array_free( bkg_image_arr_ft );
   bkg_image_arr_ft = NULL;
   array_free( bkg_image_arr_bk );
   bkg_image_arr_bk = NULL;
 
   /* Free the Lua. */
   nlua_freeEnv( bkg_cur_env );
   bkg_cur_env = LUA_NOREF;
 
   gl_vboDestroy( dust_vertexVBO );
   dust_vertexVBO = NULL;
 
   ndust = 0;
}
 
glTexture** background_getStarTextures (void)
{
  glTexture **imgs = array_create_size( glTexture*, array_size( bkg_image_arr_ft ));
  for (int i=0; i<array_size(bkg_image_arr_ft); i++)
    array_push_back( &imgs, gl_dupTexture(bkg_image_arr_ft[i].image) );
  return imgs;
}
 
glTexture* background_getAmbientTexture (void)
{
  /* Assume many bg-layer images => none is representative => we should return NULL. Example: Taiomi system's debris field. */
  if (array_size( bkg_image_arr_bk ) == 1)
    return gl_dupTexture(bkg_image_arr_bk[0].image);
  else
     return NULL;
}