images::ImagesScanner Class Reference

: Scan all the images in the formats supported by gdk_pixbuf under the input directory or the directory which the input filename is located in. It also supports the option of scanning recursively or not. More...

#include <images_scanner.h>

Collaboration diagram for images::ImagesScanner:

[legend]

Public Member Functions
	ImagesScanner (void)
	Construct a 'ImagesScanner'.
	~ImagesScanner (void)
bool	is_image (const std::string &filename)
int	scan_images (const std::string &filename, bool to_scan_dir, bool recursive_flag, SortType sort_type, bool sort_ascending, Images &results)
	Set the filename or directory to scan.
Static Public Member Functions
static bool	get_size (const std::string &filename, int *width, int *height)
static void	get_original_rotation (const std::string &filename, PluginRotationDegree &rotation)

---

Detailed Description

: Scan all the images in the formats supported by gdk_pixbuf under the input directory or the directory which the input filename is located in. It also supports the option of scanning recursively or not.

Definition at line 71 of file images_scanner.h.

---

Constructor & Destructor Documentation

images::ImagesScanner::ImagesScanner

(

void

)

Construct a 'ImagesScanner'.

Definition at line 54 of file images_scanner.cpp.

References LOGPRINTF.

:filepath("")
,recursive(false)
,isdir(false)
,dir("")
,active(-1) 
{
    LOGPRINTF("entry");

    get_supported_extnames();
}

images::ImagesScanner::~ImagesScanner

(

void

)

Definition at line 66 of file images_scanner.cpp.

References LOGPRINTF.

{
    LOGPRINTF("entry");
}

---

Member Function Documentation

void images::ImagesScanner::get_original_rotation	(	const std::string &	filename,
		PluginRotationDegree &	rotation
	)			[static]

Definition at line 95 of file images_scanner.cpp.

References Clockwise_Degrees_0, Clockwise_Degrees_180, Clockwise_Degrees_270, Clockwise_Degrees_90, and LOGPRINTF.

{
    LOGPRINTF("entry");

    // Set the default return value.
    rotation = Clockwise_Degrees_0;
#ifndef WIN32
    ExifData * ped = exif_data_new_from_file (filename.c_str());
    if (ped == 0) { return; }

    ExifEntry * pee = exif_data_get_entry(ped, EXIF_TAG_ORIENTATION);
    if (pee == 0) 
    {
        exif_data_unref(ped);
        return; 
    }

    // CAUTION: The character set of the returned string is not defined.
    // It may be UTF-8, latin1, the native encoding of the
    // computer, or the native encoding of the camera.
    const unsigned int maxlen = 1024;
    char val[maxlen] = {0};

    if (exif_entry_get_value (pee, val, maxlen))
    {
        // Conversion table for EXIT orientation to rotation degrees.
        // See also:
        //   http://www.impulseadventure.com/photo/exif-orientation.html
        //   http://sylvana.net/jpegcrop/exif_orientation.html
        const struct
              {
                  const char                    *exif_orientation;
                  const PluginRotationDegree    rotation;
              } exif_conversion_tbl[]
              =
              {
                  { "top - left",     Clockwise_Degrees_0   },
                  { "top - right",    Clockwise_Degrees_0   },
                  { "bottom - right", Clockwise_Degrees_180 },
                  { "bottom - left",  Clockwise_Degrees_180 },
                  { "left - top",     Clockwise_Degrees_270 },
                  { "right - top",    Clockwise_Degrees_270 },
                  { "right - bottom", Clockwise_Degrees_90  },
                  { "left - bottom",  Clockwise_Degrees_90  },
                  { NULL,             Clockwise_Degrees_0   }
              };

        for (int i = 0; exif_conversion_tbl[i].exif_orientation; i++)
        {
            if ( strcmp(val, exif_conversion_tbl[i].exif_orientation) == 0 )
            {
                rotation = exif_conversion_tbl[i].rotation;
                break;
            }
        }
    }
    
    exif_data_unref(ped);
    ped = 0;
#endif
    LOGPRINTF("%d", rotation);
}

bool images::ImagesScanner::get_size	(	const std::string &	filename,
		int *	width,
		int *	height
	)			[static]

Definition at line 81 of file images_scanner.cpp.

Referenced by images::ImagesDocument::get_original_size().

{
    // Set the default values.
    if (width) { *width = 0; }
    if (height) { *height = 0; }
    
    if (gdk_pixbuf_get_file_info(filename.c_str(), width, height))
    {
        return true;
    }
    return false;
}

Here is the caller graph for this function:

bool images::ImagesScanner::is_image

(

const std::string &

filename

)

Definition at line 71 of file images_scanner.cpp.

References LOGPRINTF.

Referenced by scan_images().

{
    // Only check the extension name to imporve the performance of scanning. 
    bool ret = check_extname(filename);

    LOGPRINTF("%s is image? %d", filename.c_str(), ret);

    return ret;
}

Here is the caller graph for this function:

int images::ImagesScanner::scan_images	(	const std::string &	filename,
		bool	to_scan_dir,
		bool	recursive_flag,
		SortType	sort_type,
		bool	sort_ascending,
		Images &	results
	)

Set the filename or directory to scan.

Parameters:

	filename
	to_scan_dir	Scan or not scan the directory where the filename is in.
	recursive_flag	Scan recursively or not.
	sort_type	Sort by date, size, etc.
	sort_ascending	Sort by ascending or descending.

Returns:

Get the index of the current active image. The current active image is the input filename. Or if the input filename is directory, the active image is the first image file found.

Definition at line 159 of file images_scanner.cpp.

References Clockwise_Degrees_0, images::Image::height, is_image(), images::Image::is_rotation_calculated, images::Image::path, images::Image::rotation, and images::Image::width.

Referenced by images::ImagesDocument::open_document().

{
    set_filename(filename);
    recursive = recursive_flag;

    if (!to_scan_dir)
    {
        if (g_file_test(filename.c_str(), (GFileTest)G_FILE_TEST_IS_REGULAR)
                && is_image(filename))
        {
            ImagePtr image = new Image;
            if (image)
            { 
                image->path = filename;
                image->width = -1;
                image->height = -1;
                image->is_rotation_calculated = false;
                image->rotation = Clockwise_Degrees_0;
                results.push_back(image);
            }
        }
    }
    else
    {
        // Do scanning.
        scan_dir(dir, results);
        // Do sorting.
        sort_images(results, sort_type, sort_ascending);
    }

    return ((active != -1) ? active : 0);
}

Here is the call graph for this function:

Here is the caller graph for this function:

---

The documentation for this class was generated from the following files:

• images_scanner.h
• images_scanner.cpp