/* ScummVM - Graphic Adventure Engine
 *
 * ScummVM is the legal property of its developers, whose names
 * are too numerous to list here. Please refer to the COPYRIGHT
 * file distributed with this source distribution.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 */

#ifndef VIDEO_SUBTITLES_H
#define VIDEO_SUBTITLES_H

#include "common/str.h"
#include "common/array.h"
#include "common/hashmap.h"
#include "common/rect.h"

#include "graphics/surface.h"

namespace Graphics {
class Font;
}

namespace Video {

struct SubtitlePart {
	Common::String text;
	Common::String tag;

	SubtitlePart(const Common::String &text_, const Common::String &tag_) : text(text_), tag(tag_) {}
};

struct SRTEntry {
	uint seq;
	uint32 start;
	uint32 end;

	Common::Array<SubtitlePart> parts;

	SRTEntry(uint seq_, uint32 start_, uint32 end_) {
		seq = seq_; start = start_; end = end_;
	}

	// Dummy constructor for bsearch
	SRTEntry(uint seq_, uint32 start_, uint32 end_, const Common::String &text, const Common::String &tag = "") {
		seq = seq_; start = start_; end = end_;
		parts.push_back(SubtitlePart(text, tag));
	}
};

class SRTParser {
public:
	SRTParser();
	~SRTParser();

	void cleanup();
	bool parseFile(const Common::Path &fname);
	void parseTextAndTags(const Common::String &text, Common::Array<SubtitlePart> &parts) const;
	const Common::Array<SubtitlePart> *getSubtitleParts(uint32 timestamp) const;
	bool isSfx() const;

private:
	Common::Array<SRTEntry *> _entries;
};

class Subtitles {
public:
	enum FontStyle : int {
		kFontStyleRegular = 0,
		kFontStyleItalic,
	};

	Subtitles();
	virtual ~Subtitles();

	void loadSRTFile(const Common::Path &fname);
	void close();
	void setFont(const char *fontname, int height = 18, FontStyle type = kFontStyleRegular);
	void setBBox(const Common::Rect &bbox);
	void setColor(byte r, byte g, byte b);
	void setPadding(uint16 horizontal, uint16 vertical);
	bool drawSubtitle(uint32 timestamp, bool force = false, bool showSFX = false) const;
	bool isSfx() const {
		if (!_srtParser)
			return false;
		return _srtParser->isSfx();
	}
	bool isLoaded() const { return _loaded || _subtitleDev; }
	virtual void clearSubtitle() const;

protected:
	bool recalculateBoundingBox() const;
	void renderSubtitle() const;
	void translateBBox(int16 dx, int16 dy) const { _realBBox.translate(dx, dy); }
	virtual void updateSubtitleOverlay() const;
	virtual bool shouldShowSubtitle() const { return true; }

	bool _loaded;
	mutable const Common::Array<SubtitlePart> *_parts = nullptr;
	mutable uint16 _splitPartCount = 0;

private:
	SRTParser *_srtParser = nullptr;
	bool _subtitleDev;
	bool _overlayHasAlpha;

	mutable Common::Array<SubtitlePart> _devParts;

	Common::HashMap<int, const Graphics::Font *> _fonts;
	int _fontHeight;

	mutable Graphics::Surface _surface;

	mutable Common::Rect _drawRect;
	Common::Rect _requestedBBox;
	mutable Common::Rect _realBBox;
	mutable int16 _lastOverlayWidth, _lastOverlayHeight;

	Common::Path _fname;
	uint32 _color;
	uint32 _blackColor;
	uint32 _transparentColor;
	uint16 _hPad;
	uint16 _vPad;
};

} // End of namespace Video

#endif