TIL_NullFilter.C

Go to the documentation of this file.

/*
 * Copyright (c) 2025
 *    Side Effects Software Inc.  All rights reserved.
 *
 * Redistribution and use of Houdini Development Kit samples in source and
 * binary forms, with or without modification, are permitted provided that the
 * following conditions are met:
 * 1. Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 * 2. The name of Side Effects Software may not be used to endorse or
 *    promote products derived from this software without specific prior
 *    written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY SIDE EFFECTS SOFTWARE 'AS IS' AND ANY EXPRESS
 * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN
 * NO EVENT SHALL SIDE EFFECTS SOFTWARE BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
 * OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
 * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 */

#include "TIL_NullFilter.h"
#include <FS/UT_DSO.h>
#include <UT/UT_EnvControl.h>
#include <UT/UT_Debug.h>
#include <UT/UT_DSOVersion.h>
#include <UT/UT_WorkArgs.h>
#include <stdio.h>
#include <stdarg.h>

TIL_NullFilter::TIL_NullFilter()
    : myVerbose(false)
{
}

bool
TIL_NullFilter::setOptions(const UT_Options &o)
{
    bool        bval;
    if (o.importOption("verbose", bval))
        myVerbose = bval;

    if (myVerbose)
    {
        UTformat("{}: options:\n", className());
        o.dump();
    }
    return true;
}

TIL_NullFilter::~TIL_NullFilter()
{
}

static void
dumpRasterInfo(const char *name, const PXL_Raster *rp)
{
    UTformat("  raster[{}]: {}x{} - {} - {}\n",
                name,
                rp->getXres(),
                rp->getYres(),
                PXLdataFormat(rp->getFormat()),
                PXLpacking(rp->getPacking()));
}

bool
TIL_NullFilter::apply(PXL_Raster *raster)
{
    // TODO:  Here's where we'd actually change the raster
    if (myVerbose)
    {
        UTformat("{} process raster\n", className());
        dumpRasterInfo("", raster);

        UTformat("  {} extra rasters:\n", myAuxPlanes.size());
        for (const auto &item : myAuxPlanes)
            UTformat("    - {}: {}\n", item.first, item.second);
        UTformat("  ErrorString: '{}'", myErrorString);
    }
    return true;
}

void
TIL_NullFilter::reset()
{
    // This method gets called when starting a new image.  There may be
    // multiple calls to apply() if there are multiple AOVs which are filtered.
    //
    // Must call the base-class reset
    TIL_RasterFilter::reset();
}

namespace
{
    struct Factory final : public TIL_RasterFilter::Factory
    {
        Factory()
        {
        }
        ~Factory() override
        {
        }
        const UT_StringHolder   &name() const override
        {
            static constexpr UT_StringLit   theName("null_filter");
            return theName.asHolder();
        }
        const UT_StringHolder   &label() const override
        {
            static constexpr UT_StringLit   theName("Null Filter");
            return theName.asHolder();
        }
        UT_UniquePtr<TIL_RasterFilter>  newFilter() const override
        {
            return UTmakeUnique<TIL_NullFilter>();
        }
    };
}

void
newRasterFilter()
{
    // Register different filters
    UTdebugFormat("Registering Null Image Filter");
    TIL_RasterFilter::registerFactory(UTmakeUnique<Factory>());
}