Tracker CC Indexing

From Creative Commons
Revision as of 03:36, 23 April 2007 by Jason Kivlighn (talk | contribs) (Google Summer of Code Project: “Indexing Embedded License Claims in Tracker”)
Jump to: navigation, search

Google Summer of Code Project: “Indexing Embedded License Claims in Tracker”

In progress...

Here's some relevant sections of the Summer of Code application:


Formats to support:

 * MP3
 * OGG
 * RSS
 * SVG
 * PDF

With the exception of MP3, OGG, and RSS, all of the above formats embed information as XMP. This relieves the burden of processing such a wide variety of formats.


Probably the most significant portion of the work done will be processing of XML XMP data. Once the XML data is extracted, it will be passed to a shared piece of code that indexes each field independent of it's format.

The following is an except of raw XMP describing a work licensed under the CC Attribution 3.0 license.

<?xpacket begin= id=?>
 <rdf:Description rdf:about=
    <rdf:li xml:lang='x-default' >This work is licensed under a Creative Commons
 Attribution 3.0 License.</rdf:li>
 <rdf:Description rdf:about=
  <cc:license rdf:resource=''/>
<?xpacket end='r'?>

To fit Tracker's metadata structure, the extracted license claim would be placed into the File:License field in a form such as: "This work is licensed under a Creative Commons Attribution 3.0 License (". Such a format allows for searching the license field by both license name and URL.

License claims will similarly be extracted from RDFa metadata embedding in XML formats.


Assuming ironing out of the design phase and a clear assessment of goals of the project, coding will begin with an XMP parser. At the moment, I am not aware of any C libraries that perform this function, although I may use ccLookup (written in Python) as a guide. Tracker includes examples of parsing XML using glib which I will also follow as a guide. This is particularly important aspect that the rest of my project will build off of. It should be done before the first month.

I then will add support to Tracker to automatically read and index XMP sidecar files (I have the okay from Jamie from Tracker), which will take advantage of the XMP parser. Once Tracker indexes the metadata of independent XMP sidecar files, I will go about extending the extractors of various formats to index embedded XMP metadata. I expect that many extractors will be trivial to implement while others will require more technical research of the formats. However, most formats already take the form of XML and so extracting the relevant XMP/RDF element will be straightforward.

In addition to parsing XML for XMP/RDF metadata, I will also write a parser for RDFa for relevant formats.

I will then additionally add support for new formats to Tracker, such as SMIL and RSS. As time permits, I may also extract metadata from other image formats such as TIFF, PNG, and GIF (all of which could contain XMP metadata). Formats that take advantage of previously written code may take only a day, while others may take up to a week.

Also, time permitting, I could take my work and attempt to separate it into a stand-alone library. Doing so will be a constant consideration in the design of each stage of integration into Tracker. The feasibility of a stand-alone library, however cannot be guaranteed, as the feasibility of doing so is contingent upon the requirements for successful integration into Tracker. At the very least, I would like my work to apply outside of Tracker, such as indirectly promoting embedding license claims or gaining familiarity in order to write a library to extract license claims from outside of Tracker (such a library would be useful to Sidestream, which I mention in my bio).


Related works:

 cclookup ( - Python application for extracting license RDF metadata or license metadata from mp3s. Code may be adapted for parsing license claims in C
 ccpublisher ( - Licenses embedded by ccpublisher should all be correctly extracted.

Related links: