| | 32 | /*! |
|---|
| | 33 | * \mainpage libdiscid |
|---|
| | 34 | * \section intro Introduction |
|---|
| | 35 | * |
|---|
| | 36 | * libdiscid is a C library for calculating DiscIDs for Audio CDs. It is a C |
|---|
| | 37 | * port of the DiscID-related code from libmusicbrainz2 (which is written in |
|---|
| | 38 | * C++). The idea is to have an easy to use library without any dependencies |
|---|
| | 39 | * that can be used from scripting languages. |
|---|
| | 40 | |
|---|
| | 41 | * \section examples Examples |
|---|
| | 42 | * |
|---|
| | 43 | * This is an example of the most basic usage: |
|---|
| | 44 | * |
|---|
| | 45 | * \code |
|---|
| | 46 | * |
|---|
| | 47 | * DiscId *disc = discid_new(); |
|---|
| | 48 | * |
|---|
| | 49 | * /* read the disc in the default disc drive */ |
|---|
| | 50 | * if ( discid_read(disc, NULL) == 0 ) { |
|---|
| | 51 | * fprintf(stderr, "Error: %s\n", discid_get_error_msg(disc)); |
|---|
| | 52 | * return 1; |
|---|
| | 53 | * } |
|---|
| | 54 | * |
|---|
| | 55 | * printf("DiscID : %s\n", discid_get_id(disc)); |
|---|
| | 56 | * printf("Submit via : %s\n", discid_get_submission_url(disc)); |
|---|
| | 57 | * |
|---|
| | 58 | * discid_free(disc); |
|---|
| | 59 | * |
|---|
| | 60 | * \endcode |
|---|
| | 61 | * |
|---|
| | 62 | * \section Building |
|---|
| | 63 | * |
|---|
| | 64 | * libdiscid provides a pkg-config script that returns the necessary compiler and linker flags, as well as the |
|---|
| | 65 | * version number. To build a small sample program one would use: |
|---|
| | 66 | * |
|---|
| | 67 | * <tt>gcc libdiscid-test.c `pkg-config --cflags --libs` -o libdiscid-test</tt> |
|---|
| | 68 | * |
|---|
| | 69 | * \section Contact |
|---|
| | 70 | * |
|---|
| | 71 | * - <a href="http://lists.musicbrainz.org/mailman/listinfo/musicbrainz-devel">MusicBrainz Development Mailing List</a> |
|---|
| | 72 | * - <a href="http://bugs.musicbrainz.org/query?component=libdiscid">MusicBrainz Bug Tracker</a> |
|---|
| | 73 | * |
|---|
| | 74 | */ |
|---|
| | 75 | |
|---|
