wearable/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.76.1">
   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-gsttagexif.html" title="gsttagexif">
  11 <meta name="generator" content="GTK-Doc V1.18 (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-gsttagexif.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 <span class="type">guint8</span> *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 <span class="type">guint8</span> *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 <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-get-id3v2-tag-size" title="gst_tag_get_id3v2_tag_size ()">gst_tag_get_id3v2_tag_size</a>          (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBuffer.html#GstBuffer"><span class="type">GstBuffer</span></a> *buffer</code></em>);
  56 <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-from-id3v2-tag" title="gst_tag_list_from_id3v2_tag ()">gst_tag_list_from_id3v2_tag</a>         (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBuffer.html#GstBuffer"><span class="type">GstBuffer</span></a> *buffer</code></em>);
  57 </pre>
  58 </div>
  59 <div class="refsect1">
  60 <a name="gst-plugins-base-libs-gsttagid3.description"></a><h2>Description</h2>
  61 <p>
  62 </p>
  63 <div class="refsect2">
  64 <a name="idp24766688"></a><p>
  65 Contains various utility functions for plugins to parse or create
  66 ID3 tags and map ID3v2 identifiers to and from GStreamer identifiers.
  67 </p>
  68 </div>
  69 <p>
  70 </p>
  71 </div>
  72 <div class="refsect1">
  73 <a name="gst-plugins-base-libs-gsttagid3.details"></a><h2>Details</h2>
  74 <div class="refsect2">
  75 <a name="gst-tag-id3-genre-count"></a><h3>gst_tag_id3_genre_count ()</h3>
  76 <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>
  77 <p>
  78 Gets the number of ID3v1 genres that can be identified. Winamp genres are
  79 included.
  80 </p>
  81 <div class="variablelist"><table border="0">
  82 <col align="left" valign="top">
  83 <tbody><tr>
  84 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
  85 <td>the number of ID3v1 genres that can be identified</td>
  86 </tr></tbody>
  87 </table></div>
  88 </div>
  89 <hr>
  90 <div class="refsect2">
  91 <a name="gst-tag-id3-genre-get"></a><h3>gst_tag_id3_genre_get ()</h3>
  92 <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>
  93 <p>
  94 Gets the ID3v1 genre name for a given ID.
  95 </p>
  96 <div class="variablelist"><table border="0">
  97 <col align="left" valign="top">
  98 <tbody>
  99 <tr>
 100 <td><p><span class="term"><em class="parameter"><code>id</code></em> :</span></p></td>
 101 <td>ID of genre to query</td>
 102 </tr>
 103 <tr>
 104 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 105 <td>the genre or NULL if no genre is associated with that ID.</td>
 106 </tr>
 107 </tbody>
 108 </table></div>
 109 </div>
 110 <hr>
 111 <div class="refsect2">
 112 <a name="gst-tag-list-new-from-id3v1"></a><h3>gst_tag_list_new_from_id3v1 ()</h3>
 113 <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 <span class="type">guint8</span> *data</code></em>);</pre>
 114 <p>
 115 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
 116 parsed data.
 117 </p>
 118 <div class="variablelist"><table border="0">
 119 <col align="left" valign="top">
 120 <tbody>
 121 <tr>
 122 <td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
 123 <td>128 bytes of data containing the ID3v1 tag</td>
 124 </tr>
 125 <tr>
 126 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 127 <td>A new tag list or NULL if the data was not an ID3v1 tag.</td>
 128 </tr>
 129 </tbody>
 130 </table></div>
 131 </div>
 132 <hr>
 133 <div class="refsect2">
 134 <a name="gst-tag-from-id3-tag"></a><h3>gst_tag_from_id3_tag ()</h3>
 135 <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>
 136 <p>
 137 Looks up the GStreamer tag for a ID3v2 tag.
 138 </p>
 139 <div class="variablelist"><table border="0">
 140 <col align="left" valign="top">
 141 <tbody>
 142 <tr>
 143 <td><p><span class="term"><em class="parameter"><code>id3_tag</code></em> :</span></p></td>
 144 <td>ID3v2 tag to convert to GStreamer tag</td>
 145 </tr>
 146 <tr>
 147 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 148 <td>The corresponding GStreamer tag or NULL if none exists.</td>
 149 </tr>
 150 </tbody>
 151 </table></div>
 152 </div>
 153 <hr>
 154 <div class="refsect2">
 155 <a name="gst-tag-from-id3-user-tag"></a><h3>gst_tag_from_id3_user_tag ()</h3>
 156 <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>,
 157                                                          <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>
 158 <p>
 159 Looks up the GStreamer tag for an ID3v2 user tag (e.g. description in
 160 TXXX frame or owner in UFID frame).
 161 </p>
 162 <div class="variablelist"><table border="0">
 163 <col align="left" valign="top">
 164 <tbody>
 165 <tr>
 166 <td><p><span class="term"><em class="parameter"><code>type</code></em> :</span></p></td>
 167 <td>the type of ID3v2 user tag (e.g. "TXXX" or "UDIF")</td>
 168 </tr>
 169 <tr>
 170 <td><p><span class="term"><em class="parameter"><code>id3_user_tag</code></em> :</span></p></td>
 171 <td>ID3v2 user tag to convert to GStreamer tag</td>
 172 </tr>
 173 <tr>
 174 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 175 <td>The corresponding GStreamer tag or NULL if none exists.</td>
 176 </tr>
 177 </tbody>
 178 </table></div>
 179 </div>
 180 <hr>
 181 <div class="refsect2">
 182 <a name="gst-tag-to-id3-tag"></a><h3>gst_tag_to_id3_tag ()</h3>
 183 <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>
 184 <p>
 185 Looks up the ID3v2 tag for a GStreamer tag.
 186 </p>
 187 <div class="variablelist"><table border="0">
 188 <col align="left" valign="top">
 189 <tbody>
 190 <tr>
 191 <td><p><span class="term"><em class="parameter"><code>gst_tag</code></em> :</span></p></td>
 192 <td>GStreamer tag to convert to vorbiscomment tag</td>
 193 </tr>
 194 <tr>
 195 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 196 <td>The corresponding ID3v2 tag or NULL if none exists.</td>
 197 </tr>
 198 </tbody>
 199 </table></div>
 200 </div>
 201 <hr>
 202 <div class="refsect2">
 203 <a name="gst-tag-list-add-id3-image"></a><h3>gst_tag_list_add_id3_image ()</h3>
 204 <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>,
 205                                                          <em class="parameter"><code>const <span class="type">guint8</span> *image_data</code></em>,
 206                                                          <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>,
 207                                                          <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>
 208 <p>
 209 Adds an image from an ID3 APIC frame (or similar, such as used in FLAC)
 210 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
 211 more information on image tags in GStreamer.
 212 </p>
 213 <div class="variablelist"><table border="0">
 214 <col align="left" valign="top">
 215 <tbody>
 216 <tr>
 217 <td><p><span class="term"><em class="parameter"><code>tag_list</code></em> :</span></p></td>
 218 <td>a tag list</td>
 219 </tr>
 220 <tr>
 221 <td><p><span class="term"><em class="parameter"><code>image_data</code></em> :</span></p></td>
 222 <td>the (encoded) image</td>
 223 </tr>
 224 <tr>
 225 <td><p><span class="term"><em class="parameter"><code>image_data_len</code></em> :</span></p></td>
 226 <td>the length of the encoded image data at <em class="parameter"><code>image_data</code></em>
 227 </td>
 228 </tr>
 229 <tr>
 230 <td><p><span class="term"><em class="parameter"><code>id3_picture_type</code></em> :</span></p></td>
 231 <td>picture type as per the ID3 (v2.4.0) specification for
 232 the APIC frame (0 = unknown/other)</td>
 233 </tr>
 234 <tr>
 235 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 236 <td>
 237 <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>
 238 </td>
 239 </tr>
 240 </tbody>
 241 </table></div>
 242 <p class="since">Since 0.10.20</p>
 243 </div>
 244 <hr>
 245 <div class="refsect2">
 246 <a name="gst-tag-get-id3v2-tag-size"></a><h3>gst_tag_get_id3v2_tag_size ()</h3>
 247 <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_get_id3v2_tag_size          (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBuffer.html#GstBuffer"><span class="type">GstBuffer</span></a> *buffer</code></em>);</pre>
 248 <p>
 249 Determines size of an ID3v2 tag on buffer containing at least ID3v2 header,
 250 i.e. at least <a class="link" href="gst-plugins-base-libs-gsttag.html#GST-TAG-ID3V2-HEADER-SIZE:CAPS" title="GST_TAG_ID3V2_HEADER_SIZE"><span class="type">GST_TAG_ID3V2_HEADER_SIZE</span></a> (10) bytes;
 251 </p>
 252 <div class="variablelist"><table border="0">
 253 <col align="left" valign="top">
 254 <tbody>
 255 <tr>
 256 <td><p><span class="term"><em class="parameter"><code>buffer</code></em> :</span></p></td>
 257 <td>buffer holding ID3v2 tag (or at least the start of one)</td>
 258 </tr>
 259 <tr>
 260 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 261 <td>Size of tag, or 0 if header is invalid or too small.</td>
 262 </tr>
 263 </tbody>
 264 </table></div>
 265 <p class="since">Since 0.10.36</p>
 266 </div>
 267 <hr>
 268 <div class="refsect2">
 269 <a name="gst-tag-list-from-id3v2-tag"></a><h3>gst_tag_list_from_id3v2_tag ()</h3>
 270 <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_from_id3v2_tag         (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBuffer.html#GstBuffer"><span class="type">GstBuffer</span></a> *buffer</code></em>);</pre>
 271 <p>
 272 Creates a new tag list that contains the information parsed out of a
 273 ID3 tag.
 274 </p>
 275 <div class="variablelist"><table border="0">
 276 <col align="left" valign="top">
 277 <tbody>
 278 <tr>
 279 <td><p><span class="term"><em class="parameter"><code>buffer</code></em> :</span></p></td>
 280 <td>buffer to convert</td>
 281 </tr>
 282 <tr>
 283 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 284 <td>A new <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstTagList.html#GstTagList"><span class="type">GstTagList</span></a> with all tags that could be extracted from the
 285 given vorbiscomment buffer or NULL on error.</td>
 286 </tr>
 287 </tbody>
 288 </table></div>
 289 <p class="since">Since 0.10.36</p>
 290 </div>
 291 </div>
 292 <div class="refsect1">
 293 <a name="gst-plugins-base-libs-gsttagid3.see-also"></a><h2>See Also</h2>
 294 <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstTagList.html#GstTagList"><span class="type">GstTagList</span></a>
 295 </div>
 296 </div>
 297 <div class="footer">
 298 <hr>
 299           Generated by GTK-Doc V1.18</div>
 300 </body>
 301 </html>