72e90bd0c51f390b9d5fcf0143a89707b4a99dc7
[platform/upstream/flac.git] / include / share / grabbag / picture.h
1 /* grabbag - Convenience lib for various routines common to several tools
2  * Copyright (C) 2006,2007,2008,2009  Josh Coalson
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program 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
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License along
15  * with this program; if not, write to the Free Software Foundation, Inc.,
16  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
17  */
18
19 /* This .h cannot be included by itself; #include "share/grabbag.h" instead. */
20
21 #ifndef GRABBAG__PICTURE_H
22 #define GRABBAG__PICTURE_H
23
24 #include "FLAC/metadata.h"
25
26 #ifdef __cplusplus
27 extern "C" {
28 #endif
29
30 /* spec should be of the form "[TYPE]|MIME_TYPE|[DESCRIPTION]|[WIDTHxHEIGHTxDEPTH[/COLORS]]|FILE", e.g.
31  *   "|image/jpeg|||cover.jpg"
32  *   "4|image/jpeg||300x300x24|backcover.jpg"
33  *   "|image/png|description|300x300x24/71|cover.png"
34  *   "-->|image/gif||300x300x24/71|http://blah.blah.blah/cover.gif"
35  *
36  * empty type means default to FLAC__STREAM_METADATA_PICTURE_TYPE_FRONT_COVER
37  * empty resolution spec means to get from the file (cannot get used with "-->" linked images)
38  * spec and error_message must not be NULL
39  */
40 FLAC__StreamMetadata *grabbag__picture_parse_specification(const char *spec, const char **error_message);
41
42 #ifdef __cplusplus
43 }
44 #endif
45
46 #endif