annotate src/flac-1.2.1/doc/html/api/structFLAC____StreamMetadata__Picture.html @ 86:98c1576536ae

Bring in flac, ogg, vorbis
author Chris Cannam <cannam@all-day-breakfast.com>
date Tue, 19 Mar 2013 17:37:49 +0000
parents
children
rev   line source
cannam@86 1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
cannam@86 2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
cannam@86 3 <title>FLAC: FLAC__StreamMetadata_Picture Struct Reference</title>
cannam@86 4 <link href="doxygen.css" rel="stylesheet" type="text/css">
cannam@86 5 </head><body>
cannam@86 6 <!-- Generated by Doxygen 1.4.2 -->
cannam@86 7 <div class="qindex"><a class="qindex" href="index.html">Main&nbsp;Page</a> | <a class="qindex" href="modules.html">Modules</a> | <a class="qindex" href="hierarchy.html">Class&nbsp;Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical&nbsp;List</a> | <a class="qindex" href="annotated.html">Class&nbsp;List</a> | <a class="qindex" href="dirs.html">Directories</a> | <a class="qindex" href="files.html">File&nbsp;List</a> | <a class="qindex" href="functions.html">Class&nbsp;Members</a> | <a class="qindex" href="globals.html">File&nbsp;Members</a></div>
cannam@86 8 <h1>FLAC__StreamMetadata_Picture Struct Reference<br>
cannam@86 9 <small>
cannam@86 10 [<a class="el" href="group__flac__format.html">FLAC/format.h: format components</a>]</small>
cannam@86 11 </h1><code>#include &lt;<a class="el" href="format_8h-source.html">format.h</a>&gt;</code>
cannam@86 12 <p>
cannam@86 13 <a href="structFLAC____StreamMetadata__Picture-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
cannam@86 14 FLAC PICTURE structure. (See the <a href="../format.html#metadata_block_picture">format specification</a> for the full description of each field.)
cannam@86 15 <p>
cannam@86 16 <table border="0" cellpadding="0" cellspacing="0">
cannam@86 17 <tr><td></td></tr>
cannam@86 18 <tr><td colspan="2"><br><h2>Public Attributes</h2></td></tr>
cannam@86 19 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__flac__format.html#ga114">FLAC__StreamMetadata_Picture_Type</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structFLAC____StreamMetadata__Picture.html#FLAC____StreamMetadata__Pictureo0">type</a></td></tr>
cannam@86 20
cannam@86 21 <tr><td class="memItemLeft" nowrap align="right" valign="top">char *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structFLAC____StreamMetadata__Picture.html#FLAC____StreamMetadata__Pictureo1">mime_type</a></td></tr>
cannam@86 22
cannam@86 23 <tr><td class="memItemLeft" nowrap align="right" valign="top">FLAC__byte *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structFLAC____StreamMetadata__Picture.html#FLAC____StreamMetadata__Pictureo2">description</a></td></tr>
cannam@86 24
cannam@86 25 <tr><td class="memItemLeft" nowrap align="right" valign="top">FLAC__uint32&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structFLAC____StreamMetadata__Picture.html#FLAC____StreamMetadata__Pictureo3">width</a></td></tr>
cannam@86 26
cannam@86 27 <tr><td class="memItemLeft" nowrap align="right" valign="top">FLAC__uint32&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structFLAC____StreamMetadata__Picture.html#FLAC____StreamMetadata__Pictureo4">height</a></td></tr>
cannam@86 28
cannam@86 29 <tr><td class="memItemLeft" nowrap align="right" valign="top">FLAC__uint32&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structFLAC____StreamMetadata__Picture.html#FLAC____StreamMetadata__Pictureo5">depth</a></td></tr>
cannam@86 30
cannam@86 31 <tr><td class="memItemLeft" nowrap align="right" valign="top">FLAC__uint32&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structFLAC____StreamMetadata__Picture.html#FLAC____StreamMetadata__Pictureo6">colors</a></td></tr>
cannam@86 32
cannam@86 33 <tr><td class="memItemLeft" nowrap align="right" valign="top">FLAC__uint32&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structFLAC____StreamMetadata__Picture.html#FLAC____StreamMetadata__Pictureo7">data_length</a></td></tr>
cannam@86 34
cannam@86 35 <tr><td class="memItemLeft" nowrap align="right" valign="top">FLAC__byte *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structFLAC____StreamMetadata__Picture.html#FLAC____StreamMetadata__Pictureo8">data</a></td></tr>
cannam@86 36
cannam@86 37 </table>
cannam@86 38 <hr><h2>Member Data Documentation</h2>
cannam@86 39 <a class="anchor" name="FLAC____StreamMetadata__Pictureo0" doxytag="FLAC__StreamMetadata_Picture::type"></a><p>
cannam@86 40 <table class="mdTable" cellpadding="2" cellspacing="0">
cannam@86 41 <tr>
cannam@86 42 <td class="mdRow">
cannam@86 43 <table cellpadding="0" cellspacing="0" border="0">
cannam@86 44 <tr>
cannam@86 45 <td class="md" nowrap valign="top"><a class="el" href="group__flac__format.html#ga114">FLAC__StreamMetadata_Picture_Type</a> <a class="el" href="structFLAC____StreamMetadata__Picture.html#FLAC____StreamMetadata__Pictureo0">FLAC__StreamMetadata_Picture::type</a> </td>
cannam@86 46 </tr>
cannam@86 47 </table>
cannam@86 48 </td>
cannam@86 49 </tr>
cannam@86 50 </table>
cannam@86 51 <table cellspacing="5" cellpadding="0" border="0">
cannam@86 52 <tr>
cannam@86 53 <td>
cannam@86 54 &nbsp;
cannam@86 55 </td>
cannam@86 56 <td>
cannam@86 57
cannam@86 58 <p>
cannam@86 59 The kind of picture stored. </td>
cannam@86 60 </tr>
cannam@86 61 </table>
cannam@86 62 <a class="anchor" name="FLAC____StreamMetadata__Pictureo1" doxytag="FLAC__StreamMetadata_Picture::mime_type"></a><p>
cannam@86 63 <table class="mdTable" cellpadding="2" cellspacing="0">
cannam@86 64 <tr>
cannam@86 65 <td class="mdRow">
cannam@86 66 <table cellpadding="0" cellspacing="0" border="0">
cannam@86 67 <tr>
cannam@86 68 <td class="md" nowrap valign="top">char* <a class="el" href="structFLAC____StreamMetadata__Picture.html#FLAC____StreamMetadata__Pictureo1">FLAC__StreamMetadata_Picture::mime_type</a> </td>
cannam@86 69 </tr>
cannam@86 70 </table>
cannam@86 71 </td>
cannam@86 72 </tr>
cannam@86 73 </table>
cannam@86 74 <table cellspacing="5" cellpadding="0" border="0">
cannam@86 75 <tr>
cannam@86 76 <td>
cannam@86 77 &nbsp;
cannam@86 78 </td>
cannam@86 79 <td>
cannam@86 80
cannam@86 81 <p>
cannam@86 82 Picture data's MIME type, in ASCII printable characters 0x20-0x7e, NUL terminated. For best compatibility with players, use picture data of MIME type <code>image/jpeg</code> or <code>image/png</code>. A MIME type of '--&gt;' is also allowed, in which case the picture data should be a complete URL. In file storage, the MIME type is stored as a 32-bit length followed by the ASCII string with no NUL terminator, but is converted to a plain C string in this structure for convenience. </td>
cannam@86 83 </tr>
cannam@86 84 </table>
cannam@86 85 <a class="anchor" name="FLAC____StreamMetadata__Pictureo2" doxytag="FLAC__StreamMetadata_Picture::description"></a><p>
cannam@86 86 <table class="mdTable" cellpadding="2" cellspacing="0">
cannam@86 87 <tr>
cannam@86 88 <td class="mdRow">
cannam@86 89 <table cellpadding="0" cellspacing="0" border="0">
cannam@86 90 <tr>
cannam@86 91 <td class="md" nowrap valign="top">FLAC__byte* <a class="el" href="structFLAC____StreamMetadata__Picture.html#FLAC____StreamMetadata__Pictureo2">FLAC__StreamMetadata_Picture::description</a> </td>
cannam@86 92 </tr>
cannam@86 93 </table>
cannam@86 94 </td>
cannam@86 95 </tr>
cannam@86 96 </table>
cannam@86 97 <table cellspacing="5" cellpadding="0" border="0">
cannam@86 98 <tr>
cannam@86 99 <td>
cannam@86 100 &nbsp;
cannam@86 101 </td>
cannam@86 102 <td>
cannam@86 103
cannam@86 104 <p>
cannam@86 105 Picture's description in UTF-8, NUL terminated. In file storage, the description is stored as a 32-bit length followed by the UTF-8 string with no NUL terminator, but is converted to a plain C string in this structure for convenience. </td>
cannam@86 106 </tr>
cannam@86 107 </table>
cannam@86 108 <a class="anchor" name="FLAC____StreamMetadata__Pictureo3" doxytag="FLAC__StreamMetadata_Picture::width"></a><p>
cannam@86 109 <table class="mdTable" cellpadding="2" cellspacing="0">
cannam@86 110 <tr>
cannam@86 111 <td class="mdRow">
cannam@86 112 <table cellpadding="0" cellspacing="0" border="0">
cannam@86 113 <tr>
cannam@86 114 <td class="md" nowrap valign="top">FLAC__uint32 <a class="el" href="structFLAC____StreamMetadata__Picture.html#FLAC____StreamMetadata__Pictureo3">FLAC__StreamMetadata_Picture::width</a> </td>
cannam@86 115 </tr>
cannam@86 116 </table>
cannam@86 117 </td>
cannam@86 118 </tr>
cannam@86 119 </table>
cannam@86 120 <table cellspacing="5" cellpadding="0" border="0">
cannam@86 121 <tr>
cannam@86 122 <td>
cannam@86 123 &nbsp;
cannam@86 124 </td>
cannam@86 125 <td>
cannam@86 126
cannam@86 127 <p>
cannam@86 128 Picture's width in pixels. </td>
cannam@86 129 </tr>
cannam@86 130 </table>
cannam@86 131 <a class="anchor" name="FLAC____StreamMetadata__Pictureo4" doxytag="FLAC__StreamMetadata_Picture::height"></a><p>
cannam@86 132 <table class="mdTable" cellpadding="2" cellspacing="0">
cannam@86 133 <tr>
cannam@86 134 <td class="mdRow">
cannam@86 135 <table cellpadding="0" cellspacing="0" border="0">
cannam@86 136 <tr>
cannam@86 137 <td class="md" nowrap valign="top">FLAC__uint32 <a class="el" href="structFLAC____StreamMetadata__Picture.html#FLAC____StreamMetadata__Pictureo4">FLAC__StreamMetadata_Picture::height</a> </td>
cannam@86 138 </tr>
cannam@86 139 </table>
cannam@86 140 </td>
cannam@86 141 </tr>
cannam@86 142 </table>
cannam@86 143 <table cellspacing="5" cellpadding="0" border="0">
cannam@86 144 <tr>
cannam@86 145 <td>
cannam@86 146 &nbsp;
cannam@86 147 </td>
cannam@86 148 <td>
cannam@86 149
cannam@86 150 <p>
cannam@86 151 Picture's height in pixels. </td>
cannam@86 152 </tr>
cannam@86 153 </table>
cannam@86 154 <a class="anchor" name="FLAC____StreamMetadata__Pictureo5" doxytag="FLAC__StreamMetadata_Picture::depth"></a><p>
cannam@86 155 <table class="mdTable" cellpadding="2" cellspacing="0">
cannam@86 156 <tr>
cannam@86 157 <td class="mdRow">
cannam@86 158 <table cellpadding="0" cellspacing="0" border="0">
cannam@86 159 <tr>
cannam@86 160 <td class="md" nowrap valign="top">FLAC__uint32 <a class="el" href="structFLAC____StreamMetadata__Picture.html#FLAC____StreamMetadata__Pictureo5">FLAC__StreamMetadata_Picture::depth</a> </td>
cannam@86 161 </tr>
cannam@86 162 </table>
cannam@86 163 </td>
cannam@86 164 </tr>
cannam@86 165 </table>
cannam@86 166 <table cellspacing="5" cellpadding="0" border="0">
cannam@86 167 <tr>
cannam@86 168 <td>
cannam@86 169 &nbsp;
cannam@86 170 </td>
cannam@86 171 <td>
cannam@86 172
cannam@86 173 <p>
cannam@86 174 Picture's color depth in bits-per-pixel. </td>
cannam@86 175 </tr>
cannam@86 176 </table>
cannam@86 177 <a class="anchor" name="FLAC____StreamMetadata__Pictureo6" doxytag="FLAC__StreamMetadata_Picture::colors"></a><p>
cannam@86 178 <table class="mdTable" cellpadding="2" cellspacing="0">
cannam@86 179 <tr>
cannam@86 180 <td class="mdRow">
cannam@86 181 <table cellpadding="0" cellspacing="0" border="0">
cannam@86 182 <tr>
cannam@86 183 <td class="md" nowrap valign="top">FLAC__uint32 <a class="el" href="structFLAC____StreamMetadata__Picture.html#FLAC____StreamMetadata__Pictureo6">FLAC__StreamMetadata_Picture::colors</a> </td>
cannam@86 184 </tr>
cannam@86 185 </table>
cannam@86 186 </td>
cannam@86 187 </tr>
cannam@86 188 </table>
cannam@86 189 <table cellspacing="5" cellpadding="0" border="0">
cannam@86 190 <tr>
cannam@86 191 <td>
cannam@86 192 &nbsp;
cannam@86 193 </td>
cannam@86 194 <td>
cannam@86 195
cannam@86 196 <p>
cannam@86 197 For indexed palettes (like GIF), picture's number of colors (the number of palette entries), or <code>0</code> for non-indexed (i.e. 2^depth). </td>
cannam@86 198 </tr>
cannam@86 199 </table>
cannam@86 200 <a class="anchor" name="FLAC____StreamMetadata__Pictureo7" doxytag="FLAC__StreamMetadata_Picture::data_length"></a><p>
cannam@86 201 <table class="mdTable" cellpadding="2" cellspacing="0">
cannam@86 202 <tr>
cannam@86 203 <td class="mdRow">
cannam@86 204 <table cellpadding="0" cellspacing="0" border="0">
cannam@86 205 <tr>
cannam@86 206 <td class="md" nowrap valign="top">FLAC__uint32 <a class="el" href="structFLAC____StreamMetadata__Picture.html#FLAC____StreamMetadata__Pictureo7">FLAC__StreamMetadata_Picture::data_length</a> </td>
cannam@86 207 </tr>
cannam@86 208 </table>
cannam@86 209 </td>
cannam@86 210 </tr>
cannam@86 211 </table>
cannam@86 212 <table cellspacing="5" cellpadding="0" border="0">
cannam@86 213 <tr>
cannam@86 214 <td>
cannam@86 215 &nbsp;
cannam@86 216 </td>
cannam@86 217 <td>
cannam@86 218
cannam@86 219 <p>
cannam@86 220 Length of binary picture data in bytes. </td>
cannam@86 221 </tr>
cannam@86 222 </table>
cannam@86 223 <a class="anchor" name="FLAC____StreamMetadata__Pictureo8" doxytag="FLAC__StreamMetadata_Picture::data"></a><p>
cannam@86 224 <table class="mdTable" cellpadding="2" cellspacing="0">
cannam@86 225 <tr>
cannam@86 226 <td class="mdRow">
cannam@86 227 <table cellpadding="0" cellspacing="0" border="0">
cannam@86 228 <tr>
cannam@86 229 <td class="md" nowrap valign="top">FLAC__byte* <a class="el" href="structFLAC____StreamMetadata__Picture.html#FLAC____StreamMetadata__Pictureo8">FLAC__StreamMetadata_Picture::data</a> </td>
cannam@86 230 </tr>
cannam@86 231 </table>
cannam@86 232 </td>
cannam@86 233 </tr>
cannam@86 234 </table>
cannam@86 235 <table cellspacing="5" cellpadding="0" border="0">
cannam@86 236 <tr>
cannam@86 237 <td>
cannam@86 238 &nbsp;
cannam@86 239 </td>
cannam@86 240 <td>
cannam@86 241
cannam@86 242 <p>
cannam@86 243 Binary picture data. </td>
cannam@86 244 </tr>
cannam@86 245 </table>
cannam@86 246 <hr>The documentation for this struct was generated from the following file:<ul>
cannam@86 247 <li>include/FLAC/<a class="el" href="format_8h-source.html">format.h</a></ul>
cannam@86 248
cannam@86 249 <hr size="1">
cannam@86 250 <div class="copyright">
cannam@86 251 <!-- @@@ oh so hacky -->
cannam@86 252 <table>
cannam@86 253 <tr>
cannam@86 254 <td align="left">
cannam@86 255 Copyright (c) 2000,2001,2002,2003,2004,2005,2006,2007 Josh Coalson
cannam@86 256 </td>
cannam@86 257 <td width="1%" align="right">
cannam@86 258 <a href="http://sourceforge.net"><img src="http://sflogo.sourceforge.net/sflogo.php?group_id=13478&amp;type=1" width="88" height="31" border="0" alt="SourceForge.net Logo" /></a>
cannam@86 259 </td>
cannam@86 260 </tr>
cannam@86 261 </table>
cannam@86 262 </div>
cannam@86 263 <!-- Copyright (c) 2000,2001,2002,2003,2004,2005,2006,2007 Josh Coalson -->
cannam@86 264 <!-- Permission is granted to copy, distribute and/or modify this document -->
cannam@86 265 <!-- under the terms of the GNU Free Documentation License, Version 1.1 -->
cannam@86 266 <!-- or any later version published by the Free Software Foundation; -->
cannam@86 267 <!-- with no invariant sections. -->
cannam@86 268 <!-- A copy of the license can be found at http://www.gnu.org/copyleft/fdl.html -->
cannam@86 269 </body>
cannam@86 270 </html>