#ifndef IMAGE_BUILDERS_H
#define IMAGE_BUILDERS_H

#include "tfilepath.h"

#include "toonz/imagemanager.h"

//======================================================

//  Forward declarations

class TImageInfo;
class TXshSimpleLevel;

//======================================================

//***************************************************************************************
//    ImageLoader  class declaration
//***************************************************************************************

/*!
  ImageLoader is the specialized ImageBuilder class used to automatically load
  images from a level file on hard disk.

  Refer to ImageLoader::BuildExtData for a description of the allowed options for
  image loading.
*/
class ImageLoader : public ImageBuilder
{
public:
	struct BuildExtData {
		const TXshSimpleLevel *m_sl; //!< TXshSimpleLevel instance associated to an image loading request
		TFrameId m_fid;				 //!< m_sl's fid at which the image will be loaded

		int m_subs; //!< The subsampling factor for image loading (0 meaning either
		//!< 'the currently stored one' if an image is already cached, or
		//!< m_sl's subsampling property otherwise)
		bool m_icon; //!< Whether the icon (if any) should be loaded instead

	public:
		BuildExtData(const TXshSimpleLevel *sl, const TFrameId &fid, int subs = 0, bool icon = false)
			: m_sl(sl), m_fid(fid), m_subs(subs), m_icon(icon) {}
	};

public:
	ImageLoader(const TFilePath &path, const TFrameId &fid);

	bool isImageCompatible(int imFlags, void *extData);

	/*-- ImageBuilder仮想関数の実装。アイコン、画像をLoad時に全てキャッシュに格納する --*/
	void buildAllIconsAndPutInCache(TXshSimpleLevel *level,
									std::vector<TFrameId> fids,
									std::vector<std::string> iconIds,
									bool cacheImagesAsWell);

protected:
	bool getInfo(TImageInfo &info, int imFlags, void *extData);
	TImageP build(int imFlags, void *extData);

	void invalidate();

	inline int buildSubsampling(int imFlags, BuildExtData *data);

private:
	TFilePath m_path; //!< Level path to load images from
	TFrameId m_fid;   //!< Frame of the level to load

	bool m_64bitCompatible; //!< Whether current image is 64-bit compatible
	int m_subsampling;		//!< Current image subsampling
							//!< NOTE: Should this be replaced by requests to the TImageCache?
};

//-----------------------------------------------------------------------------

class ImageRasterizer : public ImageBuilder
{
public:
	ImageRasterizer() {}
	~ImageRasterizer() {}

	bool isImageCompatible(int imFlags, void *extData) { return true; }

protected:
	bool getInfo(TImageInfo &info, int imFlags, void *extData);
	TImageP build(int imFlags, void *extData);
};

//-----------------------------------------------------------------------------

class ImageFiller : public ImageBuilder
{
public:
	ImageFiller() {}
	~ImageFiller() {}

	bool isImageCompatible(int imFlags, void *extData) { return true; }

protected:
	bool getInfo(TImageInfo &info, int imFlags, void *extData);
	TImageP build(int imFlags, void *extData);
};

#endif // IMAGE_BUILDERS_H