source/blender/imbuf/IMB_thumbs.h

   1 /*
   2  * ***** BEGIN GPL LICENSE BLOCK *****
   3  *
   4  * This program is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU General Public License
   6  * as published by the Free Software Foundation; either version 2
   7  * of the License, or (at your option) any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with this program; if not, write to the Free Software Foundation,
  16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  17  *
  18  * The Original Code is Copyright (C) 2007 Blender Foundation
  19  * All rights reserved.
  20  *
  21  * The Original Code is: all of this file.
  22  *
  23  * Contributor(s): Andrea Weikert.
  24  *
  25  * ***** END GPL LICENSE BLOCK *****
  26  */
  27
  28 /** \file blender/imbuf/IMB_thumbs.h
  29  *  \ingroup imbuf
  30  */
  31
  32
  33 #ifndef __IMB_THUMBS_H__
  34 #define __IMB_THUMBS_H__
  35
  36 #ifdef __cplusplus
  37 extern "C" {
  38 #endif
  39
  40 struct ImBuf;
  41
  42 /** Thumbnail creation and retrieval according to the 'Thumbnail Management Standard'
  43  * supported by Gimp, Gnome (Nautilus), KDE etc.
  44  * Reference: http://jens.triq.net/thumbnail-spec/index.html
  45  */
  46
  47
  48 typedef enum ThumbSize {
  49         THB_NORMAL,
  50         THB_LARGE,
  51         THB_FAIL
  52 } ThumbSize;
  53
  54 typedef enum ThumbSource {
  55         THB_SOURCE_IMAGE,
  56         THB_SOURCE_MOVIE,
  57         THB_SOURCE_BLEND,
  58         THB_SOURCE_FONT,
  59 } ThumbSource;
  60
  61 /* don't generate thumbs for images bigger then this (100mb) */
  62 #define THUMB_SIZE_MAX (100 * 1024 * 1024)
  63
  64 #define PREVIEW_RENDER_DEFAULT_HEIGHT 128
  65
  66 /* Note this can also be used as versioning system,
  67  * to force refreshing all thumbnails if e.g. we change some thumb generating code or so.
  68  * Only used by fonts so far. */
  69 #define THUMB_DEFAULT_HASH  "00000000000000000000000000000000"
  70
  71 /* create thumbnail for file and returns new imbuf for thumbnail */
  72 ImBuf *IMB_thumb_create(const char *path, ThumbSize size, ThumbSource source, ImBuf *ibuf);
  73
  74 /* read thumbnail for file and returns new imbuf for thumbnail */
  75 ImBuf *IMB_thumb_read(const char *path, ThumbSize size);
  76
  77 /* delete all thumbs for the file */
  78 void IMB_thumb_delete(const char *path, ThumbSize size);
  79
  80 /* return the state of the thumb, needed to determine how to manage the thumb */
  81 ImBuf *IMB_thumb_manage(const char *path, ThumbSize size, ThumbSource source);
  82
  83 /* create the necessary dirs to store the thumbnails */
  84 void IMB_thumb_makedirs(void);
  85
  86 /* special function for loading a thumbnail embedded into a blend file */
  87 ImBuf *IMB_thumb_load_blend(const char *blen_path, const char *blen_group, const char *blen_id);
  88 void   IMB_thumb_overlay_blend(unsigned int *thumb, int width, int height, float aspect);
  89
  90 /* special function for previewing fonts */
  91 ImBuf *IMB_thumb_load_font(const char *filename, unsigned int x, unsigned int y);
  92 bool IMB_thumb_load_font_get_hash(char *r_hash);
  93
  94 /* Threading */
  95 void IMB_thumb_locks_acquire(void);
  96 void IMB_thumb_locks_release(void);
  97 void IMB_thumb_path_lock(const char *path);
  98 void IMB_thumb_path_unlock(const char *path);
  99
 100 #ifdef __cplusplus
 101 }
 102 #endif /* __cplusplus */
 103
 104 #endif /* __IMB_THUMBS_H__ */
 105