share streaminfo parsing function
[ffmpeg.git] / libavcodec / flac.h
1 /*
2  * FLAC (Free Lossless Audio Codec) decoder/demuxer common functions
3  * Copyright (c) 2008 Justin Ruggles
4  *
5  * This file is part of FFmpeg.
6  *
7  * FFmpeg is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU Lesser General Public
9  * License as published by the Free Software Foundation; either
10  * version 2.1 of the License, or (at your option) any later version.
11  *
12  * FFmpeg is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  * Lesser General Public License for more details.
16  *
17  * You should have received a copy of the GNU Lesser General Public
18  * License along with FFmpeg; if not, write to the Free Software
19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20  */
21
22 /**
23  * @file flac.h
24  * FLAC (Free Lossless Audio Codec) decoder/demuxer common functions
25  */
26
27 #ifndef FFMPEG_FLAC_H
28 #define FFMPEG_FLAC_H
29
30 /**
31  * Data needed from the Streaminfo header for use by the raw FLAC demuxer
32  * and/or the FLAC decoder.
33  */
34 #define FLACSTREAMINFO \
35     int min_blocksize;      /**< minimum block size, in samples          */\
36     int max_blocksize;      /**< maximum block size, in samples          */\
37     int max_framesize;      /**< maximum frame size, in bytes            */\
38     int samplerate;         /**< sample rate                             */\
39     int channels;           /**< number of channels                      */\
40     int bps;                /**< bits-per-sample                         */\
41
42 typedef struct FLACStreaminfo {
43     FLACSTREAMINFO
44 } FLACStreaminfo;
45
46 /**
47  * Parse the Streaminfo metadata block
48  * @param[out] avctx   codec context to set basic stream parameters
49  * @param[out] s       where parsed information is stored
50  * @param[in]  buffer  pointer to start of 34-byte streaminfo data
51  */
52 void ff_flac_parse_streaminfo(AVCodecContext *avctx, struct FLACStreaminfo *s,
53                               const uint8_t *buffer);
54
55 #endif /* FFMPEG_FLAC_H */