doc/examples/decode_audio: print message about how to play the output file
[ffmpeg.git] / doc / examples / decode_audio.c
1 /*
2  * Copyright (c) 2001 Fabrice Bellard
3  *
4  * Permission is hereby granted, free of charge, to any person obtaining a copy
5  * of this software and associated documentation files (the "Software"), to deal
6  * in the Software without restriction, including without limitation the rights
7  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8  * copies of the Software, and to permit persons to whom the Software is
9  * furnished to do so, subject to the following conditions:
10  *
11  * The above copyright notice and this permission notice shall be included in
12  * all copies or substantial portions of the Software.
13  *
14  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
17  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
20  * THE SOFTWARE.
21  */
22
23 /**
24  * @file
25  * audio decoding with libavcodec API example
26  *
27  * @example decode_audio.c
28  */
29
30 #include <stdio.h>
31 #include <stdlib.h>
32 #include <string.h>
33
34 #include <libavutil/frame.h>
35 #include <libavutil/mem.h>
36
37 #include <libavcodec/avcodec.h>
38
39 #define AUDIO_INBUF_SIZE 20480
40 #define AUDIO_REFILL_THRESH 4096
41
42 static int get_format_from_sample_fmt(const char **fmt,
43                                       enum AVSampleFormat sample_fmt)
44 {
45     int i;
46     struct sample_fmt_entry {
47         enum AVSampleFormat sample_fmt; const char *fmt_be, *fmt_le;
48     } sample_fmt_entries[] = {
49         { AV_SAMPLE_FMT_U8,  "u8",    "u8"    },
50         { AV_SAMPLE_FMT_S16, "s16be", "s16le" },
51         { AV_SAMPLE_FMT_S32, "s32be", "s32le" },
52         { AV_SAMPLE_FMT_FLT, "f32be", "f32le" },
53         { AV_SAMPLE_FMT_DBL, "f64be", "f64le" },
54     };
55     *fmt = NULL;
56
57     for (i = 0; i < FF_ARRAY_ELEMS(sample_fmt_entries); i++) {
58         struct sample_fmt_entry *entry = &sample_fmt_entries[i];
59         if (sample_fmt == entry->sample_fmt) {
60             *fmt = AV_NE(entry->fmt_be, entry->fmt_le);
61             return 0;
62         }
63     }
64
65     fprintf(stderr,
66             "sample format %s is not supported as output format\n",
67             av_get_sample_fmt_name(sample_fmt));
68     return -1;
69 }
70
71 static void decode(AVCodecContext *dec_ctx, AVPacket *pkt, AVFrame *frame,
72                    FILE *outfile)
73 {
74     int i, ch;
75     int ret, data_size;
76
77     /* send the packet with the compressed data to the decoder */
78     ret = avcodec_send_packet(dec_ctx, pkt);
79     if (ret < 0) {
80         fprintf(stderr, "Error submitting the packet to the decoder\n");
81         exit(1);
82     }
83
84     /* read all the output frames (in general there may be any number of them */
85     while (ret >= 0) {
86         ret = avcodec_receive_frame(dec_ctx, frame);
87         if (ret == AVERROR(EAGAIN) || ret == AVERROR_EOF)
88             return;
89         else if (ret < 0) {
90             fprintf(stderr, "Error during decoding\n");
91             exit(1);
92         }
93         data_size = av_get_bytes_per_sample(dec_ctx->sample_fmt);
94         if (data_size < 0) {
95             /* This should not occur, checking just for paranoia */
96             fprintf(stderr, "Failed to calculate data size\n");
97             exit(1);
98         }
99         for (i = 0; i < frame->nb_samples; i++)
100             for (ch = 0; ch < dec_ctx->channels; ch++)
101                 fwrite(frame->data[ch] + data_size*i, 1, data_size, outfile);
102     }
103 }
104
105 int main(int argc, char **argv)
106 {
107     const char *outfilename, *filename;
108     const AVCodec *codec;
109     AVCodecContext *c= NULL;
110     AVCodecParserContext *parser = NULL;
111     int len, ret;
112     FILE *f, *outfile;
113     uint8_t inbuf[AUDIO_INBUF_SIZE + AV_INPUT_BUFFER_PADDING_SIZE];
114     uint8_t *data;
115     size_t   data_size;
116     AVPacket *pkt;
117     AVFrame *decoded_frame = NULL;
118
119     if (argc <= 2) {
120         fprintf(stderr, "Usage: %s <input file> <output file>\n", argv[0]);
121         exit(0);
122     }
123     filename    = argv[1];
124     outfilename = argv[2];
125
126     pkt = av_packet_alloc();
127
128     /* find the MPEG audio decoder */
129     codec = avcodec_find_decoder(AV_CODEC_ID_MP2);
130     if (!codec) {
131         fprintf(stderr, "Codec not found\n");
132         exit(1);
133     }
134
135     parser = av_parser_init(codec->id);
136     if (!parser) {
137         fprintf(stderr, "Parser not found\n");
138         exit(1);
139     }
140
141     c = avcodec_alloc_context3(codec);
142     if (!c) {
143         fprintf(stderr, "Could not allocate audio codec context\n");
144         exit(1);
145     }
146
147     /* open it */
148     if (avcodec_open2(c, codec, NULL) < 0) {
149         fprintf(stderr, "Could not open codec\n");
150         exit(1);
151     }
152
153     f = fopen(filename, "rb");
154     if (!f) {
155         fprintf(stderr, "Could not open %s\n", filename);
156         exit(1);
157     }
158     outfile = fopen(outfilename, "wb");
159     if (!outfile) {
160         av_free(c);
161         exit(1);
162     }
163
164     /* decode until eof */
165     data      = inbuf;
166     data_size = fread(inbuf, 1, AUDIO_INBUF_SIZE, f);
167
168     while (data_size > 0) {
169         if (!decoded_frame) {
170             if (!(decoded_frame = av_frame_alloc())) {
171                 fprintf(stderr, "Could not allocate audio frame\n");
172                 exit(1);
173             }
174         }
175
176         ret = av_parser_parse2(parser, c, &pkt->data, &pkt->size,
177                                data, data_size,
178                                AV_NOPTS_VALUE, AV_NOPTS_VALUE, 0);
179         if (ret < 0) {
180             fprintf(stderr, "Error while parsing\n");
181             exit(1);
182         }
183         data      += ret;
184         data_size -= ret;
185
186         if (pkt->size)
187             decode(c, pkt, decoded_frame, outfile);
188
189         if (data_size < AUDIO_REFILL_THRESH) {
190             memmove(inbuf, data, data_size);
191             data = inbuf;
192             len = fread(data + data_size, 1,
193                         AUDIO_INBUF_SIZE - data_size, f);
194             if (len > 0)
195                 data_size += len;
196         }
197     }
198
199     /* flush the decoder */
200     pkt->data = NULL;
201     pkt->size = 0;
202     decode(c, pkt, decoded_frame, outfile);
203
204     /* print output pcm infomations, because there have no metadata of pcm */
205     enum AVSampleFormat sfmt = c->sample_fmt;
206     int n_channels = 0;
207     const char *fmt;
208
209     if (av_sample_fmt_is_planar(sfmt)) {
210         const char *packed = av_get_sample_fmt_name(sfmt);
211         printf("Warning: the sample format the decoder produced is planar "
212                "(%s). This example will output the first channel only.\n",
213                packed ? packed : "?");
214         sfmt = av_get_packed_sample_fmt(sfmt);
215     }
216
217     n_channels = c->channels;
218     if ((ret = get_format_from_sample_fmt(&fmt, sfmt)) < 0)
219         goto end;
220
221     printf("Play the output audio file with the command:\n"
222            "ffplay -f %s -ac %d -ar %d %s\n",
223            fmt, n_channels, c->sample_rate,
224            outfilename);
225 end:
226     fclose(outfile);
227     fclose(f);
228
229     avcodec_free_context(&c);
230     av_parser_close(parser);
231     av_frame_free(&decoded_frame);
232     av_packet_free(&pkt);
233
234     return 0;
235 }