include/uapi/sound/compress_offload.h

   1 /*
   2  *  compress_offload.h - compress offload header definations
   3  *
   4  *  Copyright (C) 2011 Intel Corporation
   5  *  Authors:    Vinod Koul <vinod.koul@linux.intel.com>
   6  *              Pierre-Louis Bossart <pierre-louis.bossart@linux.intel.com>
   7  *  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
   8  *
   9  *  This program is free software; you can redistribute it and/or modify
  10  *  it under the terms of the GNU General Public License as published by
  11  *  the Free Software Foundation; version 2 of the License.
  12  *
  13  *  This program is distributed in the hope that it will be useful, but
  14  *  WITHOUT ANY WARRANTY; without even the implied warranty of
  15  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16  *  General Public License for more details.
  17  *
  18  *  You should have received a copy of the GNU General Public License along
  19  *  with this program; if not, write to the Free Software Foundation, Inc.,
  20  *  59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
  21  *
  22  * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  23  *
  24  */
  25 #ifndef __COMPRESS_OFFLOAD_H
  26 #define __COMPRESS_OFFLOAD_H
  27
  28 #include <linux/types.h>
  29 #include <sound/asound.h>
  30 #include <sound/compress_params.h>
  31
  32
  33 #define SNDRV_COMPRESS_VERSION SNDRV_PROTOCOL_VERSION(0, 1, 1)
  34 /**
  35  * struct snd_compressed_buffer: compressed buffer
  36  * @fragment_size: size of buffer fragment in bytes
  37  * @fragments: number of such fragments
  38  */
  39 struct snd_compressed_buffer {
  40         __u32 fragment_size;
  41         __u32 fragments;
  42 };
  43
  44 /**
  45  * struct snd_compr_params: compressed stream params
  46  * @buffer: buffer description
  47  * @codec: codec parameters
  48  * @no_wake_mode: dont wake on fragment elapsed
  49  */
  50 struct snd_compr_params {
  51         struct snd_compressed_buffer buffer;
  52         struct snd_codec codec;
  53         __u8 no_wake_mode;
  54 };
  55
  56 /**
  57  * struct snd_compr_tstamp: timestamp descriptor
  58  * @byte_offset: Byte offset in ring buffer to DSP
  59  * @copied_total: Total number of bytes copied from/to ring buffer to/by DSP
  60  * @pcm_frames: Frames decoded or encoded by DSP. This field will evolve by
  61  *      large steps and should only be used to monitor encoding/decoding
  62  *      progress. It shall not be used for timing estimates.
  63  * @pcm_io_frames: Frames rendered or received by DSP into a mixer or an audio
  64  * output/input. This field should be used for A/V sync or time estimates.
  65  * @sampling_rate: sampling rate of audio
  66  */
  67 struct snd_compr_tstamp {
  68         __u32 byte_offset;
  69         __u32 copied_total;
  70         snd_pcm_uframes_t pcm_frames;
  71         snd_pcm_uframes_t pcm_io_frames;
  72         __u32 sampling_rate;
  73 };
  74
  75 /**
  76  * struct snd_compr_avail: avail descriptor
  77  * @avail: Number of bytes available in ring buffer for writing/reading
  78  * @tstamp: timestamp infomation
  79  */
  80 struct snd_compr_avail {
  81         __u64 avail;
  82         struct snd_compr_tstamp tstamp;
  83 };
  84
  85 enum snd_compr_direction {
  86         SND_COMPRESS_PLAYBACK = 0,
  87         SND_COMPRESS_CAPTURE
  88 };
  89
  90 /**
  91  * struct snd_compr_caps: caps descriptor
  92  * @codecs: pointer to array of codecs
  93  * @direction: direction supported. Of type snd_compr_direction
  94  * @min_fragment_size: minimum fragment supported by DSP
  95  * @max_fragment_size: maximum fragment supported by DSP
  96  * @min_fragments: min fragments supported by DSP
  97  * @max_fragments: max fragments supported by DSP
  98  * @num_codecs: number of codecs supported
  99  * @reserved: reserved field
 100  */
 101 struct snd_compr_caps {
 102         __u32 num_codecs;
 103         __u32 direction;
 104         __u32 min_fragment_size;
 105         __u32 max_fragment_size;
 106         __u32 min_fragments;
 107         __u32 max_fragments;
 108         __u32 codecs[MAX_NUM_CODECS];
 109         __u32 reserved[11];
 110 };
 111
 112 /**
 113  * struct snd_compr_codec_caps: query capability of codec
 114  * @codec: codec for which capability is queried
 115  * @num_descriptors: number of codec descriptors
 116  * @descriptor: array of codec capability descriptor
 117  */
 118 struct snd_compr_codec_caps {
 119         __u32 codec;
 120         __u32 num_descriptors;
 121         struct snd_codec_desc descriptor[MAX_NUM_CODEC_DESCRIPTORS];
 122 };
 123
 124 /**
 125  * @SNDRV_COMPRESS_ENCODER_PADDING: no of samples appended by the encoder at the
 126  * end of the track
 127  * @SNDRV_COMPRESS_ENCODER_DELAY: no of samples inserted by the encoder at the
 128  * beginning of the track
 129  */
 130 enum {
 131         SNDRV_COMPRESS_ENCODER_PADDING = 1,
 132         SNDRV_COMPRESS_ENCODER_DELAY = 2,
 133 };
 134
 135 /**
 136  * struct snd_compr_metadata: compressed stream metadata
 137  * @key: key id
 138  * @value: key value
 139  */
 140 struct snd_compr_metadata {
 141          __u32 key;
 142          __u32 value[8];
 143 };
 144
 145 /**
 146  * compress path ioctl definitions
 147  * SNDRV_COMPRESS_GET_CAPS: Query capability of DSP
 148  * SNDRV_COMPRESS_GET_CODEC_CAPS: Query capability of a codec
 149  * SNDRV_COMPRESS_SET_PARAMS: Set codec and stream parameters
 150  * Note: only codec params can be changed runtime and stream params cant be
 151  * SNDRV_COMPRESS_GET_PARAMS: Query codec params
 152  * SNDRV_COMPRESS_TSTAMP: get the current timestamp value
 153  * SNDRV_COMPRESS_AVAIL: get the current buffer avail value.
 154  * This also queries the tstamp properties
 155  * SNDRV_COMPRESS_PAUSE: Pause the running stream
 156  * SNDRV_COMPRESS_RESUME: resume a paused stream
 157  * SNDRV_COMPRESS_START: Start a stream
 158  * SNDRV_COMPRESS_STOP: stop a running stream, discarding ring buffer content
 159  * and the buffers currently with DSP
 160  * SNDRV_COMPRESS_DRAIN: Play till end of buffers and stop after that
 161  * SNDRV_COMPRESS_IOCTL_VERSION: Query the API version
 162  */
 163 #define SNDRV_COMPRESS_IOCTL_VERSION    _IOR('C', 0x00, int)
 164 #define SNDRV_COMPRESS_GET_CAPS         _IOWR('C', 0x10, struct snd_compr_caps)
 165 #define SNDRV_COMPRESS_GET_CODEC_CAPS   _IOWR('C', 0x11,\
 166                                                 struct snd_compr_codec_caps)
 167 #define SNDRV_COMPRESS_SET_PARAMS       _IOW('C', 0x12, struct snd_compr_params)
 168 #define SNDRV_COMPRESS_GET_PARAMS       _IOR('C', 0x13, struct snd_codec)
 169 #define SNDRV_COMPRESS_SET_METADATA     _IOW('C', 0x14,\
 170                                                  struct snd_compr_metadata)
 171 #define SNDRV_COMPRESS_GET_METADATA     _IOWR('C', 0x15,\
 172                                                  struct snd_compr_metadata)
 173 #define SNDRV_COMPRESS_TSTAMP           _IOR('C', 0x20, struct snd_compr_tstamp)
 174 #define SNDRV_COMPRESS_AVAIL            _IOR('C', 0x21, struct snd_compr_avail)
 175 #define SNDRV_COMPRESS_PAUSE            _IO('C', 0x30)
 176 #define SNDRV_COMPRESS_RESUME           _IO('C', 0x31)
 177 #define SNDRV_COMPRESS_START            _IO('C', 0x32)
 178 #define SNDRV_COMPRESS_STOP             _IO('C', 0x33)
 179 #define SNDRV_COMPRESS_DRAIN            _IO('C', 0x34)
 180 #define SNDRV_COMPRESS_NEXT_TRACK       _IO('C', 0x35)
 181 #define SNDRV_COMPRESS_PARTIAL_DRAIN    _IO('C', 0x36)
 182 /*
 183  * TODO
 184  * 1. add mmap support
 185  *
 186  */
 187 #define SND_COMPR_TRIGGER_DRAIN 7 /*FIXME move this to pcm.h */
 188 #define SND_COMPR_TRIGGER_NEXT_TRACK 8
 189 #define SND_COMPR_TRIGGER_PARTIAL_DRAIN 9
 190 #endif