/usr/share/doc/appstream/html/sect-Metadata-Codec.html is in appstream-doc 0.9.4-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 | <?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title xmlns:d="http://docbook.org/ns/docbook">2.5. Codecs</title><link rel="stylesheet" type="text/css" href="Common_Content/css/default.css" /><link rel="stylesheet" media="print" href="Common_Content/css/print.css" type="text/css" /><meta xmlns:d="http://docbook.org/ns/docbook" name="generator" content="publican v4.3.2" /><meta xmlns:d="http://docbook.org/ns/docbook" name="package" content="AppStream-AppStream-0.9-en-US-0.0-0" /><link rel="home" href="index.html" title="AppStream" /><link rel="up" href="chap-Metadata.html" title="Chapter 2. Upstream Metadata" /><link rel="prev" href="sect-Metadata-Fonts.html" title="2.4. Fonts" /><link rel="next" href="sect-Metadata-InputMethod.html" title="2.6. Input Methods" /></head><body><p id="title"><a class="left" href="http://www.freedesktop.org/wiki/Distributions/AppStream/"><img alt="Product Site" src="Common_Content/images//image_left.png" /></a><a class="right" href="http://www.freedesktop.org/software/appstream/docs/"><img alt="Documentation Site" src="Common_Content/images//image_right.png" /></a></p><ul class="docnav top"><li class="previous"><a accesskey="p" href="sect-Metadata-Fonts.html"><strong>Prev</strong></a></li><li class="home">AppStream</li><li class="next"><a accesskey="n" href="sect-Metadata-InputMethod.html"><strong>Next</strong></a></li></ul><div xml:lang="en-US" class="section" lang="en-US"><div class="titlepage"><div><div><h2 class="title"><a id="sect-Metadata-Codec">
</a>2.5. Codecs</h2></div></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="spec-codecdata-introduction">
</a>2.5.1. Introduction</h3></div></div></div><div class="para">
Software centers might want to special-case codec handling. Therefore, we provide a component type for them.
</div><div class="para">
Codecs can ship one or more files in <code class="filename">/usr/share/metainfo/%{id}.metainfo.xml</code>.
</div><div class="para">
Codec metadata files can - just likle all other metainfo files - be translated. See the section about translation for more information about that.
</div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="spec-codecdata-example">
</a>2.5.2. Example file</h3></div></div></div><div class="para">
A codec meta-info file should look like this:
</div><pre class="programlisting"><span xmlns="" class="line"></span>
<span xmlns="" class="line"></span><span xmlns="" class="perl_Keyword"><?xml</span> version="1.0" encoding="UTF-8"<span xmlns="" class="perl_Keyword">?></span>
<span xmlns="" class="line"></span><span xmlns="" class="perl_Keyword"><component</span><span xmlns="" class="perl_Others"> type=</span><span xmlns="" class="perl_String">"codec"</span><span xmlns="" class="perl_Keyword">></span>
<span xmlns="" class="line"></span> <span xmlns="" class="perl_Keyword"><id></span>gstreamer-good<span xmlns="" class="perl_Keyword"></id></span>
<span xmlns="" class="line"></span> <span xmlns="" class="perl_Keyword"><metadata_license></span>CC0<span xmlns="" class="perl_Keyword"></metadata_license></span>
<span xmlns="" class="line"></span> <span xmlns="" class="perl_Keyword"><name></span>GStreamer Multimedia Codecs - Extra<span xmlns="" class="perl_Keyword"></name></span>
<span xmlns="" class="line"></span> <span xmlns="" class="perl_Keyword"><description></span>
<span xmlns="" class="line"></span> <span xmlns="" class="perl_Keyword"><p></span>
<span xmlns="" class="line"></span> This addon includes several additional codecs that are missing
<span xmlns="" class="line"></span> something - perhaps a good code review, some documentation, a set of
<span xmlns="" class="line"></span> tests, a real live maintainer, or some actual wide use.
<span xmlns="" class="line"></span> However, they might be good enough to play your media files.
<span xmlns="" class="line"></span> <span xmlns="" class="perl_Keyword"></p></span>
<span xmlns="" class="line"></span> <span xmlns="" class="perl_Keyword"><p></span>
<span xmlns="" class="line"></span> These codecs can be used to encode and decode media files where the
<span xmlns="" class="line"></span> format is not patent encumbered.
<span xmlns="" class="line"></span> <span xmlns="" class="perl_Keyword"></p></span>
<span xmlns="" class="line"></span> <span xmlns="" class="perl_Keyword"><p></span>
<span xmlns="" class="line"></span> A codec decodes audio and video for for playback or editing and is also
<span xmlns="" class="line"></span> used for transmission or storage.
<span xmlns="" class="line"></span> Different codecs are used in video-conferencing, streaming media and
<span xmlns="" class="line"></span> video editing applications.
<span xmlns="" class="line"></span> <span xmlns="" class="perl_Keyword"></p></span>
<span xmlns="" class="line"></span> <span xmlns="" class="perl_Keyword"></description></span>
<span xmlns="" class="line"></span> <span xmlns="" class="perl_Keyword"><provides></span>
<span xmlns="" class="line"></span> <span xmlns="" class="perl_Keyword"><codec></span>encoder-audio/mpeg<span xmlns="" class="perl_Keyword"></codec></span>
<span xmlns="" class="line"></span> <span xmlns="" class="perl_Keyword"><codec></span>mpegversion=(int){ 4, 2 }<span xmlns="" class="perl_Keyword"></codec></span>
<span xmlns="" class="line"></span> <span xmlns="" class="perl_Keyword"><codec></span>stream-format=(string){ adts, raw }<span xmlns="" class="perl_Keyword"></codec></span>
<span xmlns="" class="line"></span> <span xmlns="" class="perl_Keyword"><codec></span>encoder-video/mpeg<span xmlns="" class="perl_Keyword"></codec></span>
<span xmlns="" class="line"></span> <span xmlns="" class="perl_Keyword"><codec></span>systemstream=(boolean)false<span xmlns="" class="perl_Keyword"></codec></span>
<span xmlns="" class="line"></span> <span xmlns="" class="perl_Keyword"><codec></span>mpegversion=(int){ 1, 2, 4 }<span xmlns="" class="perl_Keyword"></codec></span>
<span xmlns="" class="line"></span> <span xmlns="" class="perl_Keyword"><codec></span>encoder-video/mpeg<span xmlns="" class="perl_Keyword"></codec></span>
<span xmlns="" class="line"></span> <span xmlns="" class="perl_Keyword"><codec></span>systemstream=(boolean)true<span xmlns="" class="perl_Keyword"></codec></span>
<span xmlns="" class="line"></span> <span xmlns="" class="perl_Keyword"><codec></span>encoder-video/x-xvid<span xmlns="" class="perl_Keyword"></codec></span>
<span xmlns="" class="line"></span> <span xmlns="" class="perl_Keyword"><codec></span>element-faac<span xmlns="" class="perl_Keyword"></codec></span>
<span xmlns="" class="line"></span> <span xmlns="" class="perl_Keyword"><codec></span>element-mpeg2enc<span xmlns="" class="perl_Keyword"></codec></span>
<span xmlns="" class="line"></span> <span xmlns="" class="perl_Keyword"><codec></span>element-mplex<span xmlns="" class="perl_Keyword"></codec></span>
<span xmlns="" class="line"></span> <span xmlns="" class="perl_Keyword"><codec></span>element-xviddec<span xmlns="" class="perl_Keyword"></codec></span>
<span xmlns="" class="line"></span> <span xmlns="" class="perl_Keyword"><codec></span>element-xvidenc<span xmlns="" class="perl_Keyword"></codec></span>
<span xmlns="" class="line"></span> <span xmlns="" class="perl_Keyword"></provides></span>
<span xmlns="" class="line"></span><span xmlns="" class="perl_Keyword"></component></span></pre></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="spec-codecdata-filespec">
</a>2.5.3. File specification</h3></div></div></div><div class="para">
Note that the XML root must have the <code class="literal">type</code> property set to <code class="code">codec</code>. This clearly identified this metainfo document as describing a codec.
</div><div class="variablelist"><dl class="variablelist"><dt><a id="tag-id-codec">
</a><span class="term"><id/></span></dt><dd><div class="para">
For codecs, there are no special requirements for what their <code class="literal">%{id}</code> should be. But, as for any other component, you should pick a reasonable and unique name.
</div></dd><dt><span class="term"><metadata_license/></span></dt><dd><div class="para">
The <code class="code"><metadata_license/></code> tag is required. See <a class="xref" href="chap-Metadata.html#sect-Metadata-GenericComponent">Section 2.1, “Generic Component”</a> for a description of this tag.
</div></dd><dt><a id="tag-codec-provides">
</a><span class="term"><provides/> ↪ <codec/></span></dt><dd><div class="para">
This tag is described for generic components at <a class="xref" href="chap-Metadata.html#sect-Metadata-GenericComponent">Section 2.1, “Generic Component”</a> in detail.
</div><div class="para">
You must add one or more children of type <code class="code"><codec/></code> to make it known to the system that your software is able to provide the mentioned codecs. Adding this data is required for all components of <code class="literal">type=codec</code>.
</div></dd></dl></div><div class="para">
For a component of type <code class="literal">codec</code>, the following tags are required and must be present: <a class="xref" href="sect-Metadata-Codec.html#tag-id-codec"><id/></a>, <a class="xref" href="chap-Metadata.html#tag-name"><name/></a>, <a class="xref" href="chap-Metadata.html#tag-summary"><summary/></a>, <a class="xref" href="chap-Metadata.html#tag-metadata_license"><metadata_license/></a>, <a class="xref" href="sect-Metadata-Codec.html#tag-codec-provides"><provides/> ↪ <codec/></a>.
</div></div></div><ul class="docnav"><li class="previous"><a accesskey="p" href="sect-Metadata-Fonts.html"><strong>Prev</strong>2.4. Fonts</a></li><li class="up"><a accesskey="u" href="#"><strong>Up</strong></a></li><li class="home"><a accesskey="h" href="index.html"><strong>Home</strong></a></li><li class="next"><a accesskey="n" href="sect-Metadata-InputMethod.html"><strong>Next</strong>2.6. Input Methods</a></li></ul></body></html>
|