rygel r774 - trunk/src/rygel

[zeeshanak svn gnome org]

Author: zeeshanak
Date: Sat Mar 28 00:46:45 2009
New Revision: 774
URL: http://svn.gnome.org/viewvc/rygel?rev=774&view=rev

Log:
Some basic documentation for recently added classes.

Modified:
   trunk/src/rygel/rygel-l16-transcoder-bin.vala
   trunk/src/rygel/rygel-l16-transcoder.vala
   trunk/src/rygel/rygel-mp2ts-transcoder-bin.vala
   trunk/src/rygel/rygel-mp2ts-transcoder.vala
   trunk/src/rygel/rygel-mp3-transcoder-bin.vala
   trunk/src/rygel/rygel-mp3-transcoder.vala
   trunk/src/rygel/rygel-transcode-manager.vala
   trunk/src/rygel/rygel-transcoder.vala

Modified: trunk/src/rygel/rygel-l16-transcoder-bin.vala
==============================================================================
--- trunk/src/rygel/rygel-l16-transcoder-bin.vala	(original)
+++ trunk/src/rygel/rygel-l16-transcoder-bin.vala	Sat Mar 28 00:46:45 2009
@@ -23,6 +23,10 @@
 using Rygel;
 using Gst;
 
+/**
+ * A Gst.Bin derivative that implements transcoding of any type of media (using
+ * decodebin2) to linear PCM audio.
+ */
 internal class Rygel.L16TranscoderBin : Gst.Bin {
     private const string DECODEBIN = "decodebin2";
 

Modified: trunk/src/rygel/rygel-l16-transcoder.vala
==============================================================================
--- trunk/src/rygel/rygel-l16-transcoder.vala	(original)
+++ trunk/src/rygel/rygel-l16-transcoder.vala	Sat Mar 28 00:46:45 2009
@@ -29,6 +29,10 @@
     BIG = ByteOrder.BIG_ENDIAN
 }
 
+/**
+ * Transcoder for linear PCM audio (LPCM). This element uses L16TrancoderBin for
+ * actual transcoding.
+ */
 internal class Rygel.L16Transcoder : Rygel.Transcoder {
     private const int CHANNELS = 2;
     private const int FREQUENCY = 44100;

Modified: trunk/src/rygel/rygel-mp2ts-transcoder-bin.vala
==============================================================================
--- trunk/src/rygel/rygel-mp2ts-transcoder-bin.vala	(original)
+++ trunk/src/rygel/rygel-mp2ts-transcoder-bin.vala	Sat Mar 28 00:46:45 2009
@@ -23,6 +23,10 @@
 using Rygel;
 using Gst;
 
+/**
+ * A Gst.Bin derivative that implements transcoding of any type of media (using
+ * decodebin2) to mpeg transport stream containing mpeg 2 video and mp2 audio.
+ */
 internal class Rygel.MP2TSTranscoderBin : Gst.Bin {
     private const string DECODEBIN = "decodebin2";
     private const string MUXER = "mpegtsmux";

Modified: trunk/src/rygel/rygel-mp2ts-transcoder.vala
==============================================================================
--- trunk/src/rygel/rygel-mp2ts-transcoder.vala	(original)
+++ trunk/src/rygel/rygel-mp2ts-transcoder.vala	Sat Mar 28 00:46:45 2009
@@ -29,6 +29,10 @@
     HD
 }
 
+/**
+ * Transcoder for mpeg transport stream containing mpeg 2 video and mp2 audio.
+ * This element uses MP2TSTrancoderBin for actual transcoding.
+ */
 internal class Rygel.MP2TSTranscoder : Rygel.Transcoder {
     // HD
     private const int[] WIDTH = {640, 1920};

Modified: trunk/src/rygel/rygel-mp3-transcoder-bin.vala
==============================================================================
--- trunk/src/rygel/rygel-mp3-transcoder-bin.vala	(original)
+++ trunk/src/rygel/rygel-mp3-transcoder-bin.vala	Sat Mar 28 00:46:45 2009
@@ -28,6 +28,10 @@
     THREE = 2
 }
 
+/**
+ * A Gst.Bin derivative that implements transcoding of any type of media (using
+ * decodebin2) to mpeg 1 layer 2 and 3 format.
+ */
 internal class Rygel.MP3TranscoderBin : Gst.Bin {
     private const string DECODEBIN = "decodebin2";
 

Modified: trunk/src/rygel/rygel-mp3-transcoder.vala
==============================================================================
--- trunk/src/rygel/rygel-mp3-transcoder.vala	(original)
+++ trunk/src/rygel/rygel-mp3-transcoder.vala	Sat Mar 28 00:46:45 2009
@@ -24,6 +24,10 @@
 using Gst;
 using GUPnP;
 
+/**
+ * Transcoder for mpeg 1 layer 2 and 3 audio. This element uses MP3TrancoderBin
+ * for actual transcoding.
+ */
 internal class Rygel.MP3Transcoder : Rygel.Transcoder {
     private const int BITRATE = 256;
 

Modified: trunk/src/rygel/rygel-transcode-manager.vala
==============================================================================
--- trunk/src/rygel/rygel-transcode-manager.vala	(original)
+++ trunk/src/rygel/rygel-transcode-manager.vala	Sat Mar 28 00:46:45 2009
@@ -26,6 +26,11 @@
 using Gee;
 using Gst;
 
+/**
+ * Responsible for management of all transcoders:
+ *    - gets the appropriate transcoder given a transcoding target.
+ *    - provide all possible transcoding resources for items.
+ */
 internal abstract class Rygel.TranscodeManager : GLib.Object {
     private ArrayList<Transcoder> transcoders;
 

Modified: trunk/src/rygel/rygel-transcoder.vala
==============================================================================
--- trunk/src/rygel/rygel-transcoder.vala	(original)
+++ trunk/src/rygel/rygel-transcoder.vala	Sat Mar 28 00:46:45 2009
@@ -25,6 +25,10 @@
 using GUPnP;
 using Gee;
 
+/**
+ * The base Transcoder class. Each implementation derives from it and must
+ * at least implement create_source method.
+ */
 internal abstract class Rygel.Transcoder : GLib.Object {
     public string mime_type { get; protected set; }
     public string dlna_profile { get; protected set; }
@@ -41,6 +45,13 @@
         this.upnp_class = upnp_class;
     }
 
+    /**
+     * Creates a transcoding source.
+     *
+     * @param src the original (non-transcoding) source
+     *
+     * @return      the new transcoding source
+     */
     public abstract Element create_source (Element src) throws Error;
 
     public void add_resources (ArrayList<DIDLLiteResource?> resources,