sdm/include/private/noise_algo_intf.h

/*
 * Copyright (c) 2021 The Linux Foundation. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met:
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above
 *       copyright notice, this list of conditions and the following
 *       disclaimer in the documentation and/or other materials provided
 *       with the distribution.
 *     * Neither the name of The Linux Foundation nor the names of its
 *       contributors may be used to endorse or promote products derived
 *       from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESS OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS
 * 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.
 *
 */

#ifndef __NOISE_ALGO_INTF_H__
#define __NOISE_ALGO_INTF_H__

#include <private/generic_payload.h>
#include <private/generic_intf.h>
#include <memory>

namespace sdm {

enum NoiseAlgoParams { kNoiseAlgoPramsMax = 0xfff };

enum NoiseAlgoOps {
  kOpsRunNoiseAlgo,  // Calculate Noise strength & Noise Alpha
  kNoiseAlgoOpsMax = 0xfff
};

struct NoiseAlgoInputParams {
  uint32_t attn_factor = ~0x0;       // Attenuation factor
  uint32_t zpos_attn_layer = ~0x0;   // Attenuation layer position
  uint32_t zpos_noise_layer = ~0x0;  // Noise layer position
};

struct NoiseAlgoOutputParams {
  uint32_t attn_factor = ~0x0;       // Will be same as input
  uint32_t zpos_attn_layer = ~0x0;   // Will be same as input
  uint32_t zpos_noise_layer = ~0x0;  // Will be same as input
  uint32_t strength = ~0x0;          // Output Noise strength
  uint32_t alpha_noise = ~0x0;       // Output Noise Alpha (transparency coefficient)
  bool temporal_en = true;           // Enable temporal rotation of Noise matrix
};

using NoiseAlgoIntf = GenericIntf<NoiseAlgoParams, NoiseAlgoOps, GenericPayload>;

class NoiseAlgoFactoryIntf {
 public:
  virtual ~NoiseAlgoFactoryIntf() {}
  virtual std::unique_ptr<NoiseAlgoIntf> CreateNoiseAlgoIntf(uint32_t major_ver,
                                                             uint32_t minor_ver) = 0;
};

extern "C" NoiseAlgoFactoryIntf *GetNoiseAlgoFactoryIntf();

}  // namespace sdm

#endif  // __NOISE_ALGO_INTF_H__