library.h

Go to the documentation of this file.

// SPDX-License-Identifier: Apache-2.0
#pragma once
 
#include "audio_player/tags.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef uint32_t lib_id_t;
#define LIB_ID_NONE 0xFFFFFFFFu
 
typedef enum {
    LIB_VIEW_ARTISTS = 0,     
    LIB_VIEW_ALBUMS,          
    LIB_VIEW_ARTIST_ALBUMS,   
    LIB_VIEW_ALBUM_TRACKS,    
    LIB_VIEW_ARTIST_TRACKS,   
    LIB_VIEW_TRACKS,          
    LIB_VIEW_GENRES,          
    LIB_VIEW_GENRE_ALBUMS,    
    LIB_VIEW_RECENT,          
    LIB_VIEW_AUDIOBOOKS,      
    LIB_VIEW_COUNT
} lib_view_t;
 
typedef struct {
    lib_id_t id;              
    char title[TAG_TEXT_MAX];
    char subtitle[TAG_TEXT_MAX];  
    uint32_t count;           
    uint32_t duration_ms;     
    uint16_t year;
    uint32_t sort_letter;     
} lib_item_t;
 
typedef struct {
    lib_id_t id;
    char path[CORE_PATH_MAX];
    track_tags_t tags;
    lib_id_t album_id, artist_id, genre_id;
    uint32_t file_size;
    uint32_t mtime;
} lib_track_t;
 
typedef struct {
    uint32_t files_seen;
    uint32_t files_total;     
    uint32_t tracks_added, tracks_updated, tracks_removed;
    const char *current_path; 
} lib_scan_progress_t;
 
typedef bool (*lib_scan_cb_t)(const lib_scan_progress_t *p, void *user);
 
typedef void (*lib_throttle_cb_t)(void *user);
 
typedef struct library library_t;
 
typedef struct {
    const char *music_root;   
    const char *db_dir;       
    bool ignore_articles;     
    lib_throttle_cb_t throttle;
    void *throttle_user;
} library_config_t;
 
library_t *library_open(const library_config_t *cfg);  
void library_close(library_t *lib);
 
int library_scan(library_t *lib, bool full_rebuild, lib_scan_cb_t cb, void *user);
bool library_is_scanning(const library_t *lib);
 
uint32_t library_track_count(const library_t *lib);
uint32_t library_view_count(library_t *lib, lib_view_t view, lib_id_t parent);
int library_view_item(library_t *lib, lib_view_t view, lib_id_t parent, uint32_t index, lib_item_t *out);
uint32_t library_view_find_letter(library_t *lib, lib_view_t view, lib_id_t parent, uint32_t letter);
uint32_t library_view_track_ids(library_t *lib, lib_view_t view, lib_id_t parent, lib_id_t *out, uint32_t max);
 
int library_get_track(library_t *lib, lib_id_t track_id, lib_track_t *out);
lib_id_t library_find_path(library_t *lib, const char *path);  
 
uint32_t library_generation(const library_t *lib);
bool library_translate_ids(library_t *lib, uint32_t *gen, lib_id_t *ids, uint32_t n);
 
int library_save_position(library_t *lib, const char *path, uint32_t position_ms);
uint32_t library_load_position(library_t *lib, const char *path);  
 
#ifdef __cplusplus
}
#endif