Project

General

Profile

Htsp » History » Version 94

Jaroslav Kysela, 2014-10-19 20:45

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