1a3cadc2b8e18ccfeaf93f362ab404aef3ca2874
[xonotic/netradiant.git] / plugins / imagepng / plugin.cpp
1 /*
2 Copyright (C) 1999-2007 id Software, Inc. and contributors.
3 For a list of contributors, see the accompanying CONTRIBUTORS file.
4
5 This file is part of GtkRadiant.
6
7 GtkRadiant is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 2 of the License, or
10 (at your option) any later version.
11
12 GtkRadiant is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15 GNU General Public License for more details.
16
17 You should have received a copy of the GNU General Public License
18 along with GtkRadiant; if not, write to the Free Software
19 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
20 */
21
22 // =============================================================================
23 // global tables
24
25 #include "plugin.h"
26
27 _QERFuncTable_1 g_FuncTable;
28 _QERFileSystemTable g_FileSystemTable;
29
30 // =============================================================================
31 // SYNAPSE
32
33 #include "synapse.h"
34
35 class CSynapseClientImage : public CSynapseClient
36 {
37 public:
38   // CSynapseClient API
39   bool RequestAPI(APIDescriptor_t *pAPI);
40   const char* GetInfo();
41   
42   CSynapseClientImage() { }
43   virtual ~CSynapseClientImage() { }
44 };
45
46 CSynapseServer* g_pSynapseServer = NULL;
47 CSynapseClientImage g_SynapseClient;
48
49 extern "C" CSynapseClient* SYNAPSE_DLL_EXPORT Synapse_EnumerateInterfaces (const char *version, CSynapseServer *pServer)
50 {
51   if (strcmp(version, SYNAPSE_VERSION))
52   {
53     Syn_Printf("ERROR: synapse API version mismatch: should be '" SYNAPSE_VERSION "', got '%s'\n", version);
54     return NULL;
55   }
56   g_pSynapseServer = pServer;
57   g_pSynapseServer->IncRef();
58   Set_Syn_Printf(g_pSynapseServer->Get_Syn_Printf());
59
60   g_SynapseClient.AddAPI(IMAGE_MAJOR, "png", sizeof(_QERPlugImageTable));
61   g_SynapseClient.AddAPI(RADIANT_MAJOR, NULL, sizeof(_QERFuncTable_1), SYN_REQUIRE, &g_FuncTable);
62   // NOTE: if imagepng starts being used for non "VFS" "pk3" config, need to add a dynamic config chunk
63   // see:
64   // http://zerowing.idsoftware.com/bugzilla/show_bug.cgi?id=794
65   // http://zerowing.idsoftware.com/bugzilla/show_bug.cgi?id=800
66   g_SynapseClient.AddAPI(VFS_MAJOR, "pk3", sizeof(_QERFileSystemTable), SYN_REQUIRE, &g_FileSystemTable);
67
68   return &g_SynapseClient;
69 }
70
71 bool CSynapseClientImage::RequestAPI(APIDescriptor_t *pAPI)
72 {
73   if (!strcmp(pAPI->major_name, IMAGE_MAJOR))
74   {    
75     _QERPlugImageTable* pTable= static_cast<_QERPlugImageTable*>(pAPI->mpTable);
76     if (!strcmp(pAPI->minor_name, "png"))
77     {
78       pTable->m_pfnLoadImage = &LoadImage;
79       return true;
80     }
81   }
82
83   Syn_Printf("ERROR: RequestAPI( '%s' ) not found in '%s'\n", pAPI->major_name, GetInfo());
84   return false;
85 }
86
87 #include "version.h"
88
89 const char* CSynapseClientImage::GetInfo()
90 {
91   return "PNG loader module built " __DATE__ " " RADIANT_VERSION;
92 }
93
94
95
96 // ====== PNG loader functionality ======
97
98 #include "png.h"
99
100 #ifdef __APPLE__        //tigital
101 #include <stdlib.h>
102 #endif
103
104 void user_warning_fn(png_structp png_ptr, png_const_charp warning_msg)
105 {
106   g_FuncTable.m_pfnSysPrintf ("libpng warning: %s\n", warning_msg);
107 }
108
109 void user_error_fn(png_structp png_ptr, png_const_charp error_msg)
110 {
111   g_FuncTable.m_pfnSysPrintf ("libpng error: %s\n", error_msg);
112   longjmp(png_ptr->jmpbuf, 0);
113 }
114
115 void user_read_data(png_structp png_ptr, png_bytep data, png_uint_32 length)
116 {
117   png_bytep *p_p_fbuffer = (png_bytep*)png_get_io_ptr(png_ptr);
118   memcpy(data, *p_p_fbuffer, length);
119   *p_p_fbuffer += length;
120 }
121
122 void LoadImage (const char *filename, unsigned char **pic, int *width, int *height)
123 {
124   png_byte** row_pointers;
125   unsigned char *fbuffer = NULL;
126   png_bytep p_fbuffer;
127
128   int nLen = g_FileSystemTable.m_pfnLoadFile( (char *)filename, (void **)&fbuffer, 0 );
129   if (nLen == -1)
130     return;
131
132   p_fbuffer = fbuffer;
133         
134   // the reading glue
135   // http://www.libpng.org/pub/png/libpng-manual.html
136
137   png_structp png_ptr = png_create_read_struct
138     (PNG_LIBPNG_VER_STRING, png_voidp_NULL,
139     user_error_fn, user_warning_fn);
140   if (!png_ptr)
141   {
142     g_FuncTable.m_pfnSysPrintf ("libpng error: png_create_read_struct\n");
143     return;
144   }
145                 
146   png_infop info_ptr = png_create_info_struct(png_ptr);
147   if (!info_ptr) {
148     png_destroy_read_struct(&png_ptr,
149       png_infopp_NULL, png_infopp_NULL);
150     g_FuncTable.m_pfnSysPrintf ("libpng error: png_create_info_struct (info_ptr)\n");
151     return;
152   }
153         
154   png_infop end_info = png_create_info_struct(png_ptr);
155   if (!end_info) {
156     png_destroy_read_struct(&png_ptr, &info_ptr,
157       png_infopp_NULL);
158     g_FuncTable.m_pfnSysPrintf ("libpng error: png_create_info_struct (end_info)\n");
159     return;
160   }
161
162   // configure the read function
163   png_set_read_fn(png_ptr, (voidp)&p_fbuffer, (png_rw_ptr)&user_read_data);
164
165   if (setjmp(png_ptr->jmpbuf)) {
166     png_destroy_read_struct(&png_ptr, &info_ptr,
167       &end_info);
168     if (*pic)
169     {
170       g_free(*pic);
171       free(row_pointers);
172     }
173     return;
174   }
175
176   png_read_info(png_ptr, info_ptr);
177
178   int bit_depth = png_get_bit_depth(png_ptr, info_ptr);
179   int color_type = png_get_color_type(png_ptr, info_ptr);
180
181   // we want to treat all images the same way
182   //   The following code transforms grayscale images of less than 8 to 8 bits, 
183   //   changes paletted images to RGB, and adds a full alpha channel if there is 
184   //   transparency information in a tRNS chunk.
185   if (color_type == PNG_COLOR_TYPE_PALETTE)
186    png_set_palette_to_rgb(png_ptr);
187
188   if (color_type == PNG_COLOR_TYPE_GRAY && bit_depth < 8)
189     png_set_gray_1_2_4_to_8(png_ptr);
190
191   if (png_get_valid(png_ptr, info_ptr, PNG_INFO_tRNS))
192     png_set_tRNS_to_alpha(png_ptr);
193
194   if ( ! ( color_type & PNG_COLOR_MASK_ALPHA ) ) {
195     // Set the background color to draw transparent and alpha images over.
196     png_color_16 my_background, *image_background;
197
198     if (png_get_bKGD(png_ptr, info_ptr, &image_background))
199       png_set_background(png_ptr, image_background, 
200       PNG_BACKGROUND_GAMMA_FILE, 1, 1.0);
201     else
202       png_set_background(png_ptr, &my_background,
203       PNG_BACKGROUND_GAMMA_SCREEN, 0, 1.0);
204
205     // Add alpha byte after each RGB triplet
206     png_set_filler(png_ptr, 0xff, PNG_FILLER_AFTER);
207   }
208
209   // read the sucker in one chunk
210   png_read_update_info(png_ptr, info_ptr);
211
212   color_type = png_get_color_type(png_ptr, info_ptr);
213   bit_depth = png_get_bit_depth(png_ptr, info_ptr);
214
215   *width = png_get_image_width(png_ptr, info_ptr);
216   *height = png_get_image_height(png_ptr, info_ptr);
217
218   // allocate the pixel buffer, and the row pointers
219   int size = (*width)*(*height)*4;
220   // still have to use that g_malloc heresy
221   // http://zerowing.idsoftware.com/bugzilla/show_bug.cgi?id=491
222   *pic = (unsigned char *)g_malloc(size);
223   row_pointers = (png_byte**) malloc((*height) * sizeof(png_byte*));
224
225   int i;
226   for(i = 0; i < (*height); i++)
227     row_pointers[i] = (png_byte*)(*pic) + i * 4 * (*width);
228
229   // actual read
230   png_read_image(png_ptr, row_pointers);
231
232   /* read rest of file, and get additional chunks in info_ptr - REQUIRED */
233   png_read_end(png_ptr, info_ptr);
234
235   /* free up the memory structure */
236   png_destroy_read_struct(&png_ptr, &info_ptr, png_infopp_NULL);
237
238   free(row_pointers);
239   g_FileSystemTable.m_pfnFreeFile (fbuffer);
240 }
241
242