CWE-ou-minkata/Sources/Plasma/PubUtilLib/plAudioCore/plSrtFileReader.h

/*==LICENSE==*

CyanWorlds.com Engine - MMOG client, server and tools
Copyright (C) 2011 Cyan Worlds, Inc.

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/>.

Additional permissions under GNU GPL version 3 section 7

If you modify this Program, or any covered work, by linking or
combining it with any of RAD Game Tools Bink SDK, Autodesk 3ds Max SDK,
NVIDIA PhysX SDK, Microsoft DirectX SDK, OpenSSL library, Independent
JPEG Group JPEG library, Microsoft Windows Media SDK, or Apple QuickTime SDK
(or a modified version of those libraries),
containing parts covered by the terms of the Bink SDK EULA, 3ds Max EULA,
PhysX SDK EULA, DirectX SDK EULA, OpenSSL and SSLeay licenses, IJG
JPEG Library README, Windows Media SDK EULA, or QuickTime SDK EULA, the
licensors of this Program grant you additional
permission to convey the resulting work. Corresponding Source for a
non-source form of such a combination shall include the source code for
the parts of OpenSSL and IJG JPEG Library used as well as that of the covered
work.

You can contact Cyan Worlds, Inc. by email legal@cyan.com
 or by snail mail at:
	  Cyan Worlds, Inc.
	  14617 N Newport Hwy
	  Mead, WA   99021

*==LICENSE==*/
//////////////////////////////////////////////////////////////////////////////
//                                                                          //
//  plSrtFileReader - Class for reading an SRT format file and              //
//                    storing the read entries for access later             //
//                                                                          //
//////////////////////////////////////////////////////////////////////////////

#ifndef _plSrtFileReader_h
#define _plSrtFileReader_h

#include "hsTypes.h"
#include "../pnUtils/pnUtils.h"

#include <cstdint>
#include <vector>

class plSrtEntry
{
public:

	plSrtEntry(uint32_t entryNum, uint32_t startTimeMs, uint32_t endTimeMs, std::string subtitleText, std::string speakerName)
		: fEntryNum(entryNum), fStartTimeMs(startTimeMs), fEndTimeMs(endTimeMs), fSubtitleText(std::move(subtitleText)),
		fSpeakerName(std::move(speakerName)) { }

	plSrtEntry(uint32_t entryNum, uint32_t startTimeMs, uint32_t endTimeMs, std::string subtitleText)
		: fEntryNum(entryNum), fStartTimeMs(startTimeMs), fEndTimeMs(endTimeMs), fSubtitleText(std::move(subtitleText)) { }

	std::string     GetSubtitleText() const { return fSubtitleText; }
	std::string     GetSpeakerName() const { return fSpeakerName; }
	uint32_t		GetStartTimeMs() const { return fStartTimeMs; }
	uint32_t		GetEndTimeMs() const { return fEndTimeMs; }

protected:

	uint32_t		fEntryNum;
	uint32_t		fStartTimeMs;
	uint32_t		fEndTimeMs;
	std::string		fSubtitleText;
	std::string		fSpeakerName;

};

class plSrtFileReader
{
public:

	plSrtFileReader(const char* audioFileName)
		: fAudioFileName(StrDup(audioFileName)), fCurrentEntryIndex(0) { }
	virtual ~plSrtFileReader() { delete[] fAudioFileName; }

	bool            ReadFile();
	void            StartOver() { fCurrentEntryIndex = 0; }
	const char*		GetCurrentAudioFileName() const { return fAudioFileName; }
	void            AdvanceToTime(uint32_t timeMs);
	plSrtEntry*		GetNextEntryStartingBeforeTime(uint32_t timeMs);
	plSrtEntry*		GetNextEntryEndingBeforeTime(uint32_t timeMs);
	uint32_t		GetLastEntryEndTime();

protected:

	const char*		fAudioFileName;
	std::vector<plSrtEntry> fEntries;
	uint32_t		fCurrentEntryIndex;

};

#endif //_plSrtFileReader_h