player.h

Go to the documentation of this file.

// SPDX-License-Identifier: Apache-2.0
#pragma once
 
#include "audio_player/decoder.h"
#include "audio_player/dsp.h"
#include "audio_player/library.h"
#include "audio_player/sink.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef enum { PLAYER_STOPPED = 0, PLAYER_PLAYING, PLAYER_PAUSED } player_state_t;
typedef enum { REPEAT_OFF = 0, REPEAT_ALL, REPEAT_ONE } repeat_mode_t;
 
#define PLAYER_QUEUE_MAX 20000
 
#define PLAYER_VOLUME_MIN_DB (-96.0f)
 
typedef struct {
    lib_id_t track_id;         
    char path[CORE_PATH_MAX];
    uint32_t start_ms;
    uint32_t end_ms;
} queue_item_t;
 
typedef struct {
    player_state_t state;
    uint32_t queue_index;      
    uint32_t queue_length;
    char path[CORE_PATH_MAX];
    char title[TAG_TEXT_MAX];  
    char artist[TAG_TEXT_MAX];
    char album[TAG_TEXT_MAX];
    uint16_t year;
    uint16_t track_no;
    lib_id_t track_id;
    uint64_t cover_offset;     
    uint32_t cover_size;
    uint32_t position_ms;
    uint32_t duration_ms;      
    codec_id_t codec;
    uint32_t bitrate_kbps;
    audio_format_t src_fmt;    
    audio_format_t out_fmt;    
    bool bitperfect;           
    uint32_t dsp_flags;        
    float volume_db;           
    float volume_max_db;       
    bool shuffle;
    repeat_mode_t repeat;
    uint32_t sleep_left_s;     
    uint32_t underruns;
    char sink_name[16];
    char sink_detail[48];
} player_status_t;
 
typedef struct {
    audio_sink_t *sink;           
    library_t *library;           
    core_stream_t *(*open_stream)(const char *path, void *user);
    void *open_stream_user;
    const char *state_dir;        
    bool scrobble_log;            
    float volume_default_db;
    float volume_max_db;
    float volume_step_db;         
    void (*wake)(void *user);
    void *wake_user;
} player_config_t;
 
typedef struct player player_t;
 
player_t *player_create(const player_config_t *cfg);
void player_destroy(player_t *p);
 
// ---- commands (any thread) -------------------------------------------------
void player_cmd_play_items(player_t *p, const queue_item_t *items, uint32_t n, uint32_t start, bool shuffle);
void player_cmd_play_tracks(player_t *p, const lib_id_t *ids, uint32_t n, uint32_t start, bool shuffle);
#define PLAYER_FOLDER_MAX 2000
int player_cmd_play_folder(player_t *p, const char *dir, uint32_t start, bool shuffle);
void player_cmd_enqueue(player_t *p, const queue_item_t *items, uint32_t n, bool play_next);
void player_cmd_queue_remove(player_t *p, uint32_t index);
void player_cmd_queue_jump(player_t *p, uint32_t index);
void player_cmd_queue_clear(player_t *p);
void player_cmd_toggle_pause(player_t *p);
void player_cmd_pause(player_t *p);
void player_cmd_resume(player_t *p);         
void player_cmd_stop(player_t *p);
void player_cmd_next(player_t *p);
void player_cmd_prev(player_t *p);           
void player_cmd_seek_ms(player_t *p, uint32_t ms);
void player_cmd_seek_relative_ms(player_t *p, int32_t delta_ms);
void player_cmd_set_volume_db(player_t *p, float db);
void player_cmd_volume_step(player_t *p, int steps);
void player_cmd_set_shuffle(player_t *p, bool on);
void player_cmd_set_repeat(player_t *p, repeat_mode_t mode);
void player_cmd_set_dsp(player_t *p, const dsp_config_t *cfg);
void player_cmd_set_gapless(player_t *p, bool on);
void player_cmd_set_sleep_timer(player_t *p, uint32_t minutes);  
void player_cmd_set_volume_limit(player_t *p, float max_db);
void player_cmd_set_sink(player_t *p, audio_sink_t *sink);
 
// ---- queries (any thread, copies under lock) ---------------------------------
void player_get_status(player_t *p, player_status_t *out);
uint32_t player_queue_count(player_t *p);
int player_queue_get(player_t *p, uint32_t index, queue_item_t *out);  
 
// ---- persistence -------------------------------------------------------------
int player_save_state(player_t *p);
int player_restore_state(player_t *p, bool autoplay);
 
// ---- audio thread -------------------------------------------------------------
int32_t player_run_once(player_t *p);
uint32_t player_wait_hint_ms(player_t *p);
void player_set_chunk_frames(player_t *p, uint32_t frames);
 
#ifdef __cplusplus
}
#endif