1
0
mirror of https://github.com/cookiengineer/audacity synced 2025-06-19 09:30:06 +02:00
audacity/lib-src/libflac/doc/html/api/structFLAC____StreamMetadata__Picture.html
2015-05-01 03:33:07 -05:00

228 lines
11 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.8"/>
<title>FLAC: FLAC__StreamMetadata_Picture Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">FLAC
&#160;<span id="projectnumber">1.3.1</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.8 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class&#160;List</span></a></li>
<li><a href="classes.html"><span>Class&#160;Index</span></a></li>
<li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&#160;Members</span></a></li>
</ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="structFLAC____StreamMetadata__Picture-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">FLAC__StreamMetadata_Picture Struct Reference<div class="ingroups"><a class="el" href="group__flac.html">FLAC C API</a> &raquo; <a class="el" href="group__flac__format.html">FLAC/format.h: format components</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="format_8h_source.html">format.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:addc05a87a1da1ec7dd2301944ff2819c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__flac__format.html#gaf6d3e836cee023e0b8d897f1fdc9825d">FLAC__StreamMetadata_Picture_Type</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structFLAC____StreamMetadata__Picture.html#addc05a87a1da1ec7dd2301944ff2819c">type</a></td></tr>
<tr class="separator:addc05a87a1da1ec7dd2301944ff2819c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9b4af2e10b627c0e79abf4cdd79f80e0"><td class="memItemLeft" align="right" valign="top">char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structFLAC____StreamMetadata__Picture.html#a9b4af2e10b627c0e79abf4cdd79f80e0">mime_type</a></td></tr>
<tr class="separator:a9b4af2e10b627c0e79abf4cdd79f80e0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5bbfb168b265edfb0b29cfdb71fb413c"><td class="memItemLeft" align="right" valign="top">FLAC__byte *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structFLAC____StreamMetadata__Picture.html#a5bbfb168b265edfb0b29cfdb71fb413c">description</a></td></tr>
<tr class="separator:a5bbfb168b265edfb0b29cfdb71fb413c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a18dc6cdef9fa6c815450671f631a1e04"><td class="memItemLeft" align="right" valign="top">FLAC__uint32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structFLAC____StreamMetadata__Picture.html#a18dc6cdef9fa6c815450671f631a1e04">width</a></td></tr>
<tr class="separator:a18dc6cdef9fa6c815450671f631a1e04"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a76dbd1212d330807cda289660f5ee754"><td class="memItemLeft" align="right" valign="top">FLAC__uint32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structFLAC____StreamMetadata__Picture.html#a76dbd1212d330807cda289660f5ee754">height</a></td></tr>
<tr class="separator:a76dbd1212d330807cda289660f5ee754"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0f2092ddf28a6803e9c8adb7328c1967"><td class="memItemLeft" align="right" valign="top">FLAC__uint32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structFLAC____StreamMetadata__Picture.html#a0f2092ddf28a6803e9c8adb7328c1967">depth</a></td></tr>
<tr class="separator:a0f2092ddf28a6803e9c8adb7328c1967"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af17c1738bab67eba049ee101acfd36f0"><td class="memItemLeft" align="right" valign="top">FLAC__uint32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structFLAC____StreamMetadata__Picture.html#af17c1738bab67eba049ee101acfd36f0">colors</a></td></tr>
<tr class="separator:af17c1738bab67eba049ee101acfd36f0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acb893f63a196f70263468770a90580a4"><td class="memItemLeft" align="right" valign="top">FLAC__uint32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structFLAC____StreamMetadata__Picture.html#acb893f63a196f70263468770a90580a4">data_length</a></td></tr>
<tr class="separator:acb893f63a196f70263468770a90580a4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9c71b5d77920e6d3aee6893795c43605"><td class="memItemLeft" align="right" valign="top">FLAC__byte *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structFLAC____StreamMetadata__Picture.html#a9c71b5d77920e6d3aee6893795c43605">data</a></td></tr>
<tr class="separator:a9c71b5d77920e6d3aee6893795c43605"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>FLAC PICTURE structure. (See the <a href="../format.html#metadata_block_picture">format specification</a> for the full description of each field.) </p>
</div><h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="addc05a87a1da1ec7dd2301944ff2819c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__flac__format.html#gaf6d3e836cee023e0b8d897f1fdc9825d">FLAC__StreamMetadata_Picture_Type</a> FLAC__StreamMetadata_Picture::type</td>
</tr>
</table>
</div><div class="memdoc">
<p>The kind of picture stored. </p>
</div>
</div>
<a class="anchor" id="a9b4af2e10b627c0e79abf4cdd79f80e0"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char* FLAC__StreamMetadata_Picture::mime_type</td>
</tr>
</table>
</div><div class="memdoc">
<p>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 '&ndash;&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. </p>
</div>
</div>
<a class="anchor" id="a5bbfb168b265edfb0b29cfdb71fb413c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">FLAC__byte* FLAC__StreamMetadata_Picture::description</td>
</tr>
</table>
</div><div class="memdoc">
<p>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. </p>
</div>
</div>
<a class="anchor" id="a18dc6cdef9fa6c815450671f631a1e04"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">FLAC__uint32 FLAC__StreamMetadata_Picture::width</td>
</tr>
</table>
</div><div class="memdoc">
<p>Picture's width in pixels. </p>
</div>
</div>
<a class="anchor" id="a76dbd1212d330807cda289660f5ee754"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">FLAC__uint32 FLAC__StreamMetadata_Picture::height</td>
</tr>
</table>
</div><div class="memdoc">
<p>Picture's height in pixels. </p>
</div>
</div>
<a class="anchor" id="a0f2092ddf28a6803e9c8adb7328c1967"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">FLAC__uint32 FLAC__StreamMetadata_Picture::depth</td>
</tr>
</table>
</div><div class="memdoc">
<p>Picture's color depth in bits-per-pixel. </p>
</div>
</div>
<a class="anchor" id="af17c1738bab67eba049ee101acfd36f0"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">FLAC__uint32 FLAC__StreamMetadata_Picture::colors</td>
</tr>
</table>
</div><div class="memdoc">
<p>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). </p>
</div>
</div>
<a class="anchor" id="acb893f63a196f70263468770a90580a4"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">FLAC__uint32 FLAC__StreamMetadata_Picture::data_length</td>
</tr>
</table>
</div><div class="memdoc">
<p>Length of binary picture data in bytes. </p>
</div>
</div>
<a class="anchor" id="a9c71b5d77920e6d3aee6893795c43605"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">FLAC__byte* FLAC__StreamMetadata_Picture::data</td>
</tr>
</table>
</div><div class="memdoc">
<p>Binary picture data. </p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>include/FLAC/<a class="el" href="format_8h_source.html">format.h</a></li>
</ul>
</div><!-- contents -->
<hr size="1">
<div class="copyright">
<!-- @@@ oh so hacky -->
<table>
<tr>
<td align="left">
Copyright (c) 2000-2009 Josh Coalson
Copyright (c) 2011-2014 Xiph.Org Foundation
</td>
<td width="1%" align="right">
<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>
</td>
</tr>
</table>
</div>
<!-- Copyright (c) 2000-2009 Josh Coalson -->
<!-- Copyright (c) 2011-2014 Xiph.Org Foundation -->
<!-- Permission is granted to copy, distribute and/or modify this document -->
<!-- under the terms of the GNU Free Documentation License, Version 1.1 -->
<!-- or any later version published by the Free Software Foundation; -->
<!-- with no invariant sections. -->
<!-- A copy of the license can be found at http://www.gnu.org/copyleft/fdl.html -->
</body>
</html>