2 * Copyright (c) 2014 Samsung Electronics Co., Ltd.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
19 #include <dali/internal/render/shaders/program.h>
22 #include <dali/public-api/common/vector-wrapper.h>
26 #include <dali/public-api/common/dali-common.h>
27 #include <dali/public-api/common/constants.h>
28 #include <dali/internal/render/common/performance-monitor.h>
29 #include <dali/integration-api/debug.h>
30 #include <dali/integration-api/shader-data.h>
34 void LogWithLineNumbers( const char * source )
36 unsigned int lineNumber = 0u;
37 const char *prev = source;
38 const char *ptr = prev;
46 // seek the next end of line or end of text
47 while( *ptr!='\n' && *ptr != '\0' )
52 std::string line( prev, ptr-prev );
53 Dali::Integration::Log::LogMessage(Dali::Integration::Log::DebugError, "%4d %s\n", lineNumber, line.c_str());
76 const char* gStdAttribs[ Program::ATTRIB_TYPE_LAST ] =
78 "aPosition", // ATTRIB_POSITION
79 "aNormal", // ATTRIB_NORMAL
80 "aTexCoord", // ATTRIB_TEXCOORD
81 "aColor", // ATTRIB_COLOR
82 "aBoneWeights", // ATTRIB_BONE_WEIGHTS
83 "aBoneIndices" // ATTRIB_BONE_INDICES
86 const char* gStdUniforms[ Program::UNIFORM_TYPE_LAST ] =
88 "uMvpMatrix", // UNIFORM_MVP_MATRIX
89 "uModelView", // UNIFORM_MODELVIEW_MATRIX
90 "uProjection", // UNIFORM_PROJECTION_MATRIX
91 "uModelMatrix", // UNIFORM_MODEL_MATRIX,
92 "uViewMatrix", // UNIFORM_VIEW_MATRIX,
93 "uNormalMatrix", // UNIFORM_NORMAL_MATRIX
94 "uColor", // UNIFORM_COLOR
95 "uCustomTextureCoords", // UNIFORM_CUSTOM_TEXTURE_COORDS
96 "sTexture", // UNIFORM_SAMPLER
97 "sTextureRect", // UNIFORM_SAMPLER_RECT
98 "sEffect", // UNIFORM_EFFECT_SAMPLER
99 "sEffectRect", // UNIFORM_EFFECT_SAMPLER_RECT
100 "uTimeDelta", // UNIFORM_TIME_DELTA
101 "sOpacityTexture", // UNIFORM_SAMPLER_OPACITY
102 "sNormalMapTexture", // UNIFORM_SAMPLER_NORMAL_MAP
103 "uTextColor", // UNIFORM_TEXT_COLOR
104 "uSmoothing", // UNIFORM_SMOOTHING
105 "uOutline", // UNIFORM_OUTLINE
106 "uOutlineColor", // UNIFORM_OUTLINE_COLOR
107 "uGlow", // UNIFORM_GLOW
108 "uGlowColor", // UNIFORM_GLOW_COLOR
109 "uShadow", // UNIFORM_SHADOW
110 "uShadowColor", // UNIFORM_SHADOW_COLOR
111 "uShadowSmoothing", // UNIFORM_SHADOW_SMOOTHING
112 "uGradientColor", // UNIFORM_GRADIENT_COLOR
113 "uGradientLine", // UNIFORM_GRADIENT_LINE
114 "uInvTextSize" // UNIFORM_INVERSE_TEXT_SIZE
117 } // <unnamed> namespace
121 Program* Program::New( const Integration::ResourceId& resourceId, Integration::ShaderDataPtr shaderData, Context& context, bool modifiesGeometry )
123 size_t shaderHash = shaderData->GetHashValue();
124 Program* program = context.GetCachedProgram( shaderHash );
126 if( NULL == program )
128 // program not found so create it
129 program = new Program( shaderData, context, modifiesGeometry );
131 // we want to lazy load programs so dont do a Load yet, it gets done in Use
133 // tell context to cache it
134 context.CacheProgram( shaderHash, program );
143 mContext.IsGlContextCreated() )
150 if ( this != mContext.GetCurrentProgram() )
152 LOG_GL( "UseProgram(%d)\n", mProgramId );
153 CHECK_GL( mContext, mGlAbstraction.UseProgram(mProgramId) );
154 INCREASE_COUNTER(PerformanceMonitor::SHADER_STATE_CHANGES);
156 mContext.SetCurrentProgram( this );
161 bool Program::IsUsed()
163 return ( this == mContext.GetCurrentProgram() );
166 GLint Program::GetAttribLocation( AttribType type )
168 DALI_ASSERT_DEBUG(type != ATTRIB_UNKNOWN);
170 if( mAttribLocations[ type ] == ATTRIB_UNKNOWN )
172 GLint loc = CHECK_GL( mContext, mGlAbstraction.GetAttribLocation( mProgramId, gStdAttribs[type] ) );
173 mAttribLocations[ type ] = loc;
174 LOG_GL( "GetAttribLocation(program=%d,%s) = %d\n", mProgramId, gStdAttribs[type], mAttribLocations[type] );
177 return mAttribLocations[type];
180 unsigned int Program::RegisterUniform( const std::string& name )
182 unsigned int index = 0;
183 // find the value from cache
184 for( ;index < mUniformLocations.size(); ++index )
186 if( mUniformLocations[ index ].first == name )
188 // name found so return index
192 // if we get here, index is one past end so push back the new name
193 mUniformLocations.push_back( std::make_pair( name, UNIFORM_NOT_QUERIED ) );
197 GLint Program::GetUniformLocation( unsigned int uniformIndex )
199 // debug check that index is within name cache
200 DALI_ASSERT_DEBUG( mUniformLocations.size() > uniformIndex );
202 // check if we have already queried the location of the uniform
203 GLint location = mUniformLocations[ uniformIndex ].second;
205 if( location == UNIFORM_NOT_QUERIED )
207 location = CHECK_GL( mContext, mGlAbstraction.GetUniformLocation( mProgramId, mUniformLocations[ uniformIndex ].first.c_str() ) );
209 mUniformLocations[ uniformIndex ].second = location;
210 LOG_GL( "GetUniformLocation(program=%d,%s) = %d\n", mProgramId, mUniformLocations[ uniformIndex ].first.c_str(), mUniformLocations[ uniformIndex ].second );
216 void Program::SetUniform1i( GLint location, GLint value0 )
218 DALI_ASSERT_DEBUG( IsUsed() ); // should not call this if this program is not used
220 if( UNIFORM_UNKNOWN == location )
222 // From http://www.khronos.org/opengles/sdk/docs/man/xhtml/glUniform.xml : Notes
223 // If location is equal to UNIFORM_UNKNOWN, the data passed in will be silently ignored and the
224 // specified uniform variable will not be changed.following opengl silently do nothing
228 // check if uniform location fits the cache
229 if( location >= MAX_UNIFORM_CACHE_SIZE )
231 // not cached, make the gl call
232 LOG_GL( "Uniform1i(%d,%d)\n", location, value0 );
233 CHECK_GL( mContext, mGlAbstraction.Uniform1i( location, value0 ) );
237 // check if the value is different from what's already been set
238 if( value0 != mUniformCacheInt[ location ] )
241 LOG_GL( "Uniform1i(%d,%d)\n", location, value0 );
242 CHECK_GL( mContext, mGlAbstraction.Uniform1i( location, value0 ) );
244 mUniformCacheInt[ location ] = value0;
249 void Program::SetUniform4i( GLint location, GLint value0, GLint value1, GLint value2, GLint value3 )
251 DALI_ASSERT_DEBUG( IsUsed() ); // should not call this if this program is not used
253 if( UNIFORM_UNKNOWN == location )
255 // From http://www.khronos.org/opengles/sdk/docs/man/xhtml/glUniform.xml : Notes
256 // If location is equal to UNIFORM_UNKNOWN, the data passed in will be silently ignored and the
257 // specified uniform variable will not be changed.following opengl silently do nothing
261 // Not caching these as based on current analysis this is not called that often by our shaders
262 LOG_GL( "Uniform4i(%d,%d,%d,%d,%d)\n", location, value0, value1, value2, value3 );
263 CHECK_GL( mContext, mGlAbstraction.Uniform4i( location, value0, value1, value2, value3 ) );
266 void Program::SetUniform1f( GLint location, GLfloat value0 )
268 DALI_ASSERT_DEBUG( IsUsed() ); // should not call this if this program is not used
270 if( UNIFORM_UNKNOWN == location )
272 // From http://www.khronos.org/opengles/sdk/docs/man/xhtml/glUniform.xml : Notes
273 // If location is equal to UNIFORM_UNKNOWN, the data passed in will be silently ignored and the
274 // specified uniform variable will not be changed.following opengl silently do nothing
278 // check if uniform location fits the cache
279 if( location >= MAX_UNIFORM_CACHE_SIZE )
281 // not cached, make the gl call
282 LOG_GL( "Uniform1f(%d,%f)\n", location, value0 );
283 CHECK_GL( mContext, mGlAbstraction.Uniform1f( location, value0 ) );
287 // check if the same value has already been set, reset if it is different
288 if( ( fabsf(value0 - mUniformCacheFloat[ location ]) >= Math::MACHINE_EPSILON_1 ) )
291 LOG_GL( "Uniform1f(%d,%f)\n", location, value0 );
292 CHECK_GL( mContext, mGlAbstraction.Uniform1f( location, value0 ) );
295 mUniformCacheFloat[ location ] = value0;
300 void Program::SetUniform2f( GLint location, GLfloat value0, GLfloat value1 )
302 DALI_ASSERT_DEBUG( IsUsed() ); // should not call this if this program is not used
304 if( UNIFORM_UNKNOWN == location )
306 // From http://www.khronos.org/opengles/sdk/docs/man/xhtml/glUniform.xml : Notes
307 // If location is equal to UNIFORM_UNKNOWN, the data passed in will be silently ignored and the
308 // specified uniform variable will not be changed.following opengl silently do nothing
312 // Not caching these as based on current analysis this is not called that often by our shaders
313 LOG_GL( "Uniform2f(%d,%f,%f)\n", location, value0, value1 );
314 CHECK_GL( mContext, mGlAbstraction.Uniform2f( location, value0, value1 ) );
317 void Program::SetUniform3f( GLint location, GLfloat value0, GLfloat value1, GLfloat value2 )
319 DALI_ASSERT_DEBUG( IsUsed() ); // should not call this if this program is not used
321 if( UNIFORM_UNKNOWN == location )
323 // From http://www.khronos.org/opengles/sdk/docs/man/xhtml/glUniform.xml : Notes
324 // If location is equal to UNIFORM_UNKNOWN, the data passed in will be silently ignored and the
325 // specified uniform variable will not be changed.following opengl silently do nothing
329 // Not caching these as based on current analysis this is not called that often by our shaders
330 LOG_GL( "Uniform3f(%d,%f,%f,%f)\n", location, value0, value1, value2 );
331 CHECK_GL( mContext, mGlAbstraction.Uniform3f( location, value0, value1, value2 ) );
334 void Program::SetUniform4f( GLint location, GLfloat value0, GLfloat value1, GLfloat value2, GLfloat value3 )
336 DALI_ASSERT_DEBUG( IsUsed() ); // should not call this if this program is not used
338 if( UNIFORM_UNKNOWN == location )
340 // From http://www.khronos.org/opengles/sdk/docs/man/xhtml/glUniform.xml : Notes
341 // If location is equal to UNIFORM_UNKNOWN, the data passed in will be silently ignored and the
342 // specified uniform variable will not be changed.following opengl silently do nothing
346 // check if uniform location fits the cache
347 if( location >= MAX_UNIFORM_CACHE_SIZE )
349 // not cached, make the gl call
350 LOG_GL( "Uniform4f(%d,%f,%f,%f,%f)\n", location, value0, value1, value2, value3 );
351 CHECK_GL( mContext, mGlAbstraction.Uniform4f( location, value0, value1, value2, value3 ) );
355 // check if the same value has already been set, reset if any component is different
356 // checking index 3 first because we're often animating alpha (rgba)
357 if( ( fabsf(value3 - mUniformCacheFloat4[ location ][ 3 ]) >= Math::MACHINE_EPSILON_1 )||
358 ( fabsf(value0 - mUniformCacheFloat4[ location ][ 0 ]) >= Math::MACHINE_EPSILON_1 )||
359 ( fabsf(value1 - mUniformCacheFloat4[ location ][ 1 ]) >= Math::MACHINE_EPSILON_1 )||
360 ( fabsf(value2 - mUniformCacheFloat4[ location ][ 2 ]) >= Math::MACHINE_EPSILON_1 ) )
363 LOG_GL( "Uniform4f(%d,%f,%f,%f,%f)\n", location, value0, value1, value2, value3 );
364 CHECK_GL( mContext, mGlAbstraction.Uniform4f( location, value0, value1, value2, value3 ) );
366 mUniformCacheFloat4[ location ][ 0 ] = value0;
367 mUniformCacheFloat4[ location ][ 1 ] = value1;
368 mUniformCacheFloat4[ location ][ 2 ] = value2;
369 mUniformCacheFloat4[ location ][ 3 ] = value3;
374 void Program::SetUniformMatrix4fv( GLint location, GLsizei count, const GLfloat* value )
376 DALI_ASSERT_DEBUG( IsUsed() ); // should not call this if this program is not used
378 if( UNIFORM_UNKNOWN == location )
380 // From http://www.khronos.org/opengles/sdk/docs/man/xhtml/glUniform.xml : Notes
381 // If location is equal to UNIFORM_UNKNOWN, the data passed in will be silently ignored and the
382 // specified uniform variable will not be changed.following opengl silently do nothing
386 // Not caching these calls. Based on current analysis this is called very often
387 // but with different values (we're using this for MVP matrices)
388 // NOTE! we never want driver or GPU to transpose
389 LOG_GL( "UniformMatrix4fv(%d,%d,GL_FALSE,%x)\n", location, count, value );
390 CHECK_GL( mContext, mGlAbstraction.UniformMatrix4fv( location, count, GL_FALSE, value ) );
393 void Program::SetUniformMatrix3fv( GLint location, GLsizei count, const GLfloat* value )
395 DALI_ASSERT_DEBUG( IsUsed() ); // should not call this if this program is not used
397 if( UNIFORM_UNKNOWN == location )
399 // From http://www.khronos.org/opengles/sdk/docs/man/xhtml/glUniform.xml : Notes
400 // If location is equal to UNIFORM_UNKNOWN, the data passed in will be silently ignored and the
401 // specified uniform variable will not be changed.following opengl silently do nothing
406 // Not caching these calls. Based on current analysis this is called very often
407 // but with different values (we're using this for MVP matrices)
408 // NOTE! we never want driver or GPU to transpose
409 LOG_GL( "UniformMatrix3fv(%d,%d,GL_FALSE,%x)\n", location, count, value );
410 CHECK_GL( mContext, mGlAbstraction.UniformMatrix3fv( location, count, GL_FALSE, value ) );
413 void Program::GlContextCreated()
417 void Program::GlContextDestroyed()
422 mFragmentShaderId = 0;
424 mContext.SetCurrentProgram( NULL );
426 ResetAttribsUniformCache();
429 bool Program::ModifiesGeometry()
431 return mModifiesGeometry;
434 Program::Program(Integration::ShaderDataPtr shaderData, Context& context, bool modifiesGeometry )
435 : mContext( context ),
436 mGlAbstraction( context.GetAbstraction() ),
437 mProjectionMatrix( NULL ),
440 mVertexShaderId( 0 ),
441 mFragmentShaderId( 0 ),
443 mProgramData(shaderData),
444 mModifiesGeometry( modifiesGeometry )
446 // reserve space for standard uniforms
447 mUniformLocations.reserve( UNIFORM_TYPE_LAST );
448 // reset built in uniform names in cache
449 for( int i = 0; i < UNIFORM_TYPE_LAST; ++i )
451 RegisterUniform( gStdUniforms[ i ] );
454 ResetAttribsUniformCache();
464 DALI_ASSERT_ALWAYS( NULL != mProgramData.Get() && "Program data is not initialized" );
468 LOG_GL( "CreateProgram()\n" );
469 mProgramId = CHECK_GL( mContext, mGlAbstraction.CreateProgram() );
471 GLint linked = GL_FALSE;
473 // ShaderData contains compiled bytecode?
474 if( 0 != mContext.CachedNumberOfProgramBinaryFormats() && mProgramData->HasBinary() )
476 DALI_LOG_INFO(Debug::Filter::gShader, Debug::General, "Program::Load() - Using Compiled Shader, Size = %d\n", mProgramData->buffer.size());
478 CHECK_GL( mContext, mGlAbstraction.ProgramBinary(mProgramId, mContext.CachedProgramBinaryFormat(), mProgramData->buffer.data(), mProgramData->buffer.size()) );
480 CHECK_GL( mContext, mGlAbstraction.ValidateProgram(mProgramId) );
483 CHECK_GL( mContext, mGlAbstraction.GetProgramiv( mProgramId, GL_VALIDATE_STATUS, &success ) );
485 DALI_LOG_INFO(Debug::Filter::gShader, Debug::General, "ValidateProgram Status = %d\n", success);
487 CHECK_GL( mContext, mGlAbstraction.GetProgramiv( mProgramId, GL_LINK_STATUS, &linked ) );
489 if( GL_FALSE == linked )
491 DALI_LOG_ERROR("Failed to load program binary \n");
495 CHECK_GL( mContext, mGlAbstraction.GetProgramiv( mProgramId, GL_INFO_LOG_LENGTH, &nLength) );
498 szLog = new char[ nLength ];
499 CHECK_GL( mContext, mGlAbstraction.GetProgramInfoLog( mProgramId, nLength, &nLength, szLog ) );
500 DALI_LOG_ERROR( "Program Link Error: %s\n", szLog );
511 // Fall back to compiling and linking the vertex and fragment sources
512 if( GL_FALSE == linked )
514 DALI_LOG_INFO(Debug::Filter::gShader, Debug::General, "Program::Load() - Runtime compilation\n");
515 if( CompileShader( GL_VERTEX_SHADER, mVertexShaderId, mProgramData->vertexShader.c_str() ) )
517 if( CompileShader( GL_FRAGMENT_SHADER, mFragmentShaderId, mProgramData->fragmentShader.c_str() ) )
523 GLint binaryLength = 0;
526 CHECK_GL( mContext, mGlAbstraction.GetProgramiv(mProgramId, GL_PROGRAM_BINARY_LENGTH_OES, &binaryLength) );
527 DALI_LOG_INFO(Debug::Filter::gShader, Debug::General, "Program::Load() - GL_PROGRAM_BINARY_LENGTH_OES: %d\n", binaryLength);
529 // Allocate space for the bytecode in ShaderData
530 mProgramData->AllocateBuffer(binaryLength);
531 // Copy the bytecode to ShaderData
532 CHECK_GL( mContext, mGlAbstraction.GetProgramBinary(mProgramId, binaryLength, NULL, &binaryFormat, mProgramData->buffer.data()) );
543 void Program::Unload()
547 if( this == mContext.GetCurrentProgram() )
549 CHECK_GL( mContext, mGlAbstraction.UseProgram(0) );
551 mContext.SetCurrentProgram( NULL );
556 LOG_GL( "DeleteProgram(%d)\n", mProgramId );
557 CHECK_GL( mContext, mGlAbstraction.DeleteProgram( mProgramId ) );
565 bool Program::CompileShader( GLenum shaderType, GLuint& shaderId, const char* src )
569 LOG_GL( "CreateShader(%d)\n", shaderType );
570 shaderId = CHECK_GL( mContext, mGlAbstraction.CreateShader( shaderType ) );
571 LOG_GL( "AttachShader(%d,%d)\n", mProgramId, shaderId );
572 CHECK_GL( mContext, mGlAbstraction.AttachShader( mProgramId, shaderId ) );
575 LOG_GL( "ShaderSource(%d)\n", shaderId );
576 CHECK_GL( mContext, mGlAbstraction.ShaderSource(shaderId, 1, &src, NULL ) );
578 LOG_GL( "CompileShader(%d)\n", shaderId );
579 CHECK_GL( mContext, mGlAbstraction.CompileShader( shaderId ) );
582 LOG_GL( "GetShaderiv(%d)\n", shaderId );
583 CHECK_GL( mContext, mGlAbstraction.GetShaderiv( shaderId, GL_COMPILE_STATUS, &compiled ) );
585 if (compiled == GL_FALSE)
587 DALI_LOG_ERROR("Failed to compile shader\n");
588 LogWithLineNumbers(src);
590 std::vector< char > szLog;
592 mGlAbstraction.GetShaderiv( shaderId, GL_INFO_LOG_LENGTH, &nLength);
595 szLog.reserve( nLength );
596 mGlAbstraction.GetShaderInfoLog( shaderId, nLength, &nLength, &szLog[ 0 ] );
597 DALI_LOG_ERROR( "Shader Compiler Error: %s\n", &szLog[ 0 ] );
600 throw DaliException( "Shader compilation failure", &szLog[ 0 ] );
603 return compiled != 0;
608 LOG_GL( "LinkProgram(%d)\n", mProgramId );
609 CHECK_GL( mContext, mGlAbstraction.LinkProgram( mProgramId ) );
612 LOG_GL( "GetProgramiv(%d)\n", mProgramId );
613 CHECK_GL( mContext, mGlAbstraction.GetProgramiv( mProgramId, GL_LINK_STATUS, &linked ) );
615 if (linked == GL_FALSE)
617 DALI_LOG_ERROR("Shader failed to link \n");
621 mGlAbstraction.GetProgramiv( mProgramId, GL_INFO_LOG_LENGTH, &nLength);
624 szLog = new char[ nLength ];
625 mGlAbstraction.GetProgramInfoLog( mProgramId, nLength, &nLength, szLog );
626 DALI_LOG_ERROR( "Shader Link Error: %s\n", szLog );
630 DALI_ASSERT_DEBUG(0);
633 mLinked = linked != GL_FALSE;
636 void Program::FreeShaders()
640 LOG_GL( "DeleteShader(%d)\n", mVertexShaderId );
641 CHECK_GL( mContext, mGlAbstraction.DetachShader( mProgramId, mVertexShaderId ) );
642 CHECK_GL( mContext, mGlAbstraction.DeleteShader( mVertexShaderId ) );
646 if (mFragmentShaderId)
648 LOG_GL( "DeleteShader(%d)\n", mFragmentShaderId );
649 CHECK_GL( mContext, mGlAbstraction.DetachShader( mProgramId, mFragmentShaderId ) );
650 CHECK_GL( mContext, mGlAbstraction.DeleteShader( mFragmentShaderId ) );
651 mFragmentShaderId = 0;
655 void Program::ResetAttribsUniformCache()
657 // reset attribute locations
658 for( unsigned i = 0; i < ATTRIB_TYPE_LAST; ++i )
660 mAttribLocations[ i ] = ATTRIB_UNKNOWN;
663 // reset all gl uniform locations
664 for( unsigned int i = 0; i < mUniformLocations.size(); ++i )
666 // reset gl program locations and names
667 mUniformLocations[ i ].second = UNIFORM_NOT_QUERIED;
670 // reset uniform cache
671 for( int i = 0; i < MAX_UNIFORM_CACHE_SIZE; ++i )
673 // GL initializes uniforms to 0
674 mUniformCacheInt[ i ] = 0;
675 mUniformCacheFloat[ i ] = 0.0f;
676 mUniformCacheFloat4[ i ][ 0 ] = 0.0f;
677 mUniformCacheFloat4[ i ][ 1 ] = 0.0f;
678 mUniformCacheFloat4[ i ][ 2 ] = 0.0f;
679 mUniformCacheFloat4[ i ][ 3 ] = 0.0f;
683 } // namespace Internal