avopt: Explicitly store rational option defaults in .dbl
[ffmpeg.git] / libavutil / samplefmt.c
1 /*
2  * This file is part of Libav.
3  *
4  * Libav is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU Lesser General Public
6  * License as published by the Free Software Foundation; either
7  * version 2.1 of the License, or (at your option) any later version.
8  *
9  * Libav is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12  * Lesser General Public License for more details.
13  *
14  * You should have received a copy of the GNU Lesser General Public
15  * License along with Libav; if not, write to the Free Software
16  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17  */
18
19 #include "common.h"
20 #include "samplefmt.h"
21
22 #include <stdio.h>
23 #include <stdlib.h>
24 #include <string.h>
25
26 typedef struct SampleFmtInfo {
27     const char *name;
28     int bits;
29     int planar;
30     enum AVSampleFormat altform; ///< planar<->packed alternative form
31 } SampleFmtInfo;
32
33 /** this table gives more information about formats */
34 static const SampleFmtInfo sample_fmt_info[AV_SAMPLE_FMT_NB] = {
35     [AV_SAMPLE_FMT_U8]   = { .name =   "u8", .bits =  8, .planar = 0, .altform = AV_SAMPLE_FMT_U8P  },
36     [AV_SAMPLE_FMT_S16]  = { .name =  "s16", .bits = 16, .planar = 0, .altform = AV_SAMPLE_FMT_S16P },
37     [AV_SAMPLE_FMT_S32]  = { .name =  "s32", .bits = 32, .planar = 0, .altform = AV_SAMPLE_FMT_S32P },
38     [AV_SAMPLE_FMT_FLT]  = { .name =  "flt", .bits = 32, .planar = 0, .altform = AV_SAMPLE_FMT_FLTP },
39     [AV_SAMPLE_FMT_DBL]  = { .name =  "dbl", .bits = 64, .planar = 0, .altform = AV_SAMPLE_FMT_DBLP },
40     [AV_SAMPLE_FMT_U8P]  = { .name =  "u8p", .bits =  8, .planar = 1, .altform = AV_SAMPLE_FMT_U8   },
41     [AV_SAMPLE_FMT_S16P] = { .name = "s16p", .bits = 16, .planar = 1, .altform = AV_SAMPLE_FMT_S16  },
42     [AV_SAMPLE_FMT_S32P] = { .name = "s32p", .bits = 32, .planar = 1, .altform = AV_SAMPLE_FMT_S32  },
43     [AV_SAMPLE_FMT_FLTP] = { .name = "fltp", .bits = 32, .planar = 1, .altform = AV_SAMPLE_FMT_FLT  },
44     [AV_SAMPLE_FMT_DBLP] = { .name = "dblp", .bits = 64, .planar = 1, .altform = AV_SAMPLE_FMT_DBL  },
45 };
46
47 const char *av_get_sample_fmt_name(enum AVSampleFormat sample_fmt)
48 {
49     if (sample_fmt < 0 || sample_fmt >= AV_SAMPLE_FMT_NB)
50         return NULL;
51     return sample_fmt_info[sample_fmt].name;
52 }
53
54 enum AVSampleFormat av_get_sample_fmt(const char *name)
55 {
56     int i;
57
58     for (i = 0; i < AV_SAMPLE_FMT_NB; i++)
59         if (!strcmp(sample_fmt_info[i].name, name))
60             return i;
61     return AV_SAMPLE_FMT_NONE;
62 }
63
64 enum AVSampleFormat av_get_packed_sample_fmt(enum AVSampleFormat sample_fmt)
65 {
66     if (sample_fmt < 0 || sample_fmt >= AV_SAMPLE_FMT_NB)
67         return AV_SAMPLE_FMT_NONE;
68     if (sample_fmt_info[sample_fmt].planar)
69         return sample_fmt_info[sample_fmt].altform;
70     return sample_fmt;
71 }
72
73 enum AVSampleFormat av_get_planar_sample_fmt(enum AVSampleFormat sample_fmt)
74 {
75     if (sample_fmt < 0 || sample_fmt >= AV_SAMPLE_FMT_NB)
76         return AV_SAMPLE_FMT_NONE;
77     if (sample_fmt_info[sample_fmt].planar)
78         return sample_fmt;
79     return sample_fmt_info[sample_fmt].altform;
80 }
81
82 char *av_get_sample_fmt_string (char *buf, int buf_size, enum AVSampleFormat sample_fmt)
83 {
84     /* print header */
85     if (sample_fmt < 0)
86         snprintf(buf, buf_size, "name  " " depth");
87     else if (sample_fmt < AV_SAMPLE_FMT_NB) {
88         SampleFmtInfo info = sample_fmt_info[sample_fmt];
89         snprintf (buf, buf_size, "%-6s" "   %2d ", info.name, info.bits);
90     }
91
92     return buf;
93 }
94
95 int av_get_bytes_per_sample(enum AVSampleFormat sample_fmt)
96 {
97      return sample_fmt < 0 || sample_fmt >= AV_SAMPLE_FMT_NB ?
98         0 : sample_fmt_info[sample_fmt].bits >> 3;
99 }
100
101 #if FF_API_GET_BITS_PER_SAMPLE_FMT
102 int av_get_bits_per_sample_fmt(enum AVSampleFormat sample_fmt)
103 {
104     return sample_fmt < 0 || sample_fmt >= AV_SAMPLE_FMT_NB ?
105         0 : sample_fmt_info[sample_fmt].bits;
106 }
107 #endif
108
109 int av_sample_fmt_is_planar(enum AVSampleFormat sample_fmt)
110 {
111      if (sample_fmt < 0 || sample_fmt >= AV_SAMPLE_FMT_NB)
112          return 0;
113      return sample_fmt_info[sample_fmt].planar;
114 }
115
116 int av_samples_get_buffer_size(int *linesize, int nb_channels, int nb_samples,
117                                enum AVSampleFormat sample_fmt, int align)
118 {
119     int line_size;
120     int sample_size = av_get_bytes_per_sample(sample_fmt);
121     int planar      = av_sample_fmt_is_planar(sample_fmt);
122
123     /* validate parameter ranges */
124     if (!sample_size || nb_samples <= 0 || nb_channels <= 0)
125         return AVERROR(EINVAL);
126
127     /* auto-select alignment if not specified */
128     if (!align) {
129         align = 1;
130         nb_samples = FFALIGN(nb_samples, 32);
131     }
132
133     /* check for integer overflow */
134     if (nb_channels > INT_MAX / align ||
135         (int64_t)nb_channels * nb_samples > (INT_MAX - (align * nb_channels)) / sample_size)
136         return AVERROR(EINVAL);
137
138     line_size = planar ? FFALIGN(nb_samples * sample_size,               align) :
139                          FFALIGN(nb_samples * sample_size * nb_channels, align);
140     if (linesize)
141         *linesize = line_size;
142
143     return planar ? line_size * nb_channels : line_size;
144 }
145
146 int av_samples_fill_arrays(uint8_t **audio_data, int *linesize,
147                            const uint8_t *buf, int nb_channels, int nb_samples,
148                            enum AVSampleFormat sample_fmt, int align)
149 {
150     int ch, planar, buf_size, line_size;
151
152     planar   = av_sample_fmt_is_planar(sample_fmt);
153     buf_size = av_samples_get_buffer_size(&line_size, nb_channels, nb_samples,
154                                           sample_fmt, align);
155     if (buf_size < 0)
156         return buf_size;
157
158     audio_data[0] = buf;
159     for (ch = 1; planar && ch < nb_channels; ch++)
160         audio_data[ch] = audio_data[ch-1] + line_size;
161
162     if (linesize)
163         *linesize = line_size;
164
165     return 0;
166 }
167
168 int av_samples_alloc(uint8_t **audio_data, int *linesize, int nb_channels,
169                      int nb_samples, enum AVSampleFormat sample_fmt, int align)
170 {
171     uint8_t *buf;
172     int size = av_samples_get_buffer_size(NULL, nb_channels, nb_samples,
173                                           sample_fmt, align);
174     if (size < 0)
175         return size;
176
177     buf = av_mallocz(size);
178     if (!buf)
179         return AVERROR(ENOMEM);
180
181     size = av_samples_fill_arrays(audio_data, linesize, buf, nb_channels,
182                                   nb_samples, sample_fmt, align);
183     if (size < 0) {
184         av_free(buf);
185         return size;
186     }
187     return 0;
188 }
189
190 int av_samples_copy(uint8_t **dst, uint8_t * const *src, int dst_offset,
191                     int src_offset, int nb_samples, int nb_channels,
192                     enum AVSampleFormat sample_fmt)
193 {
194     int planar      = av_sample_fmt_is_planar(sample_fmt);
195     int planes      = planar ? nb_channels : 1;
196     int block_align = av_get_bytes_per_sample(sample_fmt) * (planar ? 1 : nb_channels);
197     int data_size   = nb_samples * block_align;
198     int i;
199
200     dst_offset *= block_align;
201     src_offset *= block_align;
202
203     for (i = 0; i < planes; i++)
204         memcpy(dst[i] + dst_offset, src[i] + src_offset, data_size);
205
206     return 0;
207 }
208
209 int av_samples_set_silence(uint8_t **audio_data, int offset, int nb_samples,
210                            int nb_channels, enum AVSampleFormat sample_fmt)
211 {
212     int planar      = av_sample_fmt_is_planar(sample_fmt);
213     int planes      = planar ? nb_channels : 1;
214     int block_align = av_get_bytes_per_sample(sample_fmt) * (planar ? 1 : nb_channels);
215     int data_size   = nb_samples * block_align;
216     int fill_char   = (sample_fmt == AV_SAMPLE_FMT_U8 ||
217                      sample_fmt == AV_SAMPLE_FMT_U8P) ? 0x80 : 0x00;
218     int i;
219
220     offset *= block_align;
221
222     for (i = 0; i < planes; i++)
223         memset(audio_data[i] + offset, fill_char, data_size);
224
225     return 0;
226 }