1.1 --- a/gst-plugins-mythtv/src/gstmythtvsrc.c Tue Apr 17 15:17:26 2007 +0100
1.2 +++ b/gst-plugins-mythtv/src/gstmythtvsrc.c Tue Apr 17 15:37:20 2007 +0100
1.3 @@ -17,12 +17,28 @@
1.4 * Boston, MA 02111-1307, USA.
1.5 */
1.6 /**
1.7 + * SECTION:element-mythtvsrc
1.8 + *
1.9 + * <refsect2>
1.10 + * <para>
1.11 + * MythTVSrc allows to access a remote MythTV backend streaming Video/Audio server,
1.12 + * and to render audio and video content through a TCP/IP connection to a specific
1.13 + * port on this server, and based on a known MythTV protocol that is based on
1.14 + * some message passing, such as REQUEST_BLOCK on a specified number of bytes, to get
1.15 + * some chunk of remote file data.
1.16 + * You should pass the information aboute the remote MythTV backend server
1.17 + * through the <link linkend="GstMythTVSrc--location">location</link> property.
1.18 + * </para>
1.19 + * <title>Examples</title>
1.20 + * <para>
1.21 * If you want to get the LiveTV content (set channel, TV tuner, RemoteEncoder,
1.22 * Recorder),
1.23 * put the following URI:
1.24 *
1.25 - * myth://xxx.xxx.xxx.xxx:6543/livetv?channel=BBC
1.26 - *
1.27 + * <programlisting>
1.28 + * myth://xxx.xxx.xxx.xxx:6543/livetv?channel=BBC
1.29 + * </programlisting>
1.30 + *
1.31 * This URI will say to the gmyth library to configure the Recorder instance (used to
1.32 * change the channel, start the TV multimedia content transmition, etc.), using
1.33 * the IP address (xxx.xxx.xxx.xxx) and port number (6543) of the MythTV backend
1.34 @@ -30,8 +46,10 @@
1.35 *
1.36 * To get a already recorded the MythTV NUV file, put the following URI:
1.37 *
1.38 - * myth://xxx.xxx.xxx.xxx:6543/filename.nuv
1.39 - *
1.40 + * <programlisting>
1.41 + * myth://xxx.xxx.xxx.xxx:6543/filename.nuv
1.42 + * </programlisting>
1.43 + *
1.44 * This URI will say to the gmyth library to configure the Recorder instance (used to
1.45 * change the channel, start the TV multimedia content transmition, etc.), using
1.46 * the IP address (xxx.xxx.xxx.xxx) and port number (6543) of the MythTV backend
1.47 @@ -40,13 +58,16 @@
1.48 * Another possible way to use the LiveTV content, and just in the case you want to
1.49 * use the mysql database, put the location URI in the following format:
1.50 *
1.51 - * myth://mythtv:mythtv@xxx.xxx.xxx.xxx:6543/?mythconverg&channel=9
1.52 + * <programlisting>
1.53 + * myth://mythtv:mythtv@xxx.xxx.xxx.xxx:6543/?mythconverg&channel=9
1.54 + * </programlisting>
1.55 *
1.56 * Where the first field is the protocol (myth), the second and third are user
1.57 * name (mythtv) and password (mythtv), then backend host name and port number,
1.58 * and the last field is the database name (mythconverg).
1.59 + * </para>
1.60 + * </refsect2>
1.61 */
1.62 -
1.63 #ifdef HAVE_CONFIG_H
1.64 #include "config.h"
1.65 #endif
1.66 @@ -66,25 +87,25 @@
1.67 GST_DEBUG_CATEGORY_STATIC (mythtvsrc_debug);
1.68 #define GST_CAT_DEFAULT mythtvsrc_debug
1.69
1.70 -#define GST_GMYTHTV_ID_NUM 1
1.71 +#define GST_GMYTHTV_ID_NUM 1
1.72
1.73 -#define GST_GMYTHTV_CHANNEL_DEFAULT_NUM (-1)
1.74 +#define GST_GMYTHTV_CHANNEL_DEFAULT_NUM (-1)
1.75
1.76 #define GMYTHTV_VERSION_DEFAULT 30
1.77
1.78 -#define GMYTHTV_TRANSFER_MAX_WAITS 100
1.79 +#define GMYTHTV_TRANSFER_MAX_WAITS 100
1.80
1.81 -#define GMYTHTV_TRANSFER_MAX_RESENDS 2
1.82 +#define GMYTHTV_TRANSFER_MAX_RESENDS 2
1.83
1.84 -#define GMYTHTV_TRANSFER_MAX_BUFFER (128*1024)
1.85 +#define GMYTHTV_TRANSFER_MAX_BUFFER (128*1024)
1.86
1.87 -#define MAX_READ_SIZE (4*1024)
1.88 +#define MAX_READ_SIZE (4*1024)
1.89
1.90 -#define GST_FLOW_ERROR_NO_DATA (-101)
1.91 +#define GST_FLOW_ERROR_NO_DATA (-101)
1.92
1.93 -#define REQUEST_MAX_SIZE (64*1024)
1.94 +#define REQUEST_MAX_SIZE (64*1024)
1.95
1.96 -#define INTERNAL_BUFFER_SIZE (90*1024)
1.97 +#define INTERNAL_BUFFER_SIZE (90*1024)
1.98
1.99 static const GstElementDetails gst_mythtv_src_details =
1.100 GST_ELEMENT_DETAILS ("MythTV client source",