dwarfs/ricepp/include/ricepp/encoder_interface.h
2025-04-07 21:32:26 +02:00

59 lines
1.9 KiB
C++

/* vim:set ts=2 sw=2 sts=2 et: */
/**
* \author Marcus Holland-Moritz (github@mhxnet.de)
* \copyright Copyright (c) Marcus Holland-Moritz
*
* This file is part of ricepp.
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the “Software”), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*
* SPDX-License-Identifier: MIT
*/
#pragma once
#include <concepts>
#include <cstdint>
#include <span>
#include <vector>
namespace ricepp {
template <std::unsigned_integral PixelT>
class encoder_interface {
public:
using pixel_type = PixelT;
virtual ~encoder_interface() = default;
[[nodiscard]] virtual std::vector<uint8_t>
encode(std::span<pixel_type const> input) const = 0;
virtual size_t worst_case_encoded_bytes(size_t pixel_count) const = 0;
virtual size_t
worst_case_encoded_bytes(std::span<pixel_type const> input) const = 0;
virtual std::span<uint8_t>
encode(std::span<uint8_t> output,
std::span<pixel_type const> input) const = 0;
};
} // namespace ricepp