code.delx.au - pulseaudio/blob - src/pulse/scache.h

   1 #ifndef fooscachehfoo
   2 #define fooscachehfoo
   3
   4 /***
   5   This file is part of PulseAudio.
   6
   7   Copyright 2004-2006 Lennart Poettering
   8   Copyright 2006 Pierre Ossman <ossman@cendio.se> for Cendio AB
   9
  10   PulseAudio is free software; you can redistribute it and/or modify
  11   it under the terms of the GNU Lesser General Public License as published
  12   by the Free Software Foundation; either version 2 of the License,
  13   or (at your option) any later version.
  14
  15   PulseAudio is distributed in the hope that it will be useful, but
  16   WITHOUT ANY WARRANTY; without even the implied warranty of
  17   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  18   General Public License for more details.
  19
  20   You should have received a copy of the GNU Lesser General Public License
  21   along with PulseAudio; if not, write to the Free Software
  22   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
  23   USA.
  24 ***/
  25
  26 #include <sys/types.h>
  27
  28 #include <pulse/context.h>
  29 #include <pulse/stream.h>
  30 #include <pulse/cdecl.h>
  31
  32 /** \page scache Sample Cache
  33  *
  34  * \section overv_sec Overview
  35  *
  36  * The sample cache provides a simple way of overcoming high network latencies
  37  * and reducing bandwidth. Instead of streaming a sound precisely when it
  38  * should be played, it is stored on the server and only the command to start
  39  * playing it needs to be sent.
  40  *
  41  * \section create_sec Creation
  42  *
  43  * To create a sample, the normal stream API is used (see \ref streams). The
  44  * function pa_stream_connect_upload() will make sure the stream is stored as
  45  * a sample on the server.
  46  *
  47  * To complete the upload, pa_stream_finish_upload() is called and the sample
  48  * will receive the same name as the stream. If the upload should be aborted,
  49  * simply call pa_stream_disconnect().
  50  *
  51  * \section play_sec Playing samples
  52  *
  53  * To play back a sample, simply call pa_context_play_sample():
  54  *
  55  * \code
  56  * pa_operation *o;
  57  *
  58  * o = pa_context_play_sample(my_context,
  59  *                            "sample2",       // Name of my sample
  60  *                            NULL,            // Use default sink
  61  *                            PA_VOLUME_NORM,  // Full volume
  62  *                            NULL,            // Don't need a callback
  63  *                            NULL
  64  *                            );
  65  * if (o)
  66  *     pa_operation_unref(o);
  67  * \endcode
  68  *
  69  * \section rem_sec Removing samples
  70  *
  71  * When a sample is no longer needed, it should be removed on the server to
  72  * save resources. The sample is deleted using pa_context_remove_sample().
  73  */
  74
  75 /** \file
  76  * All sample cache related routines */
  77
  78 PA_C_DECL_BEGIN
  79
  80 /** Callback prototype for pa_context_play_sample_with_proplist(). The
  81  * idx value is the index of the sink input object, or
  82  * PA_INVALID_INDEX on failure. \since 0.9.11 */
  83 typedef void (*pa_context_play_sample_cb_t)(pa_context *c, uint32_t idx, void *userdata);
  84
  85 /** Make this stream a sample upload stream */
  86 int pa_stream_connect_upload(pa_stream *s, size_t length);
  87
  88 /** Finish the sample upload, the stream name will become the sample
  89  * name. You cancel a sample upload by issuing
  90  * pa_stream_disconnect() */
  91 int pa_stream_finish_upload(pa_stream *s);
  92
  93 /** Remove a sample from the sample cache. Returns an operation object which may be used to cancel the operation while it is running */
  94 pa_operation* pa_context_remove_sample(pa_context *c, const char *name, pa_context_success_cb_t cb, void *userdata);
  95
  96 /** Play a sample from the sample cache to the specified device. If
  97  * the latter is NULL use the default sink. Returns an operation
  98  * object */
  99 pa_operation* pa_context_play_sample(
 100         pa_context *c               /**< Context */,
 101         const char *name            /**< Name of the sample to play */,
 102         const char *dev             /**< Sink to play this sample on */,
 103         pa_volume_t volume          /**< Volume to play this sample with */ ,
 104         pa_context_success_cb_t cb  /**< Call this function after successfully starting playback, or NULL */,
 105         void *userdata              /**< Userdata to pass to the callback */);
 106
 107 /** Play a sample from the sample cache to the specified device,
 108  * allowing specification of a property list for the playback
 109  * stream. If the latter is NULL use the default sink. Returns an
 110  * operation object. \since 0.9.11 */
 111 pa_operation* pa_context_play_sample_with_proplist(
 112         pa_context *c                   /**< Context */,
 113         const char *name                /**< Name of the sample to play */,
 114         const char *dev                 /**< Sink to play this sample on */,
 115         pa_volume_t volume              /**< Volume to play this sample with */ ,
 116         pa_proplist *proplist           /**< Property list for this sound. The property list of the cached entry will be merged into this property list */,
 117         pa_context_play_sample_cb_t cb  /**< Call this function after successfully starting playback, or NULL */,
 118         void *userdata                  /**< Userdata to pass to the callback */);
 119
 120 PA_C_DECL_END
 121
 122 #endif