doxygen: replace @sa tag by the more readable but equivalent @see
[libav.git] / libavformat / soxdec.c
CommitLineData
cbfe5bee
DV
1/*
2 * SoX native format demuxer
3 * Copyright (c) 2009 Daniel Verkamp <daniel@drv.nu>
4 *
5 * Based on libSoX sox-fmt.c
6 * Copyright (c) 2008 robs@users.sourceforge.net
7 *
2912e87a 8 * This file is part of Libav.
cbfe5bee 9 *
2912e87a 10 * Libav is free software; you can redistribute it and/or
cbfe5bee
DV
11 * modify it under the terms of the GNU Lesser General Public
12 * License as published by the Free Software Foundation; either
13 * version 2.1 of the License, or (at your option) any later version.
14 *
2912e87a 15 * Libav is distributed in the hope that it will be useful,
cbfe5bee
DV
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18 * Lesser General Public License for more details.
19 *
20 * You should have received a copy of the GNU Lesser General Public
2912e87a 21 * License along with Libav; if not, write to the Free Software
cbfe5bee
DV
22 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
23 */
24
25/**
ba87f080 26 * @file
f6f95d4e 27 * SoX native format demuxer
cbfe5bee 28 * @author Daniel Verkamp
bee6d2fd 29 * @see http://wiki.multimedia.cx/index.php?title=SoX_native_intermediate_format
cbfe5bee
DV
30 */
31
32#include "libavutil/intreadwrite.h"
ee8aecd2 33#include "libavutil/intfloat_readwrite.h"
d2d67e42 34#include "libavutil/dict.h"
cbfe5bee 35#include "avformat.h"
e94204df 36#include "pcm.h"
cbfe5bee
DV
37#include "sox.h"
38
39static int sox_probe(AVProbeData *p)
40{
41 if (AV_RL32(p->buf) == SOX_TAG || AV_RB32(p->buf) == SOX_TAG)
42 return AVPROBE_SCORE_MAX;
43 return 0;
44}
45
46static int sox_read_header(AVFormatContext *s,
47 AVFormatParameters *ap)
48{
ae628ec1 49 AVIOContext *pb = s->pb;
cbfe5bee
DV
50 unsigned header_size, comment_size;
51 double sample_rate, sample_rate_frac;
52 AVStream *st;
53
54 st = av_new_stream(s, 0);
55 if (!st)
56 return AVERROR(ENOMEM);
57
72415b2a 58 st->codec->codec_type = AVMEDIA_TYPE_AUDIO;
cbfe5bee 59
b7effd4e 60 if (avio_rl32(pb) == SOX_TAG) {
cbfe5bee 61 st->codec->codec_id = CODEC_ID_PCM_S32LE;
b7effd4e 62 header_size = avio_rl32(pb);
45a8a02a 63 avio_skip(pb, 8); /* sample count */
b7effd4e
AK
64 sample_rate = av_int2dbl(avio_rl64(pb));
65 st->codec->channels = avio_rl32(pb);
66 comment_size = avio_rl32(pb);
cbfe5bee
DV
67 } else {
68 st->codec->codec_id = CODEC_ID_PCM_S32BE;
b7effd4e 69 header_size = avio_rb32(pb);
45a8a02a 70 avio_skip(pb, 8); /* sample count */
b7effd4e
AK
71 sample_rate = av_int2dbl(avio_rb64(pb));
72 st->codec->channels = avio_rb32(pb);
73 comment_size = avio_rb32(pb);
cbfe5bee
DV
74 }
75
76 if (comment_size > 0xFFFFFFFFU - SOX_FIXED_HDR - 4U) {
77 av_log(s, AV_LOG_ERROR, "invalid comment size (%u)\n", comment_size);
78 return -1;
79 }
80
81 if (sample_rate <= 0 || sample_rate > INT_MAX) {
82 av_log(s, AV_LOG_ERROR, "invalid sample rate (%f)\n", sample_rate);
83 return -1;
84 }
85
86 sample_rate_frac = sample_rate - floor(sample_rate);
87 if (sample_rate_frac)
88 av_log(s, AV_LOG_WARNING,
89 "truncating fractional part of sample rate (%f)\n",
90 sample_rate_frac);
91
92 if ((header_size + 4) & 7 || header_size < SOX_FIXED_HDR + comment_size
93 || st->codec->channels > 65535) /* Reserve top 16 bits */ {
94 av_log(s, AV_LOG_ERROR, "invalid header\n");
95 return -1;
96 }
97
12ad6671
MN
98 if (comment_size && comment_size < UINT_MAX) {
99 char *comment = av_malloc(comment_size+1);
b7effd4e 100 if (avio_read(pb, comment, comment_size) != comment_size) {
cbfe5bee 101 av_freep(&comment);
5ae092ee 102 return AVERROR(EIO);
cbfe5bee 103 }
12ad6671
MN
104 comment[comment_size] = 0;
105
d2d67e42
AK
106 av_dict_set(&s->metadata, "comment", comment,
107 AV_DICT_DONT_STRDUP_VAL);
cbfe5bee
DV
108 }
109
45a8a02a 110 avio_skip(pb, header_size - SOX_FIXED_HDR - comment_size);
cbfe5bee
DV
111
112 st->codec->sample_rate = sample_rate;
cbfe5bee
DV
113 st->codec->bits_per_coded_sample = 32;
114 st->codec->bit_rate = st->codec->sample_rate *
115 st->codec->bits_per_coded_sample *
116 st->codec->channels;
5a1e202b
PR
117 st->codec->block_align = st->codec->bits_per_coded_sample *
118 st->codec->channels / 8;
cbfe5bee
DV
119
120 av_set_pts_info(st, 64, 1, st->codec->sample_rate);
121
122 return 0;
123}
124
5a1e202b 125#define SOX_SAMPLES 1024
cbfe5bee
DV
126
127static int sox_read_packet(AVFormatContext *s,
128 AVPacket *pkt)
129{
5a1e202b 130 int ret, size;
cbfe5bee 131
66e5b1df 132 if (s->pb->eof_reached)
cbfe5bee
DV
133 return AVERROR_EOF;
134
5a1e202b
PR
135 size = SOX_SAMPLES*s->streams[0]->codec->block_align;
136 ret = av_get_packet(s->pb, pkt, size);
cbfe5bee
DV
137 if (ret < 0)
138 return AVERROR(EIO);
139 pkt->stream_index = 0;
140 pkt->size = ret;
141
142 return 0;
143}
144
c6610a21 145AVInputFormat ff_sox_demuxer = {
cbfe5bee
DV
146 "sox",
147 NULL_IF_CONFIG_SMALL("SoX native format"),
148 0,
149 sox_probe,
150 sox_read_header,
151 sox_read_packet,
152 NULL,
153 pcm_read_seek,
154};