CompositorLogic Framework

Introduction

The CompositorLogic framework is a small addon framework for Ogre that aims to make advanced compositors dynamically loadable by introducing a new interface for advanced compositors (CompositorLogic) that allow the creator of the compositor to get callbacks with the information required to setup the parameters required for the compositor to work properly. These classes will be dynamically loaded when needed, making compositors much more easy to deploy and share.

Current State

(As of January 2008 - Ogre 1.4.6)

By looking at Ogre's compositor demo, we can see that despite the fact that compositors are defined in scripts, for some of them (in the case of the demo they are HDR, Gaussian Blur and Heat Vision) the scripts are not enough, and they require listeners to be attached to the compositors and their functions to be called before enabling them. If you wanted to incorporate the HDR compositor on your application, even if you compiled the code to a DLL, you would still need to manually link with the library and setup the listeners in your code. This makes the deployment more than just copy-paste. It also makes it much harder to configure compositor chain in scripts, as you need to treat specific compositors in the loader that will load the chain from the script.

Another problem, is that there is no generic interface for specifying viewport-specific compositor parameters. If a pixel shader has a parameter stating the blending factor, we would like to be able to change this blending factor per viewport. This is not possible currently.

We aim to address these two issues and introduce a simple, intuitive API for handling advanced compositors.

Solution

To solve this problem, we will introduce a new API for specifying advanced compositors with code behind them.
This is the API that developers wanting to create a new compositor will implement : 

#ifndef _CompositorLogic_H_
#define _CompositorLogic_H_

#include "OgrePrerequisites.h"
#include "OgreCompositor.h"
#include "OgreStringInterface.h"

#include "CompositorLogicPrerequisities.h"

/** An enum for the requested chain position of a certain Compositor Logic
*/
enum ChainPosition {
    /** This compositor can be anywhere in the chain */
    CP_NOT_IMPORTANT,
    /** This compositor must be first in the chain */
    CP_FIRST,
    /** This compositor must be last in the chain */
    CP_LAST
};

/** A class representing a single instance of a CompositorLogic on a viewport
*/
class _CompositorLogicExport CompositorLogicInstance : public Ogre::StringInterface {
public:
    /** Get the requested chain position of this instance
    @returns The requested chain position of this compositor logic instance
    */
    virtual ChainPosition getChainPosition() { return CP_NOT_IMPORTANT; }

    /** Notify the compositor logic instance of the viewport it is attached to.
    @param viewport The viewport that this compositor will work on.
    @remarks Override this to add viewport specific logic code to your 
        compositor, such as setting shader params based on its dimensions
    */
    virtual void notifyViewport(Ogre::Viewport* viewport) {}

    /** Notify the compositor logic instance of the Ogre compositor that has
        been created for it
    @param instance The Ogre compositor instance that this Compositor Logic 
        manages.
    @remarks Override this to add compositor-instance specific logic to your
        compositor, such as attaching a listener.
    */
    virtual void notifyCompositor(Ogre::CompositorInstance* instance) {}

    /** D'tor
    @remarks The CompositorLogicInstance is destroyed before the 
        CompositorInstance, so unregister any listeners here
    */
    virtual ~CompositorLogicInstance() {}
};

/** A factory class managing the creation of a certain compositor
*/
class _CompositorLogicExport CompositorLogic : public Ogre::Resource  {
public:

    /// @copydoc Resource::loadImpl
    virtual void loadImpl() {}
    /// @copydoc Resource::unloadImpl
    virtual void unloadImpl() {}
    /// @copydoc Resource::calculationSize
    virtual size_t calculateSize() const { return 0; }
    
    /** Create an instance of this compositor logic.
    @returns A new instance of the compositor logic
    @remarks This method must be overriden.
    */
    virtual CompositorLogicInstance* createCompositorLogic() = 0;

    /** Get the name of this compositor logic
    @returns The name of this compositor logic
    @remarks This method must be overriden.
    */
    virtual const Ogre::String& getCompositorName() = 0;
};

#endif


Some notes :

  • CompositorLogic is parallel to Ogre's Compositor, and CompositorLogicInstance is parallel to Ogre's CompositorInstance.
  • CompositorLogicInstance inherits from Ogre's StringInterface, allowing the creator of the compositor to specify per-viewport parameters for each instance of the compositor.
  • CompositorInstance's two virtual methods - notifyViewport and notifyCompositor - allow the creator of the compositor to setup advanced parameters requiring advanced logic impossible (at least currently) to implement in scripts.




The user of the program will have to use a different class to setup the compositors in the scene. This is the CompositorLogicManager: 

#ifndef _CompositorLogicManager_H_
#define _CompositorLogicManager_H_

#include <OgrePrerequisites.h>
#include <OgreSingleton.h>
#include <OgreResourceManager.h>

#include <vector>
#include <map>

#include "CompositorLogicPrerequisities.h"
#include "CompositorLogic.h"

/**
A class in charge of managing compositor logics and their attachment to viewports
*/
class _CompositorLogicExport CompositorLogicManager : public Ogre::ResourceManager,
    public Ogre::Singleton<CompositorLogicManager> {
public:
    typedef std::vector<Ogre::String> CompositorNameList;
    typedef std::vector<CompositorLogicInstance*> CompositorList;
public:
    /** C'tor */
    CompositorLogicManager();
    /** D'tor */
    ~CompositorLogicManager();
    /** Override standard Singleton retrieval.
    @remarks
    Why do we do this? Well, it's because the Singleton
    implementation is in a .h file, which means it gets compiled
    into anybody who includes it. This is needed for the
    Singleton template to work, but we actually only want it
    compiled into the implementation of the class based on the
    Singleton, not all of them. If we don't change this, we get
    link errors when trying to use the Singleton-based class from
    an outside dll.
    @par
    This method just delegates to the template version anyway,
    but the implementation stays in this single compilation unit,
    preventing link errors.
    */
    static CompositorLogicManager& getSingleton(void);
    /** Override standard Singleton retrieval.
    @remarks
    Why do we do this? Well, it's because the Singleton
    implementation is in a .h file, which means it gets compiled
    into anybody who includes it. This is needed for the
    Singleton template to work, but we actually only want it
    compiled into the implementation of the class based on the
    Singleton, not all of them. If we don't change this, we get
    link errors when trying to use the Singleton-based class from
    an outside dll.
    @par
    This method just delegates to the template version anyway,
    but the implementation stays in this single compilation unit,
    preventing link errors.
    */
    static CompositorLogicManager* getSingletonPtr(void);

    /// copydoc ResourceManager::createImpl
    virtual CompositorLogic* createImpl(const Ogre::String& name, Ogre::ResourceHandle handle, 
        const Ogre::String& group, bool isManual, Ogre::ManualResourceLoader* loader, 
        const Ogre::NameValuePairList* createParams);

    /** Get a list of all the available compositor names
    @returns A list of all the available compositor names
    */
    CompositorNameList getAvailableCompositors();

    /** Get an ordered list of all the compositors attached to a viewport
    @param vp The viewport being questioned
    @returns A list of the compositors attached to a viewport, in order of 
        execution.
    */
    CompositorNameList getAttachedCompositors(Ogre::Viewport* vp);

    /** Get an instance of a compositor attached to a viewport
    @param vp The viewport to get the instance from
    @param compositorName the name of the compositor to get
    @returns The compositor requested
    @remarks This method is mainly useful for getting and setting instance-specific parameters
    */
    CompositorLogicInstance* getCompositorLogicInstance(Ogre::Viewport* vp, const Ogre::String& compositorName);

    /** Attach a compositor to a viewport
    @param vp The viewport to attach the compositor to
    @param compositor The name of the compositor to add
    @param enable Enable the compositor after attaching it?
    */
    void attachCompositor(Ogre::Viewport* vp, const Ogre::String& compositor, bool enable = true);

    /** Detach a compositor from a viewport
    @param vp The viewport to detach the compositor from
    @param compositor The compositor to detach
    */
    void detachCompositor(Ogre::Viewport* vp, const Ogre::String& compositor);

    /** Set a compositor's status on a certain viewport
    @param vp The viewport to change the status of
    @param compositor The compositor to set its state
    @param enabled Is the compositor enabled for this viewport?
    */
    void setCompositorEnabled(Ogre::Viewport* vp, const Ogre::String& compositor, bool enabled);
    
private:
    std::map<Ogre::Viewport*, CompositorList> mAttachedCompositors;
};

#endif


This class is parallel to CompositorManager, and has a similar API.
Some notes :

  • CompositorLogicManager does not fully replace CompositorManager. Re-ordering existing compositors in a chain, for example, still needs to be done via the CompositorManager.
  • It is important to use attachCompositor, detachCompositor and setCompositorEnabled via this new manager in order to proeperly load and run the code needed.
  • "Simple" compositors which have no code counterpart can also be used from this manager. A SimpleCompositorLogic class exists to wrap their functionality in this API. Remember - the user doesn't need to know if the compositor has code behind it.
  • The getCompositorLogicInstance exists mainly for viewport-specific parameter settings.




Here are some sequence diagrams showing the majot flows of the addon :

Attaching to a viewport

http://nomanogre.googlepages.com/CL_Attaching.png

Setting parameters

http://nomanogre.googlepages.com/CL_Params.png

Disabling and removing

http://nomanogre.googlepages.com/CL_Disable.png

Advantages

  • Easier deployment and integration of compositors with advanced code.
  • Better decoupling between the compositor and the program that using it.
  • Per-viewport parameters, with a shared interface between all compositors. An additional parameter processing layer allows for exposing high-level parameters to the user of the compositor, and translating them to the proper low level (GPU program mostly) parameters in code.
  • Automatic sanity control with illegal chains (two compositors that need to be first, for example)

Open Issues / Future Possibilities

  1. Currently, the name of the compositor and the filename of the compositor plugin (.comp file) must match. Compositor:HDR -> CompositorPlugin:HDR.comp .
  2. In the first version you will have to define the compositor itself in a script.
  3. Like plugins, the compositor plugins currently have to be placed in the working directory.

References

Improving the compositor framework thread @ Ogre forums

Schedule

Code can be found here : http://nomanogre.googlepages.com/CompositorLogic.zip

<HR>
Creative Commons Copyright -- Some rights reserved.


THE WORK (AS DEFINED BELOW) IS PROVIDED UNDER THE TERMS OF THIS CREATIVE COMMONS PUBLIC LICENSE ("CCPL" OR "LICENSE"). THE WORK IS PROTECTED BY COPYRIGHT AND/OR OTHER APPLICABLE LAW. ANY USE OF THE WORK OTHER THAN AS AUTHORIZED UNDER THIS LICENSE OR COPYRIGHT LAW IS PROHIBITED.

BY EXERCISING ANY RIGHTS TO THE WORK PROVIDED HERE, YOU ACCEPT AND AGREE TO BE BOUND BY THE TERMS OF THIS LICENSE. THE LICENSOR GRANTS YOU THE RIGHTS CONTAINED HERE IN CONSIDERATION OF YOUR ACCEPTANCE OF SUCH TERMS AND CONDITIONS.

1. Definitions

  • "Collective Work" means a work, such as a periodical issue, anthology or encyclopedia, in which the Work in its entirety in unmodified form, along with a number of other contributions, constituting separate and independent works in themselves, are assembled into a collective whole. A work that constitutes a Collective Work will not be considered a Derivative Work (as defined below) for the purposes of this License.
  • "Derivative Work" means a work based upon the Work or upon the Work and other pre-existing works, such as a translation, musical arrangement, dramatization, fictionalization, motion picture version, sound recording, art reproduction, abridgment, condensation, or any other form in which the Work may be recast, transformed, or adapted, except that a work that constitutes a Collective Work will not be considered a Derivative Work for the purpose of this License. For the avoidance of doubt, where the Work is a musical composition or sound recording, the synchronization of the Work in timed-relation with a moving image ("synching") will be considered a Derivative Work for the purpose of this License.
  • "Licensor" means the individual or entity that offers the Work under the terms of this License.
  • "Original Author" means the individual or entity who created the Work.
  • "Work" means the copyrightable work of authorship offered under the terms of this License.
  • "You" means an individual or entity exercising rights under this License who has not previously violated the terms of this License with respect to the Work, or who has received express permission from the Licensor to exercise rights under this License despite a previous violation.
  • "License Elements" means the following high-level license attributes as selected by Licensor and indicated in the title of this License: Attribution, ShareAlike.

2. Fair Use Rights

Nothing in this license is intended to reduce, limit, or restrict any rights arising from fair use, first sale or other limitations on the exclusive rights of the copyright owner under copyright law or other applicable laws.

3. License Grant

Subject to the terms and conditions of this License, Licensor hereby grants You a worldwide, royalty-free, non-exclusive, perpetual (for the duration of the applicable copyright) license to exercise the rights in the Work as stated below:

  • to reproduce the Work, to incorporate the Work into one or more Collective Works, and to reproduce the Work as incorporated in the Collective Works;
  • to create and reproduce Derivative Works;
  • to distribute copies or phonorecords of, display publicly, perform publicly, and perform publicly by means of a digital audio transmission the Work including as incorporated in Collective Works;
  • to distribute copies or phonorecords of, display publicly, perform publicly, and perform publicly by means of a digital audio transmission Derivative Works.
  • For the avoidance of doubt, where the work is a musical composition:
    • Performance Royalties Under Blanket Licenses. Licensor waives the exclusive right to collect, whether individually or via a performance rights society (e.g. ASCAP, BMI, SESAC), royalties for the public performance or public digital performance (e.g. webcast) of the Work.
    • Mechanical Rights and Statutory Royalties. Licensor waives the exclusive right to collect, whether individually or via a music rights society or designated agent (e.g. Harry Fox Agency), royalties for any phonorecord You create from the Work ("cover version") and distribute, subject to the compulsory license created by 17 USC Section 115 of the US Copyright Act (or the equivalent in other jurisdictions).
    • Webcasting Rights and Statutory Royalties. For the avoidance of doubt, where the Work is a sound recording, Licensor waives the exclusive right to collect, whether individually or via a performance-rights society (e.g. SoundExchange), royalties for the public digital performance (e.g. webcast) of the Work, subject to the compulsory license created by 17 USC Section 114 of the US Copyright Act (or the equivalent in other jurisdictions).


The above rights may be exercised in all media and formats whether now known or hereafter devised. The above rights include the right to make such modifications as are technically necessary to exercise the rights in other media and formats. All rights not expressly granted by Licensor are hereby reserved.

4. Restrictions

The license granted in Section 3 above is expressly made subject to and limited by the following restrictions:

  • You may distribute, publicly display, publicly perform, or publicly digitally perform the Work only under the terms of this License, and You must include a copy of, or the Uniform Resource Identifier for, this License with every copy or phonorecord of the Work You distribute, publicly display, publicly perform, or publicly digitally perform. You may not offer or impose any terms on the Work that alter or restrict the terms of this License or the recipients' exercise of the rights granted hereunder. You may not sublicense the Work. You must keep intact all notices that refer to this License and to the disclaimer of warranties. You may not distribute, publicly display, publicly perform, or publicly digitally perform the Work with any technological measures that control access or use of the Work in a manner inconsistent with the terms of this License Agreement. The above applies to the Work as incorporated in a Collective Work, but this does not require the Collective Work apart from the Work itself to be made subject to the terms of this License. If You create a Collective Work, upon notice from any Licensor You must, to the extent practicable, remove from the Collective Work any credit as required by clause 4(c), as requested. If You create a Derivative Work, upon notice from any Licensor You must, to the extent practicable, remove from the Derivative Work any credit as required by clause 4(c), as requested.
  • You may distribute, publicly display, publicly perform, or publicly digitally perform a Derivative Work only under the terms of this License, a later version of this License with the same License Elements as this License, or a Creative Commons iCommons license that contains the same License Elements as this License (e.g. Attribution-ShareAlike 2.5 Japan). You must include a copy of, or the Uniform Resource Identifier for, this License or other license specified in the previous sentence with every copy or phonorecord of each Derivative Work You distribute, publicly display, publicly perform, or publicly digitally perform. You may not offer or impose any terms on the Derivative Works that alter or restrict the terms of this License or the recipients' exercise of the rights granted hereunder, and You must keep intact all notices that refer to this License and to the disclaimer of warranties. You may not distribute, publicly display, publicly perform, or publicly digitally perform the Derivative Work with any technological measures that control access or use of the Work in a manner inconsistent with the terms of this License Agreement. The above applies to the Derivative Work as incorporated in a Collective Work, but this does not require the Collective Work apart from the Derivative Work itself to be made subject to the terms of this License.
  • If you distribute, publicly display, publicly perform, or publicly digitally perform the Work or any Derivative Works or Collective Works, You must keep intact all copyright notices for the Work and provide, reasonable to the medium or means You are utilizing: (i) the name of the Original Author (or pseudonym, if applicable) if supplied, and/or (ii) if the Original Author and/or Licensor designate another party or parties (e.g. a sponsor institute, publishing entity, journal) for attribution in Licensor's copyright notice, terms of service or by other reasonable means, the name of such party or parties; the title of the Work if supplied; to the extent reasonably practicable, the Uniform Resource Identifier, if any, that Licensor specifies to be associated with the Work, unless such URI does not refer to the copyright notice or licensing information for the Work; and in the case of a Derivative Work, a credit identifying the use of the Work in the Derivative Work (e.g., "French translation of the Work by Original Author," or "Screenplay based on original Work by Original Author"). Such credit may be implemented in any reasonable manner; provided, however, that in the case of a Derivative Work or Collective Work, at a minimum such credit will appear where any other comparable authorship credit appears and in a manner at least as prominent as such other comparable authorship credit.

5. Representations, Warranties and Disclaimer

UNLESS OTHERWISE AGREED TO BY THE PARTIES IN WRITING, LICENSOR OFFERS THE WORK AS-IS AND MAKES NO REPRESENTATIONS OR WARRANTIES OF ANY KIND CONCERNING THE MATERIALS, EXPRESS, IMPLIED, STATUTORY OR OTHERWISE, INCLUDING, WITHOUT LIMITATION, WARRANTIES OF TITLE, MERCHANTIBILITY, FITNESS FOR A PARTICULAR PURPOSE, NONINFRINGEMENT, OR THE ABSENCE OF LATENT OR OTHER DEFECTS, ACCURACY, OR THE PRESENCE OF ABSENCE OF ERRORS, WHETHER OR NOT DISCOVERABLE. SOME JURISDICTIONS DO NOT ALLOW THE EXCLUSION OF IMPLIED WARRANTIES, SO SUCH EXCLUSION MAY NOT APPLY TO YOU.

6. Limitation on Liability.

EXCEPT TO THE EXTENT REQUIRED BY APPLICABLE LAW, IN NO EVENT WILL LICENSOR BE LIABLE TO YOU ON ANY LEGAL THEORY FOR ANY SPECIAL, INCIDENTAL, CONSEQUENTIAL, PUNITIVE OR EXEMPLARY DAMAGES ARISING OUT OF THIS LICENSE OR THE USE OF THE WORK, EVEN IF LICENSOR HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

7. Termination

  • This License and the rights granted hereunder will terminate automatically upon any breach by You of the terms of this License. Individuals or entities who have received Derivative Works or Collective Works from You under this License, however, will not have their licenses terminated provided such individuals or entities remain in full compliance with those licenses. Sections 1, 2, 5, 6, 7, and 8 will survive any termination of this License.
  • Subject to the above terms and conditions, the license granted here is perpetual (for the duration of the applicable copyright in the Work). Notwithstanding the above, Licensor reserves the right to release the Work under different license terms or to stop distributing the Work at any time; provided, however that any such election will not serve to withdraw this License (or any other license that has been, or is required to be, granted under the terms of this License), and this License will continue in full force and effect unless terminated as stated above.

8. Miscellaneous

  • Each time You distribute or publicly digitally perform the Work or a Collective Work, the Licensor offers to the recipient a license to the Work on the same terms and conditions as the license granted to You under this License.
  • Each time You distribute or publicly digitally perform a Derivative Work, Licensor offers to the recipient a license to the original Work on the same terms and conditions as the license granted to You under this License.
  • If any provision of this License is invalid or unenforceable under applicable law, it shall not affect the validity or enforceability of the remainder of the terms of this License, and without further action by the parties to this agreement, such provision shall be reformed to the minimum extent necessary to make such provision valid and enforceable.
  • No term or provision of this License shall be deemed waived and no breach consented to unless such waiver or consent shall be in writing and signed by the party to be charged with such waiver or consent.
  • This License constitutes the entire agreement between the parties with respect to the Work licensed here. There are no understandings, agreements or representations with respect to the Work not specified here. Licensor shall not be bound by any additional provisions that may appear in any communication from You. This License may not be modified without the mutual written agreement of the Licensor and You.