apps/recorder/albumart.c

   1 /***************************************************************************
   2  *             __________               __   ___.
   3  *   Open      \______   \ ____   ____ |  | _\_ |__   _______  ___
   4  *   Source     |       _//  _ \_/ ___\|  |/ /| __ \ /  _ \  \/  /
   5  *   Jukebox    |    |   (  <_> )  \___|    < | \_\ (  <_> > <  <
   6  *   Firmware   |____|_  /\____/ \___  >__|_ \|___  /\____/__/\_ \
   7  *                     \/            \/     \/    \/            \/
   8  * $Id$
   9  *
  10  * Copyright (C) 2007 Nicolas Pennequin
  11  *
  12  * This program is free software; you can redistribute it and/or
  13  * modify it under the terms of the GNU General Public License
  14  * as published by the Free Software Foundation; either version 2
  15  * of the License, or (at your option) any later version.
  16  *
  17  * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
  18  * KIND, either express or implied.
  19  *
  20  ****************************************************************************/
  21
  22 #include <string.h>
  23 #include "sprintf.h"
  24 #include "system.h"
  25 #include "albumart.h"
  26 #include "metadata.h"
  27 #include "gwps.h"
  28 #include "buffering.h"
  29 #include "dircache.h"
  30 #include "debug.h"
  31 #include "misc.h"
  32 #include "settings.h"
  33
  34 #if defined(HAVE_JPEG) || defined(PLUGIN)
  35 #define USE_JPEG_COVER
  36 #endif
  37
  38 /* Strip filename from a full path
  39  *
  40  * buf      - buffer to extract directory to.
  41  * buf_size - size of buffer.
  42  * fullpath - fullpath to extract from.
  43  *
  44  * Split the directory part of the given fullpath and store it in buf
  45  *   (including last '/').
  46  * The function return parameter is a pointer to the filename
  47  *   inside the given fullpath.
  48  */
  49 static char* strip_filename(char* buf, int buf_size, const char* fullpath)
  50 {
  51     char* sep;
  52     int   len;
  53
  54     if (!buf || buf_size <= 0 || !fullpath)
  55         return NULL;
  56
  57     /* if 'fullpath' is only a filename return immediately */
  58     sep = strrchr(fullpath, '/');
  59     if (sep == NULL)
  60     {
  61         buf[0] = 0;
  62         return (char*)fullpath;
  63     }
  64
  65     len = MIN(sep - fullpath + 1, buf_size - 1);
  66     strncpy(buf, fullpath, len);
  67     buf[len] = 0;
  68     return (sep + 1);
  69 }
  70
  71 /* Make sure part of path only contain chars valid for a FAT32 long name.
  72  * Double quotes are replaced with single quotes, other unsupported chars
  73  * are replaced with an underscore.
  74  *
  75  * path   - path to modify.
  76  * offset - where in path to start checking.
  77  * count  - number of chars to check.
  78  */
  79 static void fix_path_part(char* path, int offset, int count)
  80 {
  81     static const char invalid_chars[] = "*/:<>?\\|";
  82     int i;
  83
  84     path += offset;
  85
  86     for (i = 0; i <= count; i++, path++)
  87     {
  88         if (*path == 0)
  89             return;
  90         if (*path == '"')
  91             *path = '\'';
  92         else if (strchr(invalid_chars, *path))
  93             *path = '_';
  94     }
  95 }
  96
  97 #ifdef USE_JPEG_COVER
  98 static const char * extensions[] = { "jpeg", "jpg", "bmp" };
  99 static int extension_lens[] = { 4, 3, 3 };
 100 /* Try checking for several file extensions, return true if a file is found and
 101  * leaving the path modified to include the matching extension.
 102  */
 103 static bool try_exts(char *path, int len)
 104 {
 105     int i;
 106     for (i = 0; i < 3; i++)
 107     {
 108         if (extension_lens[i] + len > MAX_PATH)
 109             continue;
 110         strcpy(path + len, extensions[i]);
 111         if (file_exists(path))
 112             return true;
 113     }
 114     return false;
 115 }
 116 #define EXT
 117 #else
 118 #define EXT "bmp"
 119 #define try_exts(path, len) file_exists(path)
 120 #endif
 121
 122 /* Look for the first matching album art bitmap in the following list:
 123  *  ./<trackname><size>.bmp
 124  *  ./<albumname><size>.bmp
 125  *  ./cover<size>.bmp
 126  *  ../<albumname><size>.bmp
 127  *  ../cover<size>.bmp
 128  *  ROCKBOX_DIR/albumart/<artist>-<albumname><size>.bmp
 129  * <size> is the value of the size_string parameter, <trackname> and
 130  * <albumname> are read from the ID3 metadata.
 131  * If a matching bitmap is found, its filename is stored in buf.
 132  * Return value is true if a bitmap was found, false otherwise.
 133  */
 134 bool search_albumart_files(const struct mp3entry *id3, const char *size_string,
 135                            char *buf, int buflen)
 136 {
 137     char path[MAX_PATH + 1];
 138     char dir[MAX_PATH + 1];
 139     bool found = false;
 140     const char *trackname;
 141     const char *artist;
 142     int dirlen;
 143     int albumlen;
 144     int pathlen;
 145
 146     if (!id3 || !buf)
 147         return false;
 148
 149     trackname = id3->path;
 150
 151     if (strcmp(trackname, "No file!") == 0)
 152         return false;
 153
 154     strip_filename(dir, sizeof(dir), trackname);
 155     dirlen = strlen(dir);
 156     albumlen = id3->album ? strlen(id3->album) : 0;
 157
 158     /* the first file we look for is one specific to the track playing */
 159     if (*size_string == ':')
 160         size_string++;
 161     else {
 162         strip_extension(path, sizeof(path) - strlen(size_string) - 4, trackname);
 163         strcat(path, size_string);
 164         strcat(path, "." EXT);
 165     #ifdef USE_JPEG_COVER
 166         pathlen = strlen(path);
 167     #endif
 168         found = try_exts(path, pathlen);
 169     }
 170     if (!found && albumlen > 0)
 171     {
 172         /* if it doesn't exist,
 173          * we look for a file specific to the track's album name */
 174         pathlen = snprintf(path, sizeof(path),
 175                            "%s%s%s." EXT, dir, id3->album, size_string);
 176         fix_path_part(path, dirlen, albumlen);
 177         found = try_exts(path, pathlen);
 178     }
 179
 180     if (!found)
 181     {
 182         /* if it still doesn't exist, we look for a generic file */
 183         pathlen = snprintf(path, sizeof(path),
 184                            "%scover%s." EXT, dir, size_string);
 185         found = try_exts(path, pathlen);
 186     }
 187
 188 #ifdef USE_JPEG_COVER
 189     if (!found && !*size_string)
 190     {
 191         snprintf (path, sizeof(path), "%sfolder.jpg", dir);
 192         found = file_exists(path);
 193     }
 194 #endif
 195
 196     artist = id3->albumartist != NULL ? id3->albumartist : id3->artist;
 197
 198     if (!found && artist && id3->album)
 199     {
 200         /* look in the albumart subdir of .rockbox */
 201         pathlen = snprintf(path, sizeof(path),
 202                            ROCKBOX_DIR "/albumart/%s-%s%s." EXT,
 203                            artist,
 204                            id3->album,
 205                            size_string);
 206         fix_path_part(path, strlen(ROCKBOX_DIR "/albumart/"), MAX_PATH);
 207         found = try_exts(path, pathlen);
 208     }
 209
 210     if (!found)
 211     {
 212         /* if it still doesn't exist,
 213          * we continue to search in the parent directory */
 214         strcpy(path, dir);
 215         path[dirlen - 1] = 0;
 216         strip_filename(dir, sizeof(dir), path);
 217         dirlen = strlen(dir);
 218     }
 219
 220     /* only try parent if there is one */
 221     if (dirlen > 0)
 222     {
 223         if (!found && albumlen > 0)
 224         {
 225             /* we look in the parent directory
 226              * for a file specific to the track's album name */
 227             pathlen = snprintf(path, sizeof(path),
 228                                "%s%s%s." EXT, dir, id3->album, size_string);
 229             fix_path_part(path, dirlen, albumlen);
 230             found = try_exts(path, pathlen);
 231         }
 232
 233         if (!found)
 234         {
 235             /* if it still doesn't exist, we look in the parent directory
 236              * for a generic file */
 237             pathlen = snprintf(path, sizeof(path),
 238                                "%scover%s." EXT, dir, size_string);
 239             found = try_exts(path, pathlen);
 240         }
 241     }
 242
 243     if (!found)
 244         return false;
 245
 246     strncpy(buf, path, buflen);
 247     DEBUGF("Album art found: %s\n", path);
 248     return true;
 249 }
 250
 251 #ifndef PLUGIN
 252 /* Look for albumart bitmap in the same dir as the track and in its parent dir.
 253  * Stores the found filename in the buf parameter.
 254  * Returns true if a bitmap was found, false otherwise */
 255 bool find_albumart(const struct mp3entry *id3, char *buf, int buflen)
 256 {
 257     if (!id3 || !buf)
 258         return false;
 259
 260     char size_string[9];
 261     struct wps_data *data = gui_wps[0].data;
 262
 263     if (!data)
 264         return false;
 265
 266     DEBUGF("Looking for album art for %s\n", id3->path);
 267
 268     /* Write the size string, e.g. ".100x100". */
 269     snprintf(size_string, sizeof(size_string), ".%dx%d",
 270              data->albumart_max_width, data->albumart_max_height);
 271
 272     /* First we look for a bitmap of the right size */
 273     if (search_albumart_files(id3, size_string, buf, buflen))
 274         return true;
 275
 276     /* Then we look for generic bitmaps */
 277     *size_string = 0;
 278     return search_albumart_files(id3, size_string, buf, buflen);
 279 }
 280
 281 /* Draw the album art bitmap from the given handle ID onto the given WPS.
 282    Call with clear = true to clear the bitmap instead of drawing it. */
 283 void draw_album_art(struct gui_wps *gwps, int handle_id, bool clear)
 284 {
 285     if (!gwps || !gwps->data || !gwps->display || handle_id < 0)
 286         return;
 287
 288     struct wps_data *data = gwps->data;
 289
 290 #ifdef HAVE_REMOTE_LCD
 291     /* No album art on RWPS */
 292     if (data->remote_wps)
 293         return;
 294 #endif
 295
 296     struct bitmap *bmp;
 297     if (bufgetdata(handle_id, 0, (void *)&bmp) <= 0)
 298         return;
 299
 300     short x = data->albumart_x;
 301     short y = data->albumart_y;
 302     short width = bmp->width;
 303     short height = bmp->height;
 304
 305     if (data->albumart_max_width > 0)
 306     {
 307         /* Crop if the bitmap is too wide */
 308         width = MIN(bmp->width, data->albumart_max_width);
 309
 310         /* Align */
 311         if (data->albumart_xalign & WPS_ALBUMART_ALIGN_RIGHT)
 312             x += data->albumart_max_width - width;
 313         else if (data->albumart_xalign & WPS_ALBUMART_ALIGN_CENTER)
 314             x += (data->albumart_max_width - width) / 2;
 315     }
 316
 317     if (data->albumart_max_height > 0)
 318     {
 319         /* Crop if the bitmap is too high */
 320         height = MIN(bmp->height, data->albumart_max_height);
 321
 322         /* Align */
 323         if (data->albumart_yalign & WPS_ALBUMART_ALIGN_BOTTOM)
 324             y += data->albumart_max_height - height;
 325         else if (data->albumart_yalign & WPS_ALBUMART_ALIGN_CENTER)
 326             y += (data->albumart_max_height - height) / 2;
 327     }
 328
 329     if (!clear)
 330     {
 331         /* Draw the bitmap */
 332         gwps->display->bitmap_part((fb_data*)bmp->data, 0, 0, bmp->width,
 333                                    x, y, width, height);
 334 #ifdef HAVE_LCD_INVERT
 335         if (global_settings.invert) {
 336             gwps->display->set_drawmode(DRMODE_COMPLEMENT);
 337             gwps->display->fillrect(x, y, width, height);
 338             gwps->display->set_drawmode(DRMODE_SOLID);
 339         }
 340 #endif
 341     }
 342     else
 343     {
 344         /* Clear the bitmap */
 345         gwps->display->set_drawmode(DRMODE_SOLID|DRMODE_INVERSEVID);
 346         gwps->display->fillrect(x, y, width, height);
 347         gwps->display->set_drawmode(DRMODE_SOLID);
 348     }
 349 }
 350
 351 void get_albumart_size(struct bitmap *bmp)
 352 {
 353     /* FIXME: What should we do with albumart on remote? */
 354     struct wps_data *data = gui_wps[0].data;
 355
 356     bmp->width = data->albumart_max_width;
 357     bmp->height = data->albumart_max_height;
 358 }
 359 #endif /* PLUGIN */