-
Notifications
You must be signed in to change notification settings - Fork 2
/
libFireBird.h
3137 lines (2683 loc) · 135 KB
/
libFireBird.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
#ifndef __FBLIB__
#define __FBLIB__
#define __FBLIB_RELEASEDATE__ "2020-01-02"
#define __FBLIB_VERSION__ __FBLIB_RELEASEDATE__
#define isTMS 1
// Use -DFB_DEBUG_FULL if you want to activate all debug-like functions,
// thus getting debugging and tracing information at runtime.
#ifdef FB_DEBUG_FULL
#define FB_DEBUG
#define STACKTRACE
#endif
// Use -DFB_DEBUG if you want to activate debug-like functions,
// thus getting debugging information at runtime.
#ifdef FB_DEBUG
// Call FBLIB's special check-and-log API wrapper functions.
#define FB_DEBUG_CHK
// Call LogEntryFBLibPrintf().
#define FB_LOG_ENTRY_LIB_PRINTF
// Make use of tracing functions.
#define FB_CALL_TRACE
#endif
#ifdef STACKTRACE
#ifndef FB_CALL_TRACE
#define FB_CALL_TRACE
#endif
#endif
#ifdef PC_BASED
#define inline
#define __attribute__(a)
#else
#include "tap.h"
#endif
#undef __USE_LARGEFILE64
#define __USE_LARGEFILE64
#undef _LARGEFILE64_SOURCE
#define _LARGEFILE64_SOURCE
#define _FILE_OFFSET_BITS 64
#include <sys/types.h>
#ifdef __cplusplus
extern "C" {
#endif
extern word ApplID;
extern dword TAP_TableIndex;
/*****************************************************************************************************************************/
/* Main */
/*****************************************************************************************************************************/
#define TAP_MAX 16
#define DIR_PROGRAMFILES "/ProgramFiles"
#define DIR_SETTINGS "Settings"
typedef enum
{
ST_UNKNOWN,
ST_S,
ST_T,
ST_C,
ST_T5700,
ST_TMSS,
ST_TMST,
ST_TMSC,
ST_T5800,
ST_ST,
ST_CT,
ST_TF7k7HDPVR,
ST_NRTYPES
} SYSTEM_TYPE;
typedef enum
{ //Toppy has been bootet by...
BOOT_FRONT_PANEL, //... pressing a front panel key
BOOT_REMOTE_CONTROL, //... a remote key
BOOT_TIMER, //... a timer
BOOT_FW_REBOOT, //... Firmware controlled reboot
BOOT_RESERVED_4, //... unknown. Possibly used by the front panel, but never seen
BOOT_POWER, //... an mains power failure.
BOOT_ANTIFREEZE //... an AntiFreeze reboot. Patched front panels only
} tBootReason;
typedef enum
{
TIMESTAMP_NONE,
TIMESTAMP_HM,
TIMESTAMP_HMS,
TIMESTAMP_YMD,
TIMESTAMP_YMDHM,
TIMESTAMP_YMDHMS,
TIMESTAMP_FNYMDHM
} eTimeStampFormat;
//Firmware.dat structure
typedef struct
{
dword Magic; //0x12345678
dword CompileDate; //yymd
word ToppyInfoLayoutVersion;
word FWInfoLayoutVersion;
dword NrOfToppyInfoEntries;
dword NrOfFWInfoEntries;
} tFWDATHeader;
typedef enum
{
DT_LED,
DT_VFD5500,
DT_VFDMP
} DISPLAY_TYPE;
typedef enum
{
RT_5000,
RT_2100,
RT_7100PLUS,
RT_7260PLUS //Identical to RT_2100, except that the code for the red key is RKEY_F1
} REMOTE_TYPE;
typedef struct
{
word SysID;
word unused1;
char Device [256];
char AppType [32];
SYSTEM_TYPE SystemType;
dword FlashBase;
bool EMMA;
bool BigEndian;
bool PVR;
bool TAPs;
DISPLAY_TYPE DisplayType;
REMOTE_TYPE RemoteType;
dword MaxRecStreams;
byte RecExtension; //0=.rec, 1=.mpg
byte unused2[18];
} tToppyInfo;
typedef struct
{
word SysID;
word unused1;
dword FWgp;
dword FWDate;
word AppVersion;
word unused2;
dword unused3;
bool Beta;
byte MD5 [16];
byte unused4 [32];
} tFWInfo;
#define LE16(p) (p)
#define LE32(p) (p)
#define XDATA //don't use XDATA on the TMS
#define TS_FILE_NAME_SIZE (MAX_FILE_NAME_SIZE + 1)//name and usage have changed: name[TS_FILE_NAME_SIZE] vs. name[MAX_FILE_NAME_SIZE + 1]
#define ATTR_PARENT 0xf0 //FindFirst/FindNext doesn't know about ..
#ifndef PC_BASED
extern char PrintNetBuffer[1024];
void PrintNet(char *puffer);
// Define the following override if you want to stop FBLIB
// intercepting TAP_Print() [i.e. printf() from TAPs]. Normally,
// FBLIB intercepts these messages to a local pseudo terminal.
// Without the interception, TMS directs these to an FTP debug
// socket.
#ifndef FB_NO_TAP_PRINT_OVERRIDE
extern int snprintf(char *, size_t, const char *, ...);
#define TAP_PrintNet(...) do { snprintf(PrintNetBuffer, sizeof(PrintNetBuffer), __VA_ARGS__); PrintNet(PrintNetBuffer); } while (0)
#define TAP_Print TAP_PrintNet
#endif
#endif
bool InitTAPex(void);
void InitTAPexFailedMsg(char *ProgramName);
tBootReason BootReason(void);
dword FirmwareDatMJD(void);
void FlushCache(dword *pAddr, int Size);
bool FrontPanelEEPROMRead(word Address, byte *Data); //Only supported with a patched front panel
bool FrontPanelEEPROMWrite(word Address, byte Data); //Only supported with a patched front panel
bool FrontPanelGetPatch(byte *Version, byte *Type);
char *GetApplVer(void);
byte *GetMacAddress(void);
word GetSysID(void);
SYSTEM_TYPE GetSystemType(void);
char *GetToppyString(word SysID);
dword GetUptime(void);
bool isIceTVToppy(void);
char *iso639_1(int OSDLan);
char *iso639_2(int OSDLan);
bool LoadFirmwareDat(tFWDATHeader **FWDatHeader, tToppyInfo **ToppyInfo, tFWInfo **FWInfo);
bool PutDevEvent(word Event, dword Param1);
/*****************************************************************************************************************************/
/* Audio / Video / OSD */
/*****************************************************************************************************************************/
//Forgotten keys
#define RKEY_Red RKEY_NewF1
#define RKEY_Green RKEY_F2
#define RKEY_Yellow RKEY_F3
#define RKEY_Blue RKEY_F4
#define RKEY_Option 0x10049
#define RKEY_White RKEY_Option
//In addition to the Service Status Mask defined in tap.h
#define SVCSTATUS_MASK_Audio 0x00010000
#ifndef TAP_ALPHA
#define TAP_ALPHA 255
#endif
#define _Clip(a) (a)>255 ? 255 : (a)<0 ? 0 : (a)
#define YUVR(y,u,v) ((0x2568*(y) + 0x3343*(u)) >>13) //0x2000
#define YUVG(y,u,v) ((0x2568*(y) - 0x0c92*(v) - 0x1a1e*(u)) >>13) //0x2000
#define YUVB(y,u,v) ((0x2568*(y) + 0x40cf*(v)) >>13) //0x2000
#define win_w(w) ((w) + 51)
#define win_h(h) (((h) / 22 + ((h) % 22 ? 1 : 0)) * 22 + 8)
#define win_l(h) ((win_h(h) - 8) / 22)
#define A1555(x) (((x)>>15)&0x01)
#define R1555(x) (((x)>>10)&0x1f)
#define G1555(x) (((x)>> 5)&0x1f)
#define B1555(x) (((x)>> 0)&0x1f)
#define A8888(x) (((x)>>24)&0xff)
#define R8888(x) (((x)>>16)&0xff)
#define G8888(x) (((x)>> 8)&0xff)
#define B8888(x) (((x)>> 0)&0xff)
#define ARGB2TMS(a,r,g,b) ((dword) (((a) ? TAP_ALPHA : 0) << 24 | (byte) ((r) * 8.2258) << 16 | (byte) ((g) * 8.2258) << 8 | (byte) ((b) * 8.2258)))
#define ARGBtoTMS(a,r,g,b) a*=0xff;r*=8.2258;g*=8.2258;b*=8.2258
#define TMStoARGB(a,r,g,b) a/=0xff;r/=8.2258;g/=8.2258;b/=8.2258
struct BMP_HEAD
{
byte id[2];
word size_l;
word size_h;
word reserved[2];
word offset_l;
word offset_h;
};
struct BMP_INFO
{
long info_size;
long width;
long height;
word plane;
word bits_per_pixel;
long compress;
long img_size;
long x_res;
long y_res;
long color;
long icolor;
};
typedef struct
{
word x;
word y;
word Width;
word Height;
dword pMemoryOSD;
byte byteFormat;
byte lutIdx;
byte plane;
byte unknown;
} tOSDMapInfo;
// directions
typedef enum
{
X,
Y
} eCopyDirection;
typedef struct
{
byte unused1[4677];
byte NrOfTracks;
byte CurrentTrack;
byte unused2;
word PID[64];
byte StreamType[64];
char StreamName[64][32];
word unknown1[64];
byte unused4[64 * 32];
dword unknown2[64];
} tAudioTrk;
typedef enum
{
PLT_Unchanged = 0,
PLT_DataFiles = 1,
PLT_ProgramFiles = 2,
PLT_MP3Files = 3,
PLT_MediaFiles = 4,
} tPvrListType;
tAudioTrk *AudioTrackInfo(void);
bool CaptureScreen(int BMPwidth, int BMPheight, byte *BMPPixelBuffer, bool bOSD, int Alpha);
void DrawOSDLine(word OSDRgn, dword Ax, dword Ay, dword Bx, dword By, dword Color);
void DrawScrollbar(word sbRegion, int sbX, int sbY, int sbHeight, int sbCurrent, int sbWindow, int sbMax);
void EndMessageWin(void);
void FreeOSDRegion(word Region);
dword GetOSDMapAddress(void);
word GetOSDRegionHeight(word Region);
word GetOSDRegionWidth(word Region);
bool GetPIPPosition(int *North, int *South, int *East, int *West);
byte GetStreamFormat(byte Index);
bool isAnyOSDVisible(dword CheckX, dword CheckY, dword CheckW, dword CheckH);
bool isAnyOSDVisibleEx(dword CheckX, dword CheckY, dword CheckW, dword CheckH, byte Plane);
bool isInfoBoxVisible(void);
bool isDirectSvcNumVisible(void);
bool isOSDRegionAlive(word Region);
bool isPIPActive(void);
void OSDCopy(word rgn, dword x, dword y, dword w, dword h, word items, eCopyDirection direction);
bool PlayMediaFile(char *MediaFileName);
bool SaveBitmap(char *FileName, int width, int height, byte* pBuffer);
void SetRemoteMode(byte Mode, byte Index, bool Active);
void ShowMessageWin(char* title, char* lpMessage1, char* lpMessage2, dword dwDelay);
void ShowMessageWindow(char **content, dword pos_x, dword pos_y, byte fntSize, byte align, dword bdcolor, dword titlecolor, dword msgcolor, dword bgcolor, dword delay);
bool ShowPvrList(tPvrListType PvrListType);
void SoundSinus(word freq, dword durationInMilliseconds, word Amplitude);
bool TAP_GetSysOsdControl(TYPE_TapSysOsdId osdId);
int TAP_Osd_PutFreeColorGd(word rgn, int x, int y, TYPE_GrData *gd, bool sprite, dword FilterColor);
byte TunerGet(int MainSub);
bool TunerSet(byte Tuner);
/*****************************************************************************************************************************/
/* Compression */
/*****************************************************************************************************************************/
typedef enum
{
TFDTYPE_LoaderPgm,
TFDTYPE_ApplPgm,
TFDTYPE_FlashData,
TFDTYPE_EepromData,
TFDTYPE_FactoryData,
TFDTYPE_BackgndPict,
} TFDTYPE;
word CompressBlock(byte *pInput, word InBufferSize, byte *pOutput);
dword CompressTFD(byte *pSrc, dword SourceBufferSize, byte *pDest, word TFDType, word SysID, void *pPercentFinishedCallback);
dword CompressedTFDSize(byte *pSrc, dword SourceBufferSize, void *pPercentFinishedCallback);
word CRC16(word StartValue, void *StartAddress, dword Length);
dword CRC32(dword StartValue, void *StartAddress, dword Length);
bool MD5String(char *inString, byte *Digest);
bool MD5File(char *FileName, byte *Digest);
dword OATH(register byte *data, int len, dword hash);
dword SuperFastHash(register byte *data, int len, dword hash);
word UncompressBlock(byte *pInput, word compCount, byte *pOutput, word BufferSize);
dword UncompressLoader(byte *pSrc, byte *pDest, void *pPercentFinishedCallback);
dword UncompressedLoaderSize(byte *pSrc);
dword UncompressFirmware(byte *pSrc, byte *pDest, void *pPercentFinishedCallback);
dword UncompressedFirmwareSize(byte *pSrc);
dword UncompressTFD(byte *pSrc, byte *pDest, void *pPercentFinishedCallback);
dword UncompressedTFDSize(byte *pSrc);
dword TFDSize(byte *pTFD);
/*****************************************************************************************************************************/
/* curl */
/*****************************************************************************************************************************/
typedef enum
{
CURLE_OK = 0,
CURLE_UNSUPPORTED_PROTOCOL, /* 1 */
CURLE_FAILED_INIT, /* 2 */
CURLE_URL_MALFORMAT, /* 3 */
CURLE_NOT_BUILT_IN, /* 4 - [was obsoleted in August 2007 for 7.17.0, reused in April 2011 for 7.21.5] */
CURLE_COULDNT_RESOLVE_PROXY, /* 5 */
CURLE_COULDNT_RESOLVE_HOST, /* 6 */
CURLE_COULDNT_CONNECT, /* 7 */
CURLE_FTP_WEIRD_SERVER_REPLY, /* 8 */
CURLE_REMOTE_ACCESS_DENIED, /* 9 - a service was denied by the server
due to lack of access - when login fails
this is not returned. */
CURLE_FTP_ACCEPT_FAILED, /* 10 - [was obsoleted in April 2006 for 7.15.4, reused in Dec 2011 for 7.24.0]*/
CURLE_FTP_WEIRD_PASS_REPLY, /* 11 */
CURLE_FTP_ACCEPT_TIMEOUT, /* 12 - timeout occurred accepting server
[was obsoleted in August 2007 for 7.17.0,
reused in Dec 2011 for 7.24.0]*/
CURLE_FTP_WEIRD_PASV_REPLY, /* 13 */
CURLE_FTP_WEIRD_227_FORMAT, /* 14 */
CURLE_FTP_CANT_GET_HOST, /* 15 */
CURLE_OBSOLETE16, /* 16 - NOT USED */
CURLE_FTP_COULDNT_SET_TYPE, /* 17 */
CURLE_PARTIAL_FILE, /* 18 */
CURLE_FTP_COULDNT_RETR_FILE, /* 19 */
CURLE_OBSOLETE20, /* 20 - NOT USED */
CURLE_QUOTE_ERROR, /* 21 - quote command failure */
CURLE_HTTP_RETURNED_ERROR, /* 22 */
CURLE_WRITE_ERROR, /* 23 */
CURLE_OBSOLETE24, /* 24 - NOT USED */
CURLE_UPLOAD_FAILED, /* 25 - failed upload "command" */
CURLE_READ_ERROR, /* 26 - couldn't open/read from file */
CURLE_OUT_OF_MEMORY, /* 27 */
/* Note: CURLE_OUT_OF_MEMORY may sometimes indicate a conversion error
instead of a memory allocation error if CURL_DOES_CONVERSIONS
is defined */
CURLE_OPERATION_TIMEDOUT, /* 28 - the timeout time was reached */
CURLE_OBSOLETE29, /* 29 - NOT USED */
CURLE_FTP_PORT_FAILED, /* 30 - FTP PORT operation failed */
CURLE_FTP_COULDNT_USE_REST, /* 31 - the REST command failed */
CURLE_OBSOLETE32, /* 32 - NOT USED */
CURLE_RANGE_ERROR, /* 33 - RANGE "command" didn't work */
CURLE_HTTP_POST_ERROR, /* 34 */
CURLE_SSL_CONNECT_ERROR, /* 35 - wrong when connecting with SSL */
CURLE_BAD_DOWNLOAD_RESUME, /* 36 - couldn't resume download */
CURLE_FILE_COULDNT_READ_FILE, /* 37 */
CURLE_LDAP_CANNOT_BIND, /* 38 */
CURLE_LDAP_SEARCH_FAILED, /* 39 */
CURLE_OBSOLETE40, /* 40 - NOT USED */
CURLE_FUNCTION_NOT_FOUND, /* 41 */
CURLE_ABORTED_BY_CALLBACK, /* 42 */
CURLE_BAD_FUNCTION_ARGUMENT, /* 43 */
CURLE_OBSOLETE44, /* 44 - NOT USED */
CURLE_INTERFACE_FAILED, /* 45 - CURLOPT_INTERFACE failed */
CURLE_OBSOLETE46, /* 46 - NOT USED */
CURLE_TOO_MANY_REDIRECTS , /* 47 - catch endless re-direct loops */
CURLE_UNKNOWN_OPTION, /* 48 - User specified an unknown option */
CURLE_TELNET_OPTION_SYNTAX , /* 49 - Malformed telnet option */
CURLE_OBSOLETE50, /* 50 - NOT USED */
CURLE_PEER_FAILED_VERIFICATION, /* 51 - peer's certificate or fingerprint wasn't verified fine */
CURLE_GOT_NOTHING, /* 52 - when this is a specific error */
CURLE_SSL_ENGINE_NOTFOUND, /* 53 - SSL crypto engine not found */
CURLE_SSL_ENGINE_SETFAILED, /* 54 - can not set SSL crypto engine as default */
CURLE_SEND_ERROR, /* 55 - failed sending network data */
CURLE_RECV_ERROR, /* 56 - failure in receiving network data */
CURLE_OBSOLETE57, /* 57 - NOT IN USE */
CURLE_SSL_CERTPROBLEM, /* 58 - problem with the local certificate */
CURLE_SSL_CIPHER, /* 59 - couldn't use specified cipher */
CURLE_SSL_CACERT, /* 60 - problem with the CA cert (path?) */
CURLE_BAD_CONTENT_ENCODING, /* 61 - Unrecognized/bad encoding */
CURLE_LDAP_INVALID_URL, /* 62 - Invalid LDAP URL */
CURLE_FILESIZE_EXCEEDED, /* 63 - Maximum file size exceeded */
CURLE_USE_SSL_FAILED, /* 64 - Requested FTP SSL level failed */
CURLE_SEND_FAIL_REWIND, /* 65 - Sending the data requires a rewind that failed */
CURLE_SSL_ENGINE_INITFAILED, /* 66 - failed to initialise ENGINE */
CURLE_LOGIN_DENIED, /* 67 - user, password or similar was not accepted and we failed to login */
CURLE_TFTP_NOTFOUND, /* 68 - file not found on server */
CURLE_TFTP_PERM, /* 69 - permission problem on server */
CURLE_REMOTE_DISK_FULL, /* 70 - out of disk space on server */
CURLE_TFTP_ILLEGAL, /* 71 - Illegal TFTP operation */
CURLE_TFTP_UNKNOWNID, /* 72 - Unknown transfer ID */
CURLE_REMOTE_FILE_EXISTS, /* 73 - File already exists */
CURLE_TFTP_NOSUCHUSER, /* 74 - No such user */
CURLE_CONV_FAILED, /* 75 - conversion failed */
CURLE_CONV_REQD, /* 76 - caller must register conversion
callbacks using curl_easy_setopt options
CURLOPT_CONV_FROM_NETWORK_FUNCTION,
CURLOPT_CONV_TO_NETWORK_FUNCTION, and
CURLOPT_CONV_FROM_UTF8_FUNCTION */
CURLE_SSL_CACERT_BADFILE, /* 77 - could not load CACERT file, missing or wrong format */
CURLE_REMOTE_FILE_NOT_FOUND, /* 78 - remote file not found */
CURLE_SSH, /* 79 - error from the SSH layer, somewhat
generic so the error message will be of
interest when this has happened */
CURLE_SSL_SHUTDOWN_FAILED, /* 80 - Failed to shut down the SSL connection */
CURLE_AGAIN, /* 81 - socket is not ready for send/recv,
wait till it's ready and try again (Added
in 7.18.2) */
CURLE_SSL_CRL_BADFILE, /* 82 - could not load CRL file, missing or wrong format (Added in 7.19.0) */
CURLE_SSL_ISSUER_ERROR, /* 83 - Issuer check failed. (Added in 7.19.0) */
CURLE_FTP_PRET_FAILED, /* 84 - a PRET command failed */
CURLE_RTSP_CSEQ_ERROR, /* 85 - mismatch of RTSP CSeq numbers */
CURLE_RTSP_SESSION_ERROR, /* 86 - mismatch of RTSP Session Ids */
CURLE_FTP_BAD_FILE_LIST, /* 87 - unable to parse FTP file list */
CURLE_CHUNK_FAILED, /* 88 - chunk callback reported error */
CURL_LAST /* never use! */
} CURLcode;
/* long may be 32 or 64 bits, but we should never depend on anything else but 32 */
#define CURLOPTTYPE_LONG 0
#define CURLOPTTYPE_OBJECTPOINT 10000
#define CURLOPTTYPE_FUNCTIONPOINT 20000
#define CURLOPTTYPE_OFF_T 30000
#define CINIT(na,t,nu) CURLOPT_ ## na = CURLOPTTYPE_ ## t + nu
//#define CINIT(name,type,number) CURLOPT_/**/name = type + number
/*
* This macro-mania below setups the CURLOPT_[what] enum, to be used with
* curl_easy_setopt(). The first argument in the CINIT() macro is the [what]
* word.
*/
typedef enum
{
CINIT(FILE, OBJECTPOINT, 1), /* This is the FILE * or void * the regular output should be written to. */
CINIT(URL, OBJECTPOINT, 2), /* The full URL to get/put */
CINIT(PORT, LONG, 3), /* Port number to connect to, if other than default. */
CINIT(PROXY, OBJECTPOINT, 4), /* Name of proxy to use. */
CINIT(USERPWD, OBJECTPOINT, 5), /* "name:password" to use when fetching. */
CINIT(PROXYUSERPWD, OBJECTPOINT, 6), /* "name:password" to use with proxy. */
CINIT(RANGE, OBJECTPOINT, 7), /* Range to get, specified as an ASCII string. */
/* not used */
CINIT(INFILE, OBJECTPOINT, 9), /* Specified file stream to upload from (use as input): */
CINIT(ERRORBUFFER, OBJECTPOINT, 10), /* Buffer to receive error messages in, must be at least CURL_ERROR_SIZE bytes big. If this is not used,
error messages go to stderr instead: */
CINIT(WRITEFUNCTION, FUNCTIONPOINT, 11), /* Function that will be called to store the output (instead of fwrite). The parameters will use
fwrite() syntax, make sure to follow them. */
CINIT(READFUNCTION, FUNCTIONPOINT, 12), /* Function that will be called to read the input (instead of fread). The parameters will use fread()
syntax, make sure to follow them. */
CINIT(TIMEOUT, LONG, 13), /* Time-out the read operation after this amount of seconds */
/* If the CURLOPT_INFILE is used, this can be used to inform libcurl about
* how large the file being sent really is. That allows better error
* checking and better verifies that the upload was successful. -1 means
* unknown size.
*
* For large file support, there is also a _LARGE version of the key
* which takes an off_t type, allowing platforms with larger off_t
* sizes to handle larger files. See below for INFILESIZE_LARGE.
*/
CINIT(INFILESIZE, LONG, 14),
CINIT(POSTFIELDS, OBJECTPOINT, 15), /* POST static input fields. */
CINIT(REFERER, OBJECTPOINT, 16), /* Set the referrer page (needed by some CGIs) */
CINIT(FTPPORT, OBJECTPOINT, 17), /* Set the FTP PORT string (interface name, named or numerical IP address) Use i.e '-' to use default address. */
CINIT(USERAGENT, OBJECTPOINT, 18), /* Set the User-Agent string (examined by some CGIs) */
/* If the download receives less than "low speed limit" bytes/second
* during "low speed time" seconds, the operations is aborted.
* You could i.e if you have a pretty high speed connection, abort if
* it is less than 2000 bytes/sec during 20 seconds.
*/
CINIT(LOW_SPEED_LIMIT, LONG, 19), /* Set the "low speed limit" */
CINIT(LOW_SPEED_TIME, LONG, 20), /* Set the "low speed time" */
CINIT(RESUME_FROM, LONG, 21), /* Set the continuation offset.
Note there is also a _LARGE version of this key which uses
off_t types, allowing for large file offsets on platforms which
use larger-than-32-bit off_t's. Look below for RESUME_FROM_LARGE. */
CINIT(COOKIE, OBJECTPOINT, 22), /* Set cookie in request: */
CINIT(HTTPHEADER, OBJECTPOINT, 23), /* This points to a linked list of headers, struct curl_slist kind */
CINIT(HTTPPOST, OBJECTPOINT, 24), /* This points to a linked list of post entries, struct curl_httppost */
CINIT(SSLCERT, OBJECTPOINT, 25), /* name of the file keeping your private SSL-certificate */
CINIT(KEYPASSWD, OBJECTPOINT, 26), /* password for the SSL or SSH private key */
CINIT(CRLF, LONG, 27), /* send TYPE parameter? */
CINIT(QUOTE, OBJECTPOINT, 28), /* send linked-list of QUOTE commands */
/* send FILE * or void * to store headers to, if you use a callback it
is simply passed to the callback unmodified */
CINIT(WRITEHEADER, OBJECTPOINT, 29),
/* point to a file to read the initial cookies from, also enables
"cookie awareness" */
CINIT(COOKIEFILE, OBJECTPOINT, 31),
/* What version to specifically try to use.
See CURL_SSLVERSION defines below. */
CINIT(SSLVERSION, LONG, 32),
/* What kind of HTTP time condition to use, see defines */
CINIT(TIMECONDITION, LONG, 33),
/* Time to use with the above condition. Specified in number of seconds
since 1 Jan 1970 */
CINIT(TIMEVALUE, LONG, 34),
/* 35 = OBSOLETE */
/* Custom request, for customizing the get command like
HTTP: DELETE, TRACE and others
FTP: to use a different list command
*/
CINIT(CUSTOMREQUEST, OBJECTPOINT, 36),
/* HTTP request, for odd commands like DELETE, TRACE and others */
CINIT(STDERR, OBJECTPOINT, 37),
/* 38 is not used */
/* send linked-list of post-transfer QUOTE commands */
CINIT(POSTQUOTE, OBJECTPOINT, 39),
CINIT(WRITEINFO, OBJECTPOINT, 40), /* DEPRECATED, do not use! */
CINIT(VERBOSE, LONG, 41), /* talk a lot */
CINIT(HEADER, LONG, 42), /* throw the header out too */
CINIT(NOPROGRESS, LONG, 43), /* shut off the progress meter */
CINIT(NOBODY, LONG, 44), /* use HEAD to get http document */
CINIT(FAILONERROR, LONG, 45), /* no output on http error codes >= 300 */
CINIT(UPLOAD, LONG, 46), /* this is an upload */
CINIT(POST, LONG, 47), /* HTTP POST method */
CINIT(DIRLISTONLY, LONG, 48), /* bare names when listing directories */
CINIT(APPEND, LONG, 50), /* Append instead of overwrite on upload! */
/* Specify whether to read the user+password from the .netrc or the URL.
* This must be one of the CURL_NETRC_* enums below. */
CINIT(NETRC, LONG, 51),
CINIT(FOLLOWLOCATION, LONG, 52), /* use Location: Luke! */
CINIT(TRANSFERTEXT, LONG, 53), /* transfer data in text/ASCII format */
CINIT(PUT, LONG, 54), /* HTTP PUT */
/* 55 = OBSOLETE */
/* Function that will be called instead of the internal progress display
* function. This function should be defined as the curl_progress_callback
* prototype defines. */
CINIT(PROGRESSFUNCTION, FUNCTIONPOINT, 56),
/* Data passed to the progress callback */
CINIT(PROGRESSDATA, OBJECTPOINT, 57),
/* We want the referrer field set automatically when following locations */
CINIT(AUTOREFERER, LONG, 58),
/* Port of the proxy, can be set in the proxy string as well with:
"[host]:[port]" */
CINIT(PROXYPORT, LONG, 59),
/* size of the POST input data, if strlen() is not good to use */
CINIT(POSTFIELDSIZE, LONG, 60),
/* tunnel non-http operations through a HTTP proxy */
CINIT(HTTPPROXYTUNNEL, LONG, 61),
/* Set the interface string to use as outgoing network interface */
CINIT(INTERFACE, OBJECTPOINT, 62),
/* Set the krb4/5 security level, this also enables krb4/5 awareness. This
* is a string, 'clear', 'safe', 'confidential' or 'private'. If the string
* is set but doesn't match one of these, 'private' will be used. */
CINIT(KRBLEVEL, OBJECTPOINT, 63),
/* Set if we should verify the peer in ssl handshake, set 1 to verify. */
CINIT(SSL_VERIFYPEER, LONG, 64),
/* The CApath or CAfile used to validate the peer certificate
this option is used only if SSL_VERIFYPEER is true */
CINIT(CAINFO, OBJECTPOINT, 65),
/* 66 = OBSOLETE */
/* 67 = OBSOLETE */
/* Maximum number of http redirects to follow */
CINIT(MAXREDIRS, LONG, 68),
/* Pass a long set to 1 to get the date of the requested document (if
possible)! Pass a zero to shut it off. */
CINIT(FILETIME, LONG, 69),
/* This points to a linked list of telnet options */
CINIT(TELNETOPTIONS, OBJECTPOINT, 70),
/* Max amount of cached alive connections */
CINIT(MAXCONNECTS, LONG, 71),
CINIT(CLOSEPOLICY, LONG, 72), /* DEPRECATED, do not use! */
/* 73 = OBSOLETE */
/* Set to explicitly use a new connection for the upcoming transfer.
Do not use this unless you're absolutely sure of this, as it makes the
operation slower and is less friendly for the network. */
CINIT(FRESH_CONNECT, LONG, 74),
/* Set to explicitly forbid the upcoming transfer's connection to be re-used
when done. Do not use this unless you're absolutely sure of this, as it
makes the operation slower and is less friendly for the network. */
CINIT(FORBID_REUSE, LONG, 75),
/* Set to a file name that contains random data for libcurl to use to
seed the random engine when doing SSL connects. */
CINIT(RANDOM_FILE, OBJECTPOINT, 76),
/* Set to the Entropy Gathering Daemon socket pathname */
CINIT(EGDSOCKET, OBJECTPOINT, 77),
/* Time-out connect operations after this amount of seconds, if connects are
OK within this time, then fine... This only aborts the connect phase. */
CINIT(CONNECTTIMEOUT, LONG, 78),
/* Function that will be called to store headers (instead of fwrite). The
* parameters will use fwrite() syntax, make sure to follow them. */
CINIT(HEADERFUNCTION, FUNCTIONPOINT, 79),
/* Set this to force the HTTP request to get back to GET. Only really usable
if POST, PUT or a custom request have been used first.
*/
CINIT(HTTPGET, LONG, 80),
/* Set if we should verify the Common name from the peer certificate in ssl
* handshake, set 1 to check existence, 2 to ensure that it matches the
* provided hostname. */
CINIT(SSL_VERIFYHOST, LONG, 81),
/* Specify which file name to write all known cookies in after completed
operation. Set file name to "-" (dash) to make it go to stdout. */
CINIT(COOKIEJAR, OBJECTPOINT, 82),
/* Specify which SSL ciphers to use */
CINIT(SSL_CIPHER_LIST, OBJECTPOINT, 83),
/* Specify which HTTP version to use! This must be set to one of the
CURL_HTTP_VERSION* enums set below. */
CINIT(HTTP_VERSION, LONG, 84),
/* Specifically switch on or off the FTP engine's use of the EPSV command. By
default, that one will always be attempted before the more traditional
PASV command. */
CINIT(FTP_USE_EPSV, LONG, 85),
/* type of the file keeping your SSL-certificate ("DER", "PEM", "ENG") */
CINIT(SSLCERTTYPE, OBJECTPOINT, 86),
/* name of the file keeping your private SSL-key */
CINIT(SSLKEY, OBJECTPOINT, 87),
/* type of the file keeping your private SSL-key ("DER", "PEM", "ENG") */
CINIT(SSLKEYTYPE, OBJECTPOINT, 88),
/* crypto engine for the SSL-sub system */
CINIT(SSLENGINE, OBJECTPOINT, 89),
/* set the crypto engine for the SSL-sub system as default
the param has no meaning...
*/
CINIT(SSLENGINE_DEFAULT, LONG, 90),
/* Non-zero value means to use the global dns cache */
CINIT(DNS_USE_GLOBAL_CACHE, LONG, 91), /* DEPRECATED, do not use! */
/* DNS cache timeout */
CINIT(DNS_CACHE_TIMEOUT, LONG, 92),
/* send linked-list of pre-transfer QUOTE commands */
CINIT(PREQUOTE, OBJECTPOINT, 93),
/* set the debug function */
CINIT(DEBUGFUNCTION, FUNCTIONPOINT, 94),
/* set the data for the debug function */
CINIT(DEBUGDATA, OBJECTPOINT, 95),
/* mark this as start of a cookie session */
CINIT(COOKIESESSION, LONG, 96),
/* The CApath directory used to validate the peer certificate
this option is used only if SSL_VERIFYPEER is true */
CINIT(CAPATH, OBJECTPOINT, 97),
/* Instruct libcurl to use a smaller receive buffer */
CINIT(BUFFERSIZE, LONG, 98),
/* Instruct libcurl to not use any signal/alarm handlers, even when using
timeouts. This option is useful for multi-threaded applications.
See libcurl-the-guide for more background information. */
CINIT(NOSIGNAL, LONG, 99),
/* Provide a CURLShare for mutexing non-ts data */
CINIT(SHARE, OBJECTPOINT, 100),
/* indicates type of proxy. accepted values are CURLPROXY_HTTP (default),
CURLPROXY_SOCKS4, CURLPROXY_SOCKS4A and CURLPROXY_SOCKS5. */
CINIT(PROXYTYPE, LONG, 101),
/* Set the Accept-Encoding string. Use this to tell a server you would like
the response to be compressed. Before 7.21.6, this was known as
CURLOPT_ENCODING */
CINIT(ACCEPT_ENCODING, OBJECTPOINT, 102),
/* Set pointer to private data */
CINIT(PRIVATE, OBJECTPOINT, 103),
/* Set aliases for HTTP 200 in the HTTP Response header */
CINIT(HTTP200ALIASES, OBJECTPOINT, 104),
/* Continue to send authentication (user+password) when following locations,
even when hostname changed. This can potentially send off the name
and password to whatever host the server decides. */
CINIT(UNRESTRICTED_AUTH, LONG, 105),
/* Specifically switch on or off the FTP engine's use of the EPRT command (
it also disables the LPRT attempt). By default, those ones will always be
attempted before the good old traditional PORT command. */
CINIT(FTP_USE_EPRT, LONG, 106),
/* Set this to a bitmask value to enable the particular authentications
methods you like. Use this in combination with CURLOPT_USERPWD.
Note that setting multiple bits may cause extra network round-trips. */
CINIT(HTTPAUTH, LONG, 107),
/* Set the ssl context callback function, currently only for OpenSSL ssl_ctx
in second argument. The function must be matching the
curl_ssl_ctx_callback proto. */
CINIT(SSL_CTX_FUNCTION, FUNCTIONPOINT, 108),
/* Set the userdata for the ssl context callback function's third
argument */
CINIT(SSL_CTX_DATA, OBJECTPOINT, 109),
/* FTP Option that causes missing dirs to be created on the remote server.
In 7.19.4 we introduced the convenience enums for this option using the
CURLFTP_CREATE_DIR prefix.
*/
CINIT(FTP_CREATE_MISSING_DIRS, LONG, 110),
/* Set this to a bitmask value to enable the particular authentications
methods you like. Use this in combination with CURLOPT_PROXYUSERPWD.
Note that setting multiple bits may cause extra network round-trips. */
CINIT(PROXYAUTH, LONG, 111),
/* FTP option that changes the timeout, in seconds, associated with
getting a response. This is different from transfer timeout time and
essentially places a demand on the FTP server to acknowledge commands
in a timely manner. */
CINIT(FTP_RESPONSE_TIMEOUT, LONG, 112),
#define CURLOPT_SERVER_RESPONSE_TIMEOUT CURLOPT_FTP_RESPONSE_TIMEOUT
/* Set this option to one of the CURL_IPRESOLVE_* defines (see below) to
tell libcurl to resolve names to those IP versions only. This only has
affect on systems with support for more than one, i.e IPv4 _and_ IPv6. */
CINIT(IPRESOLVE, LONG, 113),
/* Set this option to limit the size of a file that will be downloaded from
an HTTP or FTP server.
Note there is also _LARGE version which adds large file support for
platforms which have larger off_t sizes. See MAXFILESIZE_LARGE below. */
CINIT(MAXFILESIZE, LONG, 114),
/* See the comment for INFILESIZE above, but in short, specifies
* the size of the file being uploaded. -1 means unknown.
*/
CINIT(INFILESIZE_LARGE, OFF_T, 115),
/* Sets the continuation offset. There is also a LONG version of this;
* look above for RESUME_FROM.
*/
CINIT(RESUME_FROM_LARGE, OFF_T, 116),
/* Sets the maximum size of data that will be downloaded from
* an HTTP or FTP server. See MAXFILESIZE above for the LONG version.
*/
CINIT(MAXFILESIZE_LARGE, OFF_T, 117),
/* Set this option to the file name of your .netrc file you want libcurl
to parse (using the CURLOPT_NETRC option). If not set, libcurl will do
a poor attempt to find the user's home directory and check for a .netrc
file in there. */
CINIT(NETRC_FILE, OBJECTPOINT, 118),
/* Enable SSL/TLS for FTP, pick one of:
CURLUSESSL_TRY - try using SSL, proceed anyway otherwise
CURLUSESSL_CONTROL - SSL for the control connection or fail
CURLUSESSL_ALL - SSL for all communication or fail
*/
CINIT(USE_SSL, LONG, 119),
/* The _LARGE version of the standard POSTFIELDSIZE option */
CINIT(POSTFIELDSIZE_LARGE, OFF_T, 120),
/* Enable/disable the TCP Nagle algorithm */
CINIT(TCP_NODELAY, LONG, 121),
/* 122 OBSOLETE, used in 7.12.3. Gone in 7.13.0 */
/* 123 OBSOLETE. Gone in 7.16.0 */
/* 124 OBSOLETE, used in 7.12.3. Gone in 7.13.0 */
/* 125 OBSOLETE, used in 7.12.3. Gone in 7.13.0 */
/* 126 OBSOLETE, used in 7.12.3. Gone in 7.13.0 */
/* 127 OBSOLETE. Gone in 7.16.0 */
/* 128 OBSOLETE. Gone in 7.16.0 */
/* When FTP over SSL/TLS is selected (with CURLOPT_USE_SSL), this option
can be used to change libcurl's default action which is to first try
"AUTH SSL" and then "AUTH TLS" in this order, and proceed when a OK
response has been received.
Available parameters are:
CURLFTPAUTH_DEFAULT - let libcurl decide
CURLFTPAUTH_SSL - try "AUTH SSL" first, then TLS
CURLFTPAUTH_TLS - try "AUTH TLS" first, then SSL
*/
CINIT(FTPSSLAUTH, LONG, 129),
CINIT(IOCTLFUNCTION, FUNCTIONPOINT, 130),
CINIT(IOCTLDATA, OBJECTPOINT, 131),
/* 132 OBSOLETE. Gone in 7.16.0 */
/* 133 OBSOLETE. Gone in 7.16.0 */
/* zero terminated string for pass on to the FTP server when asked for
"account" info */
CINIT(FTP_ACCOUNT, OBJECTPOINT, 134),
/* feed cookies into cookie engine */
CINIT(COOKIELIST, OBJECTPOINT, 135),
/* ignore Content-Length */
CINIT(IGNORE_CONTENT_LENGTH, LONG, 136),
/* Set to non-zero to skip the IP address received in a 227 PASV FTP server
response. Typically used for FTP-SSL purposes but is not restricted to
that. libcurl will then instead use the same IP address it used for the
control connection. */
CINIT(FTP_SKIP_PASV_IP, LONG, 137),
/* Select "file method" to use when doing FTP, see the curl_ftpmethod
above. */
CINIT(FTP_FILEMETHOD, LONG, 138),
/* Local port number to bind the socket to */
CINIT(LOCALPORT, LONG, 139),
/* Number of ports to try, including the first one set with LOCALPORT.
Thus, setting it to 1 will make no additional attempts but the first.
*/
CINIT(LOCALPORTRANGE, LONG, 140),
/* no transfer, set up connection and let application use the socket by
extracting it with CURLINFO_LASTSOCKET */
CINIT(CONNECT_ONLY, LONG, 141),
/* Function that will be called to convert from the
network encoding (instead of using the iconv calls in libcurl) */
CINIT(CONV_FROM_NETWORK_FUNCTION, FUNCTIONPOINT, 142),
/* Function that will be called to convert to the
network encoding (instead of using the iconv calls in libcurl) */
CINIT(CONV_TO_NETWORK_FUNCTION, FUNCTIONPOINT, 143),
/* Function that will be called to convert from UTF8
(instead of using the iconv calls in libcurl)
Note that this is used only for SSL certificate processing */
CINIT(CONV_FROM_UTF8_FUNCTION, FUNCTIONPOINT, 144),
/* if the connection proceeds too quickly then need to slow it down */
/* limit-rate: maximum number of bytes per second to send or receive */
CINIT(MAX_SEND_SPEED_LARGE, OFF_T, 145),
CINIT(MAX_RECV_SPEED_LARGE, OFF_T, 146),
/* Pointer to command string to send if USER/PASS fails. */
CINIT(FTP_ALTERNATIVE_TO_USER, OBJECTPOINT, 147),
/* callback function for setting socket options */
CINIT(SOCKOPTFUNCTION, FUNCTIONPOINT, 148),
CINIT(SOCKOPTDATA, OBJECTPOINT, 149),
/* set to 0 to disable session ID re-use for this transfer, default is
enabled (== 1) */
CINIT(SSL_SESSIONID_CACHE, LONG, 150),
/* allowed SSH authentication methods */
CINIT(SSH_AUTH_TYPES, LONG, 151),
/* Used by scp/sftp to do public/private key authentication */
CINIT(SSH_PUBLIC_KEYFILE, OBJECTPOINT, 152),
CINIT(SSH_PRIVATE_KEYFILE, OBJECTPOINT, 153),
/* Send CCC (Clear Command Channel) after authentication */
CINIT(FTP_SSL_CCC, LONG, 154),
/* Same as TIMEOUT and CONNECTTIMEOUT, but with ms resolution */
CINIT(TIMEOUT_MS, LONG, 155),
CINIT(CONNECTTIMEOUT_MS, LONG, 156),
/* set to zero to disable the libcurl's decoding and thus pass the raw body
data to the application even when it is encoded/compressed */
CINIT(HTTP_TRANSFER_DECODING, LONG, 157),
CINIT(HTTP_CONTENT_DECODING, LONG, 158),
/* Permission used when creating new files and directories on the remote
server for protocols that support it, SFTP/SCP/FILE */
CINIT(NEW_FILE_PERMS, LONG, 159),
CINIT(NEW_DIRECTORY_PERMS, LONG, 160),
/* Set the behaviour of POST when redirecting. Values must be set to one
of CURL_REDIR* defines below. This used to be called CURLOPT_POST301 */
CINIT(POSTREDIR, LONG, 161),
/* used by scp/sftp to verify the host's public key */
CINIT(SSH_HOST_PUBLIC_KEY_MD5, OBJECTPOINT, 162),