rockbox/apps/plugins/properties.c

/***************************************************************************
 *             __________               __   ___.
 *   Open      \______   \ ____   ____ |  | _\_ |__   _______  ___
 *   Source     |       _//  _ \_/ ___\|  |/ /| __ \ /  _ \  \/  /
 *   Jukebox    |    |   (  <_> )  \___|    < | \_\ (  <_> > <  <
 *   Firmware   |____|_  /\____/ \___  >__|_ \|___  /\____/__/\_ \
 *                     \/            \/     \/    \/            \/
 * $Id$
 *
 * Copyright (C) 2006 Peter D'Hoye
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
 * KIND, either express or implied.
 *
 ****************************************************************************/
#include "plugin.h"



bool its_a_dir = false;

char str_filename[MAX_PATH];
char str_dirname[MAX_PATH];
char str_size[64];
char str_dircount[64];
char str_filecount[64];
char str_date[64];
char str_time[64];

char str_title[MAX_PATH];
char str_composer[MAX_PATH];
char str_artist[MAX_PATH];
char str_albumartist[MAX_PATH];
char str_album[MAX_PATH];
char str_genre[MAX_PATH];
char str_comment[MAX_PATH];
char str_year[MAX_PATH];
char str_discnum[MAX_PATH];
char str_tracknum[MAX_PATH];
char str_duration[32];
char str_bitrate[32];
char str_frequency[32];

unsigned nseconds;
unsigned long nsize;
int32_t size_unit;
struct tm tm;

int num_properties;

static const unsigned char* const props_file[] =
{
    ID2P(LANG_PROPERTIES_PATH),       str_dirname,
    ID2P(LANG_PROPERTIES_FILENAME),   str_filename,
    ID2P(LANG_PROPERTIES_SIZE),       str_size,
    ID2P(LANG_PROPERTIES_DATE),       str_date,
    ID2P(LANG_PROPERTIES_TIME),       str_time,
    ID2P(LANG_PROPERTIES_COMPOSER),   str_composer,
    ID2P(LANG_PROPERTIES_ARTIST),     str_artist,
    ID2P(LANG_PROPERTIES_ALBUMARTIST),     str_albumartist,
    ID2P(LANG_PROPERTIES_TITLE),      str_title,
    ID2P(LANG_PROPERTIES_ALBUM),      str_album,
    ID2P(LANG_PROPERTIES_GENRE),      str_genre,
    ID2P(LANG_PROPERTIES_COMMENT),    str_comment,
    ID2P(LANG_PROPERTIES_YEAR),       str_year,
    ID2P(LANG_PROPERTIES_DISCNUM),    str_discnum,
    ID2P(LANG_PROPERTIES_TRACKNUM),   str_tracknum,
    ID2P(LANG_PROPERTIES_DURATION),   str_duration,
    ID2P(LANG_PROPERTIES_BITRATE),    str_bitrate,
    ID2P(LANG_PROPERTIES_FREQUENCY),  str_frequency,
};
static const unsigned char* const props_dir[] =
{
    ID2P(LANG_PROPERTIES_PATH),       str_dirname,
    ID2P(LANG_PROPERTIES_SUBDIRS),    str_dircount,
    ID2P(LANG_PROPERTIES_FILES),      str_filecount,
    ID2P(LANG_PROPERTIES_SIZE),       str_size,
};

static const int32_t units[] =
{
    LANG_BYTE,
    LANG_KIBIBYTE,
    LANG_MEBIBYTE,
    LANG_GIBIBYTE
};

static unsigned human_size_log(unsigned long long size)
{
    const size_t n = sizeof(units)/sizeof(units[0]);

    unsigned i;
    /* margin set at 10K boundary: 10239 B +1 => 10 KB */
    for(i=0; i < n-1 && size >= 10*1024; i++)
        size >>= 10; /* div by 1024 */

    return i;
}

static bool file_properties(const char* selected_file)
{
    bool found = false;
    DIR* dir;
    struct dirent* entry;
    static struct mp3entry id3;

    dir = rb->opendir(str_dirname);
    if (dir)
    {
        while(0 != (entry = rb->readdir(dir)))
        {
            struct dirinfo info = rb->dir_get_info(dir, entry);
            if(!rb->strcmp(entry->d_name, str_filename))
            {
                unsigned log;
                log = human_size_log((unsigned long)info.size);
                nsize = ((unsigned long)info.size) >> (log*10);
                size_unit = units[log];
                rb->snprintf(str_size, sizeof str_size, "%lu %s", nsize, rb->str(size_unit));
                rb->gmtime_r(&info.mtime, &tm);
                rb->snprintf(str_date, sizeof str_date, "%04d/%02d/%02d",
                    tm.tm_year + 1900, tm.tm_mon + 1, tm.tm_mday);
                rb->snprintf(str_time, sizeof str_time, "%02d:%02d:%02d",
                    tm.tm_hour, tm.tm_min, tm.tm_sec);

                num_properties = 5;

                int fd = rb->open(selected_file, O_RDONLY);
                if (fd >= 0 &&
                    rb->get_metadata(&id3, fd, selected_file))
                {
                    long dur = id3.length / 1000;           /* seconds */
                    rb->snprintf(str_composer, sizeof str_composer,
                                 "%s", id3.composer ? id3.composer : "");
                    rb->snprintf(str_artist, sizeof str_artist,
                                 "%s", id3.artist ? id3.artist : "");
                    rb->snprintf(str_albumartist, sizeof str_albumartist,
                                 "%s", id3.albumartist ? id3.albumartist : "");
                    rb->snprintf(str_title, sizeof str_title,
                                 "%s", id3.title ? id3.title : "");
                    rb->snprintf(str_album, sizeof str_album,
                                 "%s", id3.album ? id3.album : "");
                    rb->snprintf(str_genre, sizeof str_genre,
                                 "%s", id3.genre_string ? id3.genre_string : "");
                    rb->snprintf(str_comment, sizeof str_comment,
                                 "%s", id3.comment ? id3.comment : "");

                    if (id3.year_string)
                        rb->snprintf(str_year, sizeof str_year,
                                 "%s", id3.year_string);
                    else if (id3.year)
                        rb->snprintf(str_year, sizeof str_year,
                                 "%d", id3.year);
                    else
                        rb->snprintf(str_year, sizeof str_year,
                                 "%s", "");

                    if (id3.disc_string)
                        rb->snprintf(str_discnum, sizeof str_discnum,
                                 "%s", id3.disc_string);
                    else if (id3.discnum)
                        rb->snprintf(str_discnum, sizeof str_discnum,
                                 "%d", id3.discnum);
                    else
                        rb->snprintf(str_discnum, sizeof str_discnum,
                                 "%s", "");

                    if (id3.track_string)
                        rb->snprintf(str_tracknum, sizeof str_tracknum,
                                 "%s", id3.track_string);
                    else if(id3.tracknum)
                        rb->snprintf(str_tracknum, sizeof str_tracknum,
                                 "%d", id3.tracknum);
                    else
                        rb->snprintf(str_tracknum, sizeof str_tracknum,
                                 "%s", "");

                    rb->snprintf(str_bitrate, sizeof str_bitrate,
                                 "%d kbps", id3.bitrate ? : 0);
                    rb->snprintf(str_frequency, sizeof str_frequency,
                                 "%ld Hz", id3.frequency ? : 0);
                    num_properties += 12;

                    if (dur > 0)
                    {
                        nseconds = dur;
                        if (dur < 3600)
                            rb->snprintf(str_duration, sizeof str_duration,
                                         "%d:%02d", (int)(dur / 60),
                                         (int)(dur % 60));
                        else
                            rb->snprintf(str_duration, sizeof str_duration,
                                         "%d:%02d:%02d",
                                         (int)(dur / 3600),
                                         (int)(dur % 3600 / 60),
                                         (int)(dur % 60));
                        num_properties++;
                    }
                }
                rb->close(fd);
                found = true;
                break;
            }
        }
        rb->closedir(dir);
    }
    return found;
}

typedef struct {
    char dirname[MAX_PATH];
    int len;
    unsigned int dc;
    unsigned int fc;
    unsigned long long bc;
} DPS;

static bool _dir_properties(DPS *dps)
{
    /* recursively scan directories in search of files
       and informs the user of the progress */
    bool result;
    static long lasttick=0;
    int dirlen;
    DIR* dir;
    struct dirent* entry;

    result = true;
    dirlen = rb->strlen(dps->dirname);
    dir = rb->opendir(dps->dirname);
    if (!dir)
    {
        rb->splashf(HZ*2, "%s", dps->dirname);
        return false; /* open error */
    }

    /* walk through the directory content */
    while(result && (0 != (entry = rb->readdir(dir))))
    {
        struct dirinfo info = rb->dir_get_info(dir, entry);
        /* append name to current directory */
        rb->snprintf(dps->dirname+dirlen, dps->len-dirlen, "/%s",
                     entry->d_name);

        if (info.attribute & ATTR_DIRECTORY)
        {
            if (!rb->strcmp((char *)entry->d_name, ".") ||
                !rb->strcmp((char *)entry->d_name, ".."))
                continue; /* skip these */

            dps->dc++; /* new directory */
            if (*rb->current_tick - lasttick > (HZ/8))
            {
                unsigned log;
                lasttick = *rb->current_tick;
                rb->lcd_clear_display();
                rb->lcd_puts(0,0,"SCANNING...");
                rb->lcd_puts(0,1,dps->dirname);
                rb->lcd_putsf(0,2,"Directories: %d", dps->dc);
                rb->lcd_putsf(0,3,"Files: %d", dps->fc);
                log = human_size_log(dps->bc);
                rb->lcd_putsf(0,4,"Size: %lu %cB", (unsigned long)(dps->bc >> (10*log)),
			      rb->str(units[log]));
                rb->lcd_update();
            }

             /* recursion */
            result = _dir_properties(dps);
        }
        else
        {
            dps->fc++; /* new file */
            dps->bc += info.size;
        }
        if(ACTION_STD_CANCEL == rb->get_action(CONTEXT_STD,TIMEOUT_NOBLOCK))
            result = false;
        rb->yield();
    }
    rb->closedir(dir);
    return result;
}

static bool dir_properties(const char* selected_file, DPS *dps)
{
    unsigned log;

    rb->strlcpy(dps->dirname, selected_file, MAX_PATH);

#ifdef HAVE_ADJUSTABLE_CPU_FREQ
    rb->cpu_boost(true);
#endif

    if (!_dir_properties(dps))
    {
#ifdef HAVE_ADJUSTABLE_CPU_FREQ
        rb->cpu_boost(false);
#endif
        return false;
    }

#ifdef HAVE_ADJUSTABLE_CPU_FREQ
    rb->cpu_boost(false);
#endif

    rb->strlcpy(str_dirname, selected_file, MAX_PATH);
    rb->snprintf(str_dircount, sizeof str_dircount, "%d", dps->dc);
    rb->snprintf(str_filecount, sizeof str_filecount, "%d", dps->fc);
    log = human_size_log(dps->bc);
    nsize = (long) (dps->bc >> (log*10));
    size_unit = units[log];
    rb->snprintf(str_size, sizeof str_size, "%ld %s", nsize, rb->str(size_unit));
    num_properties = 4;
    return true;
}

static const unsigned char* p2str(const unsigned char* p)
{
    int id = P2ID(p);
    return (id != -1) ? rb->str(id) : p;
}

static const char * get_props(int selected_item, void* data,
                              char *buffer, size_t buffer_len)
{
    (void)data;
    if(its_a_dir)
    {
        if(selected_item >= (int)(sizeof(props_dir) / sizeof(props_dir[0])))
        {
            rb->strlcpy(buffer, "ERROR", buffer_len);
        }
        else
        {
            rb->strlcpy(buffer, p2str(props_dir[selected_item]), buffer_len);
        }
    }
    else
    {
        if(selected_item >= (int)(sizeof(props_file) / sizeof(props_file[0])))
        {
            rb->strlcpy(buffer, "ERROR", buffer_len);
        }
        else
        {
            rb->strlcpy(buffer, p2str(props_file[selected_item]), buffer_len);
        }
    }
    return buffer;
}

static int speak_property_selection(int selected_item, void *data)
{
    DPS *dps = data;
    int32_t id = P2ID((its_a_dir ? props_dir : props_file)[selected_item]);
    rb->talk_id(id, false);
    switch (id)
    {
    case LANG_PROPERTIES_PATH:
        if (str_dirname[0] == '/')
        {
            char *start = str_dirname;
            char *ptr;
            while (0 != (ptr = rb->strchr(start, '/')))
            {
                *ptr = '\0';
                rb->talk_dir_or_spell(str_dirname, NULL, true);
                *ptr = '/';
                rb->talk_id(VOICE_CHAR_SLASH, true);
                start = ptr + 1;
            }
            if (*start)
                rb->talk_dir_or_spell(str_dirname, NULL, true);
        }
        else
        {
            rb->talk_spell(str_dirname, true);
        }
        break;
    case LANG_PROPERTIES_FILENAME:
        rb->talk_file_or_spell(str_dirname, str_filename, NULL, true);
        break;
    case LANG_PROPERTIES_SIZE:
        rb->talk_number(nsize, true);
        rb->talk_id(size_unit, true);
        break;
    case LANG_PROPERTIES_DATE:
        rb->talk_date(&tm, true);
        break;
    case LANG_PROPERTIES_TIME:
        rb->talk_time(&tm, true);
        break;
    case LANG_PROPERTIES_DURATION:
        rb->talk_value_decimal(nseconds, UNIT_TIME, 0, true);
        break;
    case LANG_PROPERTIES_SUBDIRS:
        rb->talk_number(dps->dc, true);
        break;
    case LANG_PROPERTIES_FILES:
        rb->talk_number(dps->fc, true);
        break;
    default:
        rb->talk_spell(props_file[selected_item + 1], true);
        break;
    }
    return 0;
}

enum plugin_status plugin_start(const void* parameter)
{
    struct gui_synclist properties_lists;
    int button;
    bool quit = false, usb = false;
    const char *file = parameter;
    if(!parameter) return PLUGIN_ERROR;
#ifdef HAVE_TOUCHSCREEN
    rb->touchscreen_set_mode(rb->global_settings->touch_mode);
#endif

    static DPS dps = {
	.len = MAX_PATH,
	.dc  = 0,
	.fc  = 0,
	.bc  = 0,
    };

    /* determine if it's a file or a directory */
    bool found = false;
    DIR* dir;
    struct dirent* entry;
    char* ptr = rb->strrchr(file, '/') + 1;
    int dirlen = (ptr - file);

    rb->strlcpy(str_dirname, file, dirlen + 1);
    rb->snprintf(str_filename, sizeof str_filename, "%s", file+dirlen);

    dir = rb->opendir(str_dirname);
    if (dir)
    {
        while(0 != (entry = rb->readdir(dir)))
        {
            if(!rb->strcmp(entry->d_name, str_filename))
            {
                struct dirinfo info = rb->dir_get_info(dir, entry);
                its_a_dir = info.attribute & ATTR_DIRECTORY ? true : false;
                found = true;
                break;
            }
        }
        rb->closedir(dir);
    }
    /* now we know if it's a file or a dir or maybe something failed */

    if(!found)
    {
        /* weird: we couldn't find the entry. This Should Never Happen (TM) */
        rb->splashf(0, "File/Dir not found: %s", file);
        rb->action_userabort(TIMEOUT_BLOCK);
        return PLUGIN_OK;
    }

    /* get the info depending on its_a_dir */
    if(!(its_a_dir ? dir_properties(file, &dps) : file_properties(file)))
    {
        /* something went wrong (to do: tell user what it was (nesting,...) */
        rb->splash(0, ID2P(LANG_PROPERTIES_FAIL));
        rb->action_userabort(TIMEOUT_BLOCK);
        return PLUGIN_OK;
    }

    FOR_NB_SCREENS(i)
        rb->viewportmanager_theme_enable(i, true, NULL);

    rb->gui_synclist_init(&properties_lists, &get_props, &dps, false, 2, NULL);
    rb->gui_synclist_set_title(&properties_lists, rb->str(its_a_dir ? LANG_PROPERTIES_DIRECTORY_PROPERTIES : LANG_PROPERTIES_FILE_PROPERTIES), NOICON);
    rb->gui_synclist_set_icon_callback(&properties_lists, NULL);
    if (rb->global_settings->talk_menu)
        rb->gui_synclist_set_voice_callback(&properties_lists, speak_property_selection);
    rb->gui_synclist_set_nb_items(&properties_lists, num_properties * 2);
    rb->gui_synclist_limit_scroll(&properties_lists, true);
    rb->gui_synclist_select_item(&properties_lists, 0);
    rb->gui_synclist_draw(&properties_lists);
    rb->gui_synclist_speak_item(&properties_lists);

    while(!quit)
    {
        button = rb->get_action(CONTEXT_LIST, HZ);
        /* HZ so the status bar redraws corectly */
        if (rb->gui_synclist_do_button(&properties_lists,&button,LIST_WRAP_ON))
            continue;
        switch(button)
        {
            case ACTION_STD_CANCEL:
                quit = true;
                break;
            default:
                if (rb->default_event_handler(button) == SYS_USB_CONNECTED)
                {
                    quit = true;
                    usb = true;
                }
                break;
        }
    }

    FOR_NB_SCREENS(i)
        rb->viewportmanager_theme_undo(i, false);

    return usb? PLUGIN_USB_CONNECTED: PLUGIN_OK;
}