src/mesa/main/texenvprogram.c

   1 /**************************************************************************
   2  *
   3  * Copyright 2007 Tungsten Graphics, Inc., Cedar Park, Texas.
   4  * All Rights Reserved.
   5  *
   6  * Permission is hereby granted, free of charge, to any person obtaining a
   7  * copy of this software and associated documentation files (the
   8  * "Software"), to deal in the Software without restriction, including
   9  * without limitation the rights to use, copy, modify, merge, publish,
  10  * distribute, sub license, and/or sell copies of the Software, and to
  11  * permit persons to whom the Software is furnished to do so, subject to
  12  * the following conditions:
  13  *
  14  * The above copyright notice and this permission notice (including the
  15  * next paragraph) shall be included in all copies or substantial portions
  16  * of the Software.
  17  *
  18  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
  19  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  20  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT.
  21  * IN NO EVENT SHALL TUNGSTEN GRAPHICS AND/OR ITS SUPPLIERS BE LIABLE FOR
  22  * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
  23  * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
  24  * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  25  *
  26  **************************************************************************/
  27
  28 #include "glheader.h"
  29 #include "macros.h"
  30 #include "enums.h"
  31 #include "shader/program.h"
  32 #include "shader/prog_parameter.h"
  33 #include "shader/prog_cache.h"
  34 #include "shader/prog_instruction.h"
  35 #include "shader/prog_print.h"
  36 #include "shader/prog_statevars.h"
  37 #include "shader/programopt.h"
  38 #include "texenvprogram.h"
  39
  40
  41 struct texenvprog_cache_item
  42 {
  43    GLuint hash;
  44    void *key;
  45    struct gl_fragment_program *data;
  46    struct texenvprog_cache_item *next;
  47 };
  48
  49
  50 /**
  51  * This MAX is probably a bit generous, but that's OK.  There can be
  52  * up to four instructions per texture unit (TEX + 3 for combine),
  53  * then there's fog and specular add.
  54  */
  55 #define MAX_INSTRUCTIONS ((MAX_TEXTURE_UNITS * 4) + 12)
  56
  57 #define DISASSEM (MESA_VERBOSE & VERBOSE_DISASSEM)
  58
  59 struct mode_opt {
  60    GLuint Source:4;
  61    GLuint Operand:3;
  62 };
  63
  64 struct state_key {
  65    GLbitfield enabled_units;
  66    GLuint separate_specular:1;
  67    GLuint fog_enabled:1;
  68    GLuint fog_mode:2;
  69
  70    struct {
  71       GLuint enabled:1;
  72       GLuint source_index:3;   /* one of TEXTURE_1D/2D/3D/CUBE/RECT_INDEX */
  73       GLuint shadow:1;
  74       GLuint ScaleShiftRGB:2;
  75       GLuint ScaleShiftA:2;
  76
  77       GLuint NumArgsRGB:2;
  78       GLuint ModeRGB:4;
  79       struct mode_opt OptRGB[3];
  80
  81       GLuint NumArgsA:2;
  82       GLuint ModeA:4;
  83       struct mode_opt OptA[3];
  84    } unit[8];
  85 };
  86
  87 #define FOG_LINEAR  0
  88 #define FOG_EXP     1
  89 #define FOG_EXP2    2
  90 #define FOG_UNKNOWN 3
  91
  92 static GLuint translate_fog_mode( GLenum mode )
  93 {
  94    switch (mode) {
  95    case GL_LINEAR: return FOG_LINEAR;
  96    case GL_EXP: return FOG_EXP;
  97    case GL_EXP2: return FOG_EXP2;
  98    default: return FOG_UNKNOWN;
  99    }
 100 }
 101
 102 #define OPR_SRC_COLOR           0
 103 #define OPR_ONE_MINUS_SRC_COLOR 1
 104 #define OPR_SRC_ALPHA           2
 105 #define OPR_ONE_MINUS_SRC_ALPHA 3
 106 #define OPR_ZERO                4
 107 #define OPR_ONE                 5
 108 #define OPR_UNKNOWN             7
 109
 110 static GLuint translate_operand( GLenum operand )
 111 {
 112    switch (operand) {
 113    case GL_SRC_COLOR: return OPR_SRC_COLOR;
 114    case GL_ONE_MINUS_SRC_COLOR: return OPR_ONE_MINUS_SRC_COLOR;
 115    case GL_SRC_ALPHA: return OPR_SRC_ALPHA;
 116    case GL_ONE_MINUS_SRC_ALPHA: return OPR_ONE_MINUS_SRC_ALPHA;
 117    case GL_ZERO: return OPR_ZERO;
 118    case GL_ONE: return OPR_ONE;
 119    default:     return OPR_UNKNOWN;
 120    }
 121 }
 122
 123 #define SRC_TEXTURE  0
 124 #define SRC_TEXTURE0 1
 125 #define SRC_TEXTURE1 2
 126 #define SRC_TEXTURE2 3
 127 #define SRC_TEXTURE3 4
 128 #define SRC_TEXTURE4 5
 129 #define SRC_TEXTURE5 6
 130 #define SRC_TEXTURE6 7
 131 #define SRC_TEXTURE7 8
 132 #define SRC_CONSTANT 9
 133 #define SRC_PRIMARY_COLOR 10
 134 #define SRC_PREVIOUS 11
 135 #define SRC_UNKNOWN  15
 136
 137 static GLuint translate_source( GLenum src )
 138 {
 139    switch (src) {
 140    case GL_TEXTURE: return SRC_TEXTURE;
 141    case GL_TEXTURE0:
 142    case GL_TEXTURE1:
 143    case GL_TEXTURE2:
 144    case GL_TEXTURE3:
 145    case GL_TEXTURE4:
 146    case GL_TEXTURE5:
 147    case GL_TEXTURE6:
 148    case GL_TEXTURE7: return SRC_TEXTURE0 + (src - GL_TEXTURE0);
 149    case GL_CONSTANT: return SRC_CONSTANT;
 150    case GL_PRIMARY_COLOR: return SRC_PRIMARY_COLOR;
 151    case GL_PREVIOUS: return SRC_PREVIOUS;
 152    default: return SRC_UNKNOWN;
 153    }
 154 }
 155
 156 #define MODE_REPLACE       0
 157 #define MODE_MODULATE      1
 158 #define MODE_ADD           2
 159 #define MODE_ADD_SIGNED    3
 160 #define MODE_INTERPOLATE   4
 161 #define MODE_SUBTRACT      5
 162 #define MODE_DOT3_RGB      6
 163 #define MODE_DOT3_RGB_EXT  7
 164 #define MODE_DOT3_RGBA     8
 165 #define MODE_DOT3_RGBA_EXT 9
 166 #define MODE_MODULATE_ADD_ATI           10
 167 #define MODE_MODULATE_SIGNED_ADD_ATI    11
 168 #define MODE_MODULATE_SUBTRACT_ATI      12
 169 #define MODE_UNKNOWN       15
 170
 171 static GLuint translate_mode( GLenum mode )
 172 {
 173    switch (mode) {
 174    case GL_REPLACE: return MODE_REPLACE;
 175    case GL_MODULATE: return MODE_MODULATE;
 176    case GL_ADD: return MODE_ADD;
 177    case GL_ADD_SIGNED: return MODE_ADD_SIGNED;
 178    case GL_INTERPOLATE: return MODE_INTERPOLATE;
 179    case GL_SUBTRACT: return MODE_SUBTRACT;
 180    case GL_DOT3_RGB: return MODE_DOT3_RGB;
 181    case GL_DOT3_RGB_EXT: return MODE_DOT3_RGB_EXT;
 182    case GL_DOT3_RGBA: return MODE_DOT3_RGBA;
 183    case GL_DOT3_RGBA_EXT: return MODE_DOT3_RGBA_EXT;
 184    case GL_MODULATE_ADD_ATI: return MODE_MODULATE_ADD_ATI;
 185    case GL_MODULATE_SIGNED_ADD_ATI: return MODE_MODULATE_SIGNED_ADD_ATI;
 186    case GL_MODULATE_SUBTRACT_ATI: return MODE_MODULATE_SUBTRACT_ATI;
 187    default: return MODE_UNKNOWN;
 188    }
 189 }
 190
 191 #define TEXTURE_UNKNOWN_INDEX 7
 192 static GLuint translate_tex_src_bit( GLbitfield bit )
 193 {
 194    switch (bit) {
 195    case TEXTURE_1D_BIT:   return TEXTURE_1D_INDEX;
 196    case TEXTURE_2D_BIT:   return TEXTURE_2D_INDEX;
 197    case TEXTURE_RECT_BIT: return TEXTURE_RECT_INDEX;
 198    case TEXTURE_3D_BIT:   return TEXTURE_3D_INDEX;
 199    case TEXTURE_CUBE_BIT: return TEXTURE_CUBE_INDEX;
 200    default: return TEXTURE_UNKNOWN_INDEX;
 201    }
 202 }
 203
 204 /**
 205  * Examine current texture environment state and generate a unique
 206  * key to identify it.
 207  */
 208 static void make_state_key( GLcontext *ctx,  struct state_key *key )
 209 {
 210    GLuint i, j;
 211
 212    memset(key, 0, sizeof(*key));
 213
 214    for (i=0;i<MAX_TEXTURE_UNITS;i++) {
 215       const struct gl_texture_unit *texUnit = &ctx->Texture.Unit[i];
 216
 217       if (!texUnit->_ReallyEnabled || !texUnit->Enabled)
 218          continue;
 219
 220       key->unit[i].enabled = 1;
 221       key->enabled_units |= (1<<i);
 222
 223       key->unit[i].source_index =
 224          translate_tex_src_bit(texUnit->_ReallyEnabled);
 225       key->unit[i].shadow = texUnit->_Current->CompareMode == GL_COMPARE_R_TO_TEXTURE;
 226
 227       key->unit[i].NumArgsRGB = texUnit->_CurrentCombine->_NumArgsRGB;
 228       key->unit[i].NumArgsA = texUnit->_CurrentCombine->_NumArgsA;
 229
 230       key->unit[i].ModeRGB =
 231          translate_mode(texUnit->_CurrentCombine->ModeRGB);
 232       key->unit[i].ModeA =
 233          translate_mode(texUnit->_CurrentCombine->ModeA);
 234
 235       key->unit[i].ScaleShiftRGB = texUnit->_CurrentCombine->ScaleShiftRGB;
 236       key->unit[i].ScaleShiftA = texUnit->_CurrentCombine->ScaleShiftA;
 237
 238       for (j=0;j<3;j++) {
 239          key->unit[i].OptRGB[j].Operand =
 240             translate_operand(texUnit->_CurrentCombine->OperandRGB[j]);
 241          key->unit[i].OptA[j].Operand =
 242             translate_operand(texUnit->_CurrentCombine->OperandA[j]);
 243          key->unit[i].OptRGB[j].Source =
 244             translate_source(texUnit->_CurrentCombine->SourceRGB[j]);
 245          key->unit[i].OptA[j].Source =
 246             translate_source(texUnit->_CurrentCombine->SourceA[j]);
 247       }
 248    }
 249
 250    if (ctx->_TriangleCaps & DD_SEPARATE_SPECULAR)
 251       key->separate_specular = 1;
 252
 253    if (ctx->Fog.Enabled) {
 254       key->fog_enabled = 1;
 255       key->fog_mode = translate_fog_mode(ctx->Fog.Mode);
 256    }
 257 }
 258
 259 /* Use uregs to represent registers internally, translate to Mesa's
 260  * expected formats on emit.
 261  *
 262  * NOTE: These are passed by value extensively in this file rather
 263  * than as usual by pointer reference.  If this disturbs you, try
 264  * remembering they are just 32bits in size.
 265  *
 266  * GCC is smart enough to deal with these dword-sized structures in
 267  * much the same way as if I had defined them as dwords and was using
 268  * macros to access and set the fields.  This is much nicer and easier
 269  * to evolve.
 270  */
 271 struct ureg {
 272    GLuint file:4;
 273    GLuint idx:8;
 274    GLuint negatebase:1;
 275    GLuint abs:1;
 276    GLuint negateabs:1;
 277    GLuint swz:12;
 278    GLuint pad:5;
 279 };
 280
 281 static const struct ureg undef = {
 282    PROGRAM_UNDEFINED,
 283    ~0,
 284    0,
 285    0,
 286    0,
 287    0,
 288    0
 289 };
 290
 291
 292 /* State used to build the fragment program:
 293  */
 294 struct texenv_fragment_program {
 295    struct gl_fragment_program *program;
 296    GLcontext *ctx;
 297    struct state_key *state;
 298
 299    GLbitfield alu_temps;        /* Track texture indirections, see spec. */
 300    GLbitfield temps_output;     /* Track texture indirections, see spec. */
 301    GLbitfield temp_in_use;      /* Tracks temporary regs which are in use. */
 302    GLboolean error;
 303
 304    struct ureg src_texture[MAX_TEXTURE_UNITS];
 305    /* Reg containing each texture unit's sampled texture color,
 306     * else undef.
 307     */
 308
 309    struct ureg src_previous;    /* Reg containing color from previous
 310                                  * stage.  May need to be decl'd.
 311                                  */
 312
 313    GLuint last_tex_stage;       /* Number of last enabled texture unit */
 314
 315    struct ureg half;
 316    struct ureg one;
 317    struct ureg zero;
 318 };
 319
 320
 321
 322 static struct ureg make_ureg(GLuint file, GLuint idx)
 323 {
 324    struct ureg reg;
 325    reg.file = file;
 326    reg.idx = idx;
 327    reg.negatebase = 0;
 328    reg.abs = 0;
 329    reg.negateabs = 0;
 330    reg.swz = SWIZZLE_NOOP;
 331    reg.pad = 0;
 332    return reg;
 333 }
 334
 335 static struct ureg swizzle( struct ureg reg, int x, int y, int z, int w )
 336 {
 337    reg.swz = MAKE_SWIZZLE4(GET_SWZ(reg.swz, x),
 338                            GET_SWZ(reg.swz, y),
 339                            GET_SWZ(reg.swz, z),
 340                            GET_SWZ(reg.swz, w));
 341
 342    return reg;
 343 }
 344
 345 static struct ureg swizzle1( struct ureg reg, int x )
 346 {
 347    return swizzle(reg, x, x, x, x);
 348 }
 349
 350 static struct ureg negate( struct ureg reg )
 351 {
 352    reg.negatebase ^= 1;
 353    return reg;
 354 }
 355
 356 static GLboolean is_undef( struct ureg reg )
 357 {
 358    return reg.file == PROGRAM_UNDEFINED;
 359 }
 360
 361
 362 static struct ureg get_temp( struct texenv_fragment_program *p )
 363 {
 364    GLint bit;
 365
 366    /* First try and reuse temps which have been used already:
 367     */
 368    bit = _mesa_ffs( ~p->temp_in_use & p->alu_temps );
 369
 370    /* Then any unused temporary:
 371     */
 372    if (!bit)
 373       bit = _mesa_ffs( ~p->temp_in_use );
 374
 375    if (!bit) {
 376       _mesa_problem(NULL, "%s: out of temporaries\n", __FILE__);
 377       _mesa_exit(1);
 378    }
 379
 380    if ((GLuint) bit > p->program->Base.NumTemporaries)
 381       p->program->Base.NumTemporaries = bit;
 382
 383    p->temp_in_use |= 1<<(bit-1);
 384    return make_ureg(PROGRAM_TEMPORARY, (bit-1));
 385 }
 386
 387 static struct ureg get_tex_temp( struct texenv_fragment_program *p )
 388 {
 389    int bit;
 390
 391    /* First try to find available temp not previously used (to avoid
 392     * starting a new texture indirection).  According to the spec, the
 393     * ~p->temps_output isn't necessary, but will keep it there for
 394     * now:
 395     */
 396    bit = _mesa_ffs( ~p->temp_in_use & ~p->alu_temps & ~p->temps_output );
 397
 398    /* Then any unused temporary:
 399     */
 400    if (!bit)
 401       bit = _mesa_ffs( ~p->temp_in_use );
 402
 403    if (!bit) {
 404       _mesa_problem(NULL, "%s: out of temporaries\n", __FILE__);
 405       _mesa_exit(1);
 406    }
 407
 408    if ((GLuint) bit > p->program->Base.NumTemporaries)
 409       p->program->Base.NumTemporaries = bit;
 410
 411    p->temp_in_use |= 1<<(bit-1);
 412    return make_ureg(PROGRAM_TEMPORARY, (bit-1));
 413 }
 414
 415
 416 static void release_temps(GLcontext *ctx, struct texenv_fragment_program *p )
 417 {
 418    GLuint max_temp = ctx->Const.FragmentProgram.MaxTemps;
 419
 420    /* KW: To support tex_env_crossbar, don't release the registers in
 421     * temps_output.
 422     */
 423    if (max_temp >= sizeof(int) * 8)
 424       p->temp_in_use = p->temps_output;
 425    else
 426       p->temp_in_use = ~((1<<max_temp)-1) | p->temps_output;
 427 }
 428
 429
 430 static struct ureg register_param5( struct texenv_fragment_program *p,
 431                                     GLint s0,
 432                                     GLint s1,
 433                                     GLint s2,
 434                                     GLint s3,
 435                                     GLint s4)
 436 {
 437    gl_state_index tokens[STATE_LENGTH];
 438    GLuint idx;
 439    tokens[0] = s0;
 440    tokens[1] = s1;
 441    tokens[2] = s2;
 442    tokens[3] = s3;
 443    tokens[4] = s4;
 444    idx = _mesa_add_state_reference( p->program->Base.Parameters, tokens );
 445    return make_ureg(PROGRAM_STATE_VAR, idx);
 446 }
 447
 448
 449 #define register_param1(p,s0)          register_param5(p,s0,0,0,0,0)
 450 #define register_param2(p,s0,s1)       register_param5(p,s0,s1,0,0,0)
 451 #define register_param3(p,s0,s1,s2)    register_param5(p,s0,s1,s2,0,0)
 452 #define register_param4(p,s0,s1,s2,s3) register_param5(p,s0,s1,s2,s3,0)
 453
 454
 455 static struct ureg register_input( struct texenv_fragment_program *p, GLuint input )
 456 {
 457    p->program->Base.InputsRead |= (1 << input);
 458    return make_ureg(PROGRAM_INPUT, input);
 459 }
 460
 461
 462 static void emit_arg( struct prog_src_register *reg,
 463                       struct ureg ureg )
 464 {
 465    reg->File = ureg.file;
 466    reg->Index = ureg.idx;
 467    reg->Swizzle = ureg.swz;
 468    reg->NegateBase = ureg.negatebase ? 0xf : 0x0;
 469    reg->Abs = ureg.abs;
 470    reg->NegateAbs = ureg.negateabs;
 471 }
 472
 473 static void emit_dst( struct prog_dst_register *dst,
 474                       struct ureg ureg, GLuint mask )
 475 {
 476    dst->File = ureg.file;
 477    dst->Index = ureg.idx;
 478    dst->WriteMask = mask;
 479    dst->CondMask = COND_TR;  /* always pass cond test */
 480    dst->CondSwizzle = SWIZZLE_NOOP;
 481 }
 482
 483 static struct prog_instruction *
 484 emit_op(struct texenv_fragment_program *p,
 485         enum prog_opcode op,
 486         struct ureg dest,
 487         GLuint mask,
 488         GLboolean saturate,
 489         struct ureg src0,
 490         struct ureg src1,
 491         struct ureg src2 )
 492 {
 493    GLuint nr = p->program->Base.NumInstructions++;
 494    struct prog_instruction *inst = &p->program->Base.Instructions[nr];
 495
 496    assert(nr < MAX_INSTRUCTIONS);
 497
 498    _mesa_init_instructions(inst, 1);
 499    inst->Opcode = op;
 500
 501    emit_arg( &inst->SrcReg[0], src0 );
 502    emit_arg( &inst->SrcReg[1], src1 );
 503    emit_arg( &inst->SrcReg[2], src2 );
 504
 505    inst->SaturateMode = saturate ? SATURATE_ZERO_ONE : SATURATE_OFF;
 506
 507    emit_dst( &inst->DstReg, dest, mask );
 508
 509    /* Accounting for indirection tracking:
 510     */
 511    if (dest.file == PROGRAM_TEMPORARY)
 512       p->temps_output |= 1 << dest.idx;
 513
 514    return inst;
 515 }
 516
 517
 518 static struct ureg emit_arith( struct texenv_fragment_program *p,
 519                                enum prog_opcode op,
 520                                struct ureg dest,
 521                                GLuint mask,
 522                                GLboolean saturate,
 523                                struct ureg src0,
 524                                struct ureg src1,
 525                                struct ureg src2 )
 526 {
 527    emit_op(p, op, dest, mask, saturate, src0, src1, src2);
 528
 529    /* Accounting for indirection tracking:
 530     */
 531    if (src0.file == PROGRAM_TEMPORARY)
 532       p->alu_temps |= 1 << src0.idx;
 533
 534    if (!is_undef(src1) && src1.file == PROGRAM_TEMPORARY)
 535       p->alu_temps |= 1 << src1.idx;
 536
 537    if (!is_undef(src2) && src2.file == PROGRAM_TEMPORARY)
 538       p->alu_temps |= 1 << src2.idx;
 539
 540    if (dest.file == PROGRAM_TEMPORARY)
 541       p->alu_temps |= 1 << dest.idx;
 542
 543    p->program->Base.NumAluInstructions++;
 544    return dest;
 545 }
 546
 547 static struct ureg emit_texld( struct texenv_fragment_program *p,
 548                                enum prog_opcode op,
 549                                struct ureg dest,
 550                                GLuint destmask,
 551                                GLuint tex_unit,
 552                                GLuint tex_idx,
 553                                struct ureg coord )
 554 {
 555    struct prog_instruction *inst = emit_op( p, op,
 556                                           dest, destmask,
 557                                           GL_FALSE,     /* don't saturate? */
 558                                           coord,        /* arg 0? */
 559                                           undef,
 560                                           undef);
 561
 562    inst->TexSrcTarget = tex_idx;
 563    inst->TexSrcUnit = tex_unit;
 564
 565    p->program->Base.NumTexInstructions++;
 566
 567    /* Is this a texture indirection?
 568     */
 569    if ((coord.file == PROGRAM_TEMPORARY &&
 570         (p->temps_output & (1<<coord.idx))) ||
 571        (dest.file == PROGRAM_TEMPORARY &&
 572         (p->alu_temps & (1<<dest.idx)))) {
 573       p->program->Base.NumTexIndirections++;
 574       p->temps_output = 1<<coord.idx;
 575       p->alu_temps = 0;
 576       assert(0);                /* KW: texture env crossbar */
 577    }
 578
 579    return dest;
 580 }
 581
 582
 583 static struct ureg register_const4f( struct texenv_fragment_program *p,
 584                                      GLfloat s0,
 585                                      GLfloat s1,
 586                                      GLfloat s2,
 587                                      GLfloat s3)
 588 {
 589    GLfloat values[4];
 590    GLuint idx, swizzle;
 591    struct ureg r;
 592    values[0] = s0;
 593    values[1] = s1;
 594    values[2] = s2;
 595    values[3] = s3;
 596    idx = _mesa_add_unnamed_constant( p->program->Base.Parameters, values, 4,
 597                                      &swizzle );
 598    r = make_ureg(PROGRAM_CONSTANT, idx);
 599    r.swz = swizzle;
 600    return r;
 601 }
 602
 603 #define register_scalar_const(p, s0)    register_const4f(p, s0, s0, s0, s0)
 604 #define register_const1f(p, s0)         register_const4f(p, s0, 0, 0, 1)
 605 #define register_const2f(p, s0, s1)     register_const4f(p, s0, s1, 0, 1)
 606 #define register_const3f(p, s0, s1, s2) register_const4f(p, s0, s1, s2, 1)
 607
 608
 609 static struct ureg get_one( struct texenv_fragment_program *p )
 610 {
 611    if (is_undef(p->one))
 612       p->one = register_scalar_const(p, 1.0);
 613    return p->one;
 614 }
 615
 616 static struct ureg get_half( struct texenv_fragment_program *p )
 617 {
 618    if (is_undef(p->half))
 619       p->half = register_scalar_const(p, 0.5);
 620    return p->half;
 621 }
 622
 623 static struct ureg get_zero( struct texenv_fragment_program *p )
 624 {
 625    if (is_undef(p->zero))
 626       p->zero = register_scalar_const(p, 0.0);
 627    return p->zero;
 628 }
 629
 630
 631 static void program_error( struct texenv_fragment_program *p, const char *msg )
 632 {
 633    _mesa_problem(NULL, msg);
 634    p->error = 1;
 635 }
 636
 637 static struct ureg get_source( struct texenv_fragment_program *p,
 638                                GLuint src, GLuint unit )
 639 {
 640    switch (src) {
 641    case SRC_TEXTURE:
 642       assert(!is_undef(p->src_texture[unit]));
 643       return p->src_texture[unit];
 644
 645    case SRC_TEXTURE0:
 646    case SRC_TEXTURE1:
 647    case SRC_TEXTURE2:
 648    case SRC_TEXTURE3:
 649    case SRC_TEXTURE4:
 650    case SRC_TEXTURE5:
 651    case SRC_TEXTURE6:
 652    case SRC_TEXTURE7:
 653       assert(!is_undef(p->src_texture[src - SRC_TEXTURE0]));
 654       return p->src_texture[src - SRC_TEXTURE0];
 655
 656    case SRC_CONSTANT:
 657       return register_param2(p, STATE_TEXENV_COLOR, unit);
 658
 659    case SRC_PRIMARY_COLOR:
 660       return register_input(p, FRAG_ATTRIB_COL0);
 661
 662    case SRC_PREVIOUS:
 663    default:
 664       if (is_undef(p->src_previous))
 665          return register_input(p, FRAG_ATTRIB_COL0);
 666       else
 667          return p->src_previous;
 668    }
 669 }
 670
 671 static struct ureg emit_combine_source( struct texenv_fragment_program *p,
 672                                         GLuint mask,
 673                                         GLuint unit,
 674                                         GLuint source,
 675                                         GLuint operand )
 676 {
 677    struct ureg arg, src, one;
 678
 679    src = get_source(p, source, unit);
 680
 681    switch (operand) {
 682    case OPR_ONE_MINUS_SRC_COLOR:
 683       /* Get unused tmp,
 684        * Emit tmp = 1.0 - arg.xyzw
 685        */
 686       arg = get_temp( p );
 687       one = get_one( p );
 688       return emit_arith( p, OPCODE_SUB, arg, mask, 0, one, src, undef);
 689
 690    case OPR_SRC_ALPHA:
 691       if (mask == WRITEMASK_W)
 692          return src;
 693       else
 694          return swizzle1( src, SWIZZLE_W );
 695    case OPR_ONE_MINUS_SRC_ALPHA:
 696       /* Get unused tmp,
 697        * Emit tmp = 1.0 - arg.wwww
 698        */
 699       arg = get_temp(p);
 700       one = get_one(p);
 701       return emit_arith(p, OPCODE_SUB, arg, mask, 0,
 702                         one, swizzle1(src, SWIZZLE_W), undef);
 703    case OPR_ZERO:
 704       return get_zero(p);
 705    case OPR_ONE:
 706       return get_one(p);
 707    case OPR_SRC_COLOR:
 708    default:
 709       return src;
 710    }
 711 }
 712
 713 static GLboolean args_match( struct state_key *key, GLuint unit )
 714 {
 715    GLuint i, nr = key->unit[unit].NumArgsRGB;
 716
 717    for (i = 0 ; i < nr ; i++) {
 718       if (key->unit[unit].OptA[i].Source != key->unit[unit].OptRGB[i].Source)
 719          return GL_FALSE;
 720
 721       switch(key->unit[unit].OptA[i].Operand) {
 722       case OPR_SRC_ALPHA:
 723          switch(key->unit[unit].OptRGB[i].Operand) {
 724          case OPR_SRC_COLOR:
 725          case OPR_SRC_ALPHA:
 726             break;
 727          default:
 728             return GL_FALSE;
 729          }
 730          break;
 731       case OPR_ONE_MINUS_SRC_ALPHA:
 732          switch(key->unit[unit].OptRGB[i].Operand) {
 733          case OPR_ONE_MINUS_SRC_COLOR:
 734          case OPR_ONE_MINUS_SRC_ALPHA:
 735             break;
 736          default:
 737             return GL_FALSE;
 738          }
 739          break;
 740       default:
 741          return GL_FALSE;       /* impossible */
 742       }
 743    }
 744
 745    return GL_TRUE;
 746 }
 747
 748 static struct ureg emit_combine( struct texenv_fragment_program *p,
 749                                  struct ureg dest,
 750                                  GLuint mask,
 751                                  GLboolean saturate,
 752                                  GLuint unit,
 753                                  GLuint nr,
 754                                  GLuint mode,
 755                                  const struct mode_opt *opt)
 756 {
 757    struct ureg src[3];
 758    struct ureg tmp, half;
 759    GLuint i;
 760
 761    tmp = undef; /* silence warning (bug 5318) */
 762
 763    for (i = 0; i < nr; i++)
 764       src[i] = emit_combine_source( p, mask, unit, opt[i].Source, opt[i].Operand );
 765
 766    switch (mode) {
 767    case MODE_REPLACE:
 768       if (mask == WRITEMASK_XYZW && !saturate)
 769          return src[0];
 770       else
 771          return emit_arith( p, OPCODE_MOV, dest, mask, saturate, src[0], undef, undef );
 772    case MODE_MODULATE:
 773       return emit_arith( p, OPCODE_MUL, dest, mask, saturate,
 774                          src[0], src[1], undef );
 775    case MODE_ADD:
 776       return emit_arith( p, OPCODE_ADD, dest, mask, saturate,
 777                          src[0], src[1], undef );
 778    case MODE_ADD_SIGNED:
 779       /* tmp = arg0 + arg1
 780        * result = tmp - .5
 781        */
 782       half = get_half(p);
 783       tmp = get_temp( p );
 784       emit_arith( p, OPCODE_ADD, tmp, mask, 0, src[0], src[1], undef );
 785       emit_arith( p, OPCODE_SUB, dest, mask, saturate, tmp, half, undef );
 786       return dest;
 787    case MODE_INTERPOLATE:
 788       /* Arg0 * (Arg2) + Arg1 * (1-Arg2) -- note arguments are reordered:
 789        */
 790       return emit_arith( p, OPCODE_LRP, dest, mask, saturate, src[2], src[0], src[1] );
 791
 792    case MODE_SUBTRACT:
 793       return emit_arith( p, OPCODE_SUB, dest, mask, saturate, src[0], src[1], undef );
 794
 795    case MODE_DOT3_RGBA:
 796    case MODE_DOT3_RGBA_EXT:
 797    case MODE_DOT3_RGB_EXT:
 798    case MODE_DOT3_RGB: {
 799       struct ureg tmp0 = get_temp( p );
 800       struct ureg tmp1 = get_temp( p );
 801       struct ureg neg1 = register_scalar_const(p, -1);
 802       struct ureg two  = register_scalar_const(p, 2);
 803
 804       /* tmp0 = 2*src0 - 1
 805        * tmp1 = 2*src1 - 1
 806        *
 807        * dst = tmp0 dot3 tmp1
 808        */
 809       emit_arith( p, OPCODE_MAD, tmp0, WRITEMASK_XYZW, 0,
 810                   two, src[0], neg1);
 811
 812       if (_mesa_memcmp(&src[0], &src[1], sizeof(struct ureg)) == 0)
 813          tmp1 = tmp0;
 814       else
 815          emit_arith( p, OPCODE_MAD, tmp1, WRITEMASK_XYZW, 0,
 816                      two, src[1], neg1);
 817       emit_arith( p, OPCODE_DP3, dest, mask, saturate, tmp0, tmp1, undef);
 818       return dest;
 819    }
 820    case MODE_MODULATE_ADD_ATI:
 821       /* Arg0 * Arg2 + Arg1 */
 822       return emit_arith( p, OPCODE_MAD, dest, mask, saturate,
 823                          src[0], src[2], src[1] );
 824    case MODE_MODULATE_SIGNED_ADD_ATI: {
 825       /* Arg0 * Arg2 + Arg1 - 0.5 */
 826       struct ureg tmp0 = get_temp(p);
 827       half = get_half(p);
 828       emit_arith( p, OPCODE_MAD, tmp0, mask, 0, src[0], src[2], src[1] );
 829       emit_arith( p, OPCODE_SUB, dest, mask, saturate, tmp0, half, undef );
 830       return dest;
 831    }
 832    case MODE_MODULATE_SUBTRACT_ATI:
 833       /* Arg0 * Arg2 - Arg1 */
 834       emit_arith( p, OPCODE_MAD, dest, mask, 0, src[0], src[2], negate(src[1]) );
 835       return dest;
 836    default:
 837       return src[0];
 838    }
 839 }
 840
 841
 842 /**
 843  * Generate instructions for one texture unit's env/combiner mode.
 844  */
 845 static struct ureg
 846 emit_texenv(struct texenv_fragment_program *p, GLuint unit)
 847 {
 848    struct state_key *key = p->state;
 849    GLboolean saturate = (unit < p->last_tex_stage);
 850    GLuint rgb_shift, alpha_shift;
 851    struct ureg out, shift;
 852    struct ureg dest;
 853
 854    if (!key->unit[unit].enabled) {
 855       return get_source(p, SRC_PREVIOUS, 0);
 856    }
 857
 858    switch (key->unit[unit].ModeRGB) {
 859    case MODE_DOT3_RGB_EXT:
 860       alpha_shift = key->unit[unit].ScaleShiftA;
 861       rgb_shift = 0;
 862       break;
 863    case MODE_DOT3_RGBA_EXT:
 864       alpha_shift = 0;
 865       rgb_shift = 0;
 866       break;
 867    default:
 868       rgb_shift = key->unit[unit].ScaleShiftRGB;
 869       alpha_shift = key->unit[unit].ScaleShiftA;
 870       break;
 871    }
 872
 873    /* If this is the very last calculation, emit direct to output reg:
 874     */
 875    if (key->separate_specular ||
 876        unit != p->last_tex_stage ||
 877        alpha_shift ||
 878        rgb_shift)
 879       dest = get_temp( p );
 880    else
 881       dest = make_ureg(PROGRAM_OUTPUT, FRAG_RESULT_COLR);
 882
 883    /* Emit the RGB and A combine ops
 884     */
 885    if (key->unit[unit].ModeRGB == key->unit[unit].ModeA &&
 886        args_match(key, unit)) {
 887       out = emit_combine( p, dest, WRITEMASK_XYZW, saturate,
 888                           unit,
 889                           key->unit[unit].NumArgsRGB,
 890                           key->unit[unit].ModeRGB,
 891                           key->unit[unit].OptRGB);
 892    }
 893    else if (key->unit[unit].ModeRGB == MODE_DOT3_RGBA_EXT ||
 894             key->unit[unit].ModeRGB == MODE_DOT3_RGBA) {
 895
 896       out = emit_combine( p, dest, WRITEMASK_XYZW, saturate,
 897                           unit,
 898                           key->unit[unit].NumArgsRGB,
 899                           key->unit[unit].ModeRGB,
 900                           key->unit[unit].OptRGB);
 901    }
 902    else {
 903       /* Need to do something to stop from re-emitting identical
 904        * argument calculations here:
 905        */
 906       out = emit_combine( p, dest, WRITEMASK_XYZ, saturate,
 907                           unit,
 908                           key->unit[unit].NumArgsRGB,
 909                           key->unit[unit].ModeRGB,
 910                           key->unit[unit].OptRGB);
 911       out = emit_combine( p, dest, WRITEMASK_W, saturate,
 912                           unit,
 913                           key->unit[unit].NumArgsA,
 914                           key->unit[unit].ModeA,
 915                           key->unit[unit].OptA);
 916    }
 917
 918    /* Deal with the final shift:
 919     */
 920    if (alpha_shift || rgb_shift) {
 921       if (rgb_shift == alpha_shift) {
 922          shift = register_scalar_const(p, (GLfloat)(1<<rgb_shift));
 923       }
 924       else {
 925          shift = register_const4f(p,
 926                                   (GLfloat)(1<<rgb_shift),
 927                                   (GLfloat)(1<<rgb_shift),
 928                                   (GLfloat)(1<<rgb_shift),
 929                                   (GLfloat)(1<<alpha_shift));
 930       }
 931       return emit_arith( p, OPCODE_MUL, dest, WRITEMASK_XYZW,
 932                          saturate, out, shift, undef );
 933    }
 934    else
 935       return out;
 936 }
 937
 938
 939 /**
 940  * Generate instruction for getting a texture source term.
 941  */
 942 static void load_texture( struct texenv_fragment_program *p, GLuint unit )
 943 {
 944    if (is_undef(p->src_texture[unit])) {
 945       GLuint dim = p->state->unit[unit].source_index;
 946       struct ureg texcoord = register_input(p, FRAG_ATTRIB_TEX0+unit);
 947       struct ureg tmp = get_tex_temp( p );
 948
 949       if (dim == TEXTURE_UNKNOWN_INDEX)
 950          program_error(p, "TexSrcBit");
 951
 952       /* TODO: Use D0_MASK_XY where possible.
 953        */
 954       if (p->state->unit[unit].enabled) {
 955          p->src_texture[unit] = emit_texld( p, OPCODE_TXP,
 956                                             tmp, WRITEMASK_XYZW,
 957                                             unit, dim, texcoord );
 958
 959          if (p->state->unit[unit].shadow)
 960             p->program->Base.ShadowSamplers |= 1 << unit;
 961
 962          p->program->Base.SamplersUsed |= (1 << unit);
 963          /* This identity mapping should already be in place
 964           * (see _mesa_init_program_struct()) but let's be safe.
 965           */
 966          p->program->Base.SamplerUnits[unit] = unit;
 967       }
 968       else
 969          p->src_texture[unit] = get_zero(p);
 970    }
 971 }
 972
 973 static GLboolean load_texenv_source( struct texenv_fragment_program *p,
 974                                      GLuint src, GLuint unit )
 975 {
 976    switch (src) {
 977    case SRC_TEXTURE:
 978       load_texture(p, unit);
 979       break;
 980
 981    case SRC_TEXTURE0:
 982    case SRC_TEXTURE1:
 983    case SRC_TEXTURE2:
 984    case SRC_TEXTURE3:
 985    case SRC_TEXTURE4:
 986    case SRC_TEXTURE5:
 987    case SRC_TEXTURE6:
 988    case SRC_TEXTURE7:
 989       load_texture(p, src - SRC_TEXTURE0);
 990       break;
 991
 992    default:
 993       break;
 994    }
 995
 996    return GL_TRUE;
 997 }
 998
 999
1000 /**
1001  * Generate instructions for loading all texture source terms.
1002  */
1003 static GLboolean
1004 load_texunit_sources( struct texenv_fragment_program *p, int unit )
1005 {
1006    struct state_key *key = p->state;
1007    GLuint i;
1008
1009    for (i = 0; i < key->unit[unit].NumArgsRGB; i++) {
1010       load_texenv_source( p, key->unit[unit].OptRGB[i].Source, unit);
1011    }
1012
1013    for (i = 0; i < key->unit[unit].NumArgsA; i++) {
1014       load_texenv_source( p, key->unit[unit].OptA[i].Source, unit );
1015    }
1016
1017    return GL_TRUE;
1018 }
1019
1020
1021 /**
1022  * Generate a new fragment program which implements the context's
1023  * current texture env/combine mode.
1024  */
1025 static void
1026 create_new_program(GLcontext *ctx, struct state_key *key,
1027                    struct gl_fragment_program *program)
1028 {
1029    struct prog_instruction instBuffer[MAX_INSTRUCTIONS];
1030    struct texenv_fragment_program p;
1031    GLuint unit;
1032    struct ureg cf, out;
1033
1034    _mesa_memset(&p, 0, sizeof(p));
1035    p.ctx = ctx;
1036    p.state = key;
1037    p.program = program;
1038
1039    /* During code generation, use locally-allocated instruction buffer,
1040     * then alloc dynamic storage below.
1041     */
1042    p.program->Base.Instructions = instBuffer;
1043    p.program->Base.Target = GL_FRAGMENT_PROGRAM_ARB;
1044    p.program->Base.NumTexIndirections = 1;      /* correct? */
1045    p.program->Base.NumTexInstructions = 0;
1046    p.program->Base.NumAluInstructions = 0;
1047    p.program->Base.String = NULL;
1048    p.program->Base.NumInstructions =
1049    p.program->Base.NumTemporaries =
1050    p.program->Base.NumParameters =
1051    p.program->Base.NumAttributes = p.program->Base.NumAddressRegs = 0;
1052    p.program->Base.Parameters = _mesa_new_parameter_list();
1053
1054    p.program->Base.InputsRead = 0;
1055    p.program->Base.OutputsWritten = 1 << FRAG_RESULT_COLR;
1056
1057    for (unit = 0; unit < MAX_TEXTURE_UNITS; unit++)
1058       p.src_texture[unit] = undef;
1059
1060    p.src_previous = undef;
1061    p.half = undef;
1062    p.zero = undef;
1063    p.one = undef;
1064
1065    p.last_tex_stage = 0;
1066    release_temps(ctx, &p);
1067
1068    if (key->enabled_units) {
1069       /* First pass - to support texture_env_crossbar, first identify
1070        * all referenced texture sources and emit texld instructions
1071        * for each:
1072        */
1073       for (unit = 0 ; unit < ctx->Const.MaxTextureUnits ; unit++)
1074          if (key->unit[unit].enabled) {
1075             load_texunit_sources( &p, unit );
1076             p.last_tex_stage = unit;
1077          }
1078
1079       /* Second pass - emit combine instructions to build final color:
1080        */
1081       for (unit = 0 ; unit < ctx->Const.MaxTextureUnits; unit++)
1082          if (key->enabled_units & (1<<unit)) {
1083             p.src_previous = emit_texenv( &p, unit );
1084             release_temps(ctx, &p);     /* release all temps */
1085          }
1086    }
1087
1088    cf = get_source( &p, SRC_PREVIOUS, 0 );
1089    out = make_ureg( PROGRAM_OUTPUT, FRAG_RESULT_COLR );
1090
1091    if (key->separate_specular) {
1092       /* Emit specular add.
1093        */
1094       struct ureg s = register_input(&p, FRAG_ATTRIB_COL1);
1095       emit_arith( &p, OPCODE_ADD, out, WRITEMASK_XYZ, 0, cf, s, undef );
1096       emit_arith( &p, OPCODE_MOV, out, WRITEMASK_W, 0, cf, undef, undef );
1097    }
1098    else if (_mesa_memcmp(&cf, &out, sizeof(cf)) != 0) {
1099       /* Will wind up in here if no texture enabled or a couple of
1100        * other scenarios (GL_REPLACE for instance).
1101        */
1102       emit_arith( &p, OPCODE_MOV, out, WRITEMASK_XYZW, 0, cf, undef, undef );
1103    }
1104
1105    /* Finish up:
1106     */
1107    emit_arith( &p, OPCODE_END, undef, WRITEMASK_XYZW, 0, undef, undef, undef);
1108
1109    if (key->fog_enabled) {
1110       /* Pull fog mode from GLcontext, the value in the state key is
1111        * a reduced value and not what is expected in FogOption
1112        */
1113       p.program->FogOption = ctx->Fog.Mode;
1114       p.program->Base.InputsRead |= FRAG_BIT_FOGC; /* XXX new */
1115    } else
1116       p.program->FogOption = GL_NONE;
1117
1118    if (p.program->Base.NumTexIndirections > ctx->Const.FragmentProgram.MaxTexIndirections)
1119       program_error(&p, "Exceeded max nr indirect texture lookups");
1120
1121    if (p.program->Base.NumTexInstructions > ctx->Const.FragmentProgram.MaxTexInstructions)
1122       program_error(&p, "Exceeded max TEX instructions");
1123
1124    if (p.program->Base.NumAluInstructions > ctx->Const.FragmentProgram.MaxAluInstructions)
1125       program_error(&p, "Exceeded max ALU instructions");
1126
1127    ASSERT(p.program->Base.NumInstructions <= MAX_INSTRUCTIONS);
1128
1129    /* Allocate final instruction array */
1130    p.program->Base.Instructions
1131       = _mesa_alloc_instructions(p.program->Base.NumInstructions);
1132    if (!p.program->Base.Instructions) {
1133       _mesa_error(ctx, GL_OUT_OF_MEMORY,
1134                   "generating tex env program");
1135       return;
1136    }
1137    _mesa_copy_instructions(p.program->Base.Instructions, instBuffer,
1138                            p.program->Base.NumInstructions);
1139
1140    if (p.program->FogOption) {
1141       _mesa_append_fog_code(ctx, p.program);
1142       p.program->FogOption = GL_NONE;
1143    }
1144
1145
1146    /* Notify driver the fragment program has (actually) changed.
1147     */
1148    if (ctx->Driver.ProgramStringNotify) {
1149       ctx->Driver.ProgramStringNotify( ctx, GL_FRAGMENT_PROGRAM_ARB,
1150                                        &p.program->Base );
1151    }
1152
1153    if (DISASSEM) {
1154       _mesa_print_program(&p.program->Base);
1155       _mesa_printf("\n");
1156    }
1157 }
1158
1159
1160 /**
1161  * Return a fragment program which implements the current
1162  * fixed-function texture, fog and color-sum operations.
1163  */
1164 struct gl_fragment_program *
1165 _mesa_get_fixed_func_fragment_program(GLcontext *ctx)
1166 {
1167    struct gl_fragment_program *prog;
1168    struct state_key key;
1169
1170    make_state_key(ctx, &key);
1171
1172    prog = (struct gl_fragment_program *)
1173       _mesa_search_program_cache(ctx->FragmentProgram.Cache,
1174                                  &key, sizeof(key));
1175
1176    if (!prog) {
1177       prog = (struct gl_fragment_program *)
1178          ctx->Driver.NewProgram(ctx, GL_FRAGMENT_PROGRAM_ARB, 0);
1179
1180       create_new_program(ctx, &key, prog);
1181
1182       _mesa_program_cache_insert(ctx, ctx->FragmentProgram.Cache,
1183                                  &key, sizeof(key), &prog->Base);
1184    }
1185
1186    return prog;
1187 }
1188
1189
1190
1191 /**
1192  * If _MaintainTexEnvProgram is set we'll generate a fragment program that
1193  * implements the current texture env/combine mode.
1194  * This function generates that program and puts it into effect.
1195  *
1196  * XXX: remove this function.  currently only called by some drivers,
1197  * not by mesa core.  We now handle this properly from inside mesa.
1198  */
1199 void
1200 _mesa_UpdateTexEnvProgram( GLcontext *ctx )
1201 {
1202    const struct gl_fragment_program *prev = ctx->FragmentProgram._Current;
1203
1204    ASSERT(ctx->FragmentProgram._MaintainTexEnvProgram);
1205
1206    /* If a conventional fragment program/shader isn't in effect... */
1207    if (!ctx->FragmentProgram._Enabled &&
1208        (!ctx->Shader.CurrentProgram ||
1209         !ctx->Shader.CurrentProgram->FragmentProgram) )
1210    {
1211       struct gl_fragment_program *newProg;
1212
1213       newProg = _mesa_get_fixed_func_fragment_program(ctx);
1214
1215       _mesa_reference_fragprog(ctx, &ctx->FragmentProgram._Current, newProg);
1216       _mesa_reference_fragprog(ctx, &ctx->FragmentProgram._TexEnvProgram, newProg);
1217    }
1218
1219    /* Tell the driver about the change.  Could define a new target for
1220     * this?
1221     */
1222    if (ctx->FragmentProgram._Current != prev && ctx->Driver.BindProgram) {
1223       ctx->Driver.BindProgram(ctx, GL_FRAGMENT_PROGRAM_ARB,
1224                          (struct gl_program *) ctx->FragmentProgram._Current);
1225    }
1226 }