OSGProgramChunk.cpp

Go to the documentation of this file.

/*---------------------------------------------------------------------------*\
 *                                OpenSG                                     *
 *                                                                           *
 *                                                                           *
 *               Copyright (C) 2000-2002 by the OpenSG Forum                 *
 *                                                                           *
 *                            www.opensg.org                                 *
 *                                                                           *
 *   contact: dirk@opensg.org, gerrit.voss@vossg.org, jbehr@zgdv.de          *
 *                                                                           *
\*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*\
 *                                License                                    *
 *                                                                           *
 * This library is free software; you can redistribute it and/or modify it   *
 * under the terms of the GNU Library General Public License as published    *
 * by the Free Software Foundation, version 2.                               *
 *                                                                           *
 * This library is distributed in the hope that it will be useful, but       *
 * WITHOUT ANY WARRANTY; without even the implied warranty of                *
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU         *
 * Library General Public License for more details.                          *
 *                                                                           *
 * You should have received a copy of the GNU Library General Public         *
 * License along with this library; if not, write to the Free Software       *
 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.                 *
 *                                                                           *
\*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*\
 *                                Changes                                    *
 *                                                                           *
 *                                                                           *
 *                                                                           *
 *                                                                           *
 *                                                                           *
 *                                                                           *
\*---------------------------------------------------------------------------*/

//---------------------------------------------------------------------------
//  Includes
//---------------------------------------------------------------------------

#include <stdlib.h>
#include <stdio.h>

#include <OSGConfig.h>

#include <OSGGL.h>
#include <OSGGLU.h>
#include <OSGGLEXT.h>

#include <OSGBaseFunctions.h>

#include "OSGDrawActionBase.h"
#include "OSGWindow.h"

#include "OSGProgramChunk.h"

OSG_USING_NAMESPACE

/***************************************************************************\
 *                            Description                                  *
\***************************************************************************/

/***************************************************************************\
 *                           Class variables                               *
\***************************************************************************/

StateChunkClass ProgramChunk::_class("Program");

UInt32 ProgramChunk::_funcGenPrograms;
UInt32 ProgramChunk::_funcProgramString;
UInt32 ProgramChunk::_funcBindProgram;
UInt32 ProgramChunk::_funcDeletePrograms;
UInt32 ProgramChunk::_funcProgramLocalParameter4fv;
UInt32 ProgramChunk::_funcGetProgramiv;

/***************************************************************************\
 *                           Class methods                                 *
\***************************************************************************/

void ProgramChunk::initMethod (void)
{
}


/***************************************************************************\
 *                           Instance methods                              *
\***************************************************************************/

/*-------------------------------------------------------------------------*\
 -  private                                                                 -
\*-------------------------------------------------------------------------*/

/*----------------------- constructors & destructors ----------------------*/

ProgramChunk::ProgramChunk(void) :
    Inherited()
{
    UInt32 extension = Window::registerExtension("GL_ARB_vertex_program");
    
    _funcGenPrograms                    =
        Window::registerFunction (OSG_DLSYM_UNDERSCORE"glGenProgramsARB", 
            extension);
    _funcProgramString                  =
        Window::registerFunction (OSG_DLSYM_UNDERSCORE"glProgramStringARB", 
            extension);
    _funcBindProgram                    =
        Window::registerFunction (OSG_DLSYM_UNDERSCORE"glBindProgramARB", 
            extension);
    _funcDeletePrograms                 =
        Window::registerFunction (OSG_DLSYM_UNDERSCORE"glDeleteProgramsARB", 
            extension);
    _funcProgramLocalParameter4fv       =
        Window::registerFunction (OSG_DLSYM_UNDERSCORE
                                            "glProgramLocalParameter4fvARB", 
            extension);
    _funcGetProgramiv       =
        Window::registerFunction (OSG_DLSYM_UNDERSCORE"glGetProgramivARB", 
            extension);
}

ProgramChunk::ProgramChunk(const ProgramChunk &source) :
    Inherited(source)
{
}

ProgramChunk::~ProgramChunk(void)
{
    if(getGLId() > 0)
        Window::destroyGLObject(getGLId(), 1);
}

/*----------------------------- onCreate --------------------------------*/

void ProgramChunk::onCreate(const ProgramChunk *)
{
}


/*------------------------- Chunk Class Access ---------------------------*/

const StateChunkClass *ProgramChunk::getClass( void ) const
{
    return &_class;
}

/*----------------------------- class specific ----------------------------*/

void ProgramChunk::changed(BitVector whichField, UInt32 origin)
{
    Inherited::changed(whichField, origin);
    
    if(whichField & ProgramFieldMask)
    {
        Window::reinitializeGLObject(getGLId());
    }  
     
    if(whichField & ParamValuesFieldMask)
    {
        Window::refreshGLObject(getGLId());
    }
}

/*------------------------------ Output ----------------------------------*/

void ProgramChunk::dump(      UInt32    , 
                         const BitVector ) const
{
    SLOG << "Dump ProgramChunk NI" << std::endl;
}

/*---------------------------- Access ------------------------------------*/

bool ProgramChunk::read(const char *file)
{
    std::ifstream s(file);
    
    if(s.good())
    {
        return read(s);
    }
    else
    {
        FWARNING(("ProgramChunk::read: couldn't open '%s' for reading!\n",
                    file));
        return false;
    }
}

bool ProgramChunk::read(std::istream &stream)
{
#define BUFSIZE 200
    
    getProgram().erase();    
    char buf[BUFSIZE];

    if(!stream.good())
    {
        FWARNING(("ProgramChunk::read: stream is not good!\n"));
        return false;
   
    }
    
    do
    {
        stream.read(buf, BUFSIZE);
        getProgram().append(buf, stream.gcount());
    }
    while(!stream.eof());
    
    return true;
}
    
bool ProgramChunk::addParameter(const char   *name, 
                                      Int16  index)
{
    if(index < 0)
        return true;
        
    if(getParamNames().size() <= UInt16(index))
    {
        getParamNames().resize(index + 1);
    }
    getParamNames()[index] = name;
    return false;
}
    
const Vec4f& ProgramChunk::getParameter(Int16 index)
{
    static const Vec4f bad(-1e10,-1e10,-1e10);
    
    if(index < 0)
        return bad;
        
    if(getParamValues().size() <= UInt16(index))
    {
        return getParamValues()[index];
    }
    
    return bad;
}
 
bool ProgramChunk::setParameter(Int16 index, const Vec4f& value)
{
    if(index < 0)
        return true;
        
    if(getParamValues().size() <= UInt16(index))
    {
        getParamValues().resize(index + 1);
    }
    getParamValues()[index] = value;
    return false;
}

Int16 ProgramChunk::findParameter(const std::string &name)
{
    MField<std::string>::iterator it;
    
    it = std::find(getParamNames().begin(), getParamNames().end(), name);

    if(it == getParamNames().end())
        return -1;

    return it - getParamNames().begin();
}


/*------------------------------ State ------------------------------------*/

void ProgramChunk::printCompileError(Window *win, UInt32 idstatus)
{
    Window::GLObjectStatusE mode;
    UInt32 id;
    
    Window::unpackIdStatus(idstatus, id, mode);
    
    GLint pos;   
    glGetIntegerv(GL_PROGRAM_ERROR_POSITION_ARB, &pos);
    
    FWARNING(("ProgramChunk(%p:%d,%d): error compiling program "
              "at position %d: %s\n",
              win, id, mode, pos, glGetString(GL_PROGRAM_ERROR_STRING_ARB)));
    
    UInt32 start = 0, end, line = 0;
    
    for(end = 0; end < getProgram().size(); ++end)
    {
        if(getProgram()[end] == '\n')
        {
            ++line;
            
            if(UInt32(pos) < end)
                break;
            
            start = end + 1;
        }
    }
    
    std::string mesg;
    
    for(UInt32 i = start; i < end; ++i)
    {
        if(i == pos)
        {
            mesg += '>';
            mesg += '>';
        }
        
        mesg += getProgram()[i];

        if(i == pos)
        {
            mesg += '<';
            mesg += '<';
        }
    }
    
    SWARNING << "Location (line " << line << "): " << mesg << endLog;
}

void ProgramChunk::handleGL(Window *win, UInt32 idstatus, GLenum target, UInt32 extension)
{
    Window::GLObjectStatusE mode;
    UInt32 osgid;
    GLuint id;
    
    Window::unpackIdStatus(idstatus, osgid, mode);
    
    // get the program-specific specifics from the derived chunks
    // We can't call this member methods on Window::destroy because
    // the ProgramChunk instance is already destroyed.
    //GLenum target = getTarget();
    //UInt32 extension = getExtension();
    
    if(!win->hasExtension(extension))
        return;

    id = win->getGLObjectId(osgid);
    
    if(mode == Window::destroy)
    {
        // get "glDeleteProgramsARB" function pointer
        void (OSG_APIENTRY* deletePrograms)(GLsizei num, const GLuint *progs) =
            (void (OSG_APIENTRY*)(GLsizei num, const GLuint *progs))
            win->getFunction(_funcDeletePrograms);

        deletePrograms(1, &id);
        win->setGLObjectId(osgid, 0);
    }
    else if(mode == Window::finaldestroy)
    {
        //SWARNING << "Last program user destroyed" << std::endl;
    }
    else if(mode == Window::initialize || mode == Window::reinitialize ||
            mode == Window::needrefresh)
    {
        if(mode == Window::initialize)
        {
            // get "glGenProgramsARB" function pointer
            void (OSG_APIENTRY* genPrograms)(GLsizei n, GLuint *prog) =
                (void (OSG_APIENTRY*)(GLsizei n, GLuint *prog))
                win->getFunction(_funcGenPrograms);
            genPrograms(1, &id);
            win->setGLObjectId(osgid, id);
        }
        
        // get "glBindProgramARB" function pointer
        void (OSG_APIENTRY* bindProgram)(GLenum target, GLuint prog) =
            (void (OSG_APIENTRY*)(GLenum target, GLuint prog))
            win->getFunction(_funcBindProgram);
             
        glErr("ProgramChunk::handleGL: bindProgram precheck");
        
        bindProgram(target, id);
             
        glErr("ProgramChunk::handleGL: bindProgram postcheck");
        
        if(mode != Window::needrefresh)
        {
            // get "glProgramStringARB" function pointer
            void (OSG_APIENTRY* programString)(GLenum target, GLenum format, 
                        GLsizei lesn, const void *string) =
                (void (OSG_APIENTRY*)(GLenum target, GLenum format, 
                        GLsizei len, const void *string))
                win->getFunction(_funcProgramString);
            
            glErr("ProgramChunk::handleGL: programString precheck");
            
            glEnable(target);
            
            glErr("ProgramChunk::handleGL: enable postcheck");
            
            programString(target, GL_PROGRAM_FORMAT_ASCII_ARB,
                            getProgram().size(), getProgram().c_str());
            
            GLenum err = glGetError();
            
            if(err == GL_INVALID_OPERATION)
            {
                printCompileError(win, idstatus);
            }
            else if (err != GL_NO_ERROR)
            {
                SWARNING << "ProgramChunk::programString postcheck failed:"
                         << gluErrorString(err) << endLog;
            }
            
            glDisable(target);
            
            glErr("ProgramChunk::handleGL: disable postcheck");
        }
        
        void (OSG_APIENTRY* programLocalParameter4fv)(GLenum target, 
                        GLuint index, const GLfloat *params) =
            (void (OSG_APIENTRY*)(GLenum target, 
                        GLuint index, const GLfloat *params))
            win->getFunction(_funcProgramLocalParameter4fv);
             
        glErr("ProgramChunk::handleGL: programLocalParameter precheck");
       
        for(UInt16 i = 0; i < getParamValues().size(); ++i)
        {
            Vec4f &val=getParamValues()[i];
            
            programLocalParameter4fv(target, i, val.getValues());
            
            glErr("ProgramChunk::handleGL: programLocalParameter");
        }      
             
        glErr("ProgramChunk::handleGL: programLocalParameter postcheck");
    }
    else
    {
        SWARNING << "ProgramChunk(" << this << "::handleGL: Illegal mode: "
             << mode << " for id " << id << std::endl;
    }

}

void ProgramChunk::activate(DrawActionBase *action, UInt32)
{
    // get the program-type specifics from the derived chunks
    GLenum target = getTarget();
    UInt32 extension = getExtension();

    if(!action->getWindow()->hasExtension(extension))
    {
        return;
    }
    
    if(getProgram().empty())
        return;
        
    action->getWindow()->validateGLObject(getGLId());
           
    // get "glBindProgramARB" function pointer
    void (OSG_APIENTRY* bindProgram)(GLenum target, GLuint prog) =
        (void (OSG_APIENTRY*)(GLenum target, GLuint prog))
        action->getWindow()->getFunction(_funcBindProgram);
             
    glErr("ProgramChunk::activate: bindProgram precheck");

    glEnable(target);
             
    glErr("ProgramChunk::activate: enable postcheck");

    bindProgram(target, action->getWindow()->getGLObjectId(getGLId()));
             
    glErr("ProgramChunk::activate: bindProgram postcheck");
}

void ProgramChunk::changeFrom(DrawActionBase *action, 
                              StateChunk * old_chunk, 
                              UInt32 )
{
    ProgramChunk * old = dynamic_cast<ProgramChunk*>(old_chunk);

    if(old == NULL)
    {
        FWARNING(( "ProgramChunk::changeFrom: caught non-ProgramChunk!\n"));
        return;
    }
       
    // get the program-type specifics from the derived chunks
    GLenum target = getTarget();
    UInt32 extension = getExtension();

    if(!action->getWindow()->hasExtension(extension))
        return;
     
    if(getProgram().empty())
    {
        if(old->getProgram().empty())
            return;
        
        glDisable(target);
    }

    action->getWindow()->validateGLObject(getGLId());
           
    // get "glBindProgramARB" function pointer
    void (OSG_APIENTRY* bindProgram)(GLenum target, GLuint prog) =
        (void (OSG_APIENTRY*)(GLenum target, GLuint prog))
        action->getWindow()->getFunction(_funcBindProgram);
             
    glErr("ProgramChunk::changeFrom: bindProgram precheck");

    if(old->getProgram().empty())
        glEnable(target);
             
    glErr("ProgramChunk::changeFrom: enable postcheck");

    bindProgram(target, action->getWindow()->getGLObjectId(getGLId()));
             
    glErr("ProgramChunk::changeFrom: bindProgram postcheck");
}

void ProgramChunk::deactivate(DrawActionBase *action, UInt32)
{
    // get the program-type specifics from the derived chunks
    GLenum target = getTarget();
    UInt32 extension = getExtension();

    if(!action->getWindow()->hasExtension(extension))
    {
        return;
    }
    
    if(getProgram().empty())
    {
        return;
    }
           
    // get "glBindProgramARB" function pointer
    void (OSG_APIENTRY* bindProgram)(GLenum target, GLuint prog) =
        (void (OSG_APIENTRY*)(GLenum target, GLuint prog))
        action->getWindow()->getFunction(_funcBindProgram);

             
    glErr("ProgramChunk::deactivate: bindProgram precheck");

    bindProgram(target, action->getWindow()->getGLObjectId(getGLId()));
             
    glErr("ProgramChunk::deactivate: bindProgram postcheck");

    glDisable(target);
             
    glErr("ProgramChunk::deactivate: disable postcheck");
}

UInt32 ProgramChunk::getExtension(void) const
{
    FWARNING(( "ProgramChunk::getExtension called!\n" ));
    return 0;
}

GLenum ProgramChunk::getTarget(void) const
{
    FWARNING(( "ProgramChunk::getTarget called!\n" ));
    return 0;
}

const char *ProgramChunk::getTargetName(void) const
{
    FWARNING(( "ProgramChunk::getTargetName called!\n" ));
    return "ERROR";
}

/*-------------------------- Comparison -----------------------------------*/

bool ProgramChunk::isTransparent(void) const
{
    return false;
}

Real32 ProgramChunk::switchCost(StateChunk *)
{
    return 0;
}

bool ProgramChunk::operator < (const StateChunk &other) const
{
    return this < &other;
}

bool ProgramChunk::operator == (const StateChunk &other) const
{
    ProgramChunk const *tother = dynamic_cast<ProgramChunk const*>(&other);

    if(!tother)
        return false;

    if(tother == this)
        return true;

    if(getProgram()            != tother->getProgram()            ||
       getParamValues().size() != tother->getParamValues().size() ||
       getParamNames().size()  != tother->getParamNames().size()
      )
        return false;

    // !!! FIXME: implement    
    
    return false;
}

bool ProgramChunk::operator != (const StateChunk &other) const
{
    return ! (*this == other);
}


/*------------------------------------------------------------------------*/
/*                              cvs id's                                  */

#ifdef OSG_SGI_CC
#pragma set woff 1174
#endif

#ifdef OSG_LINUX_ICC
#pragma warning( disable : 177 )
#endif

namespace
{
    static Char8 cvsid_cpp       [] = "@(#)$Id: $";
    static Char8 cvsid_hpp       [] = OSGPROGRAMCHUNKBASE_HEADER_CVSID;
    static Char8 cvsid_inl       [] = OSGPROGRAMCHUNKBASE_INLINE_CVSID;

    static Char8 cvsid_fields_hpp[] = OSGPROGRAMCHUNKFIELDS_HEADER_CVSID;
}

#ifdef __sgi
#pragma reset woff 1174
#endif

---