1 /* 2 * compress_offload.h - compress offload header definations 3 * 4 * Copyright (C) 2011 Intel Corporation 5 * Authors: Vinod Koul <[email protected]> 6 * Pierre-Louis Bossart <[email protected]> 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, 2) 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 } __attribute__((packed, aligned(4))); 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 } __attribute__((packed, aligned(4))); 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 __u64 copied_total; 70 __u32 pcm_frames; 71 __u32 pcm_io_frames; 72 __u32 sampling_rate; 73 __u64 timestamp; 74 } __attribute__((packed, aligned(4))); 75 76 /** 77 * struct snd_compr_avail - avail descriptor 78 * @avail: Number of bytes available in ring buffer for writing/reading 79 * @tstamp: timestamp information 80 */ 81 struct snd_compr_avail { 82 __u64 avail; 83 struct snd_compr_tstamp tstamp; 84 } __attribute__((packed, aligned(4))); 85 86 enum snd_compr_direction { 87 SND_COMPRESS_PLAYBACK = 0, 88 SND_COMPRESS_CAPTURE 89 }; 90 91 /** 92 * struct snd_compr_caps - caps descriptor 93 * @codecs: pointer to array of codecs 94 * @direction: direction supported. Of type snd_compr_direction 95 * @min_fragment_size: minimum fragment supported by DSP 96 * @max_fragment_size: maximum fragment supported by DSP 97 * @min_fragments: min fragments supported by DSP 98 * @max_fragments: max fragments supported by DSP 99 * @num_codecs: number of codecs supported 100 * @reserved: reserved field 101 */ 102 struct snd_compr_caps { 103 __u32 num_codecs; 104 __u32 direction; 105 __u32 min_fragment_size; 106 __u32 max_fragment_size; 107 __u32 min_fragments; 108 __u32 max_fragments; 109 __u32 codecs[MAX_NUM_CODECS]; 110 __u32 reserved[11]; 111 } __attribute__((packed, aligned(4))); 112 113 /** 114 * struct snd_compr_codec_caps - query capability of codec 115 * @codec: codec for which capability is queried 116 * @num_descriptors: number of codec descriptors 117 * @descriptor: array of codec capability descriptor 118 */ 119 struct snd_compr_codec_caps { 120 __u32 codec; 121 __u32 num_descriptors; 122 struct snd_codec_desc descriptor[MAX_NUM_CODEC_DESCRIPTORS]; 123 } __attribute__((packed, aligned(4))); 124 125 /** 126 * struct snd_compr_audio_info: compressed input audio information 127 * @frame_size: legth of the encoded frame with valid data 128 * @reserved: reserved for furture use 129 */ 130 struct snd_compr_audio_info { 131 __u32 frame_size; 132 __u32 reserved[15]; 133 } __attribute__((packed, aligned(4))); 134 135 #define SNDRV_COMPRESS_RENDER_MODE_AUDIO_MASTER 0 136 #define SNDRV_COMPRESS_RENDER_MODE_STC_MASTER 1 137 138 #define SNDRV_COMPRESS_CLK_REC_MODE_NONE 0 139 #define SNDRV_COMPRESS_CLK_REC_MODE_AUTO 1 140 141 /** 142 * enum sndrv_compress_encoder 143 * @SNDRV_COMPRESS_ENCODER_PADDING: no of samples appended by the encoder at the 144 * end of the track 145 * @SNDRV_COMPRESS_ENCODER_DELAY: no of samples inserted by the encoder at the 146 * beginning of the track 147 * @SNDRV_COMPRESS_PATH_DELAY: dsp path delay in microseconds 148 * @SNDRV_COMPRESS_RENDER_MODE: dsp render mode (audio master or stc) 149 * @SNDRV_COMPRESS_CLK_REC_MODE: clock recovery mode ( none or auto) 150 * @SNDRV_COMPRESS_RENDER_WINDOW: render window 151 * @SNDRV_COMPRESS_START_DELAY: start delay 152 * @SNDRV_COMPRESS_ENABLE_ADJUST_SESSION_CLOCK: enable dsp drift correction 153 * @SNDRV_COMPRESS_ADJUST_SESSION_CLOCK: set drift correction value 154 */ 155 enum sndrv_compress_encoder { 156 SNDRV_COMPRESS_ENCODER_PADDING = 1, 157 SNDRV_COMPRESS_ENCODER_DELAY = 2, 158 SNDRV_COMPRESS_MIN_BLK_SIZE = 3, 159 SNDRV_COMPRESS_MAX_BLK_SIZE = 4, 160 SNDRV_COMPRESS_PATH_DELAY = 5, 161 SNDRV_COMPRESS_RENDER_MODE = 6, 162 SNDRV_COMPRESS_CLK_REC_MODE = 7, 163 SNDRV_COMPRESS_RENDER_WINDOW = 8, 164 SNDRV_COMPRESS_START_DELAY = 9, 165 SNDRV_COMPRESS_ENABLE_ADJUST_SESSION_CLOCK = 10, 166 SNDRV_COMPRESS_ADJUST_SESSION_CLOCK = 11, 167 }; 168 169 #define SNDRV_COMPRESS_PATH_DELAY SNDRV_COMPRESS_PATH_DELAY 170 #define SNDRV_COMPRESS_RENDER_MODE SNDRV_COMPRESS_RENDER_MODE 171 #define SNDRV_COMPRESS_CLK_REC_MODE SNDRV_COMPRESS_CLK_REC_MODE 172 #define SNDRV_COMPRESS_RENDER_WINDOW SNDRV_COMPRESS_RENDER_WINDOW 173 #define SNDRV_COMPRESS_START_DELAY SNDRV_COMPRESS_START_DELAY 174 #define SNDRV_COMPRESS_ENABLE_ADJUST_SESSION_CLOCK \ 175 SNDRV_COMPRESS_ENABLE_ADJUST_SESSION_CLOCK 176 #define SNDRV_COMPRESS_ADJUST_SESSION_CLOCK SNDRV_COMPRESS_ADJUST_SESSION_CLOCK 177 178 /** 179 * struct snd_compr_metadata - compressed stream metadata 180 * @key: key id 181 * @value: key value 182 */ 183 struct snd_compr_metadata { 184 __u32 key; 185 __u32 value[8]; 186 } __attribute__((packed, aligned(4))); 187 188 /** 189 * compress path ioctl definitions 190 * SNDRV_COMPRESS_GET_CAPS: Query capability of DSP 191 * SNDRV_COMPRESS_GET_CODEC_CAPS: Query capability of a codec 192 * SNDRV_COMPRESS_SET_PARAMS: Set codec and stream parameters 193 * Note: only codec params can be changed runtime and stream params cant be 194 * SNDRV_COMPRESS_GET_PARAMS: Query codec params 195 * SNDRV_COMPRESS_TSTAMP: get the current timestamp value 196 * SNDRV_COMPRESS_AVAIL: get the current buffer avail value. 197 * This also queries the tstamp properties 198 * SNDRV_COMPRESS_PAUSE: Pause the running stream 199 * SNDRV_COMPRESS_RESUME: resume a paused stream 200 * SNDRV_COMPRESS_START: Start a stream 201 * SNDRV_COMPRESS_STOP: stop a running stream, discarding ring buffer content 202 * and the buffers currently with DSP 203 * SNDRV_COMPRESS_DRAIN: Play till end of buffers and stop after that 204 * SNDRV_COMPRESS_SET_NEXT_TRACK_PARAM: send codec specific data for the next 205 * track in gapless 206 * SNDRV_COMPRESS_IOCTL_VERSION: Query the API version 207 */ 208 #define SNDRV_COMPRESS_IOCTL_VERSION _IOR('C', 0x00, int) 209 #define SNDRV_COMPRESS_GET_CAPS _IOWR('C', 0x10, struct snd_compr_caps) 210 #define SNDRV_COMPRESS_GET_CODEC_CAPS _IOWR('C', 0x11,\ 211 struct snd_compr_codec_caps) 212 #define SNDRV_COMPRESS_SET_PARAMS _IOW('C', 0x12, struct snd_compr_params) 213 #define SNDRV_COMPRESS_GET_PARAMS _IOR('C', 0x13, struct snd_codec) 214 #define SNDRV_COMPRESS_SET_METADATA _IOW('C', 0x14,\ 215 struct snd_compr_metadata) 216 #define SNDRV_COMPRESS_GET_METADATA _IOWR('C', 0x15,\ 217 struct snd_compr_metadata) 218 #define SNDRV_COMPRESS_TSTAMP _IOR('C', 0x20, struct snd_compr_tstamp) 219 #define SNDRV_COMPRESS_AVAIL _IOR('C', 0x21, struct snd_compr_avail) 220 #define SNDRV_COMPRESS_PAUSE _IO('C', 0x30) 221 #define SNDRV_COMPRESS_RESUME _IO('C', 0x31) 222 #define SNDRV_COMPRESS_START _IO('C', 0x32) 223 #define SNDRV_COMPRESS_STOP _IO('C', 0x33) 224 #define SNDRV_COMPRESS_DRAIN _IO('C', 0x34) 225 #define SNDRV_COMPRESS_NEXT_TRACK _IO('C', 0x35) 226 #define SNDRV_COMPRESS_PARTIAL_DRAIN _IO('C', 0x36) 227 #define SNDRV_COMPRESS_SET_NEXT_TRACK_PARAM\ 228 _IOW('C', 0x80, union snd_codec_options) 229 /* 230 * TODO 231 * 1. add mmap support 232 * 233 */ 234 #define SND_COMPR_TRIGGER_DRAIN 7 /*FIXME move this to pcm.h */ 235 #define SND_COMPR_TRIGGER_NEXT_TRACK 8 236 #define SND_COMPR_TRIGGER_PARTIAL_DRAIN 9 237 #endif 238