/usr/include/glyr/glyr.h is in libglyr-dev 1.0.9-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 | /***********************************************************
* This file is part of glyr
* + a commnadline tool and library to download various sort of musicrelated metadata.
* + Copyright (C) [2011] [Christopher Pahl]
* + Hosted at: https://github.com/sahib/glyr
*
* glyr 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 3 of the License, or
* (at your option) any later version.
*
* glyr 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 glyr. If not, see <http://www.gnu.org/licenses/>.
**************************************************************/
#ifndef GLYR_H
#define GLYR_GLYR_H
/**
* SECTION:glyr
* @short_description: Main interface to search metadata
* @title: Glyr
* @section_id:
* @stability: Stable
* @include: glyr/glyr.h
*
* All functions used to search metadata and use the essential of libglyr
* is located here.
*/
/* All structs used by glyr are here */
#include "types.h"
#ifdef __cplusplus
extern "C"
{
#endif
/**
* glyr_init:
*
* Init the library, this has to be called before any other calls from this library are made.
*
* You should call glyr_cleanup() once for every call of glyr_init()
* <note>
* <para>
* This function is not threadsafe.
* </para>
* </note>
**/
void glyr_init (void);
/**
* glyr_cleanup:
*
* Cleanup all parts of the library, you can use <function>atexit()</function>:
*
*
* <informalexample>
* <programlisting>
* glyr_init();
* atexit(glyr_destroy);
* </programlisting>
* </informalexample>
*
* <note>
* <para>
* This function is not threadsafe.
* </para>
* </note>
**/
void glyr_cleanup (void);
/**
* glyr_get:
* @settings: The setting struct controlling glyr. (See the glyr_opt_* methods)
* @error: An optional pointer to an int, which gets filled with an error message, or GLYRE_OK on success, or %NULL
* @length: length An optional pointer storing the length of the returned list, or %NULL
*
* @settings is pointer to a #GlyrQuery struct filled to your needs via the glyr_opt_* methods,
*
* Once an item is found the callback (set via glyr_opt_dlcallback()) is called anytime a item is ready
*
*
* Returns:: a doubly linked list of #GlyrMemCache, which should be freed by passing any element of the to glyr_free_list()
*
*/
GlyrMemCache * glyr_get (GlyrQuery * settings, GLYR_ERROR * error, int * length);
/**
* glyr_query_init:
* @query: The GlyrQuery to initialize to defaultsettings.
*
* This functions may allocate dynamic memory. It should be freed with glyr_query_init() after use.
*
*/
void glyr_query_init (GlyrQuery * query);
/**
* glyr_query_destroy:
* @query: The GlyrQuery to destroy.
*
* Deletes all modifications and frees dynamic memory. It can be reused, as fresh from glyr_query_init()
*
*/
void glyr_query_destroy (GlyrQuery * query);
/**
* glyr_signal_exit:
* @query: The currently running query you want to stop.
*
* Try to stop libglyr as soon as possible.
* This is supposed to be called on another thread.
* Calling this function twice on the same query will do nothing.
* <note>
* <para>
* This function is threadsafe - but use with care anyway,
* since it causes libglyr to do really a hard stop.
* The returned data is NOT guaranteed to yield best results.
* </para>
* </note>
*/
void glyr_signal_exit (GlyrQuery * query);
/**
* glyr_free_list:
* @head: The head of the doubly linked list that should be freed.
*
* Deletes all dynamic memory by calling glyr_cache_free() on each cache.
*
*/
void glyr_free_list (GlyrMemCache * head);
/**
* glyr_cache_new:
*
* Initializes a new memcache.
*
* Normally you never need to do this.
*
* Don't forget to free the cache with glyr_cache_free()
*
* Returns:: A newly allocated and initialized memcache with no data.
*/
GlyrMemCache * glyr_cache_new (void);
/**
* glyr_cache_free:
* @cache: Frees the (valid allocated) cache pointed to by @cache
*/
void glyr_cache_free (GlyrMemCache * cache);
/**
* glyr_cache_copy:
* @cache: The cache to copy
*
* Allocate a new cache and
* copy all contents (= deep copy) from the original @cache,
* The pointers next and prev are set to NULL.
*
* Returns: A newly allocated cache.
*/
GlyrMemCache * glyr_cache_copy (GlyrMemCache * cache);
/**
* glyr_cache_set_dsrc:
* @cache: The cache to change
* @download_source: The string to be changed too
*
* Copies download_source to the dsrc field, clearing all previously allocated content safely.
*/
void glyr_cache_set_dsrc (GlyrMemCache * cache, const char * download_source);
/**
* glyr_cache_set_prov:
* @cache: The cache to change
* @provider: The string to be changed too
*
* Copies provider to the prov field, clearing all previously allocated content safely.
*/
void glyr_cache_set_prov (GlyrMemCache * cache, const char * provider);
/**
* glyr_cache_set_img_format:
* @cache: The cache to change
* @img_format: The string to be changed too
*
* Copies img_format to the img_format field, clearing all previously allocated content safely.
*/
void glyr_cache_set_img_format (GlyrMemCache * cache, const char * img_format);
/**
* glyr_cache_set_type:
* @cache: The cache to change
* @type: The new type
*/
void glyr_cache_set_type (GlyrMemCache * cache, GLYR_DATA_TYPE type);
/**
* glyr_cache_set_rating:
* @cache: The cache to change
* @rating: The new rating
*/
void glyr_cache_set_rating (GlyrMemCache * cache, int rating);
/**
* glyr_cache_set_data:
* @cache: The cache where to set the data.
* @data: The data
* @len: Length of data
*
* Safely sets the data of the cache. It frees the old data first, updates
* the checksum and adjusts the size fields accordingly to len.
* If len is a negative number strlen() is used to determine the size.
*
* Attention: @data is set directly! It get's freed once you free the cache. Be sure it's safe to be free'd.
*
*/
void glyr_cache_set_data (GlyrMemCache * cache, const char * data, int len);
/**
* glyr_cache_write:
* @cache: The data to write.
* @path: The path to write data at.
*
* Write @cache to the path specified by @path.
*
* There are three special files:
* <itemizedlist>
* <listitem>
* <para>
* "stdout" -> Outputs file to stdout
* </para>
* </listitem>
* <listitem>
* <para>
* "stderr" -> Outputs file to stderr
* </para>
* </listitem>
* <listitem>
* <para>
* "null" -> Outputs item nowhere
* </para>
* </listitem>
* </itemizedlist>
*
* Returns: the number of written bytes.
*/
int glyr_cache_write (GlyrMemCache * cache, const char * path);
/**
* glyr_cache_update_md5sum:
* @cache: a valid memcahe
*
* Updates the md5sum field of @cache.
*
*/
void glyr_cache_update_md5sum (GlyrMemCache * cache);
/**
* glyr_cache_print:
* @cache: The GlyrMemCache to be printed.
*
* A debug method to print all fields of @cache.
*
*/
void glyr_cache_print (GlyrMemCache * cache);
/********************************************************
* GlyOpt methods ahead - use them to control glyr_get() *
********************************************************/
/**
* glyr_opt_dlcallback:
* @settings: The GlyrQuery settings struct to store this option in.
* @dl_cb: The callback to register, must have a prototype like this.
* @userp: A pointer to a custom variable you can access inside the callback via <structfield>s->callback.user_pointer</structfield>
*
* The callback should have the following form:
* <informalexample>
* <programlisting>
* GLYR_ERROR my_callback(GlyrMemCache * dl, struct GlyrQuery * s);
* </programlisting>
* </informalexample>
*
* Note that you can return certaing members of %GLYR_ERROR in the callback:
* %GLYRE_SKIP: To not add this item to the results.
* %GLYRE_OK: To add this item to the results and continue happily.
* %GLYRE_STOP_POST: To stop right now and return the results. The current element will be added.
* %GLYRE_STOP_PRE: To stop right now and return the results. The current element will NOT be added.
*
* Returns: an error ID
*/
GLYR_ERROR glyr_opt_dlcallback (GlyrQuery * settings, DL_callback dl_cb, void * userp);
/**
* glyr_opt_type:
* @s: The GlyrQuery settings struct to store this option in.
* @type: The type of metadata you want to get.
*
* Example: %GLYR_GET_COVERART
*
* Returns: an error ID
*/
GLYR_ERROR glyr_opt_type (GlyrQuery * s, GLYR_GET_TYPE type);
/**
* glyr_opt_artist:
* @s: The GlyrQuery settings struct to store this option in.
* @artist: The artist you want to search for, %NULL and "" is not valid.
*
* This is needed for all types of metadata.
* Libglyr keeps a copy of this string internally.
*
* <note>
* <para>
* libglyr applies some basic normalization, like " artistX feat. artistY" -> "artistX"
* </para>
* </note>
*
* Returns: an error ID
*/
GLYR_ERROR glyr_opt_artist (GlyrQuery * s, const char * artist);
/**
* glyr_opt_album:
* @s: The GlyrQuery settings struct to store this option in.
* @album: The album you want to search for, %NULL and "" is not valid.
*
* This field is required for the following types:
* <itemizedlist>
* <listitem>
* <para>
* %GLYR_GET_COVERART
* </para>
* </listitem>
* <listitem>
* <para>
* %GLYR_GET_ALBUM_REVIEW
* </para>
* </listitem>
* <listitem>
* <para>
* %GLYR_GET_TRACKLIST
* </para>
* </listitem>
* </itemizedlist>
*
* Optional for the following types:
* <itemizedlist>
* <listitem>
* <para>
* %GLYR_GET_RELATIONS
* </para>
* </listitem>
* <listitem>
* <para>
* %GLYR_GET_TAGS
* </para>
* </listitem>
* </itemizedlist>
*
* Libglyr keeps a copy of this string internally.
*
* <note>
* <para>
* libglyr applies some basic normalization, like " CoOl_album CD01 (20.7)" -> "cool_album"
* </para>
* </note>
*
* Returns: an error ID
*/
GLYR_ERROR glyr_opt_album (GlyrQuery * s, const char * album);
/**
* glyr_opt_title:
* @s: The GlyrQuery settings struct to store this option in.
* @title: The album you want to search for, %NULL and "" is not valid.
*
* This field is required for the following types:
* <itemizedlist>
* <listitem>
* <para>
* %GLYR_GET_LYRICS
* </para>
* </listitem>
* <listitem>
* <para>
* %GLYR_GET_SIMILAR_SONGS
* </para>
* </listitem>
* </itemizedlist>
*
* Optional for the following types:
* <itemizedlist>
* <listitem>
* <para>
* %GLYR_GET_RELATIONS
* </para>
* </listitem>
* <listitem>
* <para>
* %GLYR_GET_TAGS
* </para>
* </listitem>
* </itemizedlist>
*
* Libglyr keeps a copy of this string internally.
*
* <note>
* <para>
* libglyr applies some basic normalization, like "Songtitle (blahblah remix)" -> "Songtitle"
* </para>
* </note>
*
* Returns: an error ID
*/
GLYR_ERROR glyr_opt_title (GlyrQuery * s, const char * title);
/**
* glyr_opt_img_minsize:
* @s: The GlyrQuery settings struct to store this option in.
* @size: The minimum size in pixels an image may have, assuming it to be quadratic
*
* <note>
* <para>
* This is only taken as a hint, returned images are not necessarily higher than this size, but should be around it.
* </para>
* </note>
*
* Returns: an error ID
*/
GLYR_ERROR glyr_opt_img_minsize (GlyrQuery * s, int size);
/**
* glyr_opt_img_maxsize:
* @s: The GlyrQuery settings struct to store this option in.
* @size: The maxmimum size in pixels an image may have, assuming it to be quadratic
*
* <note>
* <para>
* This is only taken as a hint, returned images are not necessarily below this size, but should be around it.
* </para>
* </note>
*
* Returns: an error ID
*/
GLYR_ERROR glyr_opt_img_maxsize (GlyrQuery * s, int size);
/**
* glyr_opt_parallel:
* @s: The GlyrQuery settings struct to store this option in.
* @parallel_jobs: The number of providers that are queried in parallel.
*
* A value of 0 lets libglyr chooses this value itself. This is the default.
*
* Returns: an error ID
*/
GLYR_ERROR glyr_opt_parallel (GlyrQuery * s, unsigned long parallel_jobs);
/**
* glyr_opt_timeout:
* @s: The GlyrQuery settings struct to store this option in.
* @timeout: Maximum number of seconds to wait before canceling a download.
*
* Default is 20 seconds
*
* Returns: an error ID
*/
GLYR_ERROR glyr_opt_timeout (GlyrQuery * s, unsigned long timeout);
/**
* glyr_opt_redirects:
* @s: The GlyrQuery settings struct to store this option in.
* @redirects: Maximum number of redirects before canceling a download.
*
* A value of 0 is allowed but may break some plugins.
*
* Returns: an error ID
*/
GLYR_ERROR glyr_opt_redirects (GlyrQuery * s, unsigned long redirects);
/**
* glyr_opt_useragent:
* @s: The GlyrQuery settings struct to store this option in.
* @useragent: A string that is used as useragent in HTTP requests.
*
* Some providers require an valid useragent, an empty string might break these therefore.
*
* Returns: an error ID
*/
GLYR_ERROR glyr_opt_useragent (GlyrQuery * s, const char * useragent);
/**
* glyr_opt_lang:
* @s: The GlyrQuery settings struct to store this option in.
* @langcode: An ISO 639-1 language code.
*
* Some providers offer localized content, or content only being available in certain countries.
* Examples are: last.fm, amazon and google.
* The language is given in ISO 639-1 codes like 'de' or 'en'.
* Alternatively you can set it to 'auto', which will cause libglyr to guess your language by your locale.
* "auto" is the default behavior.
*
* Returns: an error ID
*/
GLYR_ERROR glyr_opt_lang (GlyrQuery * s, const char * langcode);
/**
* glyr_opt_lang_aware_only:
* @s: The GlyrQuery settings struct to store this option in.
* @lang_aware_only: Boolean, set to true if you want language specific providers only.
*
* Note: Not for all types of metadata there may be localized content, and only fetchers, that provide text items are affected by this setting.
* The special provider 'local' is an exception here, it is queried, but delievers only language specific content too.
*
* Returns: an error ID
*/
GLYR_ERROR glyr_opt_lang_aware_only (GlyrQuery * s, bool lang_aware_only);
/**
* glyr_opt_number:
* @s: The GlyrQuery settings struct to store this option in.
* @num: Maximum number of items to get or 0
*
* The maximum number of items to get in a glyr_get(), resulting number of items may be below @num but not higher.
* A value of 0 causes libglyr to search till infinity.
* Default is 1.
*
* Returns: an error ID
*/
GLYR_ERROR glyr_opt_number (GlyrQuery * s, unsigned int num);
/**
* glyr_opt_verbosity:
* @s: The GlyrQuery settings struct to store this option in.
* @level: Define how verbose the library is.
*
* The verbosity level that is used by libglyr:
* <itemizedlist>
* <listitem>
* <para>
* 0: No output, but fatal errors.
* </para>
* </listitem>
* <listitem>
* <para>
* 1: Basic warnings.
* </para>
* </listitem>
* <listitem>
* <para>
* 2: Normal informal output
* </para>
* </listitem>
* <listitem>
* <para>
* 3: Basic debug output
* </para>
* </listitem>
* <listitem>
* <para>
* 4: Full debug output
* </para>
* </listitem>
* </itemizedlist>
*
* Returns: an error ID
*/
GLYR_ERROR glyr_opt_verbosity (GlyrQuery * s, unsigned int level);
/**
* glyr_opt_from:
* @s: The GlyrQuery settings struct to store this option in.
* @from: A comma separated list of provider names.
*
*
* Tell libglyr where you want your metadata want from.
* You can get a full list of providers for each getter by running @glyrc @-L
* The string you can pass here looks like this example for _cover_:
* <informalexample>
* <programlisting>
* "lastfm;google"
* </programlisting>
* </informalexample>
*
* This would query to everybody's surprise"lastfm" and "google"
* Alternatively you may use the string "all" in it:
* <informalexample>
* <programlisting>
* "all;-lastfm;"
* </programlisting>
* </informalexample>
*
* All providers except "lastfm" (therefore the '-') are used, a '+' is also allowed, which does plain nothing.
* By default all built-in providers are used.
* You can access the providernames by calling glyr_info_get()
*
* Returns: an error ID
*/
GLYR_ERROR glyr_opt_from (GlyrQuery * s, const char * from);
/**
* glyr_opt_plugmax:
* @s: The GlyrQuery settings struct to store this option in.
* @plugmax: Maximum number of items a single provider may retrieve.
*
* Restricts providers to retrieve at max. @plugmax items, you might use this to get results
* over several providers when glyr_opt_number() is set to something higher than 1.
*
* May be removed in future releases.
*
* Returns: an error ID
*/
GLYR_ERROR glyr_opt_plugmax (GlyrQuery * s, int plugmax);
/**
* glyr_opt_allowed_formats:
* @s: The GlyrQuery settings struct to store this option in.
* @formats: A commaseparated list of allowed formats.
*
* Restricts providers to retrieve at max. @plugmax items, you might use this to get results
* over several providers when glyr_opt_number() is set to something higher than 1.
*
* For the getters %GLYR_GET_COVERART and %GLYR_GET_ARTIST_PHOTOS only.
* The allowed formats for images, in a comma separated list.
* Examples:
* <itemizedlist>
* <listitem>
* <para>
* "png;jpeg"
* </para>
* </listitem>
* <listitem>
* <para>
* "png;jpeg;tiff;jpg;" (default)
* </para>
* </listitem>
* </itemizedlist>
*
* <note>
* <para>
* 'jpeg' *and* 'jpg' because some websites return strange mimetypes (should be 'jpeg' only)
* </para>
* </note>
*
* Returns: an error ID
*/
GLYR_ERROR glyr_opt_allowed_formats (GlyrQuery * s, const char * formats);
/**
* glyr_opt_download:
* @s: The GlyrQuery settings struct to store this option in.
* @download: Wether to downlaod images or just to return the found URL.
*
* Imageproviders only return URLs, by default libglyr downloads these and
* gives you the cache. By settings glyr_opt_download() to #FALSE you tell
* libglyr that you want only the URLs (in a searchengine like fashion)
*
* An check for valid images is done however.
*
* Returns: an error ID
*/
GLYR_ERROR glyr_opt_download (GlyrQuery * s, bool download);
/**
* glyr_opt_fuzzyness:
* @s: The GlyrQuery settings struct to store this option in.
* @fuzz: Maximal Levenshtein-distance tolerance may have, see below.
*
* libglyr features fuzzy matching to enhance search results.
* Look at the string "Equilibrium" and the accidentally mistyped version "Aquillibriu":
* Those strings will be compares using the "Levenshtein distance" (http://en.wikipedia.org/wiki/Levenshtein_distance) which basically counts
* the number of insert, substitute and delete operations to transform Equilibrium"" into "Aquillibriu".
* The distance in this case is 3 since three edit-operations are needed (one insert, substitute and deletion)
*
* The fuzziness parameter is the maximum distance two strings may have to match.
* A high distance (like about 10) matches even badly mistyped strings, but also introduces bad results.
* Low settings however will omit some good results.
*
* The default values is currently 4.
* To be more secure some correction is applied:
*
* Examples:
* <itemizedlist>
* <listitem>
* <para>
* artist:Adele - album:19
* </para>
* </listitem>
* <listitem>
* <para>
* artist:Adele - album:21
* </para>
* </listitem>
* <listitem>
* <para>
* lv-distance = 2 which is <= 4
* </para>
* </listitem>
* <listitem>
* <para>
* But since the lv-distance is the same as the length "21" it won't match.
* </para>
* </listitem>
* </itemizedlist>
*
* The easiest way to prevent this though, is to properly tag your music. (http://musicbrainz.org/doc/MusicBrainz_Picard).
*
* Returns: an error ID
*/
GLYR_ERROR glyr_opt_fuzzyness (GlyrQuery * s, int fuzz);
/**
* glyr_opt_qsratio:
* @s: The GlyrQuery settings struct to store this option in.
* @ratio: A float, in the range [0.0..1.0] specifying the ratio between quality and speed.
*
* 0.00 means highest speed, querying fast providers first.
* 1.00 Takes possibly longer, but should deliver best results.
* 0.85 is the current default value.
*
* All other values, smaller 0.0, greater 1.0 are clamped to [0.0..1.0]
*
* Returns: an error ID
*/
GLYR_ERROR glyr_opt_qsratio (GlyrQuery * s, float ratio);
/**
* glyr_opt_proxy:
* @s: The GlyrQuery settings struct to store this option in.
* @proxystring: The proxy to use, see below for the notation.
*
* The proxy to use, if any.
* It is passed in the form: [protocol://][user:pass@]yourproxy.domain[:port]
* Example:
* <itemizedlist>
* <listitem>
* <para>
* Proxy.fh-hof.de:3128
* </para>
* </listitem>
* <listitem>
* <para>
* http://hman:rootroot @ godserve.com:666
* </para>
* </listitem>
* </itemizedlist>
*
* The environment variables http_proxy, ftp_proxy, all_proxy are respected, but are overwritten by this.
*
* Returns: an error ID
*/
GLYR_ERROR glyr_opt_proxy (GlyrQuery * s, const char * proxystring);
/**
* glyr_opt_force_utf8:
* @s: The GlyrQuery settings struct to store this option in.
* @force_utf8: To force, or not to force.
*
* For textitems only.
* Some providers (like metrolyrics) might return text with strange encodings,
* that can not be converted to regular UTF8, but might return a subset of UTF8.
* This options forces libglyr to prohibit those.
*
* Returns: an error ID
*/
GLYR_ERROR glyr_opt_force_utf8 (GlyrQuery * s, bool force_utf8);
/**
* glyr_opt_lookup_db:
* @s: The GlyrQuery settings struct to store this option in.
* @db: a GlyrDatabase object.
*
* Bind the previosly created @db to the query @s.
* By doing this you add a new 'local' provider,
* that is queried before everything else and may speed up
* things heavily.
*
* You can either query it exclusively or disable it completely:
*
* Enable exclusiv:
* <informalexample>
* <programlisting>
* glyr_opt_from(s,"local");
* </programlisting>
* Disable:
* </informalexample>
* <informalexample>
* <programlisting>
* glyr_opt_from(s,"all;-local");
* </programlisting>
* </informalexample>
*
*
* Returns: an error ID
*/
GLYR_ERROR glyr_opt_lookup_db (GlyrQuery * s, GlyrDatabase * db);
/**
* glyr_opt_db_autowrite:
* @s: The GlyrQuery settings struct to store this option in.
* @write_to_db: true, to write this to the database automatically
*
* If a database is specified via glyr_opt_lookup_db you can choose
* to automatically save newly found items to the database.
* They will be looked up from there if you search for it again.
*
* Returns: an error ID
*/
GLYR_ERROR glyr_opt_db_autowrite (GlyrQuery * s, bool write_to_db);
/**
* glyr_opt_db_autoread:
* @s: The GlyrQuery settings struct to store this option in.
* @read_from_db: Boolean, true for DB lookup while searching
*
* If set to true libglyr will lookup the database previously given by glyr_opt_lookup_db()
* during searching in the web. If there's item that already seems to be in the DB it gets not
* mixed into the results.
* <note>
* <para>
* This does not influence the usage of the DB as local provider!
* Use glyr_opt_from() with "all;-local" to disable it.
* </para>
* </note>
*
* Returns: an error ID
**/
GLYR_ERROR glyr_opt_db_autoread (GlyrQuery * s, bool read_from_db);
/**
* glyr_opt_musictree_path:
* @s: The GlyrQuery settings struct to store this option in.
* @musictree_path: The concrete path (relative or absolute) where a mediafile reisdes (see below)
*
* Set the path to a specific mediafile and glyr will try to fetch covers from directories around this,
* since many people place things like 'folder.jpg' there. Instead of the actual file you can also pass the
* containing directory (see the 'dirname' utility) - the path can be either absolute or relative.
*
* From there on it works by cascading upwards - i.e. checking all files in the dir (not recursing), go up, repeat.
* This will be repeated $(recurse_depth) times or till it cannot go upwards.
* How the file is checked depends on the metadata type to search, see below.
*
* For reference the actual C code is given (${artist} gets expanded):
* <example>
* <title>Used regexes and recurse_depth</title>
* <programlisting>
case GLYR_GET_COVERART:
search_regex = "^(folder|front|cover|.*${album}.*)\\.(jpg|png|jpeg|gif)";
recurse_depth = 2;
break;
case GLYR_GET_ARTIST_PHOTOS:
search_regex = "^(${artist}|artist)\\.(jpg|png|jpeg|gif)$";
recurse_depth = 3;
break;
case GLYR_GET_ALBUM_REVIEW:
search_regex = "^(${album})\\.(info|txt)$";
recurse_depth = 2;
break;
case GLYR_GET_ARTIST_BIO:
search_regex = "^BIOGRAPHY(\\.txt)?$";
recurse_depth = 2;
break;
default:
search_regex = NULL;
recurse_depth = 0;
break;
* </programlisting>
* </example>
*
*
* Returns: an error ID
*/
GLYR_ERROR glyr_opt_musictree_path (GlyrQuery * s, const char * musictree_path);
/**
* glyr_opt_normalize:
* @s: The GlyrQuery settings struct to store this option in.
* @norm: Any members of GLYR_NORMALIZATION, which may be binary or'd
*
* Defines how much artist/album/title is normalized.
*
* <itemizedlist>
* <listitem>
* <para>
* GLYR_NORMALIZE_NONE: Do no normalization, except strdown and utf-8-normalization.
* </para>
* </listitem>
* <listitem>
* <para>
* GLYR_NORMALIZE_MODERATE: Remove stuff like feat., featuring. Track 01 etc.
* </para>
* </listitem>
* <listitem>
* <para>
* GLYR_NORMALIZE_AGGRESSIVE: Also remove everything between (), [] and <>. Slightly destructive!
* </para>
* </listitem>
* </itemizedlist>
*
* <note>
* <para>
* Even for None, utf-8 normalization and strdown() is done.
* The default is GLYR_NORMALIZE_AGGRESSIVE | GLYR_NORMALIZE_ALL
* </para>
* </note>
*
* Returns: an error ID
*/
GLYR_ERROR glyr_opt_normalize (GlyrQuery * s, GLYR_NORMALIZATION norm);
/**
* glyr_download:
* @url: A valid url, for example returned by libglyr
* @s: A settings struct managing timeout, useragent and redirects.
*
* Downloads the data pointed to by @url and caches in it a GlyrMemCache, which is returned to you.
* Use glyr_cache_free() to free it after use.
*
* Returns: A GlyrMemCache containing the data, or %NULL on failure, use verbose output to find out why.
*/
GlyrMemCache * glyr_download (const char * url, GlyrQuery * s);
/**
* glyr_strerror:
* @ID: a member of the %GLYR_ERROR enum.
*
* Gets a descriptive message from an error ID.
*
* Returns: a descriptive nullterminated string, do <emphasis>NOT</emphasis> pass to free
*/
const char * glyr_strerror (GLYR_ERROR ID);
/**
* glyr_version:
*
* Returns: the current version string. Example below.
*
* Version 0.4 (Larcenous Locust [dev]) of [May 20 2011] compiled at [19:12:37]
*
* Retunrs a nullterminated string, do <emphasis>NOT</emphasis> pass it to free!
*/
const char * glyr_version (void);
/**
* glyr_info_get:
*
* get information about existing Fetcher and Source
* A Doubly linked list of Fetcher is returned, each having a field 'head',
* being a pointer to a doubly linked list of GlyrSourceInfos
*
* It is best understood by an example:
* <example>
* <title>Using GlyrFetcherInfo:</title>
* <programlisting>
* static void visualize_from_options(void)
* {
* GlyrFetcherInfo * info = glyr_info_get();
* if(info != NULL)
* {
* for(GlyrFetcherInfo * elem0 = info; elem0; elem0 = elem0->next)
* {
* printf("%s\n",elem0->name);
* for(GlyrSourceInfo * elem1 = elem0->head; elem1; elem1 = elem1->next)
* {
* printf(" [%c] %s\n",elem1->key,elem1->name);
* }
* printf("\n");
* }
* }
* glyr_info_free(info);
* }
* </programlisting>
* </example>
*
* Returns: A newly allocated GlyrFetcherInfo structure, you can iterate over.
*/
GlyrFetcherInfo * glyr_info_get (void);
/**
* glyr_info_free:
* @info: The return value of glyr_info_get()
*
* Free the return value of glyr_info_get() pointed to by @info
*/
void glyr_info_free (GlyrFetcherInfo * info);
/**
* glyr_data_type_to_string:
* @type: a member of the %GLYR_DATA_TYPE enum, %GLYR_TYPE_LYRICS for example
*
* Converts a type to a string.
*
* Returns: a statically allocated string, do not free
*/
const char * glyr_data_type_to_string (GLYR_DATA_TYPE type);
/**
* glyr_get_type_to_string:
* @type: a member of the %GLYR_GET_TYPE enum, %GLYR_GET_COVERART for example
*
* Converts a get type to a string (GLYR_GET_COVERART => "cover")
* You must not modify the string or daemons will come to you at night!
*
* Returns: a statically allocated string, do not free nor modify
*/
const char * glyr_get_type_to_string (GLYR_GET_TYPE type);
/**
* glyr_md5sum_to_string:
* @md5sum: a md5sum (from a cache)
*
* Convert a md5sum (raw data) to a human readable representation.
* String consists only of [0-9] and [a-f].
*
* Returns: a newly allocated string, 32 chars long.
*/
char * glyr_md5sum_to_string (unsigned char * md5sum);
/**
* glyr_string_to_md5sum:
* @string: The string containing a human readable checksum (lowercase)
* @md5sum: A at lease 16 byte sized buffer of unsigned chars
*
* Convert a string to a raw-data md5sum.
* Must be a 32 char long string only containing [0-9] and [a-f]
* The new checksum is written to m5sum, which must be a buffer with
* a size >= 16 bytes.
*/
void glyr_string_to_md5sum (const char * string, unsigned char * md5sum);
/**
* glyr_get_requirements:
* @type: The type to get the requirements from
*
* Different getters need different fields set. You can use this
* to check if the artist, album and title field of a specific getter
* is required or optional.
*
* <informalexample>
* <programlisting>
* GLYR_FIELD_REQUIREMENT reqs = glyr_get_requirements(GLYR_GET_COVERART);
* if(reqs & GLYR_REQUIRES_ALBUM)
* {
* // do something when artist is required
* }
* else
* if(reqs & GLYR_OPTIONAL_TITLE)
* {
* // Title is optional
* }
* else
* {
* // None of both
* }
* </programlisting>
* </informalexample>
*
* Returns: A bitmask out of members of GLYR_FIELD_REQUIREMENT
*/
GLYR_FIELD_REQUIREMENT glyr_get_requirements (GLYR_GET_TYPE type);
bool glyr_type_is_image (GLYR_GET_TYPE type);
GLYR_GET_TYPE glyr_string_to_get_type (const char * string);
GLYR_DATA_TYPE glyr_string_to_data_type (const char * string);
#ifdef __cplusplus
}
#endif
#endif
|