]> git.sesse.net Git - ffmpeg/blob - libavcodec/ac3_parser.h
Spelling and puctuation
[ffmpeg] / libavcodec / ac3_parser.h
1 /*
2  * AC3 parser prototypes
3  * Copyright (c) 2003 Fabrice Bellard.
4  * Copyright (c) 2003 Michael Niedermayer.
5  *
6  * This file is part of FFmpeg.
7  *
8  * FFmpeg is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU Lesser General Public
10  * License as published by the Free Software Foundation; either
11  * version 2.1 of the License, or (at your option) any later version.
12  *
13  * FFmpeg is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
16  * Lesser General Public License for more details.
17  *
18  * You should have received a copy of the GNU Lesser General Public
19  * License along with FFmpeg; if not, write to the Free Software
20  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
21  */
22
23 #ifndef FFMPEG_AC3_PARSER_H
24 #define FFMPEG_AC3_PARSER_H
25
26 #include "ac3.h"
27
28 typedef enum {
29     AC3_PARSE_ERROR_SYNC        = -1,
30     AC3_PARSE_ERROR_BSID        = -2,
31     AC3_PARSE_ERROR_SAMPLE_RATE = -3,
32     AC3_PARSE_ERROR_FRAME_SIZE  = -4,
33     AC3_PARSE_ERROR_FRAME_TYPE  = -5,
34 } AC3ParseError;
35
36 /**
37  * Parses AC-3 frame header.
38  * Parses the header up to the lfeon element, which is the first 52 or 54 bits
39  * depending on the audio coding mode.
40  * @param buf[in] Array containing the first 7 bytes of the frame.
41  * @param hdr[out] Pointer to struct where header info is written.
42  * @return Returns 0 on success, -1 if there is a sync word mismatch,
43  * -2 if the bsid (version) element is invalid, -3 if the fscod (sample rate)
44  * element is invalid, or -4 if the frmsizecod (bit rate) element is invalid.
45  */
46 int ff_ac3_parse_header(const uint8_t buf[7], AC3HeaderInfo *hdr);
47
48 #endif /* FFMPEG_AC3_PARSER_H */