mympd_state.h

Go to the documentation of this file.

/*
 SPDX-License-Identifier: GPL-3.0-or-later
 myMPD (c) 2018-2025 Juergen Mang <mail@jcgames.de>
 https://github.com/jcorporation/mympd
*/
 
#ifndef MYMPD_STATE_H
#define MYMPD_STATE_H
 
#include "dist/sds/sds.h"
#include "src/lib/cache/cache_rax.h"
#include "src/lib/config_def.h"
#include "src/lib/event.h"
#include "src/lib/fields.h"
#include "src/lib/jukebox.h"
#include "src/lib/list.h"
#include "src/lib/webradio.h"
 
#include <time.h>
 
enum mpd_conn_states {
    MPD_CONNECTED,     
    MPD_DISCONNECTED,  
    MPD_FAILURE        
};
 
struct t_mpd_features {
    bool fingerprint;              
    bool mount;                    
    bool neighbor;                 
    bool pcre;                     
    bool playlists;                
    bool stickers;                 
    bool tags;                     
    bool library;                  
    // MPD 0.25 features
    bool mpd_0_25_0;               
    // MPD 0.24 features
    bool mpd_0_24_0;               
    bool advsticker;               
    bool db_added;                 
    bool advqueue;                 
    bool consume_oneshot;          
    bool listplaylist_range;       
    bool playlist_dir_auto;        
    bool starts_with;              
    // MPD 0.23 features
    bool whence;                   
    bool playlist_rm_range;        
};
 
struct t_mpd_state {
    struct t_config *config;            
    //connection configuration
    sds mpd_host;                       
    unsigned mpd_port;                  
    sds mpd_pass;                       
    unsigned mpd_binarylimit;           
    unsigned mpd_timeout;               
    bool mpd_keepalive;                 
    bool mpd_stringnormalization;       
    sds music_directory_value;          
    sds playlist_directory_value;       
    //tags
    sds tag_list;                       
    struct t_mympd_mpd_tags tags_mympd;       
    struct t_mympd_mpd_tags tags_mpd;         
    struct t_mympd_mpd_tags tags_search;      
    struct t_mympd_mpd_tags tags_browse;      
    struct t_mympd_mpd_tags tags_album;       
    enum mpd_tag_type tag_albumartist;  
    //Feature flags
    const unsigned *protocol;           
    struct t_mpd_features feat;         
    struct t_list sticker_types;        
};
 
struct t_jukebox_state {
    enum jukebox_modes mode;       
    sds playlist;                  
    unsigned queue_length;         
    unsigned last_played;          
    struct t_mympd_mpd_tags uniq_tag;      
    struct t_list *queue;          
    bool ignore_hated;             
    sds filter_include;            
    sds filter_exclude;            
    unsigned min_song_duration;    
    unsigned max_song_duration;    
    bool filling;                  
    sds last_error;                
    bool autostart;                
};
 
struct t_partition_state {
    struct t_config *config;               
    struct t_mpd_state *mpd_state;         
    //mpd connection
    struct mpd_connection *conn;           
    enum mpd_conn_states conn_state;       
    //track player states
    enum mpd_state play_state;             
    int song_id;                           
    int next_song_id;                      
    int last_song_id;                      
    int song_pos;                          
    time_t song_duration;                  
    struct mpd_song *song;                 
    struct mpd_song *last_song;            
    unsigned queue_version;                
    unsigned queue_length;                 
    int last_skipped_id;                   
    time_t song_end_time;                  
    time_t last_song_end_time;             
    time_t song_start_time;                
    time_t last_song_start_time;           
    time_t crossfade;                      
    bool auto_play;                        
    bool player_error;                     
    struct t_jukebox_state jukebox;        
    //partition
    sds name;                              
    sds highlight_color;                   
    sds highlight_color_contrast;          
    sds state_dir;                         
    struct t_partition_state *next;        
    bool is_default;                       
    enum mpd_idle idle_mask;               
    bool set_conn_options;                 
    //local playback
    unsigned mpd_stream_port;              
    sds stream_uri;                        
    //lists
    struct t_list last_played;             
    struct t_list preset_list;             
    //timers
    int timer_fd_jukebox;                  
    int timer_fd_scrobble;                 
    int timer_fd_mpd_connect;              
    //events
    enum pfd_type waiting_events;          
};
 
struct t_stickerdb_state {
    struct t_config *config;               
    struct t_mpd_state *mpd_state;         
    //mpd connection
    struct mpd_connection *conn;           
    enum mpd_conn_states conn_state;       
    sds name;                              
};
 
struct t_timer_definition {
    sds name;                         
    sds partition;                    
    bool enabled;                     
    int start_hour;                   
    int start_minute;                 
    sds action;                       
    sds subaction;                    
    unsigned volume;                  
    sds playlist;                     
    sds preset;                       
    bool weekdays[7];                 
    struct t_list arguments;          
};
 
struct t_timer_list {
    unsigned last_id;                   
    int active;                         
    struct t_list list;                 
};
 
struct t_lyrics {
    sds uslt_ext;     
    sds sylt_ext;     
    sds vorbis_uslt;  
    sds vorbis_sylt;  
};
 
struct t_mympd_state {
    struct t_config *config;                        
    struct t_mpd_state *mpd_state;                  
    struct t_partition_state *partition_state;      
    struct t_stickerdb_state *stickerdb;            
    struct mympd_pfds pfds;                         
    struct t_timer_list timer_list;                 
    struct t_list home_list;                        
    struct t_list trigger_list;                     
    sds tag_list_search;                            
    sds tag_list_browse;                            
    bool smartpls;                                  
    sds smartpls_sort;                              
    sds smartpls_prefix;                            
    int smartpls_interval;                          
    struct t_mympd_mpd_tags smartpls_generate_tag_types;  
    sds smartpls_generate_tag_list;                 
    sds view_queue_current;                         
    sds view_search;                                
    sds view_browse_database_album_detail_info;     
    sds view_browse_database_album_detail;          
    sds view_browse_database_album_list;            
    sds view_browse_database_tag_list;              
    sds view_browse_playlist_list;                  
    sds view_browse_playlist_detail;                
    sds view_browse_filesystem;                     
    sds view_playback;                              
    sds view_queue_last_played;                     
    sds view_queue_jukebox_song;                    
    sds view_queue_jukebox_album;                   
    sds view_browse_radio_webradiodb;               
    sds view_browse_radio_favorites;                
    sds music_directory;                            
    sds playlist_directory;                         
    sds navbar_icons;                               
    sds image_names_sm;                             
    sds image_names_md;                             
    sds image_names_lg;                             
    unsigned volume_min;                            
    unsigned volume_max;                            
    unsigned volume_step;                           
    struct t_lyrics lyrics;                         
    sds webui_settings;                             
    bool tag_disc_empty_is_first;                   
    sds booklet_name;                               
    sds info_txt_name;                              
    struct t_cache album_cache;                     
    unsigned last_played_count;                     
    struct t_webradios *webradiodb;                 
    struct t_webradios *webradio_favorites;         
};
 
void mympd_state_save(struct t_mympd_state *mympd_state, bool free_data);
void mympd_state_default(struct t_mympd_state *mympd_state, struct t_config *config);
void mympd_state_free(struct t_mympd_state *mympd_state);
 
void mympd_mpd_state_features_default(struct t_mpd_features *feat);
void mympd_mpd_state_features_copy(struct t_mpd_features *src, struct t_mpd_features *dst);
 
void mympd_mpd_state_default(struct t_mpd_state *mpd_state, struct t_config *config);
void mympd_mpd_state_copy(struct t_mpd_state *src, struct t_mpd_state *dst);
void mympd_mpd_state_free(struct t_mpd_state *mpd_state);
 
void partition_state_default(struct t_partition_state *partition_state, const char *name,
        struct t_mpd_state *mpd_state, struct t_config *config);
void partition_state_free(struct t_partition_state *partition_state);
 
void stickerdb_state_default(struct t_stickerdb_state *stickerdb, struct t_config *config);
void stickerdb_state_free(struct t_stickerdb_state *stickerdb);
 
void jukebox_state_default(struct t_jukebox_state *jukebox_state);
void jukebox_state_copy(struct t_jukebox_state *src, struct t_jukebox_state *dst);
void jukebox_state_free(struct t_jukebox_state *jukebox_state);
 
#endif