apps/playlist.h

   1 /***************************************************************************
   2  *             __________               __   ___.
   3  *   Open      \______   \ ____   ____ |  | _\_ |__   _______  ___
   4  *   Source     |       _//  _ \_/ ___\|  |/ /| __ \ /  _ \  \/  /
   5  *   Jukebox    |    |   (  <_> )  \___|    < | \_\ (  <_> > <  <
   6  *   Firmware   |____|_  /\____/ \___  >__|_ \|___  /\____/__/\_ \
   7  *                     \/            \/     \/    \/            \/
   8  * $Id$
   9  *
  10  * Copyright (C) 2002 by wavey@wavey.org
  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 #ifndef __PLAYLIST_H__
  23 #define __PLAYLIST_H__
  24
  25 #include <stdbool.h>
  26 #include "file.h"
  27 #include "kernel.h"
  28 #include "id3.h"
  29
  30 #define PLAYLIST_ATTR_QUEUED    0x01
  31 #define PLAYLIST_ATTR_INSERTED  0x02
  32 #define PLAYLIST_ATTR_SKIPPED   0x04
  33 #define PLAYLIST_MAX_CACHE      16
  34
  35 #define DEFAULT_DYNAMIC_PLAYLIST_NAME "/dynamic.m3u8"
  36
  37 enum playlist_command {
  38     PLAYLIST_COMMAND_PLAYLIST,
  39     PLAYLIST_COMMAND_ADD,
  40     PLAYLIST_COMMAND_QUEUE,
  41     PLAYLIST_COMMAND_DELETE,
  42     PLAYLIST_COMMAND_SHUFFLE,
  43     PLAYLIST_COMMAND_UNSHUFFLE,
  44     PLAYLIST_COMMAND_RESET,
  45     PLAYLIST_COMMAND_COMMENT
  46 };
  47
  48 enum {
  49     PLAYLIST_PREPEND = -1,
  50     PLAYLIST_INSERT = -2,
  51     PLAYLIST_INSERT_LAST = -3,
  52     PLAYLIST_INSERT_FIRST = -4,
  53     PLAYLIST_INSERT_SHUFFLED = -5,
  54     PLAYLIST_REPLACE = -6
  55 };
  56
  57 enum {
  58     PLAYLIST_DELETE_CURRENT = -1
  59 };
  60
  61 struct playlist_control_cache {
  62     enum playlist_command command;
  63     int i1;
  64     int i2;
  65     const char* s1;
  66     const char* s2;
  67     void* data;
  68 };
  69
  70 struct playlist_info
  71 {
  72     bool current;        /* current playing playlist                */
  73     char filename[MAX_PATH];  /* path name of m3u playlist on disk  */
  74     char control_filename[MAX_PATH]; /* full path of control file   */
  75     bool utf8;           /* playlist is in .m3u8 format             */
  76     int  fd;             /* descriptor of the open playlist file    */
  77     int  control_fd;     /* descriptor of the open control file     */
  78     bool control_created; /* has control file been created?         */
  79     int  dirlen;         /* Length of the path to the playlist file */
  80     unsigned long *indices; /* array of indices                     */
  81     const struct dircache_entry **filenames; /* Entries from dircache */
  82     int  max_playlist_size; /* Max number of files in playlist. Mirror of
  83                               global_settings.max_files_in_playlist */
  84     bool in_ram;         /* playlist stored in ram (dirplay)        */
  85     char *buffer;        /* buffer for in-ram playlists             */
  86     int  buffer_size;    /* size of buffer                          */
  87     int  buffer_end_pos; /* last position where buffer was written  */
  88     int  index;          /* index of current playing track          */
  89     int  first_index;    /* index of first song in playlist         */
  90     int  amount;         /* number of tracks in the index           */
  91     int  last_insert_pos; /* last position we inserted a track      */
  92     int  seed;           /* shuffle seed                            */
  93     bool shuffle_modified; /* has playlist been shuffled with
  94                               inserted tracks?                      */
  95     bool deleted;        /* have any tracks been deleted?           */
  96     int num_inserted_tracks; /* number of tracks inserted           */
  97     bool started;       /* has playlist been started?               */
  98
  99     /* cache of playlist control commands waiting to be flushed to
 100        to disk                                                      */
 101     struct playlist_control_cache control_cache[PLAYLIST_MAX_CACHE];
 102     int num_cached;      /* number of cached entries                */
 103     bool pending_control_sync; /* control file needs to be synced   */
 104
 105     struct mutex control_mutex; /* mutex for control file access    */
 106 };
 107
 108 struct playlist_track_info
 109 {
 110     char filename[MAX_PATH]; /* path name of mp3 file               */
 111     int  attr;               /* playlist attributes for track       */
 112     int  index;              /* index of track in playlist          */
 113     int  display_index;      /* index of track for display          */
 114 };
 115
 116 /* Exported functions only for current playlist. */
 117 void playlist_init(void);
 118 void playlist_shutdown(void);
 119 int playlist_create(const char *dir, const char *file);
 120 int playlist_resume(void);
 121 int playlist_add(const char *filename);
 122 int playlist_shuffle(int random_seed, int start_index);
 123 int playlist_start(int start_index, int offset);
 124 bool playlist_check(int steps);
 125 char *playlist_peek(int steps);
 126 int playlist_next(int steps);
 127 bool playlist_next_dir(int direction);
 128 int playlist_get_resume_info(int *resume_index);
 129 int playlist_update_resume_info(const struct mp3entry* id3);
 130 int playlist_get_display_index(void);
 131 int playlist_amount(void);
 132
 133 /* Exported functions for all playlists.  Pass NULL for playlist_info
 134    structure to work with current playlist. */
 135 int playlist_create_ex(struct playlist_info* playlist,
 136                        const char* dir, const char* file,
 137                        void* index_buffer, int index_buffer_size,
 138                        void* temp_buffer, int temp_buffer_size);
 139 int playlist_set_current(struct playlist_info* playlist);
 140 void playlist_close(struct playlist_info* playlist);
 141 void playlist_sync(struct playlist_info* playlist);
 142 int playlist_insert_track(struct playlist_info* playlist, const char *filename,
 143                           int position, bool queue, bool sync);
 144 int playlist_insert_directory(struct playlist_info* playlist,
 145                               const char *dirname, int position, bool queue,
 146                               bool recurse);
 147 int playlist_insert_playlist(struct playlist_info* playlist, const char *filename,
 148                              int position, bool queue);
 149 void playlist_skip_entry(struct playlist_info *playlist, int steps);
 150 int playlist_delete(struct playlist_info* playlist, int index);
 151 int playlist_move(struct playlist_info* playlist, int index, int new_index);
 152 int playlist_randomise(struct playlist_info* playlist, unsigned int seed,
 153                        bool start_current);
 154 int playlist_sort(struct playlist_info* playlist, bool start_current);
 155 bool playlist_modified(const struct playlist_info* playlist);
 156 int playlist_get_first_index(const struct playlist_info* playlist);
 157 int playlist_get_seed(const struct playlist_info* playlist);
 158 int playlist_amount_ex(const struct playlist_info* playlist);
 159 char *playlist_name(const struct playlist_info* playlist, char *buf,
 160                     int buf_size);
 161 char *playlist_get_name(const struct playlist_info* playlist, char *buf,
 162                         int buf_size);
 163 int playlist_get_track_info(struct playlist_info* playlist, int index,
 164                             struct playlist_track_info* info);
 165 int playlist_save(struct playlist_info* playlist, char *filename);
 166 int playlist_directory_tracksearch(const char* dirname, bool recurse,
 167                                    int (*callback)(char*, void*),
 168                                    void* context);
 169 int playlist_remove_all_tracks(struct playlist_info *playlist);
 170
 171 #endif /* __PLAYLIST_H__ */