len0rd/rockbox
1
0
Fork 1
mirror of https://github.com/Rockbox/rockbox.git synced 2026-07-10 13:29:52 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions
rockbox/apps/gui/skin_engine/wps_internals.h
Adam N. Burke a824085057 skin: add %pX tag for time-based playlist progress 
%pP reports playlist progress by position index, which treats every
track as equally long. For playlists with tracks of unequal length --
audiobooks with chapters anywhere from two minutes to an hour are the
motivating case -- position is a poor proxy for listening progress.

%pX reports the played percentage of the whole playlist by time: the
summed length of all preceding tracks plus the elapsed time in the
current one, relative to the playlist's total duration. It can be
used as a value, in a conditional, with %if(), or as a bar tag like
%pb.

If a playlist contains more than 500 tracks or the scan is taking too
long and the user aborts the tag will fallback to the behavior of %pP
except the progress through the current track will be included in the
returned percentage

--------------------------------------
Computing this needs every track's length, and reading metadata for
every track is too slow and disk-heavy for a tag that refreshes on the
WPS. Instead each track's length is estimated from its file size: the
skin engine scans the playlist in the background, a batch of files each
skin refresh, opening each file only to read its size (directory
metadata, no header parse). Size is turned into time by calibrating one
file of each type -- the first file of each extension is parsed once
with get_metadata to learn its bytes-per-second, and every later file
of that type reuses it. A single-format playlist, the usual audiobook
case, parses exactly one file and stat's the rest.

The result is an estimate -- bitrate varies within a type, especially
for VBR -- but it is cheap and accurate enough for a progress
indicator, and the playing track always contributes its exact elapsed
time. Per-track lengths are stored as two bytes of minutes each in a
movable buffer sized to the track count and allocated only while the
tag is in use; the cache is keyed on the track count and a crc of the
first, middle and last filenames, so a playlist swap or reshuffle is
caught. If the buffer cannot be allocated (a very large playlist on a
low-memory target) the tag falls back to position-based progress.

The buffer is allocated when playback starts (and when the now-playing
screen is opened with playback already active) rather than lazily on the
first WPS refresh, so the one-time allocation happens at a playback
boundary instead of during steady-state playback; it falls back to
allocating on first use if that point is missed.

Until the scan finishes the tag does not blank: it returns an instant
equal-weight estimate -- (completed tracks + fraction through the
current one) / track count -- which sharpens into the size-based value
as the scan fills in. So a theme can just use %pX and it is correct
from the first frame, and %?pX is true whenever a playlist is loaded.

Tested on a Sansa Clip Zip and in the simulator. On a 216-track,
~745 MB single-format audiobook playlist the length scan dropped from
~4150 ms (get_metadata on every track) to ~174 ms (one parse plus 215
file-size stats), roughly 24x lighter.

Change-Id: I6e572e78a10444bd513ddc77e30da04aa5153ef2
2026-06-27 12:29:31 -04:00

461 lines
13 KiB
C
Raw Blame History

/***************************************************************************
* __________ __ ___.
* Open \______ \ ____ ____ | | _\_ |__ _______ ___
* Source | _// _ \_/ ___\| |/ /| __ \ / _ \ \/ /
* Jukebox | | ( <_> ) \___| < | \_\ ( <_> > < <
* Firmware |____|_ /\____/ \___ >__|_ \|___ /\____/__/\_ \
* \/ \/ \/ \/ \/
*
* Copyright (C) 2007 Nicolas Pennequin
*
* 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.
*
****************************************************************************/
/* This stuff is for the wps engine only.. anyone caught using this outside
* of apps/gui/wps_engine will be shot on site! */
#ifndef _WPS_ENGINE_INTERNALS_
#define _WPS_ENGINE_INTERNALS_
#include "tag_table.h"
#include "skin_parser.h"
#include "gesture.h"
#ifndef __PCTOOL__
#include "core_alloc.h"
#endif
struct wps_data;
struct skin_stats {
size_t buflib_handles;
size_t tree_size;
size_t images_size;
};
int skin_get_num_skins(void);
struct skin_stats *skin_get_stats(int number, int screen);
#define skin_clear_stats(stats) memset(stats, 0, sizeof(struct skin_stats))
bool skin_backdrop_get_debug(int index, char **path, int *ref_count, size_t *size);
/*
* setup up the skin-data from a format-buffer (isfile = false)
* or from a skinfile (isfile = true)
*/
bool skin_data_load(enum screen_type screen, struct wps_data *wps_data,
const char *buf, bool isfile, struct skin_stats *stats);
/* Timeout unit expressed in HZ. In WPS, all timeouts are given in seconds
(possibly with a decimal fraction) but stored as integer values.
E.g. 2.5 is stored as 25. This means 25 tenth of a second, i.e. 25 units.
*/
#define TIMEOUT_UNIT (HZ/10) /* I.e. 0.1 sec */
#define DEFAULT_SUBLINE_TIME_MULTIPLIER 20 /* In TIMEOUT_UNIT's */
/* TODO: sort this mess out */
#include "screen_access.h"
#include "statusbar.h"
#include "metadata.h"
#define TOKEN_VALUE_ONLY 0x0DEADC0D
/* wps_data*/
struct wps_token {
union {
char c;
unsigned short i;
long l;
OFFSETTYPE(void*) data;
void *xdata;
} value;
enum skin_token_type type; /* enough to store the token type */
/* Whether the tag (e.g. track name or the album) refers the
current or the next song (false=current, true=next) */
bool next;
};
struct wps_subline_timeout {
unsigned long next_tick;
unsigned short hide;
unsigned short show;
};
char* get_dir(char* buf, int buf_size, const char* path, int level);
struct skin_token_list {
OFFSETTYPE(struct wps_token *) token;
OFFSETTYPE(struct skin_token_list *) next;
};
struct gui_img {
int16_t x; /* x-pos */
int16_t y; /* y-pos */
int16_t num_subimages; /* number of sub-images */
int16_t subimage_height; /* height of each sub-image */
struct bitmap bm;
int buflib_handle;
OFFSETTYPE(char*) label;
int display;
bool loaded; /* load state */
bool using_preloaded_icons; /* using the icon system instead of a bmp */
bool is_9_segment;
bool dither;
};
struct image_display {
OFFSETTYPE(char*) label;
OFFSETTYPE(struct wps_token*) token; /* the token to get the subimage number from */
int16_t subimage;
int16_t offset; /* offset into the bitmap strip to start */
};
struct progressbar {
enum skin_token_type type;
bool follow_lang_direction;
bool horizontal;
char setting_offset;
/* regular pb */
int16_t x;
/* >=0: explicitly set in the tag -> y-coord within the viewport
<0 : not set in the tag -> negated 1-based line number within
the viewport. y-coord will be computed based on the font height */
int16_t y;
int16_t width;
int16_t height;
OFFSETTYPE(struct gui_img *) image;
bool invert_fill_direction;
bool nofill;
bool noborder;
bool nobar;
OFFSETTYPE(struct gui_img *) slider;
OFFSETTYPE(struct gui_img *) backdrop;
const struct settings_list *setting;
};
struct draw_rectangle {
int16_t x;
int16_t y;
int16_t width;
int16_t height;
unsigned start_colour;
unsigned end_colour;
};
struct align_pos {
char* left;
char* center;
char* right;
};
#define WPS_MAX_TOKENS 1150
enum wps_parse_error {
PARSE_OK,
PARSE_FAIL_UNCLOSED_COND,
PARSE_FAIL_INVALID_CHAR,
PARSE_FAIL_COND_SYNTAX_ERROR,
PARSE_FAIL_COND_INVALID_PARAM,
PARSE_FAIL_LIMITS_EXCEEDED,
};
#ifdef HAVE_LCD_COLOR
struct gradient_config {
unsigned start;
unsigned end;
unsigned text;
int lines_count;
};
#endif
#define VP_DRAW_HIDEABLE 0x1
#define VP_DRAW_HIDDEN 0x2
#define VP_DRAW_WASHIDDEN 0x4
/* these are never drawn, nor cleared, i.e. just ignored */
#define VP_NEVER_VISIBLE 0x8
#ifndef __PCTOOL__
#define VP_DEFAULT_LABEL -200
#else
#define VP_DEFAULT_LABEL NULL
#endif
#define VP_DEFAULT_LABEL_STRING "|"
struct skin_viewport {
struct viewport vp; /* The LCD viewport struct */
struct frame_buffer_t framebuf; /* holds reference to current framebuffer */
OFFSETTYPE(char*) label;
int16_t parsed_fontid;
char hidden_flags;
bool is_infovp;
#if (LCD_DEPTH > 1) || (defined(HAVE_REMOTE_LCD) && (LCD_REMOTE_DEPTH > 1))
bool output_to_backdrop_buffer;
bool fgbg_changed;
#ifdef HAVE_LCD_COLOR
struct gradient_config start_gradient;
#endif
#endif
};
struct viewport_colour {
unsigned colour;
};
#ifdef HAVE_TOUCHSCREEN
struct touchregion {
OFFSETTYPE(char*) label; /* label to identify this region */
OFFSETTYPE(struct skin_viewport*) wvp;/* The viewport this region is in */
int16_t x; /* x-pos */
int16_t y; /* y-pos */
int16_t width; /* width */
int16_t height; /* height */
int16_t wpad; /* padding to width */
int16_t hpad; /* padding to height */
bool reverse_bar; /* if true 0% is the left or top */
bool allow_while_locked;
bool user_region; /* if true this is a user-defined region */
enum {
PRESS, /* quick press only */
LONG_PRESS, /* Long press without repeat */
REPEAT, /* long press allowing repeats */
} press_length;
int action; /* action this button will return */
union { /* Extra data, action dependant */
struct touchsetting {
const struct settings_list *setting; /* setting being controlled */
union { /* Value to set the setting to for ACTION_SETTING_SET */
int number;
OFFSETTYPE(char*) text;
} value;
} setting_data;
int value;
};
long last_press; /* last tick this was pressed */
OFFSETTYPE(struct progressbar*) bar;
};
struct touchregion_lastpress {
OFFSETTYPE(struct touchregion *) region;
long timeout;
};
#endif
struct playlistviewer {
bool show_icons;
int start_offset;
OFFSETTYPE(struct skin_element *) line;
};
#ifdef HAVE_ALBUMART
/* albumart definitions */
#define WPS_ALBUMART_NONE 0 /* WPS does not contain AA tag */
#define WPS_ALBUMART_CHECK 1 /* WPS contains AA conditional tag */
#define WPS_ALBUMART_LOAD 2 /* WPS contains AA tag */
#define WPS_ALBUMART_ALIGN_RIGHT 1 /* x align: right */
#define WPS_ALBUMART_ALIGN_CENTER 2 /* x/y align: center */
#define WPS_ALBUMART_ALIGN_LEFT 4 /* x align: left */
#define WPS_ALBUMART_ALIGN_TOP 1 /* y align: top */
#define WPS_ALBUMART_ALIGN_BOTTOM 4 /* y align: bottom */
struct skin_albumart {
/* Album art support */
int16_t x;
int16_t y;
int16_t width;
int16_t height;
unsigned char xalign; /* WPS_ALBUMART_ALIGN_LEFT, _CENTER, _RIGHT */
unsigned char yalign; /* WPS_ALBUMART_ALIGN_TOP, _CENTER, _BOTTOM */
unsigned char state; /* WPS_ALBUMART_NONE, _CHECK, _LOAD */
int draw_handle;
};
#endif
struct line {
unsigned update_mode;
};
struct line_alternator {
int current_line;
unsigned long next_change_tick;
};
struct conditional {
int last_value;
OFFSETTYPE(struct wps_token *) token;
};
struct logical_if {
OFFSETTYPE(struct wps_token *) token;
enum {
IF_EQUALS, /* == */
IF_NOTEQUALS, /* != */
IF_LESSTHAN, /* < */
IF_LESSTHAN_EQ, /* <= */
IF_GREATERTHAN, /* > */
IF_GREATERTHAN_EQ /* >= */
} op;
struct skin_tag_parameter operand;
int num_options;
};
struct substring {
int16_t start;
int16_t length;
bool expect_number;
OFFSETTYPE(struct wps_token *) token;
};
struct listitem {
bool wrap;
int16_t offset;
};
struct listitem_viewport_cfg {
struct wps_data *data;
OFFSETTYPE(char *) label;
int16_t width;
int16_t height;
int16_t xmargin;
int16_t ymargin;
bool tile;
struct skin_viewport selected_item_vp;
};
#ifdef HAVE_SKIN_VARIABLES
struct skin_var {
OFFSETTYPE(const char *) label;
int value;
long last_changed;
};
struct skin_var_lastchange {
OFFSETTYPE(struct skin_var *) var;
long timeout;
};
struct skin_var_changer {
OFFSETTYPE(struct skin_var *) var;
int newval;
bool direct; /* true to make val=newval, false for val += newval */
int max;
};
#endif
/* wps_data
this struct holds all necessary data which describes the
viewable content of a wps */
struct wps_data
{
int buflib_handle;
OFFSETTYPE(struct skin_element *) tree;
OFFSETTYPE(struct skin_token_list *) images;
OFFSETTYPE(int16_t *) font_ids;
int16_t font_count;
#ifdef HAVE_BACKDROP_IMAGE
int16_t backdrop_id;
bool use_extra_framebuffer;
#endif
#ifdef HAVE_TOUCHSCREEN
bool touchscreen_locked;
OFFSETTYPE(struct skin_token_list *) touchregions;
struct gesture gesture;
#endif
#ifdef HAVE_ALBUMART
OFFSETTYPE(struct skin_albumart *) albumart;
int playback_aa_slot;
/* copy of albumart to survive skin resets, used to check if albumart
* dimensions changed on skin change */
int16_t last_albumart_width, last_albumart_height;
#endif
#ifdef HAVE_SKIN_VARIABLES
OFFSETTYPE(struct skin_token_list *) skinvars;
#endif
bool peak_meter_enabled;
bool wps_sb_tag;
bool show_sb_on_wps;
bool wps_loaded;
};
#ifndef __PCTOOL__
static inline char* get_skin_buffer(struct wps_data* data)
{
if (data->buflib_handle > 0)
return core_get_data(data->buflib_handle);
return NULL;
}
#else
#define get_skin_buffer(d) skin_buffer
#endif
/* wps_data end */
/* gui_wps
defines a wps with its data, state,
and the screen on which the wps-content should be drawn */
struct gui_wps
{
struct screen *display;
struct wps_data *data;
};
/* gui_wps end */
void get_image_filename(const char *start, const char* bmpdir,
char *buf, int buf_size);
/***** wps_tokens.c ******/
const char *get_token_value(struct gui_wps *gwps,
struct wps_token *token, int offset,
char *buf, int buf_size,
int *intval);
/* Get the id3 fields from the cuesheet */
const char *get_cuesheetid3_token(struct wps_token *token, struct mp3entry *id3,
int offset_tracks, char *buf, int buf_size);
const char *get_id3_token(struct wps_token *token, struct mp3entry *id3,
char *filename, char *buf, int buf_size, int limit, int *intval);
/* whole-playlist progress backing %pX (number and bar forms) */
bool wps_get_playlist_percent(struct mp3entry *id3, unsigned long elapsed_ms,
unsigned long *elapsed_s, unsigned long *total_s);
void wps_playlist_percent_enable(void);
void wps_playlist_percent_prepare(void);
#if CONFIG_TUNER
const char *get_radio_token(struct wps_token *token, int preset_offset,
char *buf, int buf_size, int limit, int *intval);
#endif
enum skin_find_what {
SKIN_FIND_VP = 0,
SKIN_FIND_UIVP,
SKIN_FIND_IMAGE,
#ifdef HAVE_TOUCHSCREEN
SKIN_FIND_TOUCHREGION,
#endif
#ifdef HAVE_SKIN_VARIABLES
SKIN_VARIABLE,
#endif
};
void *skin_find_item(const char *label, enum skin_find_what what,
struct wps_data *data);
#if defined(SIMULATOR) || defined(CHECKWPS)
#define DEBUG_SKIN_ENGINE
extern bool debug_wps;
#endif
#endif
Reference in a new issue View git blame Copy permalink