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
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
|
<?xml version="1.0"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<refentry id="RBEncoder">
<refmeta>
<refentrytitle role="top_of_page" id="RBEncoder.top_of_page">RBEncoder</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>RHYTHMBOX Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>RBEncoder</refname>
<refpurpose>audio transcoder interface</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv id="RBEncoder.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>
<synopsis>
<link linkend="RBEncoder-struct">RBEncoder</link>;
<link linkend="RBEncoder">RBEncoder</link>* <link linkend="rb-encoder-new">rb_encoder_new</link> (void);
<link linkend="gboolean">gboolean</link> <link linkend="rb-encoder-encode">rb_encoder_encode</link> (<link linkend="RBEncoder">RBEncoder</link> *encoder,
<link linkend="RhythmDBEntry">RhythmDBEntry</link> *entry,
const <link linkend="char">char</link> *dest,
<link linkend="GList">GList</link> *mime_types);
<link linkend="void">void</link> <link linkend="rb-encoder-cancel">rb_encoder_cancel</link> (<link linkend="RBEncoder">RBEncoder</link> *encoder);
<link linkend="gboolean">gboolean</link> <link linkend="rb-encoder-get-preferred-mimetype">rb_encoder_get_preferred_mimetype</link> (<link linkend="RBEncoder">RBEncoder</link> *encoder,
<link linkend="GList">GList</link> *mime_types,
<link linkend="char">char</link> **mime,
<link linkend="char">char</link> **extension);
</synopsis>
</refsynopsisdiv>
<refsect1 id="RBEncoder.object-hierarchy" role="object_hierarchy">
<title role="object_hierarchy.title">Object Hierarchy</title>
<synopsis>
<link linkend="GInterface">GInterface</link>
+----RBEncoder
</synopsis>
</refsect1>
<refsect1 id="RBEncoder.signals" role="signal_proto">
<title role="signal_proto.title">Signals</title>
<synopsis>
"<link linkend="RBEncoder-completed">completed</link>" : Run Last
"<link linkend="RBEncoder-error">error</link>" : Run Last
"<link linkend="RBEncoder-progress">progress</link>" : Run Last
</synopsis>
</refsect1>
<refsect1 id="RBEncoder.description" role="desc">
<title role="desc.title">Description</title>
<para>
The RBEncoder interface provides transcoding between audio formats based on
MIME types.
</para>
<para>
The encoder picks the output format from a list provided by the caller,
limited by the available codecs. It operatees asynchronously and provides
status updates in the form of signals.
</para>
<para>
A new encoder instance should be created for each file that is transcoded.</para>
<para>
</para>
</refsect1>
<refsect1 id="RBEncoder.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="RBEncoder-struct" role="struct">
<title>RBEncoder</title>
<indexterm zone="RBEncoder-struct"><primary>RBEncoder</primary></indexterm><programlisting>typedef struct _RBEncoder RBEncoder;</programlisting>
<para>
</para></refsect2>
<refsect2 id="rb-encoder-new" role="function">
<title>rb_encoder_new ()</title>
<indexterm zone="rb-encoder-new"><primary>rb_encoder_new</primary></indexterm><programlisting><link linkend="RBEncoder">RBEncoder</link>* rb_encoder_new (void);</programlisting>
<para>
Creates a new <link linkend="RBEncoder"><type>RBEncoder</type></link> instance.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the new <link linkend="RBEncoder"><type>RBEncoder</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="rb-encoder-encode" role="function">
<title>rb_encoder_encode ()</title>
<indexterm zone="rb-encoder-encode"><primary>rb_encoder_encode</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> rb_encoder_encode (<link linkend="RBEncoder">RBEncoder</link> *encoder,
<link linkend="RhythmDBEntry">RhythmDBEntry</link> *entry,
const <link linkend="char">char</link> *dest,
<link linkend="GList">GList</link> *mime_types);</programlisting>
<para>
Initiates encoding. A target MIME type will be selected from the list
given. If the source format is in the list, that will be chosen regardless
of order. Otherwise, the first type in the list that the encoder can produce
will be selected.
</para>
<para>
Encoding takes places asynchronously. If the return value is TRUE, the caller
should wait for a 'completed' or 'error' signal to indicate that it has finished.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>encoder</parameter> :</term>
<listitem><simpara> the <link linkend="RBEncoder"><type>RBEncoder</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>entry</parameter> :</term>
<listitem><simpara> the <link linkend="RhythmDBEntry"><type>RhythmDBEntry</type></link> to transcode
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>dest</parameter> :</term>
<listitem><simpara> destination file URI
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>mime_types</parameter> :</term>
<listitem><simpara> a <link linkend="GList"><type>GList</type></link> of target MIME types in order of preference
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE if encoding has started
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="rb-encoder-cancel" role="function">
<title>rb_encoder_cancel ()</title>
<indexterm zone="rb-encoder-cancel"><primary>rb_encoder_cancel</primary></indexterm><programlisting><link linkend="void">void</link> rb_encoder_cancel (<link linkend="RBEncoder">RBEncoder</link> *encoder);</programlisting>
<para>
Attempts to cancel any in progress encoding. The encoder should
delete the destination file, if it created one.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>encoder</parameter> :</term>
<listitem><simpara> a <link linkend="RBEncoder"><type>RBEncoder</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="rb-encoder-get-preferred-mimetype" role="function">
<title>rb_encoder_get_preferred_mimetype ()</title>
<indexterm zone="rb-encoder-get-preferred-mimetype"><primary>rb_encoder_get_preferred_mimetype</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> rb_encoder_get_preferred_mimetype (<link linkend="RBEncoder">RBEncoder</link> *encoder,
<link linkend="GList">GList</link> *mime_types,
<link linkend="char">char</link> **mime,
<link linkend="char">char</link> **extension);</programlisting>
<para>
Identifies the first MIME type in the list that the encoder can actually encode to.
The file extension (eg. '.mp3' for audio/mpeg) associated with the selected type is
also returned.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>encoder</parameter> :</term>
<listitem><simpara> a <link linkend="RBEncoder"><type>RBEncoder</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>mime_types</parameter> :</term>
<listitem><simpara> a <link linkend="GList"><type>GList</type></link> of MIME type strings in order of preference
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>mime</parameter> :</term>
<listitem><simpara> returns the selected MIME type, if any
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>extension</parameter> :</term>
<listitem><simpara> returns the file extension associated with the selected MIME type, if any
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE if a format was identified
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
<refsect1 id="RBEncoder.signal-details" role="signals">
<title role="signals.title">Signal Details</title>
<refsect2 id="RBEncoder-completed"><title>The <literal>"completed"</literal> signal</title>
<indexterm zone="RBEncoder-completed"><primary>RBEncoder::completed</primary></indexterm><programlisting><link linkend="void">void</link> user_function (<link linkend="RBEncoder">RBEncoder</link> *encoder,
<link linkend="guint64">guint64</link> arg1,
<link linkend="gpointer">gpointer</link> user_data) : Run Last</programlisting>
<para>
Emitted when the encoding process is complete. The destination file
will be closed and flushed to disk when this occurs.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>encoder</parameter> :</term>
<listitem><simpara> the <link linkend="RBEncoder"><type>RBEncoder</type></link> instance
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter> :</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
</variablelist></refsect2><refsect2 id="RBEncoder-error"><title>The <literal>"error"</literal> signal</title>
<indexterm zone="RBEncoder-error"><primary>RBEncoder::error</primary></indexterm><programlisting><link linkend="void">void</link> user_function (<link linkend="RBEncoder">RBEncoder</link> *encoder,
<link linkend="gpointer">gpointer</link> error,
<link linkend="gpointer">gpointer</link> user_data) : Run Last</programlisting>
<para>
Emitted when an error occurs during encoding.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>encoder</parameter> :</term>
<listitem><simpara> the <link linkend="RBEncoder"><type>RBEncoder</type></link> instance
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>error</parameter> :</term>
<listitem><simpara> a <link linkend="GError"><type>GError</type></link> describing the error
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter> :</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
</variablelist></refsect2><refsect2 id="RBEncoder-progress"><title>The <literal>"progress"</literal> signal</title>
<indexterm zone="RBEncoder-progress"><primary>RBEncoder::progress</primary></indexterm><programlisting><link linkend="void">void</link> user_function (<link linkend="RBEncoder">RBEncoder</link> *encoder,
<link linkend="gdouble">gdouble</link> fraction,
<link linkend="gpointer">gpointer</link> user_data) : Run Last</programlisting>
<para>
Emitted regularly during the encoding process to provide progress updates.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>encoder</parameter> :</term>
<listitem><simpara> the <link linkend="RBEncoder"><type>RBEncoder</type></link> instance
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>fraction</parameter> :</term>
<listitem><simpara> progress as a fraction (0..1)
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter> :</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
</refentry>
|
