ToolDefManager serialization
[oweals/minetest.git] / src / tile.cpp
index 3fa3635473cdf6b3490cfbc56f63503cca7f2f1a..c8fffffa7ad44fca8a8d16669efd0d0b50e9667d 100644 (file)
@@ -25,6 +25,10 @@ with this program; if not, write to the Free Software Foundation, Inc.,
 #include "settings.h"
 #include <ICameraSceneNode.h>
 #include "log.h"
+#include "mapnode.h" // For texture atlas making
+#include "mineral.h" // For texture atlas making
+#include "nodedef.h" // For texture atlas making
+#include "gamedef.h"
 
 /*
        A cache from texture name to texture path
@@ -118,7 +122,7 @@ std::string getTexturePath(const std::string &filename)
        std::string texture_path = g_settings->get("texture_path");
        if(texture_path != "")
        {
-               std::string testpath = texture_path + '/' + filename;
+               std::string testpath = texture_path + DIR_DELIM + filename;
                // Check all filename extensions. Returns "" if not found.
                fullpath = getImagePath(testpath);
        }
@@ -128,7 +132,8 @@ std::string getTexturePath(const std::string &filename)
        */
        if(fullpath == "")
        {
-               std::string testpath = porting::getDataPath(filename.c_str());
+               std::string rel_path = std::string("textures")+DIR_DELIM+filename;
+               std::string testpath = porting::path_data + DIR_DELIM + rel_path;
                // Check all filename extensions. Returns "" if not found.
                fullpath = getImagePath(testpath);
        }
@@ -144,6 +149,142 @@ std::string getTexturePath(const std::string &filename)
        TextureSource
 */
 
+class TextureSource : public IWritableTextureSource
+{
+public:
+       TextureSource(IrrlichtDevice *device);
+       ~TextureSource();
+
+       /*
+               Example case:
+               Now, assume a texture with the id 1 exists, and has the name
+               "stone.png^mineral1".
+               Then a random thread calls getTextureId for a texture called
+               "stone.png^mineral1^crack0".
+               ...Now, WTF should happen? Well:
+               - getTextureId strips off stuff recursively from the end until
+                 the remaining part is found, or nothing is left when
+                 something is stripped out
+
+               But it is slow to search for textures by names and modify them
+               like that?
+               - ContentFeatures is made to contain ids for the basic plain
+                 textures
+               - Crack textures can be slow by themselves, but the framework
+                 must be fast.
+
+               Example case #2:
+               - Assume a texture with the id 1 exists, and has the name
+                 "stone.png^mineral1" and is specified as a part of some atlas.
+               - Now MapBlock::getNodeTile() stumbles upon a node which uses
+                 texture id 1, and finds out that NODEMOD_CRACK must be applied
+                 with progression=0
+               - It finds out the name of the texture with getTextureName(1),
+                 appends "^crack0" to it and gets a new texture id with
+                 getTextureId("stone.png^mineral1^crack0")
+
+       */
+       
+       /*
+               Gets a texture id from cache or
+               - if main thread, from getTextureIdDirect
+               - if other thread, adds to request queue and waits for main thread
+       */
+       u32 getTextureId(const std::string &name);
+       
+       /*
+               Example names:
+               "stone.png"
+               "stone.png^crack2"
+               "stone.png^blit:mineral_coal.png"
+               "stone.png^blit:mineral_coal.png^crack1"
+
+               - If texture specified by name is found from cache, return the
+                 cached id.
+               - Otherwise generate the texture, add to cache and return id.
+                 Recursion is used to find out the largest found part of the
+                 texture and continue based on it.
+
+               The id 0 points to a NULL texture. It is returned in case of error.
+       */
+       u32 getTextureIdDirect(const std::string &name);
+
+       /*
+               Finds out the name of a cached texture.
+       */
+       std::string getTextureName(u32 id);
+
+       /*
+               If texture specified by the name pointed by the id doesn't
+               exist, create it, then return the cached texture.
+
+               Can be called from any thread. If called from some other thread
+               and not found in cache, the call is queued to the main thread
+               for processing.
+       */
+       AtlasPointer getTexture(u32 id);
+       
+       AtlasPointer getTexture(const std::string &name)
+       {
+               return getTexture(getTextureId(name));
+       }
+       
+       // Gets a separate texture
+       video::ITexture* getTextureRaw(const std::string &name)
+       {
+               AtlasPointer ap = getTexture(name);
+               return ap.atlas;
+       }
+
+       /*
+               Update new texture pointer and texture coordinates to an
+               AtlasPointer based on it's texture id
+       */
+       void updateAP(AtlasPointer &ap);
+
+       /*
+               Build the main texture atlas which contains most of the
+               textures.
+               
+               This is called by the constructor.
+       */
+       void buildMainAtlas(class IGameDef *gamedef);
+       
+       /*
+               Processes queued texture requests from other threads.
+
+               Shall be called from the main thread.
+       */
+       void processQueue();
+       
+private:
+       
+       // The id of the thread that is allowed to use irrlicht directly
+       threadid_t m_main_thread;
+       // The irrlicht device
+       IrrlichtDevice *m_device;
+       
+       // A texture id is index in this array.
+       // The first position contains a NULL texture.
+       core::array<SourceAtlasPointer> m_atlaspointer_cache;
+       // Maps a texture name to an index in the former.
+       core::map<std::string, u32> m_name_to_id;
+       // The two former containers are behind this mutex
+       JMutex m_atlaspointer_cache_mutex;
+       
+       // Main texture atlas. This is filled at startup and is then not touched.
+       video::IImage *m_main_atlas_image;
+       video::ITexture *m_main_atlas_texture;
+
+       // Queued texture fetches (to be processed by the main thread)
+       RequestQueue<std::string, u32, u8, u8> m_get_texture_queue;
+};
+
+IWritableTextureSource* createTextureSource(IrrlichtDevice *device)
+{
+       return new TextureSource(device);
+}
+
 TextureSource::TextureSource(IrrlichtDevice *device):
                m_device(device),
                m_main_atlas_image(NULL),
@@ -158,12 +299,6 @@ TextureSource::TextureSource(IrrlichtDevice *device):
        // Add a NULL AtlasPointer as the first index, named ""
        m_atlaspointer_cache.push_back(SourceAtlasPointer(""));
        m_name_to_id[""] = 0;
-
-       // Build main texture atlas
-       if(g_settings->getBool("enable_texture_atlas"))
-               buildMainAtlas();
-       else
-               infostream<<"Not building texture atlas."<<std::endl;
 }
 
 TextureSource::~TextureSource()
@@ -483,8 +618,17 @@ AtlasPointer TextureSource::getTexture(u32 id)
        return m_atlaspointer_cache[id].a;
 }
 
-void TextureSource::buildMainAtlas() 
+void TextureSource::updateAP(AtlasPointer &ap)
+{
+       AtlasPointer ap2 = getTexture(ap.id);
+       ap = ap2;
+}
+
+void TextureSource::buildMainAtlas(class IGameDef *gamedef) 
 {
+       assert(gamedef->tsrc() == this);
+       INodeDefManager *ndef = gamedef->ndef();
+
        infostream<<"TextureSource::buildMainAtlas()"<<std::endl;
 
        //return; // Disable (for testing)
@@ -507,52 +651,62 @@ void TextureSource::buildMainAtlas()
        }
 
        /*
-               A list of stuff to include in the texture atlas.
-
-               It is a single-dimensional texture atlas due to the need to tile
-               textures.
-               
-               It should contain as much of the stuff shown in game as possible,
-               to minimize texture changes.
-
-               It fills up quickly, so do not add anything that isn't contained
-               in most MapBlocks. E.g. mese isn't suitable but stone is.
+               Grab list of stuff to include in the texture atlas from the
+               main content features
        */
 
-       core::array<std::string> sourcelist;
-
-       sourcelist.push_back("stone.png");
-       sourcelist.push_back("mud.png");
-       sourcelist.push_back("sand.png");
-       sourcelist.push_back("grass.png");
-       sourcelist.push_back("grass_footsteps.png");
-       sourcelist.push_back("tree.png");
-       sourcelist.push_back("tree_top.png");
-       sourcelist.push_back("water.png");
-       sourcelist.push_back("leaves.png");
-       sourcelist.push_back("glass.png");
-       sourcelist.push_back("mud.png^grass_side.png");
-       sourcelist.push_back("cobble.png");
-       sourcelist.push_back("mossycobble.png");
-       sourcelist.push_back("gravel.png");
-       sourcelist.push_back("jungletree.png");
-       
-       sourcelist.push_back("stone.png^mineral_coal.png");
-       sourcelist.push_back("stone.png^mineral_iron.png");
+       core::map<std::string, bool> sourcelist;
+
+       for(u16 j=0; j<MAX_CONTENT+1; j++)
+       {
+               if(j == CONTENT_IGNORE || j == CONTENT_AIR)
+                       continue;
+               const ContentFeatures &f = ndef->get(j);
+               for(std::set<std::string>::const_iterator
+                               i = f.used_texturenames.begin();
+                               i != f.used_texturenames.end(); i++)
+               {
+                       std::string name = *i;
+                       sourcelist[name] = true;
+
+                       if(f.often_contains_mineral){
+                               for(int k=1; k<MINERAL_COUNT; k++){
+                                       std::string mineraltexture = mineral_block_texture(k);
+                                       std::string fulltexture = name + "^" + mineraltexture;
+                                       sourcelist[fulltexture] = true;
+                               }
+                       }
+               }
+       }
        
+       infostream<<"Creating texture atlas out of textures: ";
+       for(core::map<std::string, bool>::Iterator
+                       i = sourcelist.getIterator();
+                       i.atEnd() == false; i++)
+       {
+               std::string name = i.getNode()->getKey();
+               infostream<<"\""<<name<<"\" ";
+       }
+       infostream<<std::endl;
+
        // Padding to disallow texture bleeding
        s32 padding = 16;
 
+       s32 column_width = 256;
+       s32 column_padding = 16;
+
        /*
                First pass: generate almost everything
        */
        core::position2d<s32> pos_in_atlas(0,0);
        
-       pos_in_atlas.Y += padding;
+       pos_in_atlas.Y = padding;
 
-       for(u32 i=0; i<sourcelist.size(); i++)
+       for(core::map<std::string, bool>::Iterator
+                       i = sourcelist.getIterator();
+                       i.atEnd() == false; i++)
        {
-               std::string name = sourcelist[i];
+               std::string name = i.getNode()->getKey();
 
                /*video::IImage *img = driver->createImageFromFile(
                                getTexturePath(name.c_str()).c_str());
@@ -586,20 +740,26 @@ void TextureSource::buildMainAtlas()
                        continue;
                }
 
-               // Stop making atlas if atlas is full
+               // Wrap columns and stop making atlas if atlas is full
                if(pos_in_atlas.Y + dim.Height > atlas_dim.Height)
                {
-                       infostream<<"TextureSource::buildMainAtlas(): "
-                                       <<"Atlas is full, not adding more textures."
-                                       <<std::endl;
-                       break;
+                       if(pos_in_atlas.X > (s32)atlas_dim.Width - 256 - padding){
+                               errorstream<<"TextureSource::buildMainAtlas(): "
+                                               <<"Atlas is full, not adding more textures."
+                                               <<std::endl;
+                               break;
+                       }
+                       pos_in_atlas.Y = padding;
+                       pos_in_atlas.X += column_width + column_padding;
                }
                
         infostream<<"TextureSource::buildMainAtlas(): Adding \""<<name
                 <<"\" to texture atlas"<<std::endl;
 
                // Tile it a few times in the X direction
-               u16 xwise_tiling = 16;
+               u16 xwise_tiling = column_width / dim.Width;
+               if(xwise_tiling > 16) // Limit to 16 (more gives no benefit)
+                       xwise_tiling = 16;
                for(u32 j=0; j<xwise_tiling; j++)
                {
                        // Copy the copy to the atlas
@@ -627,7 +787,7 @@ void TextureSource::buildMainAtlas()
                                dst_y = -y0 + pos_in_atlas.Y-1;
                                src_y = pos_in_atlas.Y;
                        }
-                       s32 x = x0 + pos_in_atlas.X * dim.Width;
+                       s32 x = x0 + pos_in_atlas.X;
                        video::SColor c = atlas_img->getPixel(x, src_y);
                        atlas_img->setPixel(x,dst_y,c);
                }
@@ -638,8 +798,18 @@ void TextureSource::buildMainAtlas()
                        Add texture to caches
                */
                
-               // Get next id
+               bool reuse_old_id = false;
                u32 id = m_atlaspointer_cache.size();
+               // Check old id without fetching a texture
+               core::map<std::string, u32>::Node *n;
+               n = m_name_to_id.find(name);
+               // If it exists, we will replace the old definition
+               if(n){
+                       id = n->getValue();
+                       reuse_old_id = true;
+               }
+               infostream<<"TextureSource::buildMainAtlas(): "
+                               <<"Replacing old AtlasPointer"<<std::endl;
 
                // Create AtlasPointer
                AtlasPointer ap(id);
@@ -652,8 +822,11 @@ void TextureSource::buildMainAtlas()
 
                // Create SourceAtlasPointer and add to containers
                SourceAtlasPointer nap(name, ap, atlas_img, pos_in_atlas, dim);
-               m_atlaspointer_cache.push_back(nap);
-               m_name_to_id.insert(name, id);
+               if(reuse_old_id)
+                       m_atlaspointer_cache[id] = nap;
+               else
+                       m_atlaspointer_cache.push_back(nap);
+               m_name_to_id[name] = id;
                        
                // Increment position
                pos_in_atlas.Y += dim.Height + padding * 2;
@@ -668,9 +841,11 @@ void TextureSource::buildMainAtlas()
        /*
                Second pass: set texture pointer in generated AtlasPointers
        */
-       for(u32 i=0; i<sourcelist.size(); i++)
+       for(core::map<std::string, bool>::Iterator
+                       i = sourcelist.getIterator();
+                       i.atEnd() == false; i++)
        {
-               std::string name = sourcelist[i];
+               std::string name = i.getNode()->getKey();
                if(m_name_to_id.find(name) == NULL)
                        continue;
                u32 id = m_name_to_id[name];
@@ -681,8 +856,12 @@ void TextureSource::buildMainAtlas()
        /*
                Write image to file so that it can be inspected
        */
-       /*driver->writeImageToFile(atlas_img, 
-                       getTexturePath("main_atlas.png").c_str());*/
+       /*std::string atlaspath = porting::path_userdata
+                       + DIR_DELIM + "generated_texture_atlas.png";
+       infostream<<"Removing and writing texture atlas for inspection to "
+                       <<atlaspath<<std::endl;
+       fs::RecursiveDelete(atlaspath);
+       driver->writeImageToFile(atlas_img, atlaspath.c_str());*/
 }
 
 video::IImage* generate_image_from_scratch(std::string name,
@@ -1092,22 +1271,23 @@ bool generate_image(std::string part_of_name, video::IImage *& baseimg,
                                core::dimension2d<u32> dim = image->getDimension();
                                baseimg = driver->createImage(video::ECF_A8R8G8B8, dim);
                                
+                               // Blit
+                               image->copyTo(baseimg);
+
+                               image->drop();
+
                                for(u32 y=0; y<dim.Height; y++)
                                for(u32 x=0; x<dim.Width; x++)
                                {
-                                       video::SColor c = image->getPixel(x,y);
+                                       video::SColor c = baseimg->getPixel(x,y);
                                        u32 r = c.getRed();
                                        u32 g = c.getGreen();
                                        u32 b = c.getBlue();
                                        if(!(r == r1 && g == g1 && b == b1))
                                                continue;
                                        c.setAlpha(0);
-                                       image->setPixel(x,y,c);
+                                       baseimg->setPixel(x,y,c);
                                }
-                               // Blit
-                               image->copyTo(baseimg);
-
-                               image->drop();
                        }
                }
                /*
@@ -1149,11 +1329,16 @@ bool generate_image(std::string part_of_name, video::IImage *& baseimg,
                        {
                                core::dimension2d<u32> dim = image->getDimension();
                                baseimg = driver->createImage(video::ECF_A8R8G8B8, dim);
+
+                               // Blit
+                               image->copyTo(baseimg);
+
+                               image->drop();
                                
                                for(u32 y=0; y<dim.Height; y++)
                                for(u32 x=0; x<dim.Width; x++)
                                {
-                                       video::SColor c = image->getPixel(x,y);
+                                       video::SColor c = baseimg->getPixel(x,y);
                                        u32 r = c.getRed();
                                        u32 g = c.getGreen();
                                        u32 b = c.getBlue();
@@ -1161,12 +1346,8 @@ bool generate_image(std::string part_of_name, video::IImage *& baseimg,
                                           !(r == r2 && g == g2 && b == b2))
                                                continue;
                                        c.setAlpha(0);
-                                       image->setPixel(x,y,c);
+                                       baseimg->setPixel(x,y,c);
                                }
-                               // Blit
-                               image->copyTo(baseimg);
-
-                               image->drop();
                        }
                }
                /*