chiark / gitweb /
DisOrder 3.0
[disorder] / lib / queue.h
1 /*
2  * This file is part of DisOrder.
3  * Copyright (C) 2004-2008 Richard Kettlewell
4  *
5  * This program is free software; you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License as published by
7  * the Free Software Foundation; either version 2 of the License, or
8  * (at your option) any later version.
9  *
10  * This program is distributed in the hope that it will be useful, but
11  * WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13  * General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public License
16  * along with this program; if not, write to the Free Software
17  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
18  * USA
19  */
20
21 #ifndef QUEUE_H
22 #define QUEUE_H
23
24 enum playing_state {
25   playing_failed,                       /* failed to play */
26   playing_isscratch,                    /* this is a scratch track */
27   playing_no_player,                    /* couldn't find a player */
28   playing_ok,                           /* played OK */
29   playing_paused,                       /* started but paused */
30   playing_quitting,                     /* interrupt because server quit */
31   playing_random,                       /* unplayed randomly chosen track */
32   playing_scratched,                    /* was scratched */
33   playing_started,                      /* started to play */
34   playing_unplayed                      /* haven't played this track yet */
35 };
36
37 extern const char *playing_states[];
38
39 /* queue entries form a circular doubly-linked list */
40 struct queue_entry {
41   struct queue_entry *next;             /* next entry */
42   struct queue_entry *prev;             /* previous entry */
43   const char *track;                    /* path to track */
44   const char *submitter;                /* name of submitter */
45   time_t when;                          /* time submitted */
46   time_t played;                        /* when played */
47   enum playing_state state;             /* state */
48   long wstat;                           /* wait status */
49   const char *scratched;                /* scratched by */
50   const char *id;                       /* queue entry ID */
51   time_t expected;                      /* expected started time */
52   /* for playing or soon-to-be-played tracks only: */
53   unsigned long type;                   /* type word from plugin */
54   const struct plugin *pl;              /* plugin that's playing this track */
55   void *data;                           /* player data */
56   long sofar;                           /* how much played so far */
57   int prepared;                         /* true when connected to speaker */
58   /* For DISORDER_PLAYER_PAUSES only: */
59   time_t lastpaused, lastresumed;       /* when last paused/resumed, or 0 */
60   long uptopause;                       /* how much played up to last pause */
61   /* For Disobedience */
62   struct queuelike *ql;                 /* owning queue */
63 };
64
65 int queue_unmarshall(struct queue_entry *q, const char *s,
66                      void (*error_handler)(const char *, void *),
67                      void *u);
68 /* unmarshall UTF-8 string @s@ into @q@ */
69
70 int queue_unmarshall_vec(struct queue_entry *q, int nvec, char **vec,
71                      void (*error_handler)(const char *, void *),
72                      void *u);
73 /* unmarshall pre-split string @vec@ into @q@ */
74
75 char *queue_marshall(const struct queue_entry *q);
76 /* marshall @q@ into a UTF-8 string */
77
78 #endif /* QUEUE_H */
79
80 /*
81 Local Variables:
82 c-basic-offset:2
83 comment-column:40
84 fill-column:79
85 End:
86 */