path: root/mg_image_provider.c

//
#include "mg_image_provider.h"

#include "mg_item_gd.h"
#include "mg_tools.h"
#include "mg_setup.h"

#include <vdr/plugin.h>

#include <id3v2header.h>
#include <flacfile.h>
#include <vorbisfile.h>
#include <mpegfile.h>
#include <attachedpictureframe.h>

#include <cstring>
#include <iostream>
#include <stdio.h>
#include <dirent.h>
#include <libgen.h>
#include <fileref.h>
#include <sys/types.h>
#include <sys/stat.h>
#include <unistd.h>
#include <fts.h>
#include <regex.h>
#include <errno.h>

using namespace std;

extern int alphasort();

const int FALSE = 0;
const int TRUE =  1;

int picture_select( struct dirent const *entry ) {
	if( (strcmp(entry->d_name, ".") == 0) ||
	(strcmp(entry->d_name, "..") == 0) ) {
		return (FALSE);
	}
	else {
		char *ext = rindex( entry->d_name, '.' );

		if( ext ) {
			if( !strcmp( ext, ".jpg" ) || !strcmp( ext, ".png" ) || !strcmp( ext, ".JPG" ) || !strcmp( ext, ".PNG" ) ) {
				return (TRUE);
			}
			else {
				return ( FALSE );
			}
		}
		else {
			return (FALSE);
		}
	}
}

#if 0
mgImage::mgImage() {
	bmp=0;
}

mgImage::~mgImage() {
	delete bmp;bmp=0;
}
#endif

string mgImageProvider::getImagePath( string &source ) {
	// returns converted image name, writes source image name into source argument reference
	string fname="";
	source = "";

	if (m_image_index>=m_image_list.size())
		m_image_index=0;
	if( m_image_index < m_image_list.size() ) {
		source = m_image_list[ m_image_index ];
	}
	m_image_index += 1;

	return fname;
}

mgMpgImageProvider::mgMpgImageProvider(tArea area) 
	: mgImageProvider(area) {
}	


mgImageProvider::mgImageProvider( string dir ) {
	// iterate all files in dir and put them into m_image_list
        currItem=0;
	m_mode = IM_PLAYLIST;
	m_image_index = 0;
	m_delete_imgs_from_tag = false;

	fillImageList( dir );
}

mgMpgImageProvider::mgMpgImageProvider( string dir ) 
	: mgImageProvider(dir) {
	Start();
}

mgImageProvider::mgImageProvider(tArea area ) {
	currItem=0;
	m_mode = IM_ITEM_DIR;
	m_image_index = 0;
	m_delete_imgs_from_tag = false;
	coverarea=area;
}

mgMpgImageProvider::~mgMpgImageProvider() {
	Lock();
	m_converted_images.clear();
	Unlock();
}

bool mgImageProvider::extractImagesFromDatabase() {
	/* GD entry looks like: img0x00004810-00.jpg
	   and may reside in $ToplevelDir/[0-9]{2}/

	   Then, all img0x00004810-??.jpg are possible matches, but not
	   files such as img0x00004810-00-s200.jpg which are optimized
	   for a different resoluition.

	   Thanks to viking (from vdrportal.de) for help with this
	*/
	string file = currItem->getImagePath();
	if( file == "" ) {
		return false;
	}

	// cut -00.jpg part from file
	int pos = file.find('-');
	string file_rex_s = file.substr( 0, pos+1 );
	file_rex_s += "[0-9]*.jpg";
	// now file_rex contains a regular expression we can test for to obtain valid images

	bool result = false;

	char *dir[2];
	dir[0] = the_setup.ToplevelDir;
	dir[1] = NULL;

	FTS *fts = fts_open( dir, FTS_LOGICAL, 0);
	if( fts ) {
		FTSENT *ftsent;
		regex_t path_rex, file_rex;

		if( regcomp( &path_rex, "[0-9][0-9]", REG_NOSUB ) ) {
			mgDebug( 1, "mgImageProvider::extractImagesFromDatabase: Error compiling dir regex. Not using GD images." );
			return false;
		}

		if( regcomp( &file_rex, file_rex_s.c_str(), REG_NOSUB ) ) {
			mgDebug( 1, "mgImageProvider::extractImagesFromDatabase: Error compiling file regex. Not using GD images." );
			return false;
		}

		while( (ftsent = fts_read(fts)) != NULL ) {
			switch( ftsent->fts_info ) {
				case FTS_DC:
				{
					mgDebug( 1, "Image import: Ignoring directory %s, would cycle already seen %s",
						ftsent->fts_path,ftsent->fts_cycle->fts_path );
				} break;
				case FTS_DNR:
				{
					mgDebug( 1, "Ignoring unreadable directory %s: error %d",
						ftsent->fts_path,ftsent->fts_errno);
				} break;
				case FTS_DOT:
				{
					mgDebug( 1, "Ignoring dot file %s:",
						ftsent->fts_path );
				} break;
				case FTS_SLNONE:
				{
					mgDebug(1,"Ignoring broken symbolic link %s",
						ftsent->fts_path);
				} break;
				case FTS_NSOK:	 // should never happen because we do not do FTS_NOSTAT
				case FTS_SL:	 // should never happen because we do FTS_LOGICAL
				case FTS_ERR:
				{
					mgDebug( 1, "Ignoring %s: error %d",
						ftsent->fts_path,ftsent->fts_errno );
				} break;
				case FTS_D:
				{
					if( !regexec( &path_rex, ftsent->fts_name, 0, NULL, 0 ) ) {
						fts_set( fts, ftsent, FTS_SKIP );
						mgDebug( 1, "Skipping directory %s", ftsent->fts_path );
					}
				} break;
				case FTS_DP:
					break;
				case FTS_F:
				{
					if( !ftsent->fts_path ) {
						mgDebug( 1, "internal error: fts_path is 0" );
					}
					else if( access( ftsent->fts_path, R_OK ) ) {
						mgDebug( 1, "Ignoring unreadable file %s: %s",
							ftsent->fts_path, strerror( errno ) );
					}
					else {
						if( regexec( &file_rex, ftsent->fts_name, 0, NULL, 0 ) ) {
								 // an image matching the GD database entry
							string img = string( ftsent->fts_path );
							m_image_list.push_back( img );
							mgDebug( 1, "Found image %s", ftsent->fts_path );
						}
					}
				} break;
				case FTS_NS:
				{
					mgDebug( 1, "Ignoring unstatable file %s: error %d",
						ftsent->fts_path,ftsent->fts_errno );
				} break;
				default:
				{
					mgDebug( 1, "Ignoring %s: unknown fts_info value %d",
						ftsent->fts_path,ftsent->fts_info );
				}
			}
		}
		fts_close(fts);
		regfree( &path_rex );
	}
	return result;
}

void mgImageProvider::updateFromItemDirectory() {
	// no images in tags, find images in the directory of the file itself
	string dir = dirname( (char *) (currItem->getSourceFile().c_str()) );

	// do something, when there are no images here, either:
	// simply go up one step in the directory hierarchy, until we reach top level directory
	bool toplevel_reached = false;
	while( !m_image_list.size() && !toplevel_reached ) {
		if( samedir( dir.c_str(), the_setup.ToplevelDir ) ) {
			toplevel_reached = true;
		}

		fillImageList( dir );

		if( !m_image_list.size() ) {
			// nothing found, turn up one directory level
			dir = dirname( (char *)dir.c_str() );
		}
	}
}

bool mgImageProvider::updateItem( mgItemGd *newitem ) {
	// clean up stuff from previous item ?

	if (newitem==currItem)
		return false;
	currItem=newitem;
	return CollectImages();
}

string
mgImageProvider::getCachedMPGFile(mgItemGd *item,string f) {
	// determine the filename of a (to be) cached .mpg file
	string bname = basename( (char *)f.c_str() );
	unsigned dotpos = bname.rfind('.');
	if (dotpos != string::npos)
		bname.replace(dotpos,9999,".mpg");
	else
		bname = bname + ".mpg";
	string result=item->getCachedFilename("covers/",false) + bname;
	mkdir_p(result.c_str());
	return result;
}

bool mgImageProvider::CollectImages() {
	string filename = currItem->getSourceFile();
	m_image_list.clear();


	if( m_mode == IM_ITEM_DIR ) {
								 // do not try to acquire new images when we are playing back a separate directory
		// check whether the item has cover images defined in the database ?
		bool has_db_images = extractImagesFromDatabase();

		if( !has_db_images ) {
			// no. check whether the item has cover images defined in tags ?
			string dir = extractImagesFromTag( filename );

			if( dir == "" ) {
				// no. use anything from the directory
				updateFromItemDirectory();
			}
			else {
				fillImageList( dir );
			}
		}

		m_image_index = 0;
	}
	bool result = m_image_list.size() > 0;
	return result;
}

bool mgMpgImageProvider::updateItem( mgItemGd *newitem ) {
	// clean up stuff from previous item ?
	if (newitem==currItem)
		return false;
	Lock();
	currItem=newitem;
	m_converted_images.clear();
	m_need_conversion.clear();
	Unlock();
	CollectImages();
	for( unsigned i=0; i < m_image_list.size(); i++ ) {
		FILE *fp;
		string filename = m_image_list[i];

		if( (fp = fopen( filename.c_str(), "rb" )) ) {
			// filename can be opened
			fclose (fp);
			string tmpFile = getCachedMPGFile(currItem,filename);
			struct stat stsource;
			struct stat sttmp;
			if (stat(filename.c_str(),&stsource))
				stsource.st_mtime=0L;
			if (stat(tmpFile.c_str(),&sttmp))
				sttmp.st_mtime=0L;
			Lock();
			if (sttmp.st_mtime==0L || sttmp.st_mtime<stsource.st_mtime)
				m_need_conversion.push_back(filename);
			else if( !access( tmpFile.c_str(), R_OK ))
				m_converted_images.push_back( tmpFile );
			Unlock();
		}
	}
	if( m_mode == IM_ITEM_DIR )
		Start();
	Lock();
	bool result = m_converted_images.size() > 0;
	Unlock();

	return result;
}

void mgMpgImageProvider::Action() {
	// convert all imges
	Lock();
	vector<string> images( m_need_conversion );
	mgItemGd *cnvItem = currItem;
	Unlock();
	for( unsigned i=0; i < images.size(); i++ ) {
		if (i>0)
			// sleep 1 sec: we don't want to start all image conversions simultaneously
			usleep(1000*1000);	
		string cachedFile = getCachedMPGFile(cnvItem,images[i]);
		char *cmd;
		msprintf( &cmd, "%s/scripts/muggle-image-convert \"%s\" \"%s\" %d %d %d %d &",
			the_setup.ConfigDirectory.c_str(),
		images[i].c_str(), cachedFile.c_str(),
		coverarea.x1,coverarea.y1,coverarea.Width(),coverarea.Height() );
		mgDebug(5,"%d %s",system( (const char*) cmd ),cmd);
		free(cmd);
	}
	int waitcount=0;
	while (images.size() && waitcount<20) { // wait up to 20 seconds for all conversions
		for( unsigned i=0; i < images.size(); i++ ) {
			Lock();
			mgItemGd *expectItem = currItem;
			Unlock();
			if (expectItem!=cnvItem) {
				images.clear();
				break;
			}
			string cachedFile = getCachedMPGFile(cnvItem,images[i]);
			// if file can be read by process, add to the list of converted images
			if( !access( cachedFile.c_str(), R_OK ) ) {
				Lock();
				m_converted_images.push_back( cachedFile );
				Unlock();
				images.erase(images.begin()+i);
			}
		}
		// wait 1/2 second
		usleep(1000*500);
		waitcount++;
	}
}

void mgImageProvider::fillImageList( string dir ) {
	// obtain all .png, .jpg in dir and gather them in m_image_list

	struct dirent **files;
	int count = scandir( dir.c_str(), &files, picture_select, alphasort );

	if( count ) {
		for ( int i=0; i < count; i++ ) {
			string fname = dir + "/" + string( files[i]->d_name );
			m_image_list.push_back( fname );
			free( files[i] );
		}
		free( files );
	}
}

void mgImageProvider::writeImage( TagLib::ByteVector &image, int num, string &image_cache ) {
	char* image_data = image.data();
	int len = image.size();

	// save image_data to temporary file
	char *buf;
	msprintf( &buf, "%s/image-%d.jpg", image_cache.c_str(), num );

	FILE *f = fopen( buf, "w+" );
	fwrite( image_data, sizeof(char), len, f );
	fclose( f );
	free( buf );
}

string mgImageProvider::treatFrameList( TagLib::ID3v2::FrameList &l, string &image_cache ) {
	string result;

	if( !l.isEmpty() ) {
		m_delete_imgs_from_tag = true;
		TagLib::ID3v2::FrameList::ConstIterator it = l.begin();

		int num = 0;
		while( !(it == l.end()) ) {
			TagLib::ID3v2::AttachedPictureFrame *picframe = (TagLib::ID3v2::AttachedPictureFrame*) (*it);

			TagLib::ByteVector image = picframe->picture();
			writeImage( image, num, image_cache );

			it++;
			num++;
		}
		result = image_cache;
	}
	else {
		result = "";
	}

	return result;
}

string mgImageProvider::extractImagesFromTag( string f ) {
	TagLib::ID3v2::FrameList l;
	const char *filename = f.c_str();
	string image_cache = string( the_setup.CacheDir );
	string dir = "";

	if( !strcasecmp(extension(filename), "flac") ) {
		TagLib::FLAC::File f(filename);
		if (f.ID3v2Tag()) {
			l = f.ID3v2Tag()->frameListMap()["APIC"];
			dir = treatFrameList( l, image_cache );
		}
	}
	else if( !strcasecmp(extension(filename), "mp3") ) {
		TagLib::MPEG::File f(filename);
		if (f.ID3v2Tag()) {
			l = f.ID3v2Tag()->frameListMap()["APIC"];
			dir = treatFrameList( l, image_cache );
		}
	}
	else if( !strcasecmp(extension(filename), "ogg") ) {
		// what to do here?

		TagLib::Vorbis::File f(filename);
		/*
		if (f.ID3v2Tag())
		  {
			l = f.ID3v2Tag()->frameListMap()["APIC"];
			dir = treatFrameList( l, image_cache );
		  }
		*/
	}

	// returns empty if no images were found in tags
	return dir;
}

string mgMpgImageProvider::getImagePath( string &source ) {
	// returns converted image name, writes source image name into source argument reference

	string fname="";
	source = "";

	// check, how many images are converted at all
	Lock();
	if (m_image_index>=m_converted_images.size())
		m_image_index=0;
	if( m_image_index < m_converted_images.size() ) {
		fname = m_converted_images[ m_image_index ];
		// here we could mangle the original name to add an extension such as -s200
		source = m_image_list[ m_image_index ];
	}
	m_image_index += 1;
	Unlock();

	return fname;
}