View source for SoC 2006: Banshee

== Current Status ==
=== On Hold ===
This project was completed for Google Summer of Code but was not able to be merged into Banshee until months later. The main tag reading framework in Banshee had moved to Gstreamer which does not support Creative Commons tags. Another Google Summer of Code project this year was able to get a patch to Gstreamer to make this possible. When I have more time, I will try and recreate this plugin and project for Banshee.

== What is it? ==
ccBanshee is a [http://code.google.com/summerofcode.html Google Summer of Code] (SoC) project that enables [http://www.banshee-project.org/ Banshee] users to view, verify, and manipulate license metadata embedded in media files. Verification is the main goal of this project and is explained in greater detail on the [[MP3]] page.

'''This project has ''three parts'' to it:'''
* '''[[cc-sharp]] Library:''' a C# library for '''''verifying''''' Creative Commons license metadata.
* '''[[ccBanshee]] Patch:''' a patch which enables [http://banshee-project.org/ Banshee] to '''''display and store''''' license information in the library.
* '''[http://svn.sourceforge.net/viewvc/cctools/banshee-license-verifier-plugin/ License Verifier Plugin]:''' a Banshee plugin which ties [[cc-sharp]] to [[ccBanshee]] using [http://banshee-project.org/Developers/Plugins Banshee's plugin interface].

== How Does it Work? ==

{| 
| colspan="2" align="center" valign="bottom"| [[Image:Screenshot-Banshee-Main.png|Valid licenses]]
|-
| colspan="2" align="center"| ''When your songs are imported or played, the license metadata is verified.<br />If the claim is valid, the appropriate logo is displayed to represent the valid license.''
|-
| colspan="2"| <br />
|-
| align="center" valign="bottom"| [[Image:Screenshot-Banshee-EditingSong.png|Viewing license metadata]] || align="center" valign="bottom"| [[Image:Screenshot-Banshee-ChooseColumns.png|Toggle the license column]]
|- 
| align="center"| ''Users can view the song license metadata URL by opening the<br />"Edit Song Metadata" window and clicking the Advanced Properties tab.'' || align="center"| ''The license column can be toggled<br />on and off via the Columns dialog.''
|}

== Where to Get it? ==
=== ccBanshee License Viewing Patch ===
The code is available on the Creative Commons Source Forge Subversion respository for [http://svn.sourceforge.net/viewcvs.cgi/cctools/ccbanshee/ browsing] or downloading with this Subversion command:
 svn checkout https://svn.sourceforge.net/svnroot/cctools/ccbanshee
=== cc-sharp ===
Information is available on the [[cc-sharp]] wiki page.
=== Banshee License Verifier Plugin ===
The code is available on the Creative Commons Source Forge Subversion respository for [http://svn.sourceforge.net/viewcvs.cgi/cctools/banshee-license-verifier-plugin/ browsing] or downloading with this Subversion command:
 svn checkout https://svn.sourceforge.net/svnroot/cctools/banshee-license-viewer-plugin

== How to Run it? ==
=== ccBanshee Patch ===
# Backup your Banshee music database (located in '''~/.gnome2/banshee/banshee.db''').
# Copy everything from '''ccbanshee/trunk/''' to your '''banshee/''' CVS directory.
# Make and install Banshee CVS.
=== cc-sharp Library ===
# Make and install cc-sharp.
# Copy '''cc-sharp.dll''' to '''/usr/lib/banshee/''' or wherever your Banshee CVS install is.
=== License Verifier Plugin ===
# Make and install the plugin.
# Run Banshee.

== Google SoC Roadmap (2006) ==
=== Project start (May 23) ===
==== May 24 ====
* Planning and Design
** Poke around in code and network with other developers
''Notes: I'm in Russia durring this time and do not have adequate computer resources for coding.''

==== June 11 ====
* Lay out [http://www.banshee-project.org/ Banshee] code for initial proof-of-concept code
** Modify database to handle basic license information
** Update library view to show database changes
''Notes: The current state of [http://www.banshee-project.org/ Banshee] will make modifying the database and PlaylistView difficult. The library view is hardcoded and a large amount of time will have to be devoted to designing an acceptable license view addition.''

==== June 18 ====
* Implement [[MP3]] ID3 tag parsing
** Integrate with whatever code already exists in [http://cvs.gnome.org/viewcvs/banshee/entagged-sharp/ entagged-sharp]
** Additions and revisions needed in [http://cvs.gnome.org/viewcvs/banshee/entagged-sharp/ entagged-sharp]
''Notes: Many updates have been made to the way license metadata is storied in the ID3 tags. More attention will be given to updating [http://cvs.gnome.org/viewcvs/banshee/entagged-sharp/ entagged-sharp] to these changes if not already done.''

==== June 25 ====
* Integrate C# CC [[License Wrappers|license wrappers]]
** Add icons to represent each license property

=== Mid-project (June 30) === 
==== July 2 ====
* Add claim validation functionality
** Write necessary network code
** Implement XML parsing of page claim validation

==== July 16 ====
* Add support for other media types such as [[OGG]]

==== July 23 ====
* [http://www.banshee-project.org/ Banshee] plugin abstraction ('''tentative''')
** Modify and update [http://www.banshee-project.org/ Banshee] plugin API to handle database changes and library view access
* Abstract Banshee-ccLicenser to plugin API

=== Project end (August 21) ===

== Developers ==
* [[User:Luke Hoersten|Luke Hoersten]] - Student developer
* [[User:NathanYergler|Nathan Yergler]] - Google SoC mentor