/usr/include/libmp3splt/mp3splt.h is in libmp3splt-dev 0.7.2-2.1.
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 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 | /**********************************************************
*
* libmp3splt -- library based on mp3splt,
* for mp3/ogg splitting without decoding
*
* Copyright (c) 2002-2005 M. Trotta - <mtrotta@users.sourceforge.net>
* Copyright (c) 2005-2012 Alexandru Munteanu - io_fx@yahoo.fr
*
* http://mp3splt.sourceforge.net
*
*********************************************************/
/**********************************************************
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
*
* This program 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 General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
* 02111-1307,
* USA.
*
*********************************************************/
#ifndef MP3SPLT_MP3SPLT_H
#include <sys/types.h>
#include <stdlib.h>
#include <stdio.h>
//libtool 1.4e is buggy on mingw if we include ltdl.h
#ifndef __WIN32__
#include <ltdl.h>
#endif
/**
* @file mp3splt.h
*
* @brief Main types, error codes and confirmations.
*
* This is the main file containing the most important types, error
* codes and confirmations
*
* The errors are negative values, the warnings and the confirmations
* are positive values
*/
/**
* @brief True value
*/
#define SPLT_TRUE 1
/**
* @brief False value
*/
#define SPLT_FALSE 0
/******************************/
/* Structures for the freedb */
/**
* @brief Defines one search result from the freedb search
*
* @see splt_freedb_results
* @see mp3splt_get_freedb_search
*/
typedef struct {
/**
* @brief Name of the album for this result
*/
char *name;
/**
* @brief Unique identifier for this result
*/
int id;
/**
* @brief How many revisions this result has
*
* If having revisions, the unique identifier for a revision is
* #id + revision + 1, with 0 <= revision < #revision_number\n
*/
int revision_number;
/**
* @brief Contains the revisions of the result
*
* The #revisions table contains #revision_number elements,
* the consecutive numbers starting at 2 (you might not need it)
*/
int *revisions;
} splt_freedb_one_result;
/**
* @brief All the freedb search results
*
* @see splt_freedb_one_result
* @see mp3splt_get_freedb_search
*/
typedef struct {
/**
* @brief All the freedb results
*/
splt_freedb_one_result *results;
/**
* @brief How many results we have
*/
int number;
} splt_freedb_results;
/**
* @brief Maximum results for the freedb search
*/
#define SPLT_MAXCD 512
//maximum length of the disc id
#define SPLT_DISCIDLEN 8
//structure for the freedb search
struct splt_cd {
char discid[SPLT_DISCIDLEN+1];
char category[20];
};
typedef struct {
struct splt_cd discs[SPLT_MAXCD];
int foundcd;
} splt_cd_state;
//structure containing everything used for the
//freedb search
typedef struct {
//we stock here the results of the freedb search
splt_freedb_results *search_results;
//we stock the state of the CD
//(for the freedb search)
splt_cd_state *cdstate;
} splt_freedb;
/******************************/
/* Structures for the wrap */
/**
* @brief The wrapped filenames found inside a file
*
* @see mp3splt_get_wrap_files
*/
typedef struct {
/**
* @brief How many filenames we have
*/
int wrap_files_num;
/**
* @brief The filenames
*/
char **wrap_files;
} splt_wrap;
/************************************/
/* Structures for the syncerrors */
/**
* @brief The number of syncerrors
*
* @see mp3splt_get_syncerrors
*/
typedef struct {
off_t *serrors_points;
/**
* @brief How many syncerrors have been found
*/
long int serrors_points_num;
} splt_syncerrors;
/***************************************/
/* Structures for the output format */
#define SPLT_MAXOLEN 255
#define SPLT_OUTNUM 20
//structure defining the output format
typedef struct {
//format as @n_@t.. as a string
char *format_string;
//when we have @n option on output format
char output_format_digits;
int output_alpha_format_digits;
//format for the cddb cue output
char format[SPLT_OUTNUM+1][SPLT_MAXOLEN];
} splt_oformat;
/***************************/
/* Structures for the tags */
/**
* @brief The tags of a splitpoint
*
* The structure contains the tags that we can set to a filename
* generated from a splitpoint. Tags may also define the output filenames.
*
* @see mp3splt_append_tags
* @see mp3splt_get_tags
*/
typedef struct {
/**
* @brief The title
*/
char *title;
/**
* @brief The artist
*/
char *artist;
/**
* @brief The album
*/
char *album;
/**
* @brief The performer
*
* The performer is not part of the tags, but may replace the
* #artist in some cases and it is useful for the output filenames\n
* You can also look at #SPLT_OPT_OUTPUT_DEFAULT
*/
char *performer;
/**
* @brief The year
*/
char *year;
/**
* @brief A comment
*/
char *comment;
/**
* @brief The track number
*/
int track;
/**
* @brief The genre
*/
char *genre;
/*
* @brief tags version (for mp3): 1 or 2 or 1 & 2
*/
int tags_version;
int set_original_tags;
} splt_tags;
typedef struct {
splt_tags tags;
void *all_original_tags;
} splt_original_tags;
/**
* @brief Definition of a splitpoint
*
* @see mp3splt_append_splitpoint
* @see mp3splt_get_splitpoints
*/
typedef struct {
/**
* @brief Value of the splitpoint in hundreths of seconds
*/
long value;
/**
* @brief Name of the new filename issued from the splitpoint
*/
char *name;
/**
* @brief Type of the splitpoint
* @see splt_type_of_splitpoint
*/
int type;
} splt_point;
/*****************************/
/* Structure for the silence */
struct splt_ssplit {
double begin_position;
double end_position;
long len;
struct splt_ssplit *next;
};
/**********************************/
/* Structure for the split */
/**
* @brief The data structure for the progress bar
The meanings of the values are:
float = fraction in percent
char * = string (name on the progress bar)
*/
typedef struct splt_progres {
/*!maximum number of characters for the filename
(without the extension) when displaying the
progress warning; default is 40 */
int progress_text_max_char;
//! Name of the file we are currently splitting
char filename_shorted[512];
//!the current percent of the progress
float percent_progress;
//!the splitpoint we are currently splitting
int current_split;
//!the maximum number of splits
int max_splits;
/*!the progress bar type
can be:
- SPLT_PROGRESS_PREPARE
- SPLT_PROGRESS_CREATE
- SPLT_PROGRESS_SEARCH_SYNC
- SPLT_PROGRESS_SCAN_SILENCE */
int progress_type;
//!infos for the silence split
int silence_found_tracks;
//! The silence leven in dB
float silence_db_level;
/*! use this variable as you wish
this variable will not be modified by the library
but it will be 0 at the start
*/
int user_data;
//! A pointer to the callback function
void (*progress)(struct splt_progres*);
} splt_progress;
//!proxy information
typedef struct {
//! True if we use a proxy
int use_proxy;
//! The name of the proxy
char hostname[256];
//! The port we use to access the procy
int port;
//! True if we need authentification
int authentification;
//! the username needed for authentification
char user[256];
//! the password needed for authentification
char password[256];
} splt_proxy;
//!used with the 'put_message' function
typedef enum {
/**
* Info message
*/
SPLT_MESSAGE_INFO,
/**
* Debug message
*/
SPLT_MESSAGE_DEBUG
} splt_message_type;
//! The data libmp3splt keeps all its internal data in
typedef struct {
//! total time of the song
long total_time;
//!When splitting: the number of the last splitpoint we arrived at.
int current_split;
//! for user feedback: the number of the file we are splitting
int current_split_file_number;
/*! how many split points do we have?
this is updated only by
check_splitpts_inf_song_length()
If this function has not been called
look at real_splitnumber instead.
*/
int splitnumber;
//!how many splitpoints do we have?
int real_splitnumber;
/*! Pointer to the fallback function that is
called when the library starts to split
a new file.
the char* is the filename that is currently
being split.
*/
void (*file_split)(const char *,int);
//!All infos for the progress bar
splt_progress *p_bar;
//!callback for sending the silence level to the client
void (*get_silence_level)(long time, float level, void *user_data);
//!user data set by the client for the 'get_silence_level' function
void *silence_level_client_data;
//!sends a message to the main program to tell what we are doing
void (*put_message)(const char *, splt_message_type );
//!structure in which we have all the splitpoints
splt_point *points;
//!how many tags do we have?
int real_tagsnumber;
//!structure in which we have all the tags
splt_tags *tags;
splt_tags tags_like_x;
} splt_struct;
/**********************************/
/* Options structure */
/**
* @brief Values for the #SPLT_OPT_SPLIT_MODE option
*
* Values for the #SPLT_OPT_SPLIT_MODE option
*/
typedef enum {
/**
* Normal split
*/
SPLT_OPTION_NORMAL_MODE,
/**
* Split the file created with mp3wrap or albumwrap
*/
SPLT_OPTION_WRAP_MODE,
/**
* Split with silence detection
*/
SPLT_OPTION_SILENCE_MODE,
/**
* Split with trim silence detection
*/
SPLT_OPTION_TRIM_SILENCE_MODE,
/**
* Split with error mode
* It is useful to split large file derivated from a concatenation of
* smaller files
*/
SPLT_OPTION_ERROR_MODE,
/**
* Will create an indefinite number of smaller files with
* a fixed time length specified by #SPLT_OPT_SPLIT_TIME
*/
SPLT_OPTION_TIME_MODE,
/**
* Split in X pieces of equal time length.
* X is defined by the #SPLT_OPT_LENGTH_SPLIT_FILE_NUMBER option
*/
SPLT_OPTION_LENGTH_MODE,
} splt_split_mode_options;
/**
* @brief Values for the #SPLT_OPT_OUTPUT_FILENAMES option
*
* Values for the #SPLT_OPT_OUTPUT_FILENAMES option
*/
typedef enum {
//!output specified by the set_oformat
SPLT_OUTPUT_FORMAT,
//!the default output. depends of the type of the split.
SPLT_OUTPUT_DEFAULT,
/*!we don't change anything
Of course we use our internal logic to generate at
least unique names in this case
*/
SPLT_OUTPUT_CUSTOM
} splt_output_filenames_options;
/**
* @brief Default value for the #SPLT_OPT_PARAM_THRESHOLD option
*/
#define SPLT_DEFAULT_PARAM_THRESHOLD -48.0
/**
* @brief Default value for the #SPLT_OPT_PARAM_OFFSET option
*/
#define SPLT_DEFAULT_PARAM_OFFSET 0.8
/**
* @brief Default value for the #SPLT_OPT_PARAM_MIN_LENGTH option
*/
#define SPLT_DEFAULT_PARAM_MINIMUM_LENGTH 0.0
/**
* @brief Default value for the #SPLT_OPT_PARAM_MIN_TRACK_LENGTH option
*/
#define SPLT_DEFAULT_PARAM_MINIMUM_TRACK_LENGTH 0.0
/**
* @brief Default value for the #SPLT_OPT_PARAM_GAP option
*/
#define SPLT_DEFAULT_PARAM_GAP 30
/**
* @brief Default value for the #SPLT_OPT_PARAM_NUMBER_TRACKS option
*/
#define SPLT_DEFAULT_PARAM_TRACKS 0
/**
* @brief Default value for the #SPLT_OPT_PARAM_SHOTS option
*/
#define SPLT_DEFAULT_PARAM_SHOTS 25
/**
* @brief Values for the #SPLT_OPT_TAGS option
*
* Values for the #SPLT_OPT_TAGS option
*/
typedef enum {
/**
* Keep the tags of the original file
*/
SPLT_TAGS_ORIGINAL_FILE,
/**
* Keep the tags issued from cddb, cue or
* set by the user with #mp3splt_append_tags
*/
SPLT_CURRENT_TAGS,
/**
* Does not put any tags
*/
SPLT_NO_TAGS,
/**
* Sets tags from filename regex.
* See #mp3splt_set_input_filename_regex.
*/
SPLT_TAGS_FROM_FILENAME_REGEX,
} splt_tags_options;
#define SPLT_ORIGINAL_TAGS_DEFAULT "%[@o,@N=1]"
#define SPLT_DEFAULT_OUTPUT "@f_@mm_@ss_@hh__@Mm_@Ss_@Hh"
/**
* @brief Default output for the cddb and cue.
* See #mp3splt_set_oformat
*/
#define SPLT_DEFAULT_CDDB_CUE_OUTPUT "@A - @n - @t"
/**
* @brief Default output for the syncerror.
* See #mp3splt_set_oformat
*/
#define SPLT_DEFAULT_SYNCERROR_OUTPUT "@f_error_@n"
/**
* @brief Default output for the silence split.
* See #mp3splt_set_oformat
*/
#define SPLT_DEFAULT_SILENCE_OUTPUT "@f_silence_@n"
/**
* @brief Default output for the trim silence split.
* See #mp3splt_set_oformat
*/
#define SPLT_DEFAULT_TRIM_SILENCE_OUTPUT "@f_trimmed"
//!structure with all the options supplied to split the file
typedef struct {
/*! this field can take the following values:
- SPLT_OPTION_NORMAL_MODE
- SPLT_OPTION_WRAP_MODE
- SPLT_OPTION_SILENCE_MODE
- SPLT_OPTION_TRIM_SILENCE_MODE
- SPLT_OPTION_ERROR_MODE
- SPLT_OPTION_TIME_MODE
*/
splt_split_mode_options split_mode;
/*! might be:
- SPLT_TAGS_ORIGINAL_FILE - write tags from original file
- SPLT_NO_TAGS - does not write any tags
- SPLT_CURRENT_TAGS - tags issued from the cddb or cue for example
- or be set manually with the functions
splt_tags_options tags;
*/
splt_tags_options tags;
int xing;
//!defines the output filenames
splt_output_filenames_options output_filenames;
//!quiet mode: don't perform CRC check or other interaction with the user
int quiet_mode;
/*!Pretend to split the file, without real split
this option works in all modes except error mode and dewrap split.
*/
int pretend_to_split;
/*! frame mode (mp3 only).
Process all frames, seeking split positions by counting frames
instead of bitrate guessing.
*/
int option_frame_mode;
//!the time of split when split_mode = OPTION_TIME_SPLIT
float split_time;
long overlap_time;
//!this option uses silence detection to auto-adjust splitpoints.
int option_auto_adjust;
/*! True means: input not seekable.
enabling this allows you to split mp3 and ogg streams
which can be read only one time and canât be seeked.
WARNING!
if you don't know what this means you know why it is wise
to set this to FALSE.
*/
int option_input_not_seekable;
/*! SPLT_TRUE= don't patse output filenames for illegal characters.
Otherwise, we parse for illegal characters the filenames and replace
them with '_'. The tags are always checked for illegal characters when
set into filenames.
*/
int create_dirs_from_filenames;
//PARAMETERS---------------------------------------
//PARAMETERS for option_auto_adjust and option_silence_mode:
/*! the sound level to be considered silence
(is a float number between -96 and 0. Default is -48 dB)*/
float parameter_threshold;
/*! the offset of cutpoint in silence
Float number between -2 and 2 and allows you to adjust the offset
of cutpoint in silence time.0 is the begin of silence, and 1 the
end;default is 0.8.
Used for option_auto_adjust and option_silence_mode
*/
float parameter_offset;
//PARAMETERS for option_silence_mode:
/*! the desired number of tracks for option_silence_mode
(positive integer number of tracks to be split;by default all
tracks are split)
*/
int parameter_number_tracks;
/*!
this option defines the number of shots to be found after the silence.
Decrease this value if you need to split files having closer silence points.
(positive integer number; default is #SPLT_DEFAULT_PARAM_SHOTS)
*/
int parameter_shots;
/*! The minimum silence length for option_silence_mode [in seconds]
A positive float of the minimum number of seconds to be considered
a valid splitpoint
*/
float parameter_minimum_length;
/*! The minimum track length for option_silence_mode [in seconds]
A positive float of the minimum number of seconds to be considered
a valid splitpoint
*/
float parameter_min_track_length;
//!possible values are #splt_str_format
int artist_tag_format;
//!possible values are #splt_str_format
int album_tag_format;
//!possible values are #splt_str_format
int title_tag_format;
//!possible values are #splt_str_format
int comment_tag_format;
//!true=replace underscores with space
int replace_underscores_tag_format;
//!SPLT_TRUE=set the current filename to split from FILE tag - if found in the CUE file
int set_file_from_cue_if_file_tag_found;
//!true=remove the silence between split tracks
int parameter_remove_silence;
//PARAMETERS for option_auto_adjust:
/*! Auto-Adjust: the gap value around splitpoint to search for
silence
(positive integer for the time to decode before and after
splitpoint;default gap is 30 seconds)
*/
int parameter_gap;
/*! Copy all tags from tag number 'remaining_tags_like_x'
set to -1 to disable
*/
int remaining_tags_like_x;
//!true=auto-increment the tracknumber of the tags
int auto_increment_tracknumber_tags;
/**
* true=enable the silence points log ('mp3splt.log')
*/
int enable_silence_log;
/**
* If we force the mp3 tags version to 1 or 2 or 1 & 2;
* Set to 0 if force disable;
* If disabled, original tags version is set to split files,
* or version 1 if compiled without libid3tag support
*/
int force_tags_version;
/**
* the number of files to be created when splitting by equal time length
*/
int length_split_file_number;
int replace_tags_in_tags;
} splt_options;
/**********************************/
/* Main structure */
//internal structures
typedef struct
{
//!Do we have send the message frame mode enabled?
int frame_mode_enabled;
//!if current_refresh_rate = refresh_rate, we call the progress callback
int current_refresh_rate;
//! if set to SPLT_TRUE then we don't send messages to clients
int messages_locked;
//!if we currently use the library, we lock it
int library_locked;
//!the new filename path (internal)
char *new_filename_path;
} splt_internal;
/**
* Structure containing information about one plugin.
* Is filled with values at plugin initialisation.
*/
typedef struct
{
float version;
char *name;
char *extension;
char *upper_extension;
} splt_plugin_info;
//!contains pointers to the plugin functions
typedef struct {
int (*check_plugin_is_for_file)(void *state, int *error);
void (*set_plugin_info)(splt_plugin_info *info, int *error);
void (*search_syncerrors)(void *state, int *error);
void (*dewrap)(void *state, int listonly, const char *dir, int *error);
void (*set_total_time)(void *state, int *error);
int (*simple_split)(void *state, const char *output_fname, off_t begin, off_t end);
double (*split)(void *state, const char *final_fname, double begin_point,
double end_point, int *error, int save_end_point);
int (*scan_silence)(void *state, int *error);
int (*scan_trim_silence)(void *state, int *error);
void (*set_original_tags)(void *state, int *error);
void (*clear_original_tags)(splt_original_tags *original_tags);
void (*init)(void *state, int *error);
void (*end)(void *state, int *error);
} splt_plugin_func;
//!structure containing all the data about a plugin
typedef struct
{
splt_plugin_info info;
//!complete filename of the plugin shared object
char *plugin_filename;
//! plugin handle get with lt_dlopen, used later for lt_dlclose
void *plugin_handle;
//! plugin functions
splt_plugin_func *func;
} splt_plugin_data;
//!internal plugins structure
typedef struct
{
//!directories where we scan for plugins
char **plugins_scan_dirs;
int number_of_dirs_to_scan;
//!the number of plugins found
int number_of_plugins_found;
//!data structure about all the plugins
splt_plugin_data *data;
} splt_plugins;
//!structure containing error strings for error messages
typedef struct
{
char *error_data;
char *strerror_msg;
} splt_error;
//!structure for the splt state
typedef struct {
//!setting to SPLT_TRUE cancels the split
int cancel_split;
//!filename to split
char *fname_to_split;
//!where the split file will be split
char *path_of_split;
//if this is non null, we write a m3u from the split files
char *m3u_filename;
//!setting tags from input filename regex
char *input_fname_regex;
char *default_comment_tag;
char *default_genre_tag;
//!tags of the original file to split
splt_original_tags original_tags;
//!options for the split
splt_options options;
//!split related
splt_struct split;
//!output format
splt_oformat oformat;
//!wrap related
splt_wrap *wrap;
//!syncerror related
splt_syncerrors *serrors;
/*! counter for the number of sync errors found
- the state->serros->serrors_points_num must be used when processing the
syncerrors from 'serrors'
- this is just a standalone counter
*/
unsigned long syncerrors;
//!freedb related
splt_freedb fdb;
//!internal options
splt_internal iopts;
//!see the ssplit structure
struct splt_ssplit *silence_list;
//proxy infos
//splt_proxy proxy;
//!file format states, mp3,ogg..
void *codec;
//!error strings for error code messages
splt_error err;
//!plugins structure
splt_plugins *plug;
int current_plugin;
//!filename of the silence log: 'mp3splt.log' in the original mp3splt
char *silence_log_fname;
} splt_state;
/*****************************************/
/* Confirmations, errors and messages */
//! All error codes we can generate
typedef enum {
SPLT_OK = 0,
SPLT_OK_SPLIT = 1,
SPLT_SPLITPOINT_BIGGER_THAN_LENGTH = 4,
SPLT_SILENCE_OK = 5,
SPLT_TIME_SPLIT_OK = 6,
SPLT_NO_SILENCE_SPLITPOINTS_FOUND = 7,
SPLT_OK_SPLIT_EOF = 8,
SPLT_LENGTH_SPLIT_OK = 9,
SPLT_TRIM_SILENCE_OK = 10,
SPLT_FREEDB_OK = 100,
SPLT_FREEDB_FILE_OK = 101,
SPLT_CDDB_OK = 102,
SPLT_CUE_OK = 103,
SPLT_FREEDB_MAX_CD_REACHED = 104,
SPLT_AUDACITY_OK = 105,
SPLT_DEWRAP_OK = 200,
SPLT_SYNC_OK = 300,
SPLT_MIGHT_BE_VBR = 301,
SPLT_ERR_SYNC = -300,
SPLT_ERR_NO_SYNC_FOUND = -301,
SPLT_ERR_TOO_MANY_SYNC_ERR = -302,
SPLT_OUTPUT_FORMAT_OK = 400,
SPLT_OUTPUT_FORMAT_AMBIGUOUS = 401,
SPLT_REGEX_OK = 800,
SPLT_ERROR_SPLITPOINTS = -1,
SPLT_ERROR_CANNOT_OPEN_FILE = -2,
SPLT_ERROR_INVALID = -3,
SPLT_ERROR_EQUAL_SPLITPOINTS = -5,
SPLT_ERROR_SPLITPOINTS_NOT_IN_ORDER = -6,
SPLT_ERROR_NEGATIVE_SPLITPOINT = -7,
SPLT_ERROR_INCORRECT_PATH = -8,
SPLT_ERROR_INCOMPATIBLE_OPTIONS = -10,
SPLT_ERROR_INPUT_OUTPUT_SAME_FILE = -12,
SPLT_ERROR_CANNOT_ALLOCATE_MEMORY = -15,
SPLT_ERROR_CANNOT_OPEN_DEST_FILE = -16,
SPLT_ERROR_CANT_WRITE_TO_OUTPUT_FILE = -17,
SPLT_ERROR_WHILE_READING_FILE = -18,
SPLT_ERROR_SEEKING_FILE = -19,
SPLT_ERROR_BEGIN_OUT_OF_FILE = -20,
SPLT_ERROR_INEXISTENT_FILE = -21,
SPLT_SPLIT_CANCELLED = -22,
SPLT_ERROR_LIBRARY_LOCKED = -24,
SPLT_ERROR_STATE_NULL = -25,
SPLT_ERROR_NEGATIVE_TIME_SPLIT = -26,
SPLT_ERROR_CANNOT_CREATE_DIRECTORY = -27,
SPLT_ERROR_CANNOT_CLOSE_FILE = -28,
SPLT_ERROR_NO_PLUGIN_FOUND = -29,
SPLT_ERROR_CANNOT_INIT_LIBLTDL = -30,
SPLT_ERROR_CRC_FAILED = -31,
SPLT_ERROR_NO_PLUGIN_FOUND_FOR_FILE = -32,
SPLT_ERROR_PLUGIN_ERROR = -33,
SPLT_ERROR_TIME_SPLIT_VALUE_INVALID = -34,
SPLT_ERROR_LENGTH_SPLIT_VALUE_INVALID = -35,
SPLT_ERROR_CANNOT_GET_TOTAL_TIME = -36,
SPLT_ERROR_LIBID3 = -37,
SPLT_FREEDB_ERROR_INITIALISE_SOCKET = -101,
SPLT_FREEDB_ERROR_CANNOT_GET_HOST = -102,
SPLT_FREEDB_ERROR_CANNOT_OPEN_SOCKET = -103,
SPLT_FREEDB_ERROR_CANNOT_CONNECT = -104,
SPLT_FREEDB_ERROR_CANNOT_SEND_MESSAGE = -105,
SPLT_FREEDB_ERROR_INVALID_SERVER_ANSWER = -106,
SPLT_FREEDB_ERROR_SITE_201 = -107,
SPLT_FREEDB_ERROR_SITE_200 = -108,
SPLT_FREEDB_ERROR_BAD_COMMUNICATION = -109,
SPLT_FREEDB_ERROR_GETTING_INFOS = -110,
SPLT_FREEDB_NO_CD_FOUND = -111,
SPLT_FREEDB_ERROR_CANNOT_RECV_MESSAGE = -112,
SPLT_INVALID_CUE_FILE = -115,
SPLT_INVALID_CDDB_FILE = -116,
SPLT_FREEDB_NO_SUCH_CD_IN_DATABASE = -118,
SPLT_FREEDB_ERROR_SITE = -119,
SPLT_FREEDB_ERROR_CANNOT_DISCONNECT = -120,
SPLT_DEWRAP_ERR_FILE_LENGTH = -200,
SPLT_DEWRAP_ERR_VERSION_OLD = -201,
SPLT_DEWRAP_ERR_NO_FILE_OR_BAD_INDEX = -202,
SPLT_DEWRAP_ERR_FILE_DAMAGED_INCOMPLETE = -203,
SPLT_DEWRAP_ERR_FILE_NOT_WRAPED_DAMAGED = -204,
SPLT_OUTPUT_FORMAT_ERROR = -400,
SPLT_ERROR_INEXISTENT_SPLITPOINT = -500,
SPLT_PLUGIN_ERROR_UNSUPPORTED_FEATURE = -600,
SPLT_INVALID_AUDACITY_FILE = -700,
SPLT_INVALID_REGEX = -800,
SPLT_REGEX_NO_MATCH = -801,
SPLT_REGEX_UNAVAILABLE = -802,
} splt_code;
//internal
#define SPLT_INTERNAL_PROGRESS_RATE 1
#define SPLT_INTERNAL_FRAME_MODE_ENABLED 2
//progress messages
/**
* @brief Progress messages sent from the library to the client
*
* Progress messages sent from the library to the client
*/
typedef enum {
/**
* Preparing to split a song
*/
SPLT_PROGRESS_PREPARE,
/**
* Creating the split file
*/
SPLT_PROGRESS_CREATE,
/**
* Searching for syncerrors
*/
SPLT_PROGRESS_SEARCH_SYNC,
/**
* Scanning for silence
*/
SPLT_PROGRESS_SCAN_SILENCE
} splt_progress_messages;
/**
* @brief Integer options
*
* Integer options
*
* Use #mp3splt_set_option to set those options\n
* Use #mp3splt_get_option to get those options
*/
typedef enum {
/**
* Pretend to split the file, without real split: this option works in
* all modes except error mode and dewrap split.
*/
SPLT_OPT_PRETEND_TO_SPLIT,
/*
* If quiet; we don't do CRC check or human interaction
*/
SPLT_OPT_QUIET_MODE,
/**
* If we print out debug messages
*
* The option can take the values #SPLT_TRUE or #SPLT_FALSE
*
* Default is #SPLT_FALSE
*/
SPLT_OPT_DEBUG_MODE,
/**
* The type of the split
*
* The option can take the values from #splt_split_mode_options
*
* Default is #SPLT_OPTION_NORMAL_MODE
*/
SPLT_OPT_SPLIT_MODE,
/**
* The type of tags to put in the new split files
*
* The option can take the values from #splt_tags_options
*
* Default is #SPLT_CURRENT_TAGS
*/
SPLT_OPT_TAGS,
/**
* #SPLT_TRUE if we write Xing header (mp3 only)
*/
SPLT_OPT_XING,
/**
* If this option is SPLT_TRUE, we create directories from the output
* file names without parsing for illegal characters the output filenames.
*
* Otherwise, we parse for illegal characters the filenames and replace
* them with '_'. The tags are always checked for illegal characters when
* set into filenames.
*
* Default is #SPLT_FALSE because it's safer to check for illegal
* characters.
*/
SPLT_OPT_CREATE_DIRS_FROM_FILENAMES,
/**
* The option can take the values from #SPLT_OUTPUT_FILENAMES_OPTIONS
*
* Default is #SPLT_FALSE
*/
SPLT_OPT_OUTPUT_FILENAMES,
/**
* If we enable the frame mode or not \n
* The frame mode processes the file frame by frame and
* it is useful when splitting a VBR (Variable Bit Rate) file
*
* The option can take the values #SPLT_TRUE or #SPLT_FALSE
*
* Default is #SPLT_TRUE
*/
SPLT_OPT_FRAME_MODE,
/**
* If we use silence detection to auto-adjust splitpoints\n
* The following options may change the behaviour of the
* auto-adjust: #SPLT_OPT_PARAM_THRESHOLD, #SPLT_OPT_PARAM_OFFSET,
* #SPLT_OPT_PARAM_GAP, #
*
* The option can take the values #SPLT_TRUE or #SPLT_FALSE
*
* Default is #SPLT_FALSE
*/
SPLT_OPT_AUTO_ADJUST,
/**
* If the input is not seekable\n
* This allows you to split mp3 and ogg streams which can be read
* only one time and can't be seeked
*
* The option can take the values #SPLT_TRUE or #SPLT_FALSE
*
* Default is #SPLT_FALSE
*/
SPLT_OPT_INPUT_NOT_SEEKABLE,
/**
* The desired number of tracks when having a
* #SPLT_OPTION_SILENCE_MODE split
*
* The option can take positive integer values. 0 means that we
* split as many files we found
*
* Default is #SPLT_DEFAULT_PARAM_TRACKS
*/
SPLT_OPT_PARAM_NUMBER_TRACKS,
/**
* The desired number of shots when having a
* #SPLT_OPTION_SILENCE_MODE or #SPLT_OPTION_TRIM_SILENCE_MODE split
* or using the #SPLT_OPT_AUTO_ADJUST option
*
* The option can take positive integer values. It defines the number of shots to be
* found after the silence. Decrease this value if you need to split files having
* closer silence points.
*
* Default is #SPLT_DEFAULT_PARAM_SHOTS
*/
SPLT_OPT_PARAM_SHOTS,
/**
* Allows you to remove the silence between the split tracks when
* having a #SPLT_OPTION_SILENCE_MODE split
*
* The option can take the values #SPLT_TRUE or #SPLT_FALSE
*
* Default is #SPLT_FALSE
*/
SPLT_OPT_PARAM_REMOVE_SILENCE,
/**
* The time to auto-adjust before and after splitpoint
* when having the #SPLT_OPT_AUTO_ADJUST option
*
* The option can take positive integer values
*
* Default is #SPLT_DEFAULT_PARAM_GAP
*/
SPLT_OPT_PARAM_GAP,
/**
* if to set all tags like X one
*/
SPLT_OPT_ALL_REMAINING_TAGS_LIKE_X,
/**
* -if we auto increment the tracknumber in the tags
*/
SPLT_OPT_AUTO_INCREMENT_TRACKNUMBER_TAGS,
/**
* if we enable the silence points log ('mp3splt.log')
*/
SPLT_OPT_ENABLE_SILENCE_LOG,
/**
* if we force a tags version or not
*/
SPLT_OPT_FORCE_TAGS_VERSION,
/**
* number of files to split by equal time length
*/
SPLT_OPT_LENGTH_SPLIT_FILE_NUMBER,
/**
*
*/
SPLT_OPT_REPLACE_TAGS_IN_TAGS,
/**
* Time to overlap between the split files
*/
SPLT_OPT_OVERLAP_TIME,
/**
* The interval for the #SPLT_OPTION_TIME_MODE split (in
* hundreths of seconds)
*
* The option can take positive float values
*
* Default is 6000 hundreths of seconds (one minute)
*/
SPLT_OPT_SPLIT_TIME,
/**
* The threshold level (dB) to be considered silence\n
* It is a float number between -96 and 0. It is used when
* having a #SPLT_OPTION_SILENCE_MODE or a #SPLT_OPTION_TRIM_SILENCE_MODE split
* or when having the #SPLT_OPT_AUTO_ADJUST option
*
* The option can take float values between -96 and 0
*
* Default is #SPLT_DEFAULT_PARAM_THRESHOLD
*/
SPLT_OPT_PARAM_THRESHOLD,
/**
* Allows you to adjust the offset of cutpoint in silence time when
* having a #SPLT_OPTION_SILENCE_MODE or a #SPLT_OPTION_TRIM_SILENCE_MODE split
* or when having the #SPLT_OPT_AUTO_ADJUST option
*
* The option can take float values between -2 and 2\n
* 0 is the begin of silence, and 1 the end
*
* Default is #SPLT_DEFAULT_PARAM_OFFSET
*/
SPLT_OPT_PARAM_OFFSET,
/**
* Minimum number of seconds to be considered a valid splitpoint\n
* All silences shorter than this value are discarded.
*
* The option can take positive float values
*
* Default is #SPLT_DEFAULT_PARAM_MINIMUM_LENGTH
*/
SPLT_OPT_PARAM_MIN_LENGTH,
/**
* Minimum number of seconds to be considered a valid track\n
* All tracks shorter than this value are discarded.
*
* The option can take positive float values.
*
* Default is #SPLT_DEFAULT_PARAM_MINIMUM_TRACK_LENGTH
*/
SPLT_OPT_PARAM_MIN_TRACK_LENGTH,
/**
* Format of the artist tag from filename.
* Possible values are #splt_str_format
*/
SPLT_OPT_ARTIST_TAG_FORMAT,
/**
* Format of the album tag from filename.
* Possible values are #splt_str_format
*/
SPLT_OPT_ALBUM_TAG_FORMAT,
/**
* Format of the title tag from filename.
* Possible values are #splt_str_format
*/
SPLT_OPT_TITLE_TAG_FORMAT,
/**
* Format of the comment tag from filename.
* Possible values are #splt_str_format
*/
SPLT_OPT_COMMENT_TAG_FORMAT,
/**
* Replace underscores with space when setting tags
* from filename regex.
*/
SPLT_OPT_REPLACE_UNDERSCORES_TAG_FORMAT,
/**
* If SPLT_TRUE, parse the FILE line and set the filename to split
* from the CUE file.
*/
SPLT_OPT_SET_FILE_FROM_CUE_IF_FILE_TAG_FOUND,
} splt_int_options;
typedef enum {
SPLT_NO_CONVERSION,
SPLT_TO_LOWERCASE,
SPLT_TO_UPPERCASE,
SPLT_TO_FIRST_UPPERCASE,
SPLT_TO_WORD_FIRST_UPPERCASE
} splt_str_format;
/**
* we define a 'skippoint' as a splitpoint that is not taken into
* consideration
*/
typedef enum {
/* a regular splitpoint */
SPLT_SPLITPOINT,
/* a skippoint */
SPLT_SKIPPOINT,
} splt_type_of_splitpoint;
#define SPLT_UNDEFINED_GENRE "Other"
#define SPLT_ID3V1_NUMBER_OF_GENRES 127
/*! ID3v1 genres
*/
static const char splt_id3v1_genres[SPLT_ID3V1_NUMBER_OF_GENRES][25] = {
{"Blues"},
{"Classic Rock"}, {"Country"}, {"Dance"},
{"Disco"},{"Funk"},{"Grunge"},{"Hip-Hop"},{"Jazz"},
{"Metal"},{"New Age"},{"Oldies"}, {"Other"}, {"Pop"},
{"R&B"}, {"Rap"}, {"Reggae"}, {"Rock"}, {"Techno"},
{"Industrial"}, {"Alternative"}, {"Ska"}, {"Death metal"},
{"Pranks"}, {"Soundtrack"}, {"Euro-Techno"},
{"Ambient"}, {"Trip-hop"}, {"Vocal"}, {"Jazz+Funk"},
{"Fusion"}, {"Trance"}, {"Classical"}, {"Instrumental"},
{"Acid"}, {"House"}, {"Game"}, {"Sound clip"}, {"Gospel"},
{"Noise"}, {"Alt. Rock"}, {"Bass"}, {"Soul"}, {"Punk"},
{"Space"}, {"Meditative"}, {"Instrumental pop"},
{"Instrumental rock"}, {"Ethnic"}, {"Gothic"},{"Darkwave"},
{"Techno-Industrial"},{"Electronic"},{"Pop-Folk"},{"Eurodance"},
{"Dream"},{"Southern Rock"},{"Comedy"}, {"Cult"},{"Gangsta"},
{"Top 40"},{"Christian Rap"},{"Pop/Funk"}, {"Jungle"},
{"Native American"},{"Cabaret"},{"New Wave"}, {"Psychedelic"},
{"Rave"},{"Showtunes"},{"Trailer"}, {"Lo-Fi"},{"Tribal"},
{"Acid Punk"},{"Acid Jazz"}, {"Polka"}, {"Retro"},
{"Musical"},{"Rock & Roll"},{"Hard Rock"},
{"Folk"}, {"Folk-Rock"}, {"National Folk"}, {"Swing"},
{"Fast Fusion"}, {"Bebob"}, {"Latin"}, {"Revival"},
{"Celtic"}, {"Bluegrass"}, {"Avantgarde"}, {"Gothic Rock"},
{"Progressive Rock"}, {"Psychedelic Rock"}, {"Symphonic Rock"},
{"Slow Rock"}, {"Big Band"}, {"Chorus"}, {"Easy Listening"},
{"Acoustic"}, {"Humour"}, {"Speech"}, {"Chanson"}, {"Opera"},
{"Chamber Music"}, {"Sonata"}, {"Symphony"}, {"Booty Bass"},
{"Primus"}, {"Porn Groove"}, {"Satire"}, {"Slow Jam"},
{"Club"}, {"Tango"}, {"Samba"}, {"Folklore"}, {"Ballad"},
{"Power Ballad"}, {"Rhythmic Soul"}, {"Freestyle"}, {"Duet"},
{"Punk Rock"}, {"Drum Solo"}, {"A capella"}, {"Euro-House"},
{"Dance Hall"},
{"misc"},
};
/**
* Freedb constants
*/
/*
* freedb2 search type
*/
#define SPLT_FREEDB_SEARCH_TYPE_CDDB_CGI 1
/*
* freedb search type
*/
#define SPLT_FREEDB_SEARCH_TYPE_CDDB 2
/*
* freedb get file type
* we retrieve the file by using the cddb.cgi script
* (usually on port 80)
*/
#define SPLT_FREEDB_GET_FILE_TYPE_CDDB_CGI 3
/*
* we retrieve the file by using the freedb cddb protocol
* (usually on port 8880)
*/
#define SPLT_FREEDB_GET_FILE_TYPE_CDDB 4
/**
* default port
*/
#define SPLT_FREEDB_CDDB_CGI_PORT 80
/**
* default port
*/
#define SPLT_FREEDB_CDDB_PORT 8880
/**
* urls of freedb2.org and freedb.org
*/
#define SPLT_FREEDB_CGI_SITE "freedb.org/~cddb/cddb.cgi"
#define SPLT_FREEDB2_CGI_SITE "tracktype.org/~cddb/cddb.cgi"
//package information constants
#ifndef SPLT_PACKAGE_NAME
/**
* @brief Package name
*/
#define SPLT_PACKAGE_NAME "libmp3splt"
#endif
#ifndef SPLT_PACKAGE_VERSION
/**
* @brief Package version
*/
#define SPLT_PACKAGE_VERSION "0.7.2"
#endif
/**
* @brief Package authors
*/
#define SPLT_AUTHOR "Matteo Trotta | Munteanu Alexandru"
#define SPLT_EMAIL "<mtrotta@users.sourceforge.net> | <io_fx@yahoo.fr>"
/**
* @brief Package website
*/
#define SPLT_WEBSITE "http://mp3splt.sourceforge.net"
/* other useful variables */
#define MP3SPLT_LIB_GETTEXT_DOMAIN "libmp3splt"
//backslash character
#ifndef SPLT_DIRCHAR
#ifdef __WIN32__
#define SPLT_DIRCHAR '\\'
#define SPLT_DIRSTR "\\"
#define SPLT_NDIRCHAR '/'
#else
#define SPLT_DIRCHAR '/'
#define SPLT_DIRSTR "/"
#define SPLT_NDIRCHAR '\\'
#endif
#endif
/**
* @file mp3splt.h
*
* @brief main functions
*
* Contains the library API functions.
*/
/**
* Initialisation and free
*/
/**
* @brief Creates a new state structure
*
* Creates a new state structure, needed by libmp3splt
*/
splt_state *mp3splt_new_state(int *error);
//find plugins
int mp3splt_find_plugins(splt_state *state);
//this function frees the left variables in the library
//don't forget to call this function ONLY at the end of the program
//returns possible error
void mp3splt_free_state(splt_state *state, int *error);
/************************************/
/** \defgrout splt_filepaths Set filenames and paths
@{
*/
/** Sets the path for the creation of new split files
@param state The central struct libmp3splt keeps all its data in
@param path The new output path
@return The error code
*/
int mp3splt_set_path_of_split(splt_state *state, const char *path);
/** Sets path to the input file
@param state The central struct libmp3splt keeps all its data in
@param path The new input file name
@return The error code
*/
int mp3splt_set_filename_to_split(splt_state *state, const char *filename);
/** Reads out the path to the input file
Is very practical after importing a cue file: The cue file provides an
input filename but does not tell us about this.
@param state The central struct libmp3splt keeps all its data in
@param path The new input file name
@return The error code
*/
char *mp3splt_get_filename_to_split(splt_state *state);
int mp3splt_set_m3u_filename(splt_state *state, const char *filename);
int mp3splt_set_silence_log_filename(splt_state *state, const char *filename);
/**
* Defines the regex that will be used for #SPLT_TAGS_FROM_FILENAME_REGEX
* to get out tags.
*
* Example: (?<artist>.*?) _ (?<album>.*?) will extract
* 'one artist' and 'one album' from 'one artist _ one album',
*/
int mp3splt_set_input_filename_regex(splt_state *state, const char *regex);
int mp3splt_set_default_comment_tag(splt_state *state, const char *default_comment_tag);
int mp3splt_set_default_genre_tag(splt_state *state, const char *default_genre_tag);
//@}
/************************************/
/*! @defgroup splt_callback_ The registering of callback functions
@{
*/
/** Register the function that is to be called if we got a text message
@param state The central struct libmp3splt keeps all its data in
@param message_cb The callback function
@return The error code
*/
int mp3splt_set_message_function(splt_state *state,
void (*message_cb)(const char *, splt_message_type));
/** Register the function that is to be called on creation of a output file
@param state The central struct libmp3splt keeps all its data in
@param file_cb The callback function
@return The error code
*/
int mp3splt_set_split_filename_function(splt_state *state,
void (*file_cb)(const char *,int));
/** Register the progress bar callback
@param state The central struct libmp3splt keeps all its data in
@param progress_cb The callback function
@return The error code
*/
int mp3splt_set_progress_function(splt_state *state,
void (*progress_cb)(splt_progress *p_bar));
int mp3splt_set_silence_level_function(splt_state *state,
void (*get_silence_cb)(long time, float level, void *user_data),
void *user_data);
//!@}
/************************************/
/*! @defgroup splt_splitpoints_ Splitpoint manipulation
@{
*/
/** Sets a new splitpoint
@param state The central struct libmp3splt keeps all its data in
@param type @see splt_type_of_splitpoint
@param split_value The position of the split point in 1/100s
@param name The name of the split point
@return The error code of any error that might have occoured
*/
int mp3splt_append_splitpoint(splt_state *state,
long split_value, const char *name, int type);
/** returns a pointer to a list of all splitpoints
@param state The central struct libmp3splt keeps all its data in
@param error Is filled with the error code of any error that might
have occoured
@param splitpoints_number The number of split points in the list
@return A pointer to the split point list
*/
const splt_point *mp3splt_get_splitpoints(splt_state *state,
int *splitpoints_number, int *error);
/** erase all splitpoints
@param state The central struct libmp3splt keeps all its data in
@param error Is filled with the error code of any error that might
have occoured
*/
void mp3splt_erase_all_splitpoints(splt_state *state,
int *error);
//@}
/************************************/
/* Tags */
//puts a tag
int mp3splt_append_tags(splt_state *state,
const char *title, const char *artist,
const char *album, const char *performer,
const char *year, const char *comment,
int track, const char *genre);
//returns a pointer to all the current tags
const splt_tags *mp3splt_get_tags(splt_state *state,
int *tags_number, int *error);
//puts tags from a string
int mp3splt_put_tags_from_string(splt_state *state, const char *tags,
int *error);
void mp3splt_erase_all_tags(splt_state *state,
int *error);
/************************************/
/* Options */
int mp3splt_set_int_option(splt_state *state, int option_name, int value);
int mp3splt_set_long_option(splt_state *state, int option_name, long value);
int mp3splt_set_float_option(splt_state *state, int option_name, float value);
int mp3splt_get_int_option(splt_state *state, int option_name, int *error);
long mp3splt_get_long_option(splt_state *state, int option_name, int *error);
float mp3splt_get_float_option(splt_state *state, int option_name, int *error);
/************************************/
/* Split functions */
//split a ogg or mp3 file
//returns possible error
int mp3splt_split(splt_state *state);
//cancel split function
//returns possible error
void mp3splt_stop_split(splt_state *state,
int *error);
/************************************/
/* Cddb and Cue functions */
//get the cue splitpoints from a file and puts them in the state
void mp3splt_put_cue_splitpoints_from_file(splt_state *state,
const char *cue_file, int *error);
//read cddb splitpoints from file and puts them in the state
void mp3splt_put_cddb_splitpoints_from_file(splt_state *state,
const char *cddb_file, int *error);
void mp3splt_put_audacity_labels_splitpoints_from_file(splt_state *state,
const char *file, int *error);
/************************************/
/* Freedb functions */
//returns the freedb results and possible eerror
/**
* @brief test
*/
const splt_freedb_results *mp3splt_get_freedb_search(splt_state *state,
const char *searched_string,
int *error,
int search_type,
const char *search_server,
int port);
void mp3splt_write_freedb_file_result(splt_state *state,
int disc_id,
const char *cddb_file,
int *error,
int cddb_get_type,
const char *cddb_get_server,
int port);
void mp3splt_export_to_cue(splt_state *state, const char *out_file,
short stop_at_total_time, int *error);
void mp3splt_set_oformat(splt_state *state,
const char *format_string, int *error);
/************************************/
/* Other utilities */
//counts the number of tracks found with silence detection
int mp3splt_count_silence_points(splt_state *state, int *error);
int mp3splt_set_silence_points(splt_state *state, int *error);
void mp3splt_set_trim_silence_points(splt_state *state, int *error);
//returns the version of libmp3splt
void mp3splt_get_version(char *version);
//result must be freed
char *mp3splt_get_strerror(splt_state *state, int error_code);
//returns the number of syncerrors
//puts possible error in error variable
const splt_syncerrors *mp3splt_get_syncerrors(splt_state *state,
int *error);
//returns the wrapped files found
const splt_wrap *mp3splt_get_wrap_files(splt_state *state, int *error);
int mp3splt_append_plugins_scan_dir(splt_state *state, char *dir);
#ifdef __WIN32__
char *mp3splt_win32_utf16_to_utf8(const wchar_t *source);
#endif
char **mp3splt_find_filenames(splt_state *state, const char *filename,
int *num_of_files_found, int *error);
int mp3splt_u_check_if_directory(const char *fname);
void mp3splt_free_one_tag(splt_tags *tags);
splt_tags *mp3splt_parse_filename_regex(splt_state *state, int *error);
#define MP3SPLT_MP3SPLT_H
#endif
|