Project

General

Profile

Htsp » History » Version 101

Jaroslav Kysela, 2014-10-19 21:10

1 75 Adam Sutton
h1. Home Tv Streaming Protocol (HTSP) - Version 10
2 1 Andreas Smas
3
h2. General
4 58 sbi -
5
HTSP is a TCP based protocol primarily intended for streaming of live TV and related meta data such as channels, group of channels (called tags in HTSP) and electronic program guide (EPG) information.
6
7 61 Adam Sutton
The transmission and reception of a channel over HTSP is referred to as a subscription. A single HTSP session can handle as many concurrent subscriptions as the bandwidth and CPU permits.
8 1 Andreas Smas
9 61 Adam Sutton
The HTSP server in tvheadend has a payload-aware scheduler for prioritizing more important packets (such as I-frames) before less important ones (such as B-frames). This makes HTSP suitable for long-distance transmissions and/or paths with non-perfect delivery.
10 1 Andreas Smas
(It has been tested with a server in Stockholm and the client in Berlin).
11
12 17 Andreas Smas
For information about the HTSP wire format please read [[htsmsgbinary|HTSMSG binary format]]
13 1 Andreas Smas
14 61 Adam Sutton
If you're looking to develop a new client, there are several existing client implementations from which you might be able to gain knowledge:
15
16
* "XBMC":https://github.com/opdenkamp/xbmc/tree/master/xbmc/pvrclients/tvheadend
17
* "Showtime":https://github.com/andoma/showtime/tree/master/src/backend/htsp
18 65 John Törnblom
* "TVHGuide":https://github.com/john-tornblom/TVHGuide
19 69 Adam Sutton
* "PyHTSP":https://github.com/adamsutton/tvheadend/tree/master/lib/py/tvh/htsp.py (This is a demo client and is WIP, it has limited functionality).
20 1 Andreas Smas
21 22 Andreas Smas
----
22 18 Andreas Smas
23 84 Jaroslav Kysela
h2. Protocol Changes
24 83 Jaroslav Kysela
25 100 Jaroslav Kysela
h3. v13..v14
26
27
* added getChannel method
28
29 85 Jaroslav Kysela
h3. v12..v13
30
31
* added addAutorecEntry method
32
* added deleteAutorecEntry method
33 92 Jaroslav Kysela
* added autorecEntryAdd, autorecEntryUpdate, autorecEntryDelete server-to-client methods
34 85 Jaroslav Kysela
* extended channelAdd server-to-client method
35 87 Jaroslav Kysela
** added channelNumberMinor (for {major}.{minor} channel numbers)
36
* extended dvrEntryAdd and dvrEntryUpdate server-to-client methods
37 88 Jaroslav Kysela
** added eventId, autorecId, startExtra, stopExtra, retention, priority, contentType fields
38 97 Jaroslav Kysela
* extended addDvrEntry method
39
** added retention
40
* extended updateDvrEntry method
41
** added retention, priority
42
* extended epgQuery method
43
** added minduration, maxduration
44 85 Jaroslav Kysela
* added subscriptionGrace server-to-client method
45 97 Jaroslav Kysela
46 85 Jaroslav Kysela
47 83 Jaroslav Kysela
h3. v11..v12
48
49
* added subscriptionFilterStream method
50
* added getDvrCutpoints method
51
52
53
h3. v10..v11
54
55 86 Jaroslav Kysela
* added audio_type in the subscriptionStart server-to-client method
56 83 Jaroslav Kysela
* added getCodecs method
57
58 58 sbi -
h2. Communication
59
60
61 69 Adam Sutton
This communication is currently implemented by using htsmsg's. All strings are encoded as UTF-8.
62 1 Andreas Smas
63
There are two distinct ways for communication within HTSP.
64
65 28 Andreas Smas
Apart from this there is a number of messages that needs to be exchanged during login, see the login section below.
66
67 1 Andreas Smas
68 58 sbi -
h3. RPC communication
69
70
71 1 Andreas Smas
There is a normal RPC way of doing things. I.e. the client sends a request and the server responds with a reply. All the RPC methods are listed below as the 'Client to Server' methods. Apart from all message fields listed within each message type the client can add an additional field:
72 18 Andreas Smas
73 17 Andreas Smas
RPC request extra fields:
74 58 sbi -
<pre>
75 28 Andreas Smas
seq              int  optional   Sequence number. This field will be echoed back by the server in the reply.
76 1 Andreas Smas
username         str  optional   Username, in combination with 'digest' this can be used to raise the privileges
77
                                 for the session in combination with invocation of a method. 
78 28 Andreas Smas
digest           bin  optional   Used to raise privileges.
79 58 sbi -
</pre>
80 18 Andreas Smas
81 1 Andreas Smas
The followings field should be used by the client to match the reply with the request.
82
All replies are guaranteed to arrive in the same order as the requests.
83
Even so, probably the best way to implement the request-reply client is by taking advantage of the 'seq' field.
84
85
RPC reply extra fields:
86 58 sbi -
<pre>
87 18 Andreas Smas
seq              int  optional   Sequence number. Same as in the request.
88 19 Andreas Smas
error            str  optional   If present an error has occurred and the text describes the error.
89
noaccess         int  optional   If present and set to '1' the user is prohibited from invoking the method due to 
90 1 Andreas Smas
                                 access restrictions. 
91 58 sbi -
</pre>
92 1 Andreas Smas
93 18 Andreas Smas
94 58 sbi -
h3. Streaming communication
95
96
97 19 Andreas Smas
For streaming of live TV and various related messages the server will continuously push data to the client.
98 1 Andreas Smas
These messages are referred to as asynchronous messages and always have the 'method' field set and never have the 'seq' field set.
99
Also, the client can enable an additional asyncMetadata mode and by doing so it will be notified by the server when meta data changes. (EPG updates, creation of channels and tags, etc). 
100
101 34 Andreas Smas
102 58 sbi -
h3. Authentication
103
104
105 29 Andreas Smas
In Tvheadend, each method has an associated access restriction. Currently there is only one restriction (Streaming). However, this may change in the future.
106 1 Andreas Smas
107
Privileges for these restrictions may be granted in two ways: Username + Password and/or Source IP address.
108
Therefore it is possible to gain permissions to the system without entering a username and password.
109
While this is really useful it also complicates the authentication schema a bit.
110
Upon connect the initial privileges will be raised based on the source address.
111
112
Before any username / password based authentication has taken place the client must have
113 34 Andreas Smas
obtained a challenge (which stays fixed for the session). This is done via the 'hello' method.
114 1 Andreas Smas
115
In principle it's possible to use two different authentication idioms with HTSP.
116
Depending on how your application works one or another may be more suitable.
117
While they do not really differ from a protocol point of view it's worth mentioning a bit about them here:
118
119
120 58 sbi -
h3. Initial login authentication
121
122
123 1 Andreas Smas
The client performs all of its authentication using the 'login' method.
124
125
It may choose to send:
126 58 sbi -
* Username and password: Privileges will be raised based on these credentials.
127
* Username only: Privileges will be based on just the source address. The username will be used for various logging purposes.
128
* Nothing: Privileges will be based on just the source address.
129 1 Andreas Smas
130
If no privileges are granted after the login message has been received by the server (i.e. both network and username + password based)
131
the server will reply with 'noaccess' set to 1. A client that only employs initial login should honor this flag and ask the
132
user for a username + password and retry by using the 'authenticate' method. I.e. it should not send the 'login' method again.
133
134
135 58 sbi -
h3. On-demand authentication
136
137
138 1 Andreas Smas
The client performs all of its authentication when it needs to.
139
140
When using this method, the client will check every RPC reply for the 'noaccess' field.
141
If it set to 1 it whould ask the user for username + password and retry the request but also
142 58 sbi -
add 'username' and 'digest' to the original message. (See _RPC request extra fields_ above)
143 1 Andreas Smas
144
Typically it would not send a username or digest during login.
145 29 Andreas Smas
146
----
147 34 Andreas Smas
148 66 Adam Sutton
h2. Client to Server (RPC) methods
149 34 Andreas Smas
150
h3. hello
151 58 sbi -
152
Used to identify the client toward the server and to get the session challenge used to
153 1 Andreas Smas
hash passwords into digests. The client can request a different version of the HTSP
154 66 Adam Sutton
protocol with this method. If no 'hello' message is sent the server assumes latest version
155 1 Andreas Smas
is to be used.
156 34 Andreas Smas
157 66 Adam Sutton
Client/Server should select lowest common version, if this is not possible connection should be terminated.
158 1 Andreas Smas
159
Request message fields:
160
<pre>
161 66 Adam Sutton
htspversion        u32   required   Client preferred HTSP version.
162
clientname         str   required   Client software name.
163
clientversion      str   required   Client software version.
164 58 sbi -
</pre>
165 1 Andreas Smas
166
Reply message fields:
167 34 Andreas Smas
<pre>
168 66 Adam Sutton
htspversion        u32   required   The server supports all versions of the protocol up to and including this number.
169
servername         str   required   Server software name.
170
serverversion      str   required   Server software version.
171
servercapability   str[] required   Server capabilities (Added in version 6)
172 1 Andreas Smas
challenge          bin   required   32 bytes randomized data used to generate authentication digests
173 73 Adam Sutton
webroot            str   optional   Server HTTP webroot (Added in version 8)
174
                                    Note: any access to TVH webserver should include this at start of URL path
175 1 Andreas Smas
</pre>
176
177 70 Adam Sutton
Note: possible values for servercapability[]:
178
<pre>
179
cwc                Descrambling available
180
v4l                Analogue TV available
181
linuxdvb           Linux DVB API available
182 1 Andreas Smas
imagecache         Image caching available
183 73 Adam Sutton
timeshift          Timeshifting available (Added in version 9).
184 70 Adam Sutton
</pre>
185
186 58 sbi -
h3. authenticate
187 1 Andreas Smas
188
This can be used to issue authentication without doing anything else.
189
If no privileges are gained it will return with 'noaccess' set to 1.
190
191 33 Andreas Smas
Request message fields:
192 1 Andreas Smas
<pre>
193 66 Adam Sutton
None   
194 33 Andreas Smas
</pre>
195 58 sbi -
196
Reply message fields:
197
<pre>
198 66 Adam Sutton
noaccess           u32   optional   If set to 1, no privileges were granted.
199 33 Andreas Smas
</pre>
200 1 Andreas Smas
201
----
202
203 66 Adam Sutton
h3. getDiskSpace (Added in version 3)
204 58 sbi -
205 66 Adam Sutton
Return diskspace status from Tvheadend's PVR storage
206 1 Andreas Smas
207 66 Adam Sutton
Request message fields:
208
<pre>
209
None
210
</pre>
211 1 Andreas Smas
212 66 Adam Sutton
Reply message fields:
213
<pre>
214
freediskspace      s64   required   Bytes available.
215
totaldiskspace     s64   required   Total capacity.
216
</pre>
217 1 Andreas Smas
218 66 Adam Sutton
h3. getSysTime (Added in version 3)
219 1 Andreas Smas
220 66 Adam Sutton
Return system time on the server.
221
222 1 Andreas Smas
Request message fields:
223
<pre>
224
None
225
</pre>
226
227
Reply message fields:
228 58 sbi -
<pre>
229 66 Adam Sutton
time               s64  required   UNIX time.
230
timezone           s32  required   Minutes west of GMT.
231 1 Andreas Smas
</pre>
232 23 Andreas Smas
233 1 Andreas Smas
----
234
235 66 Adam Sutton
h3. enableAsyncMetadata
236 1 Andreas Smas
237 66 Adam Sutton
When this is enabled the client will get continuous updates from the server about added, update or deleted channels, tags, dvr and epg entries.
238 1 Andreas Smas
239 66 Adam Sutton
An interactive application that presents the user with information about these things should probably enable this and the implement the various server to client methods.
240 1 Andreas Smas
241
Request message fields:
242
<pre>
243 66 Adam Sutton
epg                u32   optional   Set to 1, to include EPG data in async, implied by epgMaxTime (Added in version 6).
244
lastUpdate         s64   optional   Only provide metadata that has changed since this time (Added in version 6).
245
epgMaxTime         s64   optional   Maximum time to return EPG data up to (Added in version 6)
246
language           str   optional   RFC 2616 compatible language list (Added in version 6)
247 1 Andreas Smas
</pre>
248
249
Reply message fields:
250
<pre>
251 66 Adam Sutton
None
252 1 Andreas Smas
</pre>
253
254 66 Adam Sutton
Once the reply as been sent the initial data set will be provided, and then updates will arrive asynchronously after that. The initial data dump is sent using the following messages:
255 1 Andreas Smas
256 66 Adam Sutton
<pre>
257
tagAdd                   optional
258
channelAdd               optional
259
tagUpdate                optional
260
dvrEntryAdd              optional
261
eventAdd                 optional   (Added in version 6)
262
initialSyncComplete      required
263
</pre>
264 1 Andreas Smas
265 66 Adam Sutton
----
266 1 Andreas Smas
267 101 Jaroslav Kysela
h3. getChannel (Added in version 14)
268
269
Request information about the given channel.
270
271
Request message fields:
272
<pre>
273
channelId          u32   required   Channel ID.
274
</pre>
275
276
Reply message fields:
277
<pre>
278
see channelAdd
279
</pre>
280
281
----
282
283 66 Adam Sutton
h3. getEvent
284 1 Andreas Smas
285 66 Adam Sutton
Request information about the given event. An event typically corresponds to a program on a channel.
286 1 Andreas Smas
287 66 Adam Sutton
The language field in the request allows preference for languages to be requested for the various string fields.
288
289 1 Andreas Smas
Request message fields:
290 45 mdd -
<pre>
291 66 Adam Sutton
eventId            u32   required   Event ID.
292
language           str   optional   RFC 2616 compatible language list (Added in version 6)
293 1 Andreas Smas
</pre>
294
295
Reply message fields:
296
<pre>
297 66 Adam Sutton
see eventAdd
298 1 Andreas Smas
</pre>
299
300 66 Adam Sutton
h3. getEvents (Added in version 4)
301 1 Andreas Smas
302 66 Adam Sutton
Request information about a set of events. If no options are specified the entire EPG database will be returned.
303 57 sbi -
304 58 sbi -
Request message fields:
305 1 Andreas Smas
<pre>
306 66 Adam Sutton
eventId            u32   optional   Event ID to begin from (Optional since version 6)
307
channelId          u32   optional   Channel ID to get data for (Added in version 6)
308
numFollowing       u32   optional   Number of events to add (Optional since version 6)
309
maxTime            u64   optional   Maximum time to return data up to (Added in version 6)
310
language           str   optional   RFC 2616 compatible language list (Added in version 6)
311 1 Andreas Smas
</pre>
312
313
Reply message fields:
314
<pre>
315 66 Adam Sutton
events             msg[] required   List of events, using response message fields from eventAdd
316 1 Andreas Smas
</pre>
317 45 mdd -
318 66 Adam Sutton
h3. epgQuery (Added in version 4)
319 1 Andreas Smas
320 66 Adam Sutton
Query the EPG (event titles) and optionally restrict to channel/tag/content type.
321 1 Andreas Smas
322 66 Adam Sutton
Request message fields:
323
<pre>
324
query              str   required  Title regular expression to search for
325
channelId          u32   optional  [[ChannelId]] to restrict search to
326
tagId              u32   optional  [[TagId]] to restrict search to
327
contentType        u32   optional  DVB content type to restrict search to
328 98 Jaroslav Kysela
minduration        u32   optional  Minimal duration in seconds (Added in version 13)
329
maxduration        u32   optional  Maximal duration in seconds (Added in version 13)
330 66 Adam Sutton
language           str   optional  RFC 2616 compatible language list for title (Added in version 6)
331
full               u32   optional  Output full event list rather than just IDs
332
</pre>
333 1 Andreas Smas
334 66 Adam Sutton
Reply message fields:
335 1 Andreas Smas
336 66 Adam Sutton
if full == 1
337
<pre>
338
events             msg[] optional   List of events, using response message fields from eventAdd
339
</pre>
340
else
341
<pre>
342
eventIds           u32[] optional  List of eventIds that match the query
343
</pre>
344 1 Andreas Smas
345 66 Adam Sutton
h3. getEpgObject
346
347
Get detailed EPG Object info.
348
349 58 sbi -
Request message fields:
350 1 Andreas Smas
<pre>
351 66 Adam Sutton
id                 u32   required  Object ID
352
type               u32   optional  Object type
353 1 Andreas Smas
</pre>
354 58 sbi -
355 1 Andreas Smas
Reply message fields:
356 66 Adam Sutton
357 1 Andreas Smas
<pre>
358 66 Adam Sutton
TODO
359 1 Andreas Smas
</pre>
360
361 58 sbi -
----
362 1 Andreas Smas
363 66 Adam Sutton
h3. addDvrEntry (Added in version 4)
364 1 Andreas Smas
365 66 Adam Sutton
Create a new DVR entry. Either eventId or channelId, start and stop must be specified.
366 1 Andreas Smas
367
Request message fields:
368
<pre>
369 66 Adam Sutton
eventId            u32   optional   Event ID (Optional since version 5).
370
channelId          u32   optional   Channel ID (Added in version 5)
371
start              s64   optional   Time to start recording (Added in version 5)
372
stop               s64   optional   Time to stop recording (Added in version 5)
373 96 Jaroslav Kysela
retention          u32   optional   Retention time in days (Added in version 13)
374 66 Adam Sutton
creator            str   optional   Name of the event creator (Added in version 5)
375
priority           u32   optional   Recording priority (Added in version 5)
376
startExtra         s64   optional   Pre-recording buffer in minutes (Added in version 5)
377
stopExtra          s64   optional   Post-recording buffer in minutes (Added in version 5)
378
title              str   optional   Recording title, if no eventId (Added in version 6)
379
description        str   optional   Recording description, if no eventId (Added in version 5)
380
configName         str   optional   DVR configuration name
381 40 Andreas Smas
</pre>
382 1 Andreas Smas
383
Reply message fields:
384
<pre>
385 66 Adam Sutton
success            u32   required   1 if entry was added, 0 otherwise
386
id                 u32   optional   ID of created DVR entry
387
error              str   optional   English clear text of error message
388 1 Andreas Smas
</pre>
389
390 66 Adam Sutton
h3. updateDvrEntry (Added in version 5)
391 1 Andreas Smas
392 66 Adam Sutton
Update an existing DVR entry.
393 1 Andreas Smas
394
Request message fields:
395
<pre>
396 66 Adam Sutton
id                 u32   required   DVR Entry ID
397
start              s64   optional   New start time
398
stop               s64   optional   New stop time
399
title              str   optional   New entry title
400
description        str   optional   New entry description (Added in version 6)
401
startExtra         s64   optional   New pre-record buffer (Added in version 6)
402
stopExtra          s64   optional   New post-record buffer (Added in version 6)
403
configName         str   optional   New DVR configuration name
404 99 Jaroslav Kysela
retention          u32   optional   Retention in days (Added in version 13)
405
priority           u32   optional   Recording priority (Added in version 13)
406 1 Andreas Smas
</pre>
407
408
Reply message fields:
409
<pre>
410 66 Adam Sutton
success            u32   required   1 if update as successful, otherwise 0
411
error              str   optional   Error message if update failed
412 40 Andreas Smas
</pre>
413
414 66 Adam Sutton
h3. cancelDvrEntry (Added in version 5)
415 1 Andreas Smas
416 66 Adam Sutton
Cancel an existing recording, but don't remove the entry from the database.
417 1 Andreas Smas
418 66 Adam Sutton
Request message fields:
419
<pre>
420
id                 u32   required   dvrEnryId to delete
421
</pre>
422 1 Andreas Smas
423 66 Adam Sutton
Reply message fields:
424
<pre>
425
success            int   required   1 if entry was cancelled
426
error              str   optional   Error message if cancellation failed
427
</pre>
428 1 Andreas Smas
429 66 Adam Sutton
h3. deleteDvrEntry (Added in version 4)
430
431
Delete an existing DVR entry from the database.
432
433
Request message fields:
434 1 Andreas Smas
<pre>
435 66 Adam Sutton
id                 u32   required   DVR Entry ID
436 1 Andreas Smas
</pre>
437
438 11 Andreas Smas
Reply message fields:
439 1 Andreas Smas
<pre>
440 66 Adam Sutton
success            u32   required   1 if entry was removed
441
error              str   optional   Error message if the delete fails
442 1 Andreas Smas
</pre>
443
444 91 Jaroslav Kysela
h3. addAutorecEntry (Added in version 13)
445
446
Create a new Autorec DVR entry. Title must be specified.
447
448
Request message fields:
449
<pre>
450
title              str   required   Title for the recordings.
451
configName         str   optional   DVR Configuration Name / UUID.
452
channelId          u32   optional   Channel ID.
453
minDuration        u32   optional   Minimal duration in seconds (0 = Any).
454
maxDuration        u32   optional   Maximal duration in seconds (0 = Any).
455
daysOfWeek         u32   optional   Bitmask - Days of week (0x01 = Monday, 0x40 = Sunday, 0x7f = Whole Week, 0 = Not set).
456
priority           u32   optional   Priority (0 = Important, 1 = High, 2 = Normal, 3 = Low, 4 = Unimportant, 5 = Not set).
457
approxTime         u32   optional   Minutes from midnight (up to 24*60).
458
startExtra         s64   optional   Extra start minutes (pre-time).
459
stopExtra          s64   optional   Extra stop minutes (post-time).
460
comment            str   optional   User Comment.
461
</pre>
462
463
Reply message fields:
464
<pre>
465
success            u32   required   1 if entry was added, 0 otherwise
466 93 Jaroslav Kysela
id                 str   optional   ID (string!) of created autorec DVR entry
467 91 Jaroslav Kysela
error              str   optional   English clear text of error message
468
</pre>
469
470
h3. deleteAutorecEntry (Added in version 13)
471
472
Delete an existing autorec DVR entry from the database.
473
474
Request message fields:
475
<pre>
476 94 Jaroslav Kysela
id                 str   required   Autorec DVR Entry ID (string!)
477 91 Jaroslav Kysela
</pre>
478
479
Reply message fields:
480
<pre>
481
success            u32   required   1 if entry was removed
482
error              str   optional   Error message if the delete fails
483
</pre>
484
485 83 Jaroslav Kysela
h3. getDvrCutpoints (Added in version 12)
486
487
Get DVR cutpoints.
488
489
Request message fields:
490
<pre>
491
id                 u32   required   DVR Entry ID
492
</pre>
493
494
Reply message fields:
495
<pre>
496
cutpoints          msg[] optional   List of cutpoint entries, if a file is found and has some valid data.
497
</pre>
498
499
Cutpoint fields:
500
<pre>
501
start              u32   required   Cut start time in ms.
502
end                u32   required   Cut end time in ms.
503
type               u32   required   Action type: 
504
                                      0=Cut, 1=Mute, 2=Scene, 
505
                                      3=Commercial break.
506
</pre>
507
508 1 Andreas Smas
----
509
510 66 Adam Sutton
h3. getTicket (Added in version 5)
511 1 Andreas Smas
512 66 Adam Sutton
Get a ticket to allow access to a channel or recording via HTTP
513 1 Andreas Smas
514 66 Adam Sutton
Request message fields:
515 1 Andreas Smas
<pre>
516 66 Adam Sutton
channelId          u32  optional   Channel to gain access for
517
dvrId              u32  optional   DVR file to gain access for
518 1 Andreas Smas
</pre>
519
520
Reply message fields:
521
<pre>
522 66 Adam Sutton
path               str  required   The full path for access URL (no scheme, host or port)
523
ticket             str  required   The ticket to pass in the URL query string
524 1 Andreas Smas
</pre>
525
526 66 Adam Sutton
h3. subscribe
527 1 Andreas Smas
528 66 Adam Sutton
Request subscription to the given channel. 
529 1 Andreas Smas
530 66 Adam Sutton
Request message fields:
531
<pre>
532
channelId          u32   required   ID for channel. 
533
subscriptionId     u32   required   Subscription ID. Selected by client. This value is not interpreted by the server in any form. 
534
                                    The value is used from now on in all messages related to the subscription.
535 1 Andreas Smas
weight             u32   optional   Weighting of this subscription (same as recording priority).
536 73 Adam Sutton
90khz              u32   optional   Request PTS/DTS in default 90kHz timebase, default is 1MHz (Added in version 7)
537
normts             u32   optional   Request PTS/DTS normalisation (Added in version 7)
538
                                    Note: this will mean missing timestamps are added, first packet should be ~0 and will always be an i-frame.
539
                                    Note: this is implied if timeshiftPeriod is enabled
540
queueDepth         u32   optional   Change the default packet queue lengths, default 500000 bytes (Added in version 7)
541
                                    Note: I-frame depth is 3*queueDepth, P-frame is 2*queueDepth and B-frame is queueDepth
542
timeshiftPeriod    u32   optional   The number of seconds to keep in the timeshift buffer (Added in version 9)
543
                                    Note: this may be bounded by server configuration settings
544 11 Andreas Smas
</pre>
545 66 Adam Sutton
546 1 Andreas Smas
Reply message fields:
547
<pre>
548 73 Adam Sutton
90khz              u32   optional   Indicates 90khz timestamps will be used
549
normts             u32   optional   Indicates timestamps will be normalised (and fixed)
550
timeshiftPeriod    u32   optional   The actual timeshiftPeriod to be used
551 66 Adam Sutton
</pre>
552 1 Andreas Smas
553 66 Adam Sutton
h3. unsubscribe
554
555
Stop a subscription.
556
557
Request message fields:
558 1 Andreas Smas
<pre>
559 66 Adam Sutton
subscriptionId     u32   required   Subscription ID.
560 58 sbi -
</pre>
561
562 11 Andreas Smas
Reply message fields:
563 1 Andreas Smas
<pre>
564 66 Adam Sutton
None
565 58 sbi -
</pre>
566 11 Andreas Smas
567 66 Adam Sutton
h3. subscriptionChangeWeight (Added in version 5)
568 1 Andreas Smas
569 66 Adam Sutton
Change the weight of an existing subscription
570 1 Andreas Smas
571 66 Adam Sutton
Request message fields:
572
<pre>
573
subscriptionId     u32   required   Subscription ID.
574
weight             u32   optional   The new subscription weight.
575 1 Andreas Smas
</pre>
576
577
Reply message fields:
578
<pre>
579 69 Adam Sutton
None
580 1 Andreas Smas
</pre>
581
582 73 Adam Sutton
h3. subscriptionSkip (Added in version 9)
583
584
Skip a timeshift enabled subscription. The response will be asynchronous subscriptionSkip().
585
586
Request message fields:
587
<pre>
588
subscriptionId     u32   required   Subscription ID.
589
absolute           u32   optional   The skip request is absolute
590
time               u64   optional   Specify skip using time (units are as for PTS)
591
size               u64   optional   Specify skip using size (Not currently used)
592
</pre>
593
594
Reply message fields:
595
<pre>
596
None
597
</pre>
598
599
h3. subscriptionSeek (Added in version 9)
600
601
Synonym for subscriptionSkip
602
603
h3. subscriptionSpeed (Added in version 9)
604
605
Set the playback speed for the subscription. The response will be asynchronous subscriptionSpeed().
606
607
Request message fields:
608
<pre>
609
subscriptionId     u32   required   Subscription ID.
610
speed              u32   required   Specify speed (0=pause, 100=1x fwd, -100=1x backward)
611
</pre>
612
613
Reply message fields:
614
<pre>
615
None
616
</pre>
617
618
h3. subscriptionLive (Added in version 9)
619
620
Return a timeshifted session to live. Reply will be asynchronous subscriptionSkip().
621
622
Request message fields:
623
<pre>
624
subscriptionId     u32   required   Subscription ID.
625
</pre>
626
627
Reply message fields:
628
<pre>
629
None
630 82 Jaroslav Kysela
</pre>
631 1 Andreas Smas
632 83 Jaroslav Kysela
h3. subscriptionFilterStream (Added in version 12)
633 1 Andreas Smas
634 83 Jaroslav Kysela
Enable or disable specified streams by index.
635
636
Request message fields:
637
<pre>
638
subscriptionId     u32        required   Subscription ID.
639
enable             list[u32]  optional   Enable stream indexes
640
disable            list[u32]  optional   Disable (filter out) stream indexes
641
</pre>
642
643
Reply message fields:
644
<pre>
645
None
646
</pre>
647
648
h3. getCodecs (Added in version 11, Removed in version 16)
649
650 82 Jaroslav Kysela
Return a list of encoders (codecs).
651
652 1 Andreas Smas
Reply message fields:
653 82 Jaroslav Kysela
<pre>
654 83 Jaroslav Kysela
encoders           list[str]  optional   Supported encoders
655 82 Jaroslav Kysela
</pre>
656
657 70 Adam Sutton
h3. fileOpen (Added in version 8)
658 69 Adam Sutton
659
Open a file within the Tvheadend file system. This is now the preferred method (in place of HTTP) for accessing recordings.
660
661
Accessing recordings via HTSP will overcome the limitations of standard HTTP streaming which cannot handle both skipping and growing files (i.e. in-progress recordings) at the same time.
662
663 1 Andreas Smas
Request message fields:
664 69 Adam Sutton
<pre>
665 70 Adam Sutton
file               str   required   File path to open
666 1 Andreas Smas
</pre>
667
668 70 Adam Sutton
Valid file paths:
669
<pre>
670
/dvrfile/ID        will open the file associated with DVR entry ID
671 74 Adam Sutton
/imagecache/ID     will open the file associated with imagecache entry ID (Note: only works for HTSPv10+)
672 70 Adam Sutton
</pre>
673
674 69 Adam Sutton
Reply message fields:
675
<pre>
676
id                 u32   required   The file handle used for further file operations
677
size               u64   optional   The size of the file in bytes
678 1 Andreas Smas
mtime              u64   optional   The last time the file was modified
679 69 Adam Sutton
</pre>
680
681 70 Adam Sutton
h3. fileRead (Added in version 8)
682 69 Adam Sutton
683 1 Andreas Smas
Read data from a file.
684
685 69 Adam Sutton
Request message fields:
686
<pre>
687
id                 u32   required   The file handle used for further file operations
688 70 Adam Sutton
size               u64   required   The amount of data to read
689
offset             u64   optional   Offset into the file to read (default is current position)
690 69 Adam Sutton
</pre>
691 1 Andreas Smas
692 69 Adam Sutton
Reply message fields:
693
<pre>
694
data               bin   required   The data read from the file (size may be less than requested)
695
</pre>
696
697 70 Adam Sutton
h3. fileClose (Added in version 8)
698 69 Adam Sutton
699
Close an opened file.
700
701
Request message fields:
702
<pre>
703 1 Andreas Smas
id                 u32   required   The file handle to be closed
704 69 Adam Sutton
</pre>
705
706
Reply message fields:
707
<pre>
708
None
709
</pre>
710 70 Adam Sutton
711 69 Adam Sutton
h3. fileStat (Added in version 8)
712
713
Get status of a file.
714
715
Request message fields:
716
<pre>
717
id                 u32   required   The file handle to be stat'd
718 1 Andreas Smas
</pre>
719
720
Reply message fields:
721
<pre>
722
size               u64   optional   The size of the file in bytes
723
mtime              u64   optional   The last time the file was modified
724
</pre>
725 70 Adam Sutton
726
h3. fileSeek (Added in version 8)
727
728
Seek to position in a file.
729
730
Request message fields:
731
<pre>
732
id                 u32   required   The file handle to be stat'd
733
offset             u64   required   The position to seek in the file
734
whence             str   required   Where to seek relative to (default=SEEK_SET)
735
</pre>
736
737
Note: valid values for whence
738
<pre>
739
SEEK_SET           Seek relative to start of file
740
SEEK_CUR           Seek relative to current position in file
741 72 Adam Sutton
SEEK_END           Seek relative (backwards) to end of file
742 70 Adam Sutton
</pre>
743
744
Reply message fields:
745
<pre>
746
offset             u64   optional   The new absolute position within the file
747
</pre>
748 66 Adam Sutton
749 1 Andreas Smas
h1. Server to Client methods
750
751
----
752
753
h3. channelAdd
754
755
A new channel has been created on the server.
756
757
Message fields:
758
<pre>
759
channelId          u32   required   ID of channel.
760 66 Adam Sutton
channelNumber      u32   required   Channel number, 0 means unconfigured.
761 90 Jaroslav Kysela
channelNumberMinor u32   optional   Minor channel number (Added in version 13).
762 1 Andreas Smas
channelName        str   required   Name of channel.
763 70 Adam Sutton
channelIcon        str   optional   URL to an icon representative for the channel
764
                                    (For v8+ clients this could be a relative /imagecache/ID URL
765 73 Adam Sutton
                                     intended to be fed to fileOpen() or HTTP server)
766 66 Adam Sutton
eventId            u32   optional   ID of the current event on this channel.
767
nextEventId        u32   optional   ID of the next event on the channel.
768
tags               u32[] optional   Tags this channel is mapped to.
769
services           msg[] optional   List of available services (Added in version 5)
770 13 Andreas Smas
</pre>
771 1 Andreas Smas
772 66 Adam Sutton
Service fields:
773 1 Andreas Smas
<pre>
774 66 Adam Sutton
name               str   required   Service name
775
type               str   required   Service type
776
caid               u32   optional   Encryption CA ID
777
caname             str   optional   Encryption CA name
778 11 Andreas Smas
</pre>
779 1 Andreas Smas
780 66 Adam Sutton
h3. channelUpdate
781 11 Andreas Smas
782 66 Adam Sutton
Same as channelAdd, but all fields (except channelId) are optional.
783
784 58 sbi -
h3. channelDelete
785 1 Andreas Smas
786
A channel has been deleted on the server.
787 58 sbi -
788
Message fields:
789 1 Andreas Smas
<pre>
790 66 Adam Sutton
channelId          u32   required   ID of channel.
791 1 Andreas Smas
</pre>
792
793
----
794
795
h3. tagAdd
796 11 Andreas Smas
797 1 Andreas Smas
A new tag has been created on the server.
798
799
Message fields:
800
<pre>
801 66 Adam Sutton
tagId              u32   required   ID of tag.
802
tagName            str   required   Name of tag.
803
tagIcon            str   optional   URL to an icon representative for the channel.
804
tagTitledIcon      u32   optional   Icon includes a title
805
members            u32[] optional   Channel IDs of those that belong to the tag
806 1 Andreas Smas
</pre>
807 11 Andreas Smas
808 39 elupus -
h3. tagUpdate
809 58 sbi -
810 66 Adam Sutton
Same as tagAdd, but all fields (except tagId) are optional.
811 11 Andreas Smas
812
h3. tagDelete
813 1 Andreas Smas
814 58 sbi -
A tag has been deleted from the server.
815 1 Andreas Smas
816
Message fields:
817
<pre>
818 66 Adam Sutton
tagId              u32   required   ID of tag.
819 58 sbi -
</pre>
820
821 12 Andreas Smas
----
822 1 Andreas Smas
823 66 Adam Sutton
h3. dvrEntryAdd (Added in version 4)
824 58 sbi -
825 1 Andreas Smas
A new recording has been created on the server.
826 58 sbi -
827 1 Andreas Smas
Message fields:
828 2 Andreas Smas
<pre>
829 66 Adam Sutton
id                 u32   required   ID of dvrEntry.
830
channel            u32   required   Channel of dvrEntry.
831
start              s64   required   Time of when this entry was scheduled to start recording.
832
stop               s64   required   Time of when this entry was scheduled to stop recording.
833 89 Jaroslav Kysela
startExtra         s64   required   Extra start time (pre-time) in minutes (Added in version 13).
834
stopExtra          s64   required   Extra stop time (post-time) in minutes (Added in version 13).
835
retention          s64   required   DVR Entry retention time in days.
836
priority           u32   required   Priority (0 = Important, 1 = High, 2 = Normal, 3 = Low, 4 = Unimportant, 5 = Not set) (Added in version 13).
837
eventId            u32   optional   Associated EPG Event ID (Added in version 13).
838
autorecId          u32   optional   Associated Autorec ID (Added in version 13).
839
contentType        u32   optional   Content Type (like in the DVB standard) (Added in version 13).
840 66 Adam Sutton
title              str   optional   Title of recording
841
summary            str   optional   Short description of the recording (Added in version 6).
842
description        str   optional   Long description of the recording.
843
state              str   required   Recording state
844
error              str   optional   Plain english error description (e.g. "Aborted by user").
845 48 mdd -
</pre>
846 1 Andreas Smas
847 66 Adam Sutton
TODO: recording states
848 48 mdd -
849
h3. dvrEntryUpdate
850
851 66 Adam Sutton
Message fields:
852
<pre>
853
Same as dvrEntryAdd, but all fields (except id) are optional.
854
</pre>
855 51 elupus -
856 66 Adam Sutton
h3. dvrEntryDelete (Added in version 4)
857 58 sbi -
858 66 Adam Sutton
A recording has been deleted from the server.
859 58 sbi -
860 48 mdd -
Message fields:
861
<pre>
862 66 Adam Sutton
id                 u32   required   ID of recording to delete.
863 1 Andreas Smas
</pre>
864 48 mdd -
865 58 sbi -
----
866 48 mdd -
867 95 Jaroslav Kysela
h3. autorecEntryAdd (Added in version 13)
868
869
A new autorec recording has been created on the server.
870
871
Message fields:
872
<pre>
873
id                 str   required   ID (string!) of dvrAutorecEntry.
874
enabled            u32   required   If autorec entry is enabled (activated).
875
minDuration        u32   required   Minimal duration in seconds (0 = Any).
876
maxDuration        u32   required   Maximal duration in seconds (0 = Any).
877
retention          u32   required   Retention time (in days).
878
daysOfWeek         u32   required   Bitmask - Days of week (0x01 = Monday, 0x40 = Sunday, 0x7f = Whole Week, 0 = Not set).
879
priority           u32   required   Priority (0 = Important, 1 = High, 2 = Normal, 3 = Low, 4 = Unimportant, 5 = Not set).
880
approxTime         u32   required   Minutes from midnight (up to 24*60).
881
startExtra         s64   required   Extra start minutes (pre-time).
882
stopExtra          s64   required   Extra stop minutes (post-time).
883
title              str   optional   Title.
884
channel            u32   optional   Channel ID.
885
</pre>
886
887
h3. autorecEntryUpdate (Added in version 13)
888
889
Message fields:
890
<pre>
891
Same as autorecEntryUpdate but all fields (except id) are optional.
892
</pre>
893
894
h3. autorecEntryDelete (Added in version 13)
895
896
Message fields:
897
<pre>
898
id                 str   required   Autorec Entry ID (string!)
899
</pre>
900
901
----
902
903 66 Adam Sutton
h3. eventAdd (Added in version 6)
904 48 mdd -
905 66 Adam Sutton
Message fields:
906
<pre>
907
eventId            u32   required   Event ID
908
channelId          u32   required   The channel this event is related to.
909
start              u64   required   Start time of event, UNIX time.
910
stop               u64   required   Ending time of event, UNIX time.
911
title              str   optional   Title of event.
912
summary            str   optional   Short description of the event (Added in version 6).
913
description        str   optional   Long description of the event.
914
serieslinkId       u32   optional   Series Link ID (Added in version 6).
915
episodeId          u32   optional   Episode ID (Added in version 6).
916
seasonId           u32   optional   Season ID (Added in version 6).
917
brandId            u32   optional   Brand ID (Added in version 6).
918
contentType        u32   optional   DVB content code (Added in version 4, Modified in version 6*).
919
ageRating          u32   optional   Minimum age rating (Added in version 6).
920
starRating         u32   optional   Star rating (1-5) (Added in version 6).
921
firstAired         s64   optional   Original broadcast time, UNIX time (Added in version 6).
922
seasonNumber       u32   optional   Season number (Added in version 6).
923
seasonCount        u32   optional   Show season count (Added in version 6).
924
episodeNumber      u32   optional   Episode number (Added in version 6).
925
episodeCount       u32   optional   Season episode count (Added in version 6).
926
partNumber         u32   optional   Multi-part episode part number (Added in version 6).
927
partCount          u32   optional   Multi-part episode part count (Added in version 6).
928
episodeOnscreen    str   optional   Textual representation of episode number (Added in version 6).
929
image              str   optional   URL to a still capture from the episode (Added in version 6).
930
dvrId              u32   optional   ID of a recording (Added in version 5).
931
nextEventId        u32   optional   ID of next event on the same channel.
932
</pre>
933 48 mdd -
934 66 Adam Sutton
* *contentType previously had the major DVB category in the bottom 4 bits, 
935
  however in v6 this has been changed to properly match DVB, so top 4 bits
936
  as major category and bottom 4 bits has sub-category. Clients requesting
937
  v5 or lower will get the old output.
938 48 mdd -
939 66 Adam Sutton
h3. eventUpdate (Added in version 6)
940 35 Andreas Smas
941 58 sbi -
Message fields:
942
<pre>
943 66 Adam Sutton
Same as eventAdd but all fields (except eventId) are optional.
944 35 Andreas Smas
</pre>
945 58 sbi -
946 77 John Törnblom
h3. eventDelete (Added in version 6)
947 35 Andreas Smas
948 66 Adam Sutton
Message fields:
949
<pre>
950
eventId            u32   required   Event ID
951
</pre>
952 14 Andreas Smas
953 66 Adam Sutton
---
954 14 Andreas Smas
955 66 Adam Sutton
h3. initialSyncCompleted (Added in version 2)
956 14 Andreas Smas
957 66 Adam Sutton
Sent after all the initial metadata has been sent when session has been set to async mode.
958 38 Andreas Smas
959
Message fields:
960 14 Andreas Smas
<pre>
961
</pre>
962
963
----
964
965
h3. subscriptionStart
966 53 Andreas Smas
967 66 Adam Sutton
Asynchronous message output when a new subscription is successfully started.
968 14 Andreas Smas
969
Message fields:
970 1 Andreas Smas
<pre>
971 66 Adam Sutton
subscriptionId     u32   required   Subscription ID.
972
streams            msg[] required   Array of messages with stream information
973
sourceinfo         msg   optional   Source information.
974
</pre>
975 37 Andreas Smas
976 66 Adam Sutton
Stream message fields:
977
<pre>
978
index              u32   required   Index for this stream
979
type               str   required   Type of stream
980 80 Jaroslav Kysela
meta               bin   optional   Codec metadata (private data) (Added in version 17)
981 66 Adam Sutton
language           str   optional   Language for stream
982
Video components only:
983
width              u32   optional   Width of video in pixels
984
height             u32   optional   Height of video in pixels
985 68 Andreas Smas
aspect_num         u32   optional   Aspect ratio numerator (Added in version 5) *Can be incorrect and should not be relied upon*
986
aspect_den         u32   optional   Aspect ratio denonminator (Added in version 5) *Can be incorrect and should not be relied upon*
987 66 Adam Sutton
Audio components only:
988 76 Dave Chapman
audio_type         u32   optional   Audio type - 0=Normal; 1=Clean effects; 2=Hearing impaired; 3=Visually impaired commentary; 4-255=Reserved (Added in version 11)
989 66 Adam Sutton
channels           u32   optional   Number of audio channels (Added in version 5)
990
rate               u32   optional   Audio bitrate (Added in version 5)
991
Subtitle components only:
992
composition_id     u32   optional   ??? (Added in version 5)
993
ancillary_id       u32   optional   ??? (Added in version 5)
994
</pre>
995 2 Andreas Smas
996 66 Adam Sutton
Sourceinfo message fields:
997
<pre>
998
adapter            str   optional   Adapter name
999
mux                str   optional   Transponder name
1000
network            str   optional   Network name
1001
provider           str   optional   ???
1002
service            str   optional   Service name
1003
</pre>
1004 15 Andreas Smas
1005 66 Adam Sutton
Video Stream types:
1006 1 Andreas Smas
<pre>
1007 79 Jaroslav Kysela
MPEG2VIDEO                    MPEG2 video, meta field is present (configuration blocks)
1008
H264                          H264 video, meta field is present (configuration blocks)
1009
HEVC                          HEVC video, meta field is present (configuration blocks)
1010 66 Adam Sutton
</pre>
1011 15 Andreas Smas
1012 1 Andreas Smas
Audio Stream types:
1013
<pre>
1014 66 Adam Sutton
MPEG2AUDIO                    MPEG2 audio (MP2)
1015
AC3                           AC3 audio
1016 79 Jaroslav Kysela
AAC                           ADTS framed AAC (one AAC packet per ADTS frame), meta field is present (MPEG4 config)
1017 66 Adam Sutton
EAC3                          Enhanced AC3 audio
1018 79 Jaroslav Kysela
VORBIS                        Vorbis audio, meta field is present with the main vorbis header
1019 16 Andreas Smas
</pre>
1020
1021 66 Adam Sutton
Subtitle Stream types:
1022
<pre>
1023
TELETEXT                      ???
1024
DVBSUB                        ???
1025
</pre>
1026 55 Lars Op den Kamp -
1027
h3. subscriptionStop
1028
1029 66 Adam Sutton
A subscription has been stopped.
1030 55 Lars Op den Kamp -
1031
Message fields:
1032
<pre>
1033 66 Adam Sutton
subscriptionId     u32   required   Subscription ID.
1034 1 Andreas Smas
status             str   optional   Error message if subscription stopped unexpectedly.
1035
</pre>
1036
1037 73 Adam Sutton
h3. subscriptionSkip (Added version 9)
1038
1039
A subscription has been skipped.
1040
1041
Message fields:
1042
<pre>
1043
subscriptionId     u32   required   Subscription ID.
1044
error              u32   optional   The last skip command caused an error.
1045
absolute           u32   optional   Indicates the output is absolute (Note: should always be 1 at the moment)
1046
time               u64   optional   The time the subscription has skipped to.
1047
size               u64   optional   The position in the file we've skipped to (Note: not currently used).
1048
</pre>
1049
1050
h3. subscriptionSpeed (Added version 9)
1051
1052
A subscription's playback speed has changed.
1053
1054
This can happen even without a speed request, should playback reach either end of the buffer.
1055
1056
Message fields:
1057
<pre>
1058
subscriptionId     u32   required   Subscription ID.
1059
speed              u32   required   The new speed of the subscription
1060
</pre>
1061
1062 55 Lars Op den Kamp -
h3. subscriptionStatus
1063
1064 66 Adam Sutton
Subscription status update.
1065 58 sbi -
1066
Message fields:
1067
<pre>
1068 66 Adam Sutton
subscriptionId     u32   required   Subscription ID.
1069
status             str   optional   English clear text of error status. Absence of this field means that the status is OK. 
1070 16 Andreas Smas
</pre>
1071 58 sbi -
1072 16 Andreas Smas
h3. queueStatus
1073
1074 1 Andreas Smas
The queueStatus message is sent every second during normal data delivery.
1075 60 John Törnblom
1076
The transmit scheduler have different drop thresholds for different frame types.
1077 66 Adam Sutton
1078 1 Andreas Smas
If congestion occurs it will favor dropping B-frames before P-frames before I-frames.
1079
All audio is recognized as I-frames. 
1080 58 sbi -
1081 1 Andreas Smas
Message fields:
1082
<pre>
1083 66 Adam Sutton
subscriptionId     u32   required   Subscription ID.
1084
packets            u32   required   Number of data packets in queue.
1085
bytes              u32   required   Number of bytes in queue.
1086
delay              u32   optional   Estimated delay of queue (in µs).
1087 1 Andreas Smas
Bdrops             u32   required   Number of B-frames dropped
1088 66 Adam Sutton
Pdrops             u32   required   Number of P-frames dropped
1089
Idrops             u32   required   Number of I-frames dropped
1090 73 Adam Sutton
delay              s64   required   Delta between first and last DTS (Added in version 9)
1091 1 Andreas Smas
</pre>
1092
1093
h3. signalStatus
1094
1095
The signalStatus message is sent every second during normal data delivery.
1096
1097
The optional fields may not have been implemented or may not be supported by the active adapter.
1098
1099
Message fields:
1100
<pre>
1101 66 Adam Sutton
subscriptionId     u32   required   Subscription ID.
1102
feStatus           str   required   Frontend status.
1103
feSNR              u32   optional   Signal to noise ratio.
1104 1 Andreas Smas
feSignal           u32   optional   Signal status percentage.
1105
feBER              u32   optional   Bit error rate.
1106
feUNC              u32   optional   Uncorrected blocks.
1107 73 Adam Sutton
</pre>
1108
1109
h3. timeshiftStatus
1110
1111
Provide status every second about the timeshift buffer.
1112
1113
Message fields:
1114
<pre>
1115
subscriptionId     u32   required   Subscription ID.
1116
full               u32   required   Indicates whether the buffer is full
1117
shift              s64   required   Current position relative to live
1118
start              s64   optional   PTS of the first frame in the buffer
1119
end                s64   optional   PTS of the last frame in the buffer
1120 1 Andreas Smas
</pre>
1121
1122
h3. muxpkt
1123
1124
Streaming data.
1125
1126
Message fields:
1127
<pre>
1128 66 Adam Sutton
subscriptionId     u32   required   Subscription ID.
1129
frametype          u32   required   Type of frame as ASCII value: 'I', 'P', 'B'
1130
stream             u32   required   Stream index. Corresponds to the streams reported in the subscriptionStart message.
1131
dts                s64   optional   Decode Time Stamp in µs.
1132
pts                s64   optional   Presentation Time Stamp in µs.
1133
duration           u32   required   Duration of frame in µs.
1134
payload            bin   required   Actual frame data.
1135 1 Andreas Smas
</pre>
1136 81 Jaroslav Kysela
1137
Note: From protocol version 17, the H264 payload does not contain the H264 configuration blocks (they are only in the meta field - see start message).