<?php
/**
 * Interface LuminanceSourceInterface
 *
 * @created      18.11.2021
 * @author       smiley <smiley@chillerlan.net>
 * @copyright    2021 smiley
 * @license      MIT
 */
declare(strict_types=1);

namespace chillerlan\QRCode\Common;

use chillerlan\QRCode\QROptions;
use chillerlan\Settings\SettingsContainerInterface;

/**
 * Interface for the luminance sources
 */
interface LuminanceSourceInterface{

	/**
	 * Fetches luminance data for the underlying bitmap. Values should be fetched using:
	 * `int luminance = array[y * width + x] & 0xff`
	 *
	 * @return int[] A row-major 2D array of luminance values. Do not use result $length as it may be
	 *         larger than $width * $height bytes on some platforms. Do not modify the contents
	 *         of the result.
	 *
	 * @deprecated 6.0.1 This method will be removed. In v7, use the property "LuminanceSourceInterface::$luminances" instead.
	 */
	public function getLuminances():array;

	/**
	 * @return int The width of the bitmap.
	 *
	 * @deprecated 6.0.1 This method will be removed. In v7, use the property "LuminanceSourceInterface::$width" instead.
	 */
	public function getWidth():int;

	/**
	 * @return int The height of the bitmap.
	 *
	 * @deprecated 6.0.1 This method will be removed. In v7, use the property "LuminanceSourceInterface::$height" instead.
	 */
	public function getHeight():int;

	/**
	 * Fetches one row of luminance data from the underlying platform's bitmap. Values range from
	 * 0 (black) to 255 (white). Because Java does not have an unsigned byte type, callers will have
	 * to bitwise and with 0xff for each value. It is preferable for implementations of this method
	 * to only fetch this row rather than the whole image, since no 2D Readers may be installed and
	 * getLuminances() may never be called.
	 *
	 * @param int $y  The row to fetch, which must be in [0,getHeight())
	 *
	 * @return int[] An array containing the luminance data.
	 * @throws \chillerlan\QRCode\Decoder\QRCodeDecoderException
	 */
	public function getRow(int $y):array;

	/**
	 * Creates a LuminanceSource instance from the given file
	 */
	public static function fromFile(string $path, SettingsContainerInterface|QROptions $options = new QROptions):static;

	/**
	 * Creates a LuminanceSource instance from the given data blob
	 */
	public static function fromBlob(string $blob, SettingsContainerInterface|QROptions $options = new QROptions):static;

}
