avutil: allow NULL linesize in av_samples_fill_arrays() and av_samples_alloc()
[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 "samplefmt.h"
20
21 #include <stdio.h>
22 #include <stdlib.h>
23 #include <string.h>
24
25 typedef struct SampleFmtInfo {
26     const char *name;
27     int bits;
28     int planar;
29     enum AVSampleFormat altform; ///< planar<->packed alternative form
30 } SampleFmtInfo;
31
32 /** this table gives more information about formats */
33 static const SampleFmtInfo sample_fmt_info[AV_SAMPLE_FMT_NB] = {
34     [AV_SAMPLE_FMT_U8]   = { .name =   "u8", .bits =  8, .planar = 0, .altform = AV_SAMPLE_FMT_U8P  },
35     [AV_SAMPLE_FMT_S16]  = { .name =  "s16", .bits = 16, .planar = 0, .altform = AV_SAMPLE_FMT_S16P },
36     [AV_SAMPLE_FMT_S32]  = { .name =  "s32", .bits = 32, .planar = 0, .altform = AV_SAMPLE_FMT_S32P },
37     [AV_SAMPLE_FMT_FLT]  = { .name =  "flt", .bits = 32, .planar = 0, .altform = AV_SAMPLE_FMT_FLTP },
38     [AV_SAMPLE_FMT_DBL]  = { .name =  "dbl", .bits = 64, .planar = 0, .altform = AV_SAMPLE_FMT_DBLP },
39     [AV_SAMPLE_FMT_U8P]  = { .name =  "u8p", .bits =  8, .planar = 1, .altform = AV_SAMPLE_FMT_U8   },
40     [AV_SAMPLE_FMT_S16P] = { .name = "s16p", .bits = 16, .planar = 1, .altform = AV_SAMPLE_FMT_S16  },
41     [AV_SAMPLE_FMT_S32P] = { .name = "s32p", .bits = 32, .planar = 1, .altform = AV_SAMPLE_FMT_S32  },
42     [AV_SAMPLE_FMT_FLTP] = { .name = "fltp", .bits = 32, .planar = 1, .altform = AV_SAMPLE_FMT_FLT  },
43     [AV_SAMPLE_FMT_DBLP] = { .name = "dblp", .bits = 64, .planar = 1, .altform = AV_SAMPLE_FMT_DBL  },
44 };
45
46 const char *av_get_sample_fmt_name(enum AVSampleFormat sample_fmt)
47 {
48     if (sample_fmt < 0 || sample_fmt >= AV_SAMPLE_FMT_NB)
49         return NULL;
50     return sample_fmt_info[sample_fmt].name;
51 }
52
53 enum AVSampleFormat av_get_sample_fmt(const char *name)
54 {
55     int i;
56
57     for (i = 0; i < AV_SAMPLE_FMT_NB; i++)
58         if (!strcmp(sample_fmt_info[i].name, name))
59             return i;
60     return AV_SAMPLE_FMT_NONE;
61 }
62
63 enum AVSampleFormat av_get_packed_sample_fmt(enum AVSampleFormat sample_fmt)
64 {
65     if (sample_fmt < 0 || sample_fmt >= AV_SAMPLE_FMT_NB)
66         return AV_SAMPLE_FMT_NONE;
67     if (sample_fmt_info[sample_fmt].planar)
68         return sample_fmt_info[sample_fmt].altform;
69     return sample_fmt;
70 }
71
72 enum AVSampleFormat av_get_planar_sample_fmt(enum AVSampleFormat sample_fmt)
73 {
74     if (sample_fmt < 0 || sample_fmt >= AV_SAMPLE_FMT_NB)
75         return AV_SAMPLE_FMT_NONE;
76     if (sample_fmt_info[sample_fmt].planar)
77         return sample_fmt;
78     return sample_fmt_info[sample_fmt].altform;
79 }
80
81 char *av_get_sample_fmt_string (char *buf, int buf_size, enum AVSampleFormat sample_fmt)
82 {
83     /* print header */
84     if (sample_fmt < 0)
85         snprintf(buf, buf_size, "name  " " depth");
86     else if (sample_fmt < AV_SAMPLE_FMT_NB) {
87         SampleFmtInfo info = sample_fmt_info[sample_fmt];
88         snprintf (buf, buf_size, "%-6s" "   %2d ", info.name, info.bits);
89     }
90
91     return buf;
92 }
93
94 int av_get_bytes_per_sample(enum AVSampleFormat sample_fmt)
95 {
96      return sample_fmt < 0 || sample_fmt >= AV_SAMPLE_FMT_NB ?
97         0 : sample_fmt_info[sample_fmt].bits >> 3;
98 }
99
100 #if FF_API_GET_BITS_PER_SAMPLE_FMT
101 int av_get_bits_per_sample_fmt(enum AVSampleFormat sample_fmt)
102 {
103     return sample_fmt < 0 || sample_fmt >= AV_SAMPLE_FMT_NB ?
104         0 : sample_fmt_info[sample_fmt].bits;
105 }
106 #endif
107
108 int av_sample_fmt_is_planar(enum AVSampleFormat sample_fmt)
109 {
110      if (sample_fmt < 0 || sample_fmt >= AV_SAMPLE_FMT_NB)
111          return 0;
112      return sample_fmt_info[sample_fmt].planar;
113 }
114
115 int av_samples_get_buffer_size(int *linesize, int nb_channels, int nb_samples,
116                                enum AVSampleFormat sample_fmt, int align)
117 {
118     int line_size;
119     int sample_size = av_get_bytes_per_sample(sample_fmt);
120     int planar      = av_sample_fmt_is_planar(sample_fmt);
121
122     /* validate parameter ranges */
123     if (!sample_size || nb_samples <= 0 || nb_channels <= 0)
124         return AVERROR(EINVAL);
125
126     /* check for integer overflow */
127     if (nb_channels > INT_MAX / align ||
128         (int64_t)nb_channels * nb_samples > (INT_MAX - (align * nb_channels)) / sample_size)
129         return AVERROR(EINVAL);
130
131     line_size = planar ? FFALIGN(nb_samples * sample_size,               align) :
132                          FFALIGN(nb_samples * sample_size * nb_channels, align);
133     if (linesize)
134         *linesize = line_size;
135
136     return planar ? line_size * nb_channels : line_size;
137 }
138
139 int av_samples_fill_arrays(uint8_t **audio_data, int *linesize,
140                            uint8_t *buf, int nb_channels, int nb_samples,
141                            enum AVSampleFormat sample_fmt, int align)
142 {
143     int ch, planar, buf_size, line_size;
144
145     planar   = av_sample_fmt_is_planar(sample_fmt);
146     buf_size = av_samples_get_buffer_size(&line_size, nb_channels, nb_samples,
147                                           sample_fmt, align);
148     if (buf_size < 0)
149         return buf_size;
150
151     audio_data[0] = buf;
152     for (ch = 1; planar && ch < nb_channels; ch++)
153         audio_data[ch] = audio_data[ch-1] + line_size;
154
155     if (linesize)
156         *linesize = line_size;
157
158     return 0;
159 }
160
161 int av_samples_alloc(uint8_t **audio_data, int *linesize, int nb_channels,
162                      int nb_samples, enum AVSampleFormat sample_fmt, int align)
163 {
164     uint8_t *buf;
165     int size = av_samples_get_buffer_size(NULL, nb_channels, nb_samples,
166                                           sample_fmt, align);
167     if (size < 0)
168         return size;
169
170     buf = av_mallocz(size);
171     if (!buf)
172         return AVERROR(ENOMEM);
173
174     size = av_samples_fill_arrays(audio_data, linesize, buf, nb_channels,
175                                   nb_samples, sample_fmt, align);
176     if (size < 0) {
177         av_free(buf);
178         return size;
179     }
180     return 0;
181 }