/usr/include/libcrystalhd/libcrystalhd_if.h is in libcrystalhd-dev 1:0.0~git20110715.fdd2f19-11.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 | /*****************************************************************************
* Copyright(c) 2006-2009 Broadcom Corporation.
*
* Name: libcrystalhd_if.h
*
* Description: Device Interface Library API.
*
* AU
*
* HISTORY:
*
*****************************************************************************
*
* This file is part of libcrystalhd.
*
* This library is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published
* by the Free Software Foundation, either version 2.1 of the License.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
* You should have received a copy of the GNU Lesser General Public License
* along with this library. If not, see <http://www.gnu.org/licenses/>.
*
****************************************************************************/
#ifndef _BCM_LDIL_IF_H_
#define _BCM_LDIL_IF_H_
#include "bc_dts_defs.h"
#include "bc_dts_types.h"
#define FLEA_MAX_TRICK_MODE_SPEED 6
#ifdef __cplusplus
extern "C" {
#endif
/*****************************************************************************
******************************************************************************
Theory of operation
The Device Interface Library (DIL) allows application level code, such
as a DirectShow filter, to access the Broadcom CrystalHD decoder driver to
provide hardware decoding for MPEG-2, H.264 (AVC) and VC-1 streams.
In the Microsoft DirectShow system, the overall system graph would look
like the following:
+--------+ +---------------+ +---------------+ +--------------------+
| Source |->| Demultiplexer |->| Audio decoder |->| DirectSound Device |
+--------+ +---------------+ +---------------+ +--------------------+
|
| +-------------------------+ +----------------+
+->| Broadcom decoder filter |->| Video Renderer |
+-------------------------+ +----------------+
| |
+----------------+
| Broadcom DIL |
+----------------+
| |
+-----------------+
| Broadcom Driver |
+-----------------+
From the view of the caller, the DIL will accept compressed video streams
and will output decoded video frames or fields to seperate Y and UV buffers.
The DIL is responsible solely for decoding video and has no responsibilities
for audio nor for rendering, as shown in the above diagram. Audio/video
sychronization is assisted by feeding the DIL with timestamps so that it
may pass those timestamps along with the decoded video. The timestamped
output video will then be presented at the appropriate time by the renderer.
A minimal implementation would be:
HANDLE hBRCMhandle;
uint8_t input_buffer[INPUT_SIZE];
uint8_t y_output_buffer[WIDTH*HEIGHT];
uint8_t uv_output_buffer[WIDTH*HEIGHT];
BC_DTS_PROC_OUT sProcOutData = { fill in your values here };
BC_PIC_INFO_BLOCK sPIB = { fill in your values here };
// Acquire handle for device.
DtsDeviceOpen(&hBRCMhandle, 0);
// Elemental stream.
DtsOpenDecoder(hBRCMhandle, 0);
// H.264, Enable FGT SEI, do not parse metadata, no forced progressive out
DtsSetVideoParams(hBRCMhandle,0,1,0,0,0);
// Tell decoder to wait for input from host. (PC)
DtsStartDecoder(hBRCMhandle);
// Input buffer address, input buffer size, no timestamp, Unencrypted
DtsProcInput(hBRCMhandle,input_buffer,sizeof(input_buffer),0,0);
// Tell PC to wait for data from decoder.
DtsStartCapture(hBRCMhandle);
// 16ms timeout, pass pointer to PIB then get the decoded picture.
DtsProcOutput(hBRCMhandle,16,&sPIB);
// Stop the decoder.
DtsStopDecoder(hBRCMhandle);
// Close the decoder
DtsCloseDecoder(hBRCMhandle);
// Release handle for device.
DtsDeviceClose(hBRCMhandle);
******************************************************************************
*****************************************************************************/
#define DRVIFLIB_API
/*****************************************************************************
Function name:
DtsDeviceOpen
Description:
Opens a handle to the decoder device that will be used to address that
unique instance of the decoder for all subsequent operations.
Must be called once when the application opens the decoder for use.
Parameters:
*hDevice Pointer to device handle that will be filled in after the
device is successfully opened. [OUTPUT]
mode Controls the mode in which the device is opened.
Currently only mode 0 (normal playback) is supported.
All other values will return BC_STS_INV_ARG.
Return:
Returns BC_STS_SUCCESS or error codes as appropriate.
*****************************************************************************/
DRVIFLIB_API BC_STATUS
DtsDeviceOpen(
HANDLE *hDevice,
uint32_t mode
);
/*****************************************************************************
Function name:
DtsDeviceClose
Description:
Close the handle to the decoder device.
Must be called once when the application closes the decoder after use.
Parameters:
hDevice Handle to device. This is obtained via a prior call to
DtsDeviceOpen
Return:
Returns BC_STS_SUCCESS or error codes as appropriate.
*****************************************************************************/
DRVIFLIB_API BC_STATUS
DtsDeviceClose(
HANDLE hDevice
);
/*****************************************************************************
Function name:
DtsGetVersion
Description:
Get version information from the driver as well as API library.
Version numbers are maintained in <Major>.<Minor>.<Revision> format.
Example ?01.23.4567
The device must have been previously opened for this call to succeed.
The individual components of the revision number are available as follows:
o Major (8 Bits) : Bit 31 ?24
o Minor (8 Bits) : Bit 23 ?16
o Revision (16 Bits) : Bits 15 ?Bit 0.
Parameters:
hDevice Handle to device. This is obtained via a prior call to
DtsDeviceOpen
DrVer Device driver version
DilVer Driver interface library version
Return:
The revision numbers from the currently loaded driver as well as the
driver interface API library.
BC_STS_SUCCESS will be returned on successful completion.
*****************************************************************************/
DRVIFLIB_API BC_STATUS
DtsGetVersion(
HANDLE hDevice,
uint32_t *DrVer,
uint32_t *DilVer
);
/*****************************************************************************
Function name:
DtsGetFWVersionFromFile
Description:
Get version information from the Firmware Bin file when FW is not running
Version numbers in FW are maintained in <Major>.<Minor>.<Spl Revision> format.
the return value will be of the format:
(Major << 16) | (Minor<<8) | Spl_rev ?012345
The individual components of the revision number are available as follows:
o Major (8 Bits) : Bit 24 ?16
o Minor (8 Bits) : Bit 16 ?8
o Revision (16 Bits) : Bits 8 ?0.
Parameters:
hDevice Handle to device. This is obtained via a prior call to
DtsDeviceOpen
StreamVer Stream FW version
DecVer VDEC FW version
Rsvd Reserved for future use
Return:
The Stream FW Version umbers from the FW bin file in the install directory
BC_STS_SUCCESS will be returned on successful completion.
*****************************************************************************/
DRVIFLIB_API BC_STATUS
DtsGetFWVersionFromFile(
HANDLE hDevice,
uint32_t *StreamVer,
uint32_t *DecVer,
char *fname
);
/*****************************************************************************
Function name:
DtsGetFWVersion
Description:
Get version information from the Firmware. The version information is obtained
from Bin file when the flag is not set. When the flag is set, a FW command is
issued to get the version numbers.
Version numbers in FW are maintained in <Major>.<Minor>.<Spl Revision> format.
Version number will be returned in the following format
(Major << 16) | (Minor<<8) | Spl_rev ?012345
The individual components of the revision number are available as follows:
o Major (8 Bits) : Bit 24 ?16
o Minor (8 Bits) : Bit 16 ?8
o Revision (16 Bits) : Bits 8 ?Bit 0.
Parameters:
hDevice Handle to device. This is obtained via a prior call to
DtsDeviceOpen
StreamVer Stream FW version
DecVer VDEC FW version
HwVer Hardware version
Rsvd Reserved for future use
flag Reseved for future use
Return:
The Stream FW Version number, VDEC FW version and Hwrev
BC_STS_SUCCESS will be returned on successful completion.
*****************************************************************************/
DRVIFLIB_API BC_STATUS
DtsGetFWVersion(
HANDLE hDevice,
uint32_t *StreamVer,
uint32_t *DecVer,
uint32_t *HwVer,
char *fname,
uint32_t flag
);
/*****************************************************************************
Function name:
DtsOpenDecoder
Description:
Open the decoder for playback operations and sets appropriate parameters
for decode of input video data.
The device must have been previously opened for this call to succeed.
Parameters:
hDevice Handle to device. This is obtained via a prior call to
DtsDeviceOpen.
StreamType Currently supported streams are:
Elementary Streams with no timestamp management (0)
Transport Streams (2)
Elementary Streams with timestamp management (6)
All other values will return BC_STS_INV_ARG.
Return:
BC_STS_SUCCESS will be returned on successful completion.
*****************************************************************************/
DRVIFLIB_API BC_STATUS
DtsOpenDecoder(
HANDLE hDevice,
uint32_t StreamType
);
/*****************************************************************************
Function name:
DtsCloseDecoder
Description:
Close the decoder. No further pictures will be produced and all input
will be ignored.
The device must have been previously opened for this call to succeed.
This function closes the decoder and cleans up the state of the driver
and the library. All pending pictures will be dropped and all outstanding
transfers to and from the decoder will be aborted.
Parameters:
hDevice Handle to device. This is obtained via a prior call to
DtsDeviceOpen.
Return:
BC_STS_SUCCESS will be returned on successful completion.
*****************************************************************************/
DRVIFLIB_API BC_STATUS
DtsCloseDecoder(
HANDLE hDevice
);
/*****************************************************************************
Function name:
DtsStartDecoder
Description:
Start the actual processing of input data. Before this command the
decoder will ignore all of the presented input data.
DtsOpenDecoder must always be followed by a DtsStartDecoder for the
decoder to start processing input data. The device must have been
previously opened for this call to succeed. In addition the video
parameters for codec must have been set via a call to DtsSetVideoParams.
Parameters:
hDevice Handle to device. This is obtained via a prior call to
DtsDeviceOpen.
Return:
BC_STS_SUCCESS will be returned on successful completion.
*****************************************************************************/
DRVIFLIB_API BC_STATUS
DtsStartDecoder(
HANDLE hDevice
);
/*****************************************************************************
Function name:
DtsSetVideoParams
Description:
Sets various codec parameters that would be used by a subsequent call
to DtsStartDecoder.
DtsSetVideoParams must always be called before DtsStartDecoder for the
decoder to start processing input data. The device must have been
previously opened for this call to succeed.
Parameters:
hDevice Handle to device. This is obtained via a prior call to
DtsDeviceOpen.
videoAlg Video Codec to be enabled to decode stream.
H.264 (0), VC-1 (4) and MPEG-2 (1) currently supported.
All other values will return BC_STS_INV_ARG
FGTEnable Enable processing of FGT SEI.
MetaDataEnable Enable retrieval of picture metadata to be sent to video
pipeline.
Progressive Instruct decoder to always try to send back progressive
frames. If input content is 1080p, the decoder will
ignore pull-down flags and always give 1080p output.
If 1080i content is processed, the decoder will return
1080i data. When this flag is not set, the decoder will
use pull-down information in the input stream to decide
the decoded data format.
OptFlags In this field bits 0:3 are used pass default frame rate,
bits 4:5 are for operation mode (used to indicate Blu-ray
mode to the decoder) and bit 6 is for the flag mpcOutPutMaxFRate
which when set tells the FW to output at the max rate for the
resolution and ignore the frame rate determined from the
stream. Bit 7 is set to indicate that this is single threaded mode
and the driver will be peeked to get timestamps ahead of time.
Return:
BC_STS_SUCCESS will be returned on successful completion.
*****************************************************************************/
DRVIFLIB_API BC_STATUS
DtsSetVideoParams(
HANDLE hDevice,
uint32_t videoAlg,
BOOL FGTEnable,
BOOL MetaDataEnable,
BOOL Progressive,
uint32_t OptFlags
);
/*****************************************************************************
Function name:
DtsSetInputFormat
Description:
Sets input video's various parameters that would be used by a subsequent call
to DtsStartDecoder.
DtsSetInputFormat must always be called before DtsOpenDecoder for the
decoder to start processing input data. The device must have been
previously opened for this call to succeed.
Parameters:
hDevice Handle to device. This is obtained via a prior call to DtsDeviceOpen.
pInputFormat Pointer to the BC_INPUT_FORMAT data.
Return:
BC_STS_SUCCESS will be returned on successful completion.
*****************************************************************************/
DRVIFLIB_API BC_STATUS
DtsSetInputFormat(
HANDLE hDevice,
BC_INPUT_FORMAT *pInputFormat
);
/*****************************************************************************
Function name:
DtsGetVideoParams
Description:
Returns various codec parameters that would be used by a subsequent call
to DtsStartDecoder. These parameters are either default values or were
set via a prior call to DtsSetVideoParams
The device must have been previously opened for this call to succeed.
Parameters:
hDevice Handle to device. This is obtained via a prior call to
DtsDeviceOpen.
*videoAlg See DtsSetVideoParams. [OUTPUT]
*FGTEnable See DtsSetVideoParams. [OUTPUT]
*MetaDataEnable See DtsSetVideoParams. [OUTPUT]
*Progressive See DtsSetVideoParams. [OUTPUT]
Reserved This field is reserved for possible future expansion.
Set to 0.
Return:
BC_STS_SUCCESS will be returned on successful completion.
*****************************************************************************/
DRVIFLIB_API BC_STATUS
DtsGetVideoParams(
HANDLE hDevice,
uint32_t *videoAlg,
BOOL *FGTEnable,
BOOL *MetaDataEnable,
BOOL *Progressive,
uint32_t Reserved
);
/*****************************************************************************
Function name:
DtsFormatChange
Description:
Changes codec type and parameters.
The device must have been previously opened for this call to succeed.
This function should be used only for mid-stream format changes.
DtsStartDecoder must have been called before for this function to succeed.
Parameters:
hDevice Handle to device. This is obtained via a prior call to
DtsDeviceOpen.
videoAlg Video Codec to be enabled to decode stream.
H.264 (0), VC-1 (4) and MPEG-2 (1) currently supported. All
other values will return BC_STS_INV_ARG
FGTEnable Enable processing of FGT SEI.
Progressive Instruct decoder to always try to send back progressive
frames. If input content is 1080p, the decoder will ignore
pull-down flags and always give 1080p output. If 1080i
content is processed, the decoder will return 1080i data.
When this flag is not set, the decoder will use pull-down
information in the input stream to decide the decoded data
format.
Reserved This field is reserved for possible future expansion.
Set to 0.
Return:
BC_STS_SUCCESS will be returned on successful completion.
*****************************************************************************/
DRVIFLIB_API BC_STATUS
DtsFormatChange(
HANDLE hDevice,
uint32_t videoAlg,
BOOL FGTEnable,
BOOL MetaDataEnable,
BOOL Progressive,
uint32_t Reserved
);
/*****************************************************************************
Function name:
DtsStopDecoder
Description:
Stop the decoder.
The device must have been previously opened for this call to succeed.
This function will clean up any pending operations and stop the decoder.
Internal state is still maintained and the decoder can be restarted.
Any pending pictures will be dropped.
Parameters:
hDevice Handle to device. This is obtained via a prior call to
DtsDeviceOpen.
Return:
BC_STS_SUCCESS will be returned on successful completion.
*****************************************************************************/
DRVIFLIB_API BC_STATUS
DtsStopDecoder(
HANDLE hDevice
);
/*****************************************************************************
Function name:
DtsPauseDecoder
Description:
Pause the decoder. The paused picture will be repeated by decoder.
The device must have been previously opened for this call to succeed.
In addition the decoder must have been started as well. If the decoder
is open but not started, this function will return BC_STS_DEC_NOT_STARTED.
If the decoder has not been opened this function will return
BC_STS_DEC_NOT_OPEN.
Parameters:
hDevice Handle to device. This is obtained via a prior call to
DtsDeviceOpen.
Return:
BC_STS_SUCCESS will be returned on successful completion.
*****************************************************************************/
DRVIFLIB_API BC_STATUS
DtsPauseDecoder(
HANDLE hDevice
);
/*****************************************************************************
Function name:
DtsResumeDecoder
Description:
Unpause the decoder from a previous paused condition.
The device must have been previously opened for this call to succeed.
If the decoder was not paused previously, this function will return
without affecting the decoder with a BC_STS_SUCCESS status. If the
decoder is open but not started, this function will return
BC_STS_DEC_NOT_STARTED.
Parameters:
hDevice Handle to device. This is obtained via a prior call to
DtsDeviceOpen.
Return:
BC_STS_SUCCESS will be returned on successful completion.
*****************************************************************************/
DRVIFLIB_API BC_STATUS
DtsResumeDecoder(
HANDLE hDevice
);
/*****************************************************************************
Function name:
DtsSetVideoPID
Description:
Sets the video PID in the input Transport Stream that the decoder
needs to process.
The device must have been previously opened for this call to succeed.
Parameters:
hDevice Handle to device. This is obtained via a prior call to
DtsDeviceOpen.
PID PID value that decoder needs to process.
Return:
BC_STS_SUCCESS will be returned on successful completion.
*****************************************************************************/
DRVIFLIB_API BC_STATUS
DtsSetVideoPID(
HANDLE hDevice,
uint32_t pid
);
/*****************************************************************************
Function name:
StartCaptureImmidiate
Description:
Instruct the driver to start capturing decoded frames for output.
The device must have been previously opened for this call to succeed.
This function must be called before the first call to DtsProcInput.
This function instructs the receive path in the driver to start waiting
for valid data to be presented from the decoder.
Parameters:
hDevice Handle to device. This is obtained via a prior call to
DtsDeviceOpen.
Return:
BC_STS_SUCCESS will be returned on successful completion.
*****************************************************************************/
DRVIFLIB_API BC_STATUS
DtsStartCaptureImmidiate(
HANDLE hDevice,
uint32_t Reserved
);
/*****************************************************************************
Function name:
StartCapture
Description:
Instruct the driver to start capturing decoded frames for output.
The device must have been previously opened for this call to succeed.
This function must be called before the first call to DtsProcInput.
This function instructs the receive path in the driver to start waiting
for valid data to be presented from the decoder.
Parameters:
hDevice Handle to device. This is obtained via a prior call to
DtsDeviceOpen.
Return:
BC_STS_SUCCESS will be returned on successful completion.
*****************************************************************************/
DRVIFLIB_API BC_STATUS
DtsStartCapture(
HANDLE hDevice
);
/*****************************************************************************
Function name:
FlushRxCapture
Description:
***This function is deprecated and is for temporary use only.***
Flush the driverÃs queue of pictures and stops the capture process. These
functions will be replaced with automatic Stop (End of Sequence) detection.
The device must have been previously opened for this call to succeed.
Parameters:
hDevice Handle to device. This is obtained via a prior call to
DtsDeviceOpen.
Return:
BC_STS_SUCCESS will be returned on successful completion.
*****************************************************************************/
DRVIFLIB_API BC_STATUS
DtsFlushRxCapture(
HANDLE hDevice,
BOOL bDiscardOnly
);
/*****************************************************************************
Function name:
DtsProcOutput
Description:
Returns one decoded picture to the caller.
The device must have been previously opened for this call to succeed.
== NOTE ====
For PIB AND 100% output encryption/scrambling on Bcm LINK hardware
use ProcOutputNoCopy() Interace. This interface will not support
PIB encryption.
Parameters:
hDevice Handle to device. This is obtained via a prior call to
DtsDeviceOpen.
milliSecWait Timeout parameter. DtsProcOutput will fail is no picture
is received in this time.
*pOut This is a pointer to the BC_DTS_PROC_OUT structure that is
allocated by the caller. The decoded picture is returned
in this structure. This structure is described in the
data structures section. The actual data buffer to be
filled with the decoded data is allocated by the caller.
Data is copied from the decoder to the buffers before this
function returns. [INPUT/OUTPUT]
Return:
BC_STS_SUCCESS will be returned on successful completion.
*****************************************************************************/
DRVIFLIB_API BC_STATUS
DtsProcOutput(
HANDLE hDevice,
uint32_t milliSecWait,
BC_DTS_PROC_OUT *pOut
);
/*****************************************************************************
Function name:
DtsProcOutputNoCopy
Description:
Returns one decoded picture to the caller. Functionality of this API()
is very similar to ProcOutPut() API. This API will not copy the video data
to caller's buffers but provides the source buffer pointers in pOut structure.
This is more secure and preferred method for BCM's Link hardware. The actual
format conversion/copy routines are provided as part of the Filter/Security
layer source code. Using this method, all the clear data handling will be
done by bcmDFilter or bcmSec layers which are expected to be in Player's
tamper resistant area.
== NOTE ====
1) DtsReleaseOutputBuffs() interface must be called to release the buffers
back to DIL if return Status is BC_STS_SUCCESS.
2) Only this interface supports PIB and full 100% output encryption/Scrambling.
The device must have been previously opened for this call to succeed.
Parameters:
hDevice Handle to device. This is obtained via a prior call to
DtsDeviceOpen.
milliSecWait Timeout parameter. DtsProcOoutput will fail is no picture
is received in this time.
*pOut This is a pointer to the BC_DTS_PROC_OUT structure that is
allocated by the caller. The decoded picture is returned
in this structure.
Return:
BC_STS_SUCCESS will be returned on successful completion.
*****************************************************************************/
DRVIFLIB_API BC_STATUS
DtsProcOutputNoCopy(
HANDLE hDevice,
uint32_t milliSecWait,
BC_DTS_PROC_OUT *pOut
);
/*****************************************************************************
Function name:
DtsReleaseOutputBuffs
Description:
Release Buffers acquired during ProcOutputNoCopy() interface.
Parameters:
hDevice Handle to device. This is obtained via a prior call to
DtsDeviceOpen.
Reserved Reserved. Set to NULL.
fChange FALSE.
Return:
BC_STS_SUCCESS will be returned on successful completion.
*****************************************************************************/
DRVIFLIB_API BC_STATUS
DtsReleaseOutputBuffs(
HANDLE hDevice,
PVOID Reserved,
BOOL fChange
);
/*****************************************************************************
Function name:
DtsProcInput
Description:
Sends compressed (coded) data to the decoder for processing.
The device must have been previously opened for this call to succeed.
In addition, suitable keys must have been exchanged for decryption and
decode to be successful.
Parameters:
hDevice Handle to device. This is obtained via a prior call to
DtsDeviceOpen.
pUserData Pointer to data buffer that holds the data to be transferred.
[INPUT]
sizeInBytes Size in Bytes of data available to be sent to the decoder for
processing.
Timestamp Optional timestamp information attached to the media sample
that is available in the buffer. If timestamp is present
(i.e. non-zero), then this will be reflected in the output
sample (picture) produced from the contents of this buffer.
Timestamp should be in units of 100 ns.
Encrypted Flag to indicate that the data transfer is not in the clear
and that the decoder needs to decrypt before it can decode
the data. Note that due to complexity, it is preferred that
the application writer uses the higher level
dts_pre_proc_input() call if encypted content will be sent.
Return:
BC_STS_SUCCESS will be returned on successful completion.
*****************************************************************************/
DRVIFLIB_API BC_STATUS
DtsProcInput(
HANDLE hDevice,
uint8_t *pUserData,
uint32_t ulSizeInBytes,
uint64_t timeStamp,
BOOL encrypted
);
/*****************************************************************************
Function name:
DtsGetColorPrimaries
Description:
Returns color primaries information from the stream being processed.
The device must have been previously opened for this call to succeed.
In addition at least one picture must have been successfully decoded and
returned back from the decoder.
Parameters:
hDevice Handle to device. This is obtained via a prior call to
DtsDeviceOpen.
colorPrimaries Pointer to U32 to receive the color primaries information.
The values returned are described in the previous section
regarding the picture metadata. [OUTPUT]
Return:
BC_STS_SUCCESS will be returned on successful completion.
*****************************************************************************/
DRVIFLIB_API BC_STATUS
DtsGetColorPrimaries(
HANDLE hDevice,
uint32_t *colorPrimaries
);
/*****************************************************************************
Function name:
DtsFlushInput
Description:
Flushes the current channel and causes the decoder to stop accessing input
data. Based on the flush mode parameter, the channel will be flushed from
the current point in the input data or from the current processing point.
The device must have been previously opened for this call to succeed.
Parameters:
hDevice Handle to device. This is obtained via a prior call to
DtsDeviceOpen.
Mode 0 Flush at the current input point. use to drain the
input FIFO . All the data that has been received will
be decoded.
1 Flush at the current processing point. All the decoded
frames will be presented but no more data from the
input will be decoded.
2 Flushes all the decoder buffers, input, decoded and
to be decoded.
3 Cancels the pending TX Request from the DIL/driver
4 Flushes all the decoder buffers, input, decoded and
to be decoded data. Also flushes the drivers buffers
Return:
BC_STS_SUCCESS will be returned on successful completion.
*****************************************************************************/
DRVIFLIB_API BC_STATUS
DtsFlushInput(
HANDLE hDevice,
uint32_t Mode
);
/*****************************************************************************
Function name:
DtsSetRateChange
Description:
Sets the decoder playback speed and direction of playback.
The device must have been previously opened for this call to succeed.
Parameters:
hDevice Handle to device. This is obtained via a prior call to
DtsDeviceOpen.
rate Inverse of speed x 10000.
Examples:
1/2x playback speed = 20000
1x playback speed = 10000
2x playback speed = 5000
direction Playback direction.
0 Forward direction.
1 Reverse direction.
Return:
BC_STS_SUCCESS will be returned on successful completion.
*****************************************************************************/
DRVIFLIB_API BC_STATUS
DtsSetRateChange(
HANDLE hDevice,
uint32_t rate,
uint8_t direction
);
//Set FF Rate for Catching Up
/*****************************************************************************
Function name:
DtsSetFFRate
Description:
Sets the decoder playback FF speed
The device must have been previously opened for this call to succeed.
Parameters:
hDevice Handle to device. This is obtained via a prior call to
DtsDeviceOpen.
rate Inverse of speed x 10000.
Examples:
1/2x playback speed = 20000
1x playback speed = 10000
2x playback speed = 5000
Return:
BC_STS_SUCCESS will be returned on successful completion.
*****************************************************************************/
DRVIFLIB_API BC_STATUS
DtsSetFFRate(
HANDLE hDevice,
uint32_t rate
);
/*****************************************************************************
Function name:
DtsSetSkipPictureMode
Description:
This command sets the decoder to only decode selected picture types.
The device must have been previously opened for this call to succeed.
Parameters:
hDevice Handle to device. This is obtained via a prior call to
DtsDeviceOpen.
SkipMode 0 IPB, All pictures are decoded.
1 IP decoding, This mode skips all non reference pictures.
2 I decoding, This mode skips all P/B pictures and only decodes
I pictures.
Return:
BC_STS_SUCCESS will be returned on successful completion.
*****************************************************************************/
DRVIFLIB_API BC_STATUS
DtsSetSkipPictureMode(
HANDLE hDevice,
uint32_t SkipMode
);
/*****************************************************************************
Function name:
DtsSetIFrameTrickMode
Description:
This command sets the decoder to decode only I Frames for FF and FR.
Use this API for I Frame only trick mode play back in either direction. The
application/Up stream filter determines the speed of the playback by
means of Skip on the input compressed data.
The device must have been previously opened for this call to succeed.
Parameters:
hDevice Handle to device. This is obtained via a prior call to
DtsDeviceOpen.
Return:
BC_STS_SUCCESS will be returned on successful completion.
*****************************************************************************/
DRVIFLIB_API BC_STATUS
DtsSetIFrameTrickMode(
HANDLE hDevice
);
/*****************************************************************************
Function name:
DtsStepDecoder
Description:
This function forwards one frame.
The device must have been opened must be in paused
state previously for this call to succeed.
Parameters:
hDevice Handle to device. This is obtained via a prior call to
DtsDeviceOpen.
Return:
BC_STS_SUCCESS will be returned on successful completion.
*****************************************************************************/
DRVIFLIB_API BC_STATUS
DtsStepDecoder(
HANDLE hDevice
);
/*****************************************************************************
Function name:
DtsIs422Supported
Description:
This function returns whether 422 YUV mode is supported or not.
The device must have been opened previously for this call to succeed.
Parameters:
hDevice Handle to device. This is obtained via a prior call to
DtsDeviceOpen.
bSupported 1 - 422 is supported
0 - 422 is not supported.
Return:
BC_STS_SUCCESS will be returned on successful completion.
*****************************************************************************/
DRVIFLIB_API BC_STATUS
DtsIs422Supported(
HANDLE hDevice,
uint8_t *bSupported
);
/*****************************************************************************
Function name:
DtsSetColorSpace
Description:
This function sets the output sample's color space.
The device must have been opened previously and must support 422 mode for
this call to succeed.
Use "DtsIs422Supported" to find whether 422 mode is supported.
Parameters:
hDevice Handle to device. This is obtained via a prior call to
DtsDeviceOpen.
422Mode Mode is defined by BC_OUTPUT_FORMAT as follows -
OUTPUT_MODE420 = 0x0,
OUTPUT_MODE422_YUY2 = 0x1,
OUTPUT_MODE422_UYVY = 0x2,
OUTPUT_MODE_INVALID = 0xFF
Valid values for this API are OUTPUT_MODE422_YUY2 and OUTPUT_MODE422_UYVY
Return:
BC_STS_SUCCESS will be returned on successful completion.
*****************************************************************************/
DRVIFLIB_API BC_STATUS
DtsSetColorSpace(
HANDLE hDevice,
BC_OUTPUT_FORMAT Mode422
);
/*****************************************************************************
Function name:
DtsSet422Mode
Description:
This function sets the 422 mode to either YUY2 or UYVY.
The device must have been opened previously and must support 422 mode for
this call to succeed.
Use "DtsIs422Supported" to find whether 422 mode is supported.
Parameters:
hDevice Handle to device. This is obtained via a prior call to
DtsDeviceOpen.
422Mode 0 - set the YUV mode to YUY2
1 - set the YUV mode to UYVY
Return:
BC_STS_SUCCESS will be returned on successful completion.
*****************************************************************************/
DRVIFLIB_API BC_STATUS
DtsSet422Mode(
HANDLE hDevice,
uint8_t Mode422
);
/*****************************************************************************
Function name:
DtsGetDILPath
Description:
This is a helper function to return DIL's Path.
The device must have been previously opened for this call to succeed.
Parameters:
hDevice Handle to device. This is obtained via a prior call to
DtsDeviceOpen.
DilPath Buffer to hold DIL path info upto 256 bytes.
Return:
BC_STS_SUCCESS will be returned on successful completion.
*****************************************************************************/
DRVIFLIB_API BC_STATUS
DtsGetDILPath(
HANDLE hDevice,
char *DilPath,
uint32_t size
);
/*****************************************************************************
Function name:
DtsDropPictures
Description:
This command sets the decoder to skip one or more non-reference (B) pictures
in the input data stream. This is used for when the audio is ahead of
video and the application needs to cause video to move ahead to catch up.
Reference pictures are not skipped.
The device must have been previously opened for this call to succeed.
Parameters:
hDevice Handle to device. This is obtained via a prior call to
DtsDeviceOpen.
Pictures The number of non-reference pictures to drop.
Return:
BC_STS_SUCCESS will be returned on successful completion.
*****************************************************************************/
DRVIFLIB_API BC_STATUS
DtsDropPictures(
HANDLE hDevice,
uint32_t Pictures
);
/*****************************************************************************
Function name:
DtsGetDriverStatus
Description:
This command returns various statistics related to the driver and DIL.
The device must have been previously opened for this call to succeed.
Parameters:
hDevice Handle to device. This is obtained via a prior call to
DtsDeviceOpen.
*pStatus Pointer to BC_DTS_STATUS to receive driver status.
Return:
BC_STS_SUCCESS will be returned on successful completion.
*****************************************************************************/
DRVIFLIB_API BC_STATUS
DtsGetDriverStatus(
HANDLE hDevice,
BC_DTS_STATUS *pStatus
);
/*****************************************************************************
Function name:
DtsGetCapabilities
Description:
This command returns output format support and hardware capabilities.
The device must have been previously opened for this call to succeed.
Parameters:
hDevice Handle to device. This is obtained via a prior call to
DtsDeviceOpen.
pCapsBuffer Pointer to BC_HW_CAPS to receive HW Output capabilities.
Return:
BC_STS_SUCCESS will be returned on successful completion.
*****************************************************************************/
DRVIFLIB_API BC_STATUS
DtsGetCapabilities (
HANDLE hDevice,
PBC_HW_CAPS pCapsBuffer
);
/*****************************************************************************
Function name:
DtsSetScaleParams
Description:
This command sets hardware scaling parameters.
Parameters:
hDevice Handle to device. This is obtained via a prior call to
DtsDeviceOpen.
pScaleParams Pointer to BC_SCALING_PARAMS to set hardware scaling parameters.
Return:
BC_STS_SUCCESS will be returned on successful completion.
*****************************************************************************/
DRVIFLIB_API BC_STATUS
DtsSetScaleParams (
HANDLE hDevice,
PBC_SCALING_PARAMS pScaleParams
);
/*****************************************************************************
Function name:
DtsIsEndOfStream
Description:
This command returns whether the end of stream(EOS) is reaching.
Parameters:
hDevice Handle to device. This is obtained via a prior call to
DtsDeviceOpen.
bEOS Pointer to uint8_t to indicate if EOS of not
Return:
BC_STS_SUCCESS will be returned on successful completion.
*****************************************************************************/
DRVIFLIB_API BC_STATUS
DtsIsEndOfStream(
HANDLE hDevice,
uint8_t* bEOS
);
/*****************************************************************************
Function name:
DtsCrystalHDVersion
Description:
This API returns hw and sw version information for Crystal HD solutions
Parameters:
hDevice Handle to device. This is obtained via a prior call to
DtsDeviceOpen.
bCrystalInfo Pointer to structure to fill in with information
device = 0 for BCM70012, 1 for BCM70015
Return:
BC_STS_SUCCESS will be returned on successful completion.
*****************************************************************************/
DRVIFLIB_API BC_STATUS
DtsCrystalHDVersion(
HANDLE hDevice,
PBC_INFO_CRYSTAL bCrystalInfo
);
/*****************************************************************************
Function name:
DtsTxFreeSize
Description:
This API returns the amount of free space in the tx circular buffer
Parameters:
hDevice Handle to device. This is obtained via a prior call to
DtsDeviceOpen.
Return:
uint32_t value of number of free bytes in the tx circular buffer
*****************************************************************************/
DRVIFLIB_API uint32_t
DtsTxFreeSize(
HANDLE hDevice
);
#ifdef __cplusplus
}
#endif
#endif
|