herrie/src/playq_modules.h

   1 /*
   2  * Copyright (c) 2006-2011 Ed Schouten <ed@80386.nl>
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  *
  14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  15  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  17  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  18  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  20  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  21  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  22  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  23  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  24  * SUCH DAMAGE.
  25  */
  26 /**
  27  * @file playq_modules.h
  28  * @brief Custom playlist behaviour routines.
  29  */
  30
  31 struct vfsref;
  32
  33 /**
  34  * @brief Flag whether repeat is turned on by the user.
  35  */
  36 extern int playq_repeat;
  37
  38 /**
  39  * @brief Herrie's routine to fetch the next song from the playlist
  40  *        (always the first song).
  41  */
  42 struct vfsref *playq_party_give(void);
  43 /**
  44  * @brief Herrie's idle indication function.
  45  */
  46 void playq_party_idle(void);
  47 /**
  48  * @brief Herrie's song selection routine (bogus with Herrie, because we
  49  *        always start the first song).
  50  */
  51 int playq_party_select(struct vfsref *vr);
  52 /**
  53  * @brief Herrie's routine to switch to the next function.
  54  */
  55 int playq_party_next(void);
  56 /**
  57  * @brief Herrie's routine to switch to the previous function.
  58  */
  59 int playq_party_prev(void);
  60 /**
  61  * @brief Herrie's notification that a song is about to be deleted.
  62  */
  63 void playq_party_notify_pre_removal(struct vfsref *vr);
  64
  65 /**
  66  * @brief XMMS-like function that retreives the next song from the
  67  *        playlist.
  68  */
  69 struct vfsref *playq_xmms_give(void);
  70 /**
  71  * @brief XMMS-like function to notify that playback is going idle.
  72  */
  73 void playq_xmms_idle(void);
  74 /**
  75  * @brief XMMS-like function to start playback of a specific song.
  76  */
  77 int playq_xmms_select(struct vfsref *vr);
  78 /**
  79  * @brief XMMS-like function that switches playback to the next song.
  80  */
  81 int playq_xmms_next(void);
  82 /**
  83  * @brief XMMS-like function that switches playback to the previous song.
  84  */
  85 int playq_xmms_prev(void);
  86 /**
  87  * @brief XMMS-like notification that a song is about to be deleted.
  88  */
  89 void playq_xmms_notify_pre_removal(struct vfsref *vr);