docs/libs/html/gst-plugins-base-libs-gsttagid3.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
   2 <html>
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
   5 <title>gsttagid3</title>
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
   7 <link rel="home" href="index.html" title="GStreamer Base Plugins 0.10 Library Reference Manual">
   8 <link rel="up" href="gstreamer-tag.html" title="Tag Support Library">
   9 <link rel="prev" href="gst-plugins-base-libs-gsttagvorbis.html" title="gsttagvorbis">
  10 <link rel="next" href="gst-plugins-base-libs-gsttagxmp.html" title="gsttagxmp">
  11 <meta name="generator" content="GTK-Doc V1.17 (XML mode)">
  12 <link rel="stylesheet" href="style.css" type="text/css">
  13 </head>
  14 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  15 <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
  16 <tr valign="middle">
  17 <td><a accesskey="p" href="gst-plugins-base-libs-gsttagvorbis.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
  18 <td><a accesskey="u" href="gstreamer-tag.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
  19 <td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
  20 <th width="100%" align="center">GStreamer Base Plugins 0.10 Library Reference Manual</th>
  21 <td><a accesskey="n" href="gst-plugins-base-libs-gsttagxmp.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
  22 </tr>
  23 <tr><td colspan="5" class="shortcuts">
  24 <a href="#gst-plugins-base-libs-gsttagid3.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#gst-plugins-base-libs-gsttagid3.description" class="shortcut">Description</a>
  27 </td></tr>
  28 </table>
  29 <div class="refentry">
  30 <a name="gst-plugins-base-libs-gsttagid3"></a><div class="titlepage"></div>
  31 <div class="refnamediv"><table width="100%"><tr>
  32 <td valign="top">
  33 <h2><span class="refentrytitle"><a name="gst-plugins-base-libs-gsttagid3.top_of_page"></a>gsttagid3</span></h2>
  34 <p>gsttagid3 — tag mappings and support functions for plugins
  35                     dealing with ID3v1 and ID3v2 tags</p>
  36 </td>
  37 <td valign="top" align="right"></td>
  38 </tr></table></div>
  39 <div class="refsynopsisdiv">
  40 <a name="gst-plugins-base-libs-gsttagid3.synopsis"></a><h2>Synopsis</h2>
  41 <pre class="synopsis">
  42 #include &lt;gst/tag/tag.h&gt;
  43
  44 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>               <a class="link" href="gst-plugins-base-libs-gsttagid3.html#gst-tag-id3-genre-count" title="gst_tag_id3_genre_count ()">gst_tag_id3_genre_count</a>             (<em class="parameter"><code><span class="type">void</span></code></em>);
  45 const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       <a class="link" href="gst-plugins-base-libs-gsttagid3.html#gst-tag-id3-genre-get" title="gst_tag_id3_genre_get ()">gst_tag_id3_genre_get</a>               (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> id</code></em>);
  46 <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstTagList.html#GstTagList"><span class="returnvalue">GstTagList</span></a> *             <a class="link" href="gst-plugins-base-libs-gsttagid3.html#gst-tag-list-new-from-id3v1" title="gst_tag_list_new_from_id3v1 ()">gst_tag_list_new_from_id3v1</a>    (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint8"><span class="type">guint8</span></a> *data</code></em>);
  47 const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       <a class="link" href="gst-plugins-base-libs-gsttagid3.html#gst-tag-from-id3-tag" title="gst_tag_from_id3_tag ()">gst_tag_from_id3_tag</a>                (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *id3_tag</code></em>);
  48 const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       <a class="link" href="gst-plugins-base-libs-gsttagid3.html#gst-tag-from-id3-user-tag" title="gst_tag_from_id3_user_tag ()">gst_tag_from_id3_user_tag</a>           (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *type</code></em>,
  49                                                          <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *id3_user_tag</code></em>);
  50 const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       <a class="link" href="gst-plugins-base-libs-gsttagid3.html#gst-tag-to-id3-tag" title="gst_tag_to_id3_tag ()">gst_tag_to_id3_tag</a>                  (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *gst_tag</code></em>);
  51 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="gst-plugins-base-libs-gsttagid3.html#gst-tag-list-add-id3-image" title="gst_tag_list_add_id3_image ()">gst_tag_list_add_id3_image</a>          (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstTagList.html#GstTagList"><span class="type">GstTagList</span></a> *tag_list</code></em>,
  52                                                          <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint8"><span class="type">guint8</span></a> *image_data</code></em>,
  53                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> image_data_len</code></em>,
  54                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> id3_picture_type</code></em>);
  55 </pre>
  56 </div>
  57 <div class="refsect1">
  58 <a name="gst-plugins-base-libs-gsttagid3.description"></a><h2>Description</h2>
  59 <p>
  60 </p>
  61 <div class="refsect2">
  62 <a name="idp25099152"></a><p>
  63 Contains various utility functions for plugins to parse or create
  64 ID3 tags and map ID3v2 identifiers to and from GStreamer identifiers.
  65 </p>
  66 </div>
  67 <p>
  68 </p>
  69 </div>
  70 <div class="refsect1">
  71 <a name="gst-plugins-base-libs-gsttagid3.details"></a><h2>Details</h2>
  72 <div class="refsect2">
  73 <a name="gst-tag-id3-genre-count"></a><h3>gst_tag_id3_genre_count ()</h3>
  74 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>               gst_tag_id3_genre_count             (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
  75 <p>
  76 Gets the number of ID3v1 genres that can be identified. Winamp genres are
  77 included.
  78 </p>
  79 <div class="variablelist"><table border="0">
  80 <col align="left" valign="top">
  81 <tbody><tr>
  82 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
  83 <td>the number of ID3v1 genres that can be identified</td>
  84 </tr></tbody>
  85 </table></div>
  86 </div>
  87 <hr>
  88 <div class="refsect2">
  89 <a name="gst-tag-id3-genre-get"></a><h3>gst_tag_id3_genre_get ()</h3>
  90 <pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       gst_tag_id3_genre_get               (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> id</code></em>);</pre>
  91 <p>
  92 Gets the ID3v1 genre name for a given ID.
  93 </p>
  94 <div class="variablelist"><table border="0">
  95 <col align="left" valign="top">
  96 <tbody>
  97 <tr>
  98 <td><p><span class="term"><em class="parameter"><code>id</code></em> :</span></p></td>
  99 <td>ID of genre to query</td>
 100 </tr>
 101 <tr>
 102 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 103 <td>the genre or NULL if no genre is associated with that ID.</td>
 104 </tr>
 105 </tbody>
 106 </table></div>
 107 </div>
 108 <hr>
 109 <div class="refsect2">
 110 <a name="gst-tag-list-new-from-id3v1"></a><h3>gst_tag_list_new_from_id3v1 ()</h3>
 111 <pre class="programlisting"><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstTagList.html#GstTagList"><span class="returnvalue">GstTagList</span></a> *             gst_tag_list_new_from_id3v1    (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint8"><span class="type">guint8</span></a> *data</code></em>);</pre>
 112 <p>
 113 Parses the data containing an ID3v1 tag and returns a <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstTagList.html#GstTagList"><span class="type">GstTagList</span></a> from the
 114 parsed data.
 115 </p>
 116 <div class="variablelist"><table border="0">
 117 <col align="left" valign="top">
 118 <tbody>
 119 <tr>
 120 <td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
 121 <td>128 bytes of data containing the ID3v1 tag</td>
 122 </tr>
 123 <tr>
 124 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 125 <td>A new tag list or NULL if the data was not an ID3v1 tag.</td>
 126 </tr>
 127 </tbody>
 128 </table></div>
 129 </div>
 130 <hr>
 131 <div class="refsect2">
 132 <a name="gst-tag-from-id3-tag"></a><h3>gst_tag_from_id3_tag ()</h3>
 133 <pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       gst_tag_from_id3_tag                (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *id3_tag</code></em>);</pre>
 134 <p>
 135 Looks up the GStreamer tag for a ID3v2 tag.
 136 </p>
 137 <div class="variablelist"><table border="0">
 138 <col align="left" valign="top">
 139 <tbody>
 140 <tr>
 141 <td><p><span class="term"><em class="parameter"><code>id3_tag</code></em> :</span></p></td>
 142 <td>ID3v2 tag to convert to GStreamer tag</td>
 143 </tr>
 144 <tr>
 145 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 146 <td>The corresponding GStreamer tag or NULL if none exists.</td>
 147 </tr>
 148 </tbody>
 149 </table></div>
 150 </div>
 151 <hr>
 152 <div class="refsect2">
 153 <a name="gst-tag-from-id3-user-tag"></a><h3>gst_tag_from_id3_user_tag ()</h3>
 154 <pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       gst_tag_from_id3_user_tag           (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *type</code></em>,
 155                                                          <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *id3_user_tag</code></em>);</pre>
 156 <p>
 157 Looks up the GStreamer tag for an ID3v2 user tag (e.g. description in
 158 TXXX frame or owner in UFID frame).
 159 </p>
 160 <div class="variablelist"><table border="0">
 161 <col align="left" valign="top">
 162 <tbody>
 163 <tr>
 164 <td><p><span class="term"><em class="parameter"><code>type</code></em> :</span></p></td>
 165 <td>the type of ID3v2 user tag (e.g. "TXXX" or "UDIF")</td>
 166 </tr>
 167 <tr>
 168 <td><p><span class="term"><em class="parameter"><code>id3_user_tag</code></em> :</span></p></td>
 169 <td>ID3v2 user tag to convert to GStreamer tag</td>
 170 </tr>
 171 <tr>
 172 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 173 <td>The corresponding GStreamer tag or NULL if none exists.</td>
 174 </tr>
 175 </tbody>
 176 </table></div>
 177 </div>
 178 <hr>
 179 <div class="refsect2">
 180 <a name="gst-tag-to-id3-tag"></a><h3>gst_tag_to_id3_tag ()</h3>
 181 <pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       gst_tag_to_id3_tag                  (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *gst_tag</code></em>);</pre>
 182 <p>
 183 Looks up the ID3v2 tag for a GStreamer tag.
 184 </p>
 185 <div class="variablelist"><table border="0">
 186 <col align="left" valign="top">
 187 <tbody>
 188 <tr>
 189 <td><p><span class="term"><em class="parameter"><code>gst_tag</code></em> :</span></p></td>
 190 <td>GStreamer tag to convert to vorbiscomment tag</td>
 191 </tr>
 192 <tr>
 193 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 194 <td>The corresponding ID3v2 tag or NULL if none exists.</td>
 195 </tr>
 196 </tbody>
 197 </table></div>
 198 </div>
 199 <hr>
 200 <div class="refsect2">
 201 <a name="gst-tag-list-add-id3-image"></a><h3>gst_tag_list_add_id3_image ()</h3>
 202 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            gst_tag_list_add_id3_image          (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstTagList.html#GstTagList"><span class="type">GstTagList</span></a> *tag_list</code></em>,
 203                                                          <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint8"><span class="type">guint8</span></a> *image_data</code></em>,
 204                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> image_data_len</code></em>,
 205                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> id3_picture_type</code></em>);</pre>
 206 <p>
 207 Adds an image from an ID3 APIC frame (or similar, such as used in FLAC)
 208 to the given tag list. Also see <a class="link" href="gst-plugins-base-libs-gsttag.html#gst-tag-image-data-to-image-buffer" title="gst_tag_image_data_to_image_buffer ()"><code class="function">gst_tag_image_data_to_image_buffer()</code></a> for
 209 more information on image tags in GStreamer.
 210 </p>
 211 <div class="variablelist"><table border="0">
 212 <col align="left" valign="top">
 213 <tbody>
 214 <tr>
 215 <td><p><span class="term"><em class="parameter"><code>tag_list</code></em> :</span></p></td>
 216 <td>a tag list</td>
 217 </tr>
 218 <tr>
 219 <td><p><span class="term"><em class="parameter"><code>image_data</code></em> :</span></p></td>
 220 <td>the (encoded) image</td>
 221 </tr>
 222 <tr>
 223 <td><p><span class="term"><em class="parameter"><code>image_data_len</code></em> :</span></p></td>
 224 <td>the length of the encoded image data at <em class="parameter"><code>image_data</code></em>
 225 </td>
 226 </tr>
 227 <tr>
 228 <td><p><span class="term"><em class="parameter"><code>id3_picture_type</code></em> :</span></p></td>
 229 <td>picture type as per the ID3 (v2.4.0) specification for
 230 the APIC frame (0 = unknown/other)</td>
 231 </tr>
 232 <tr>
 233 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 234 <td>
 235 <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the image was processed, otherwise <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>
 236 </td>
 237 </tr>
 238 </tbody>
 239 </table></div>
 240 <p class="since">Since 0.10.20</p>
 241 </div>
 242 </div>
 243 <div class="refsect1">
 244 <a name="gst-plugins-base-libs-gsttagid3.see-also"></a><h2>See Also</h2>
 245 <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstTagList.html#GstTagList"><span class="type">GstTagList</span></a>
 246 </div>
 247 </div>
 248 <div class="footer">
 249 <hr>
 250           Generated by GTK-Doc V1.17</div>
 251 </body>
 252 </html>