recycled-ni-neutrino/src/gui/movieinfo.h

/*
	movieinfo - Neutrino-GUI

	Copyright (C) 2005 Günther <Günther@tuxbox.berlios.org>
	Copyright (C) 2015 Sven Hoefer (svenhoefer)

	License: GPL

	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 2 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, write to the Free Software
	Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.

*/

#ifndef MOVIEINFO_H_
#define MOVIEINFO_H_

#define __USE_FILE_OFFSET64 1

#ifdef HAVE_CONFIG_H
#include <config.h>
#endif

#include <string>
#include <vector>
#include <stdint.h>
#include "driver/file.h"

/* XML tags for xml file*/
#define MI_XML_TAG_NEUTRINO		"neutrino"
#define MI_XML_TAG_RECORD		"record"
#define MI_XML_TAG_CHANNELNAME		"channelname"
#define MI_XML_TAG_EPGTITLE		"epgtitle"
#define MI_XML_TAG_ID			"id"
#define MI_XML_TAG_INFO1		"info1"
#define MI_XML_TAG_INFO2		"info2"
#define MI_XML_TAG_EPGID		"epgid"
#define MI_XML_TAG_MODE			"mode"
#define MI_XML_TAG_VIDEOPID		"videopid"
#define MI_XML_TAG_VIDEOTYPE		"videotype"
#define MI_XML_TAG_AUDIOPIDS		"audiopids"
#define MI_XML_TAG_AUDIO		"audio"
#define MI_XML_TAG_PID			"pid"
#define MI_XML_TAG_NAME			"name"
#define MI_XML_TAG_ATYPE		"audiotype"
#define MI_XML_TAG_SELECTED		"selected"
#define MI_XML_TAG_VTXTPID		"vtxtpid"
#define MI_XML_TAG_GENRE_MAJOR		"genremajor"
#define MI_XML_TAG_GENRE_MINOR		"genreminor"
#define MI_XML_TAG_SERIE_NAME		"seriename"
#define MI_XML_TAG_LENGTH		"length"
#define MI_XML_TAG_PRODUCT_COUNTRY	"productioncountry"
#define MI_XML_TAG_PRODUCT_DATE		"productiondate"
#define MI_XML_TAG_RATING		"rating"
#define MI_XML_TAG_QUALITY		"quality"
#define MI_XML_TAG_QUALITIY		"qualitiy"	// just to keep compatibility to older xml-files
#define MI_XML_TAG_PARENTAL_LOCKAGE	"parentallockage"
#define MI_XML_TAG_BOOKMARK		"bookmark"
#define MI_XML_TAG_BOOKMARK_START	"bookmarkstart"
#define MI_XML_TAG_BOOKMARK_END		"bookmarkend"
#define MI_XML_TAG_BOOKMARK_LAST	"bookmarklast"
#define MI_XML_TAG_BOOKMARK_USER	"bookmarkuser"
#define MI_XML_TAG_BOOKMARK_USER_POS	"bookmarkuserpos"
#define MI_XML_TAG_BOOKMARK_USER_TYPE	"bookmarkusertype"
#define MI_XML_TAG_BOOKMARK_USER_NAME	"bookmarkusername"
#define MI_XML_TAG_DATE_OF_LAST_PLAY	"dateoflastplay"

#define MI_MAX_AUDIO_PIDS 4		// just to avoid the buffer is filled endless, might be increased later on , but 4 audio pids might be enough
#define MI_MOVIE_BOOK_USER_MAX 20	// just to avoid the buffer is filled endless, might be increased later on. Make sure to increase the bookmark menu as well

typedef enum
{
	MI_PARENTAL_OVER0	= 0,
	MI_PARENTAL_OVER6	= 6,
	MI_PARENTAL_OVER12	= 12,
	MI_PARENTAL_OVER16	= 16,
	MI_PARENTAL_OVER18	= 18,
	MI_PARENTAL_ALWAYS	= 99,
	MI_PARENTAL_MAX_NUMBER	= 100
} MI_PARENTAL_LOCKAGE;

typedef struct
{
	int pos;		// position in seconds from file start
	int length;		// bookmark type, 0: just a bookmark, < 0 jump back (seconds), > 0 jump forward (seconds)
	std::string name;	// bookmark name to be displayed
} MI_BOOKMARK;

typedef struct
{
	int start;		// movie start in seconds from file start
	int end;		// movie end in seconds from file start
	int lastPlayStop;	// position of last play stop in seconds from file start
	MI_BOOKMARK user[MI_MOVIE_BOOK_USER_MAX]; // other user defined bookmarks
} MI_MOVIE_BOOKMARKS;

typedef struct
{
	int atype;
	int selected;
	int AudioPid;		// audio pid nr, usually filled by VCR
	std::string AudioPidName; // audio pid name, usually filled by VCR
} AUDIO_PIDS;

class MI_MOVIE_INFO //MI_MOVIE_INFO &operator=(const MI_MOVIE_INFO& src);
{
	public:
		CFile file;			// not stored in xml
		std::string productionCountry;	// user defined Country (not from EPG yet, but might be possible)
		std::string epgTitle;		// plain movie name, usually filled by EPG
		std::string epgInfo1;		// used for Genre (Premiere) or second title, usually filled by EPG
		std::string epgInfo2;		// detailed movie content, usually filled by EPG
		std::string channelName;	// channel name, auto filled
		std::string serieName;		// user defines series name

		time_t dateOfLastPlay;		// last play date of movie in seconds since 1970
		int dirItNr;			// handle for quick directory path access only, this is not saved in xml, might be used by the owner of the movie info struct
		int genreMajor;			// see showEPG class for more info, usually filled by EPG
		char genreMinor;		// genreMinor not used so far
		int length;			// movie length in minutes, usually filled by EPG
		int rating;			// user rating (like IMDb rating; 75 means 7.5/10)
		int quality;			// user classification (3 stars: classics, 2 stars: very good, 1 star: good, 0 stars: OK)
		int productionDate;		// user defined Country (not from EPG yet, but might be possible)
		int parentalLockAge;		// used for age rating(0:never,6,12,16,18 years,99:always), usually filled by EPG (if available)
		//char format;			// currently not used
		//char audio;			// currently not used
		MI_MOVIE_BOOKMARKS bookmarks;	// bookmark collecton for this movie
		std::vector<AUDIO_PIDS> audioPids; // available AudioPids, usually filled by VCR. Note: Vectors are easy to is also using the heap (memory fragmentation), might be changed to array [MI_MAX_AUDIO_PIDS]

		uint64_t channelId;		// channel id, auto filled
		uint64_t epgId;			// EPG id, usually filled by EPG
		int mode;			// record mode (0: unknown; 1: tv record; 2: radio record)
		int VideoPid;			// currently not used, we just do not want to loose this info if movie info is saved backed
		int VideoType;
		int VtxtPid;			// currently not used, we just do not want to loose this info if movie info is saved backed

		bool marked;
		bool delAsk;

		std::string tfile;		// thumbnail/cover file name

		std::string ytdate;		// youtube published
		std::string ytid;		// youtube published
		int ytitag;			// youtube quality profile

		enum miSource {
			UNKNOWN = 0,
			YT,
			NK
		};
		miSource source;

		void clear(void);
		MI_MOVIE_INFO() { clear(); }
};

typedef std::vector<MI_MOVIE_INFO> MI_MOVIE_LIST;
typedef std::vector<MI_MOVIE_INFO*> P_MI_MOVIE_LIST;

class CMovieInfo
{
	public:	// Functions
		CMovieInfo();
		~CMovieInfo();
		bool convertTs2XmlName(std::string &filename);					// convert a ts file name in .xml file name
		bool loadMovieInfo(MI_MOVIE_INFO *movie_info, CFile *file = NULL );		// load movie information for the given .xml filename. If there is no filename, the filename (ts) from movie_info is converted to xml and used instead
		bool encodeMovieInfoXml(std::string *extMessage, MI_MOVIE_INFO *movie_info);	// encode the movie_info structure to xml string
		bool saveMovieInfo(MI_MOVIE_INFO &movie_info, CFile *file = NULL );		// encode the movie_info structure to xml and save it to the given .xml filename. If there is no filename, the filename (ts) from movie_info is converted to xml and used instead
		bool addNewBookmark(MI_MOVIE_INFO *movie_info, MI_BOOKMARK &new_bookmark);	// add a new bookmark to the given movie info. If there is no space false is returned

	private: // Functions
		bool parseXmlTree(std::string &text, MI_MOVIE_INFO *movie_info);
		bool loadFile(CFile &file, std::string &buffer);
		bool saveFile(const CFile &file, std::string &buffer);
};

#endif /*MOVIEINFO_H_*/