RixDspy.h

Go to the documentation of this file.

/*
# ------------------------------------------------------------------------------
#
# Copyright (c) 2020 Pixar. All rights reserved.
#
# The information in this file (the "Software") is provided for the exclusive
# use of the software licensees of Pixar ("Licensees").  Licensees have the
# right to incorporate the Software into other products for use by other
# authorized software licensees of Pixar, without fee. Except as expressly
# permitted herein, the Software may not be disclosed to third parties, copied
# or duplicated in any form, in whole or in part, without the prior written
# permission of Pixar.
#
# The copyright notices in the Software and this entire statement, including the
# above license grant, this restriction and the following disclaimer, must be
# included in all copies of the Software, in whole or in part, and all permitted
# derivative works of the Software, unless such copies or derivative works are
# solely in the form of machine-executable object code generated by a source
# language processor.
#
# PIXAR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING ALL
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL PIXAR BE
# LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
# WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION
# OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
# CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.  IN NO CASE WILL
# PIXAR'S TOTAL LIABILITY FOR ALL DAMAGES ARISING OUT OF OR IN CONNECTION WITH
# THE USE OR PERFORMANCE OF THIS SOFTWARE EXCEED $50.
#
# Pixar
# 1200 Park Ave
# Emeryville CA 94608
#
# ------------------------------------------------------------------------------
*/

#ifndef RixDspyServer_h
#define RixDspyServer_h

#include "RixInterfaces.h"              // for RixInterface
#include "ndspy.h"


enum RixDeliveryMode
{
    k_RixImmediate,
    k_RixQueued
};


//
// These are constructed via RixDspy::CreateServer()
class RixDspyServer {
public:
    
    virtual ~RixDspyServer() {};
    
    enum State
    {
        k_NeverServed,
        k_Serving,
        k_DoneServing
    };
    
    virtual State GetState() const = 0;
};


class RixDspy : public RixInterface
{
public:

    typedef void (*ServerListener)(RixDspyServer const& server,
                                    void* clientData);

    
    virtual RixDspyServer* CreateServer(const char* in, const char* out) = 0;

    virtual RixDspyServer* CreateServer(const char* in, const char* out,
                                        ServerListener listener,
                                        void* clientData) = 0;

    virtual void ProcessCallbacks() = 0;
    
    virtual void SetDeliveryMode(RixDeliveryMode mode) = 0;

    
    virtual PtDspyError
    FindStringInParamList(
                          const char* string,
                          char** result,
                          int paramCount,
                          const UserParameter* parameters) = 0;

    virtual PtDspyError
    FindIntInParamList(
                           const char* string,
                           int* result,
                           int paramCount,
                           const UserParameter* parameters) = 0;
    
    virtual PtDspyError
    FindIntsInParamList(
                            const char* string,
                            int* resultCount,
                            int* result,
                            int paramCount,
                            const UserParameter* parameters) = 0;
    
    virtual PtDspyError
    FindFloatInParamList(
                           const char* string,
                           float* result,
                           int paramCount,
                           const UserParameter* parameters) = 0;
    
    virtual PtDspyError
    FindFloatsInParamList(
                            const char* string,
                            int* resultCount,
                            float* result,
                            int paramCount,
                            const UserParameter* parameters) = 0;
    
    virtual PtDspyError
    RegisterDriverTable(
                            const char* name,
                            const PtDspyDriverFunctionTable* pTable) = 0;

    virtual PtDspyError
    ReorderFormatting(
                            int formatCount,
                            PtDspyDevFormat* format,
                            int outFormatCount,
                            const PtDspyDevFormat* outFormat) = 0;

    virtual unsigned int
    ByteCountForType(PtDspyUnsigned32 type) = 0;
    

protected:
    RixDspy() : RixInterface(1) {}
    virtual ~RixDspy() {}
};

#endif