libmp3splt  0.9.0
Lossless library for splitting audio formats like mp3 and ogg vorbis.
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
mp3splt.h
Go to the documentation of this file.
1 /**********************************************************
2  *
3  * libmp3splt -- library based on mp3splt v2.1c,
4  * for mp3/ogg splitting without decoding
5  *
6  * Copyright (c) 2002-2005 M. Trotta - <mtrotta@users.sourceforge.net>
7  * Copyright (c) 2005-2013 Alexandru Munteanu - m@ioalex.net
8  *
9  * And others ... see the AUTHORS file provided with libmp3splt source.
10  *
11  * http://mp3splt.sourceforge.net
12  *
13  *********************************************************/
14 
15 /**********************************************************
16  *
17  * This program is free software; you can redistribute it and/or
18  * modify it under the terms of the GNU General Public License
19  * as published by the Free Software Foundation; either version 2
20  * of the License, or (at your option) any later version.
21  *
22  * This program is distributed in the hope that it will be useful,
23  * but WITHOUT ANY WARRANTY; without even the implied warranty of
24  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
25  * GNU General Public License for more details.
26  *
27  * You should have received a copy of the GNU General Public License
28  * along with this program; if not, write to the Free Software
29  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
30  * USA.
31  *
32  *********************************************************/
33 
80 #ifndef MP3SPLT_MP3SPLT_H
81 
82 #include <sys/types.h>
83 
84 #include "version.h"
85 
89 #define SPLT_TRUE 1
90 
93 #define SPLT_FALSE 0
94 
106 typedef enum {
107  SPLT_OK = 0,
108 
109  SPLT_OK_SPLIT = 1,
110  SPLT_SPLITPOINT_BIGGER_THAN_LENGTH = 4,
111  SPLT_SILENCE_OK = 5,
112  SPLT_TIME_SPLIT_OK = 6,
113  SPLT_NO_SILENCE_SPLITPOINTS_FOUND = 7,
114  SPLT_OK_SPLIT_EOF = 8,
115  SPLT_LENGTH_SPLIT_OK = 9,
116  SPLT_TRIM_SILENCE_OK = 10,
117 
118  SPLT_FREEDB_OK = 100,
119  SPLT_FREEDB_FILE_OK = 101,
120  SPLT_CDDB_OK = 102,
121  SPLT_CUE_OK = 103,
122  SPLT_FREEDB_MAX_CD_REACHED = 104,
123  SPLT_AUDACITY_OK = 105,
124 
125  SPLT_DEWRAP_OK = 200,
126 
127  SPLT_SYNC_OK = 300,
128  SPLT_MIGHT_BE_VBR = 301,
129 
130  SPLT_ERR_SYNC = -300,
131  SPLT_ERR_NO_SYNC_FOUND = -301,
132  SPLT_ERR_TOO_MANY_SYNC_ERR = -302,
133 
134  SPLT_OUTPUT_FORMAT_OK = 400,
135  SPLT_OUTPUT_FORMAT_AMBIGUOUS = 401,
136 
137  SPLT_REGEX_OK = 800,
138 
139  SPLT_ERROR_SPLITPOINTS = -1,
140  SPLT_ERROR_CANNOT_OPEN_FILE = -2,
141  SPLT_ERROR_INVALID = -3,
142  SPLT_ERROR_EQUAL_SPLITPOINTS = -5,
143  SPLT_ERROR_SPLITPOINTS_NOT_IN_ORDER = -6,
144  SPLT_ERROR_NEGATIVE_SPLITPOINT = -7,
145  SPLT_ERROR_INCORRECT_PATH = -8,
146  SPLT_ERROR_INCOMPATIBLE_OPTIONS = -10,
147  SPLT_ERROR_INPUT_OUTPUT_SAME_FILE = -12,
148  SPLT_ERROR_CANNOT_ALLOCATE_MEMORY = -15,
149  SPLT_ERROR_CANNOT_OPEN_DEST_FILE = -16,
150  SPLT_ERROR_CANT_WRITE_TO_OUTPUT_FILE = -17,
151  SPLT_ERROR_WHILE_READING_FILE = -18,
152  SPLT_ERROR_SEEKING_FILE = -19,
153  SPLT_ERROR_BEGIN_OUT_OF_FILE = -20,
154  SPLT_ERROR_INEXISTENT_FILE = -21,
155  SPLT_SPLIT_CANCELLED = -22,
156  SPLT_ERROR_LIBRARY_LOCKED = -24,
157  SPLT_ERROR_STATE_NULL = -25,
158  SPLT_ERROR_NEGATIVE_TIME_SPLIT = -26,
159  SPLT_ERROR_CANNOT_CREATE_DIRECTORY = -27,
160  SPLT_ERROR_CANNOT_CLOSE_FILE = -28,
161  SPLT_ERROR_NO_PLUGIN_FOUND = -29,
162  SPLT_ERROR_CANNOT_INIT_LIBLTDL = -30,
163  SPLT_ERROR_CRC_FAILED = -31,
164  SPLT_ERROR_NO_PLUGIN_FOUND_FOR_FILE = -32,
165  SPLT_ERROR_PLUGIN_ERROR = -33,
166  SPLT_ERROR_TIME_SPLIT_VALUE_INVALID = -34,
167  SPLT_ERROR_LENGTH_SPLIT_VALUE_INVALID = -35,
168  SPLT_ERROR_CANNOT_GET_TOTAL_TIME = -36,
169  SPLT_ERROR_LIBID3 = -37,
170 
171  SPLT_FREEDB_ERROR_INITIALISE_SOCKET = -101,
172  SPLT_FREEDB_ERROR_CANNOT_GET_HOST = -102,
173  SPLT_FREEDB_ERROR_CANNOT_OPEN_SOCKET = -103,
174  SPLT_FREEDB_ERROR_CANNOT_CONNECT = -104,
175  SPLT_FREEDB_ERROR_CANNOT_SEND_MESSAGE = -105,
176  SPLT_FREEDB_ERROR_INVALID_SERVER_ANSWER = -106,
177  SPLT_FREEDB_ERROR_SITE_201 = -107,
178  SPLT_FREEDB_ERROR_SITE_200 = -108,
179  SPLT_FREEDB_ERROR_BAD_COMMUNICATION = -109,
180  SPLT_FREEDB_ERROR_GETTING_INFOS = -110,
181  SPLT_FREEDB_NO_CD_FOUND = -111,
182  SPLT_FREEDB_ERROR_CANNOT_RECV_MESSAGE = -112,
183  SPLT_INVALID_CUE_FILE = -115,
184  SPLT_INVALID_CDDB_FILE = -116,
185  SPLT_FREEDB_NO_SUCH_CD_IN_DATABASE = -118,
186  SPLT_FREEDB_ERROR_SITE = -119,
187  SPLT_FREEDB_ERROR_CANNOT_DISCONNECT = -120,
188  SPLT_FREEDB_ERROR_PROXY_NOT_SUPPORTED = -121,
189 
190  SPLT_DEWRAP_ERR_FILE_LENGTH = -200,
191  SPLT_DEWRAP_ERR_VERSION_OLD = -201,
192  SPLT_DEWRAP_ERR_NO_FILE_OR_BAD_INDEX = -202,
193  SPLT_DEWRAP_ERR_FILE_DAMAGED_INCOMPLETE = -203,
194  SPLT_DEWRAP_ERR_FILE_NOT_WRAPED_DAMAGED = -204,
195 
196  SPLT_OUTPUT_FORMAT_ERROR = -400,
197 
198  SPLT_ERROR_INEXISTENT_SPLITPOINT = -500,
199 
200  SPLT_PLUGIN_ERROR_UNSUPPORTED_FEATURE = -600,
201 
202  SPLT_INVALID_AUDACITY_FILE = -700,
203 
204  SPLT_INVALID_REGEX = -800,
205  SPLT_REGEX_NO_MATCH = -801,
206  SPLT_REGEX_UNAVAILABLE = -802,
207 } splt_code;
208 
210 
215 
223 typedef struct _splt_state splt_state;
224 
236 
246 
256 splt_code mp3splt_append_plugins_scan_dir(splt_state *state, const char *directory);
257 
268 
270 
285 char *mp3splt_get_strerror(splt_state *state, splt_code error);
286 
288 
304 typedef enum {
674 } splt_options;
675 
679 typedef enum {
714 
718 typedef enum {
732 
736 typedef enum {
755 
759 #define SPLT_DEFAULT_PARAM_THRESHOLD -48.0
760 
763 #define SPLT_DEFAULT_PARAM_OFFSET 0.8
764 
767 #define SPLT_DEFAULT_PARAM_MINIMUM_LENGTH 0.0
768 
771 #define SPLT_DEFAULT_PARAM_MINIMUM_TRACK_LENGTH 0.0
772 
775 #define SPLT_DEFAULT_PARAM_MIN_TRACK_JOIN 0.0
776 
779 #define SPLT_DEFAULT_PARAM_GAP 30
780 
783 #define SPLT_DEFAULT_PARAM_TRACKS 0
784 
787 #define SPLT_DEFAULT_PARAM_SHOTS 25
788 
791 #define SPLT_DEFAULT_KEEP_SILENCE_LEFT 0
792 
795 #define SPLT_DEFAULT_KEEP_SILENCE_RIGHT 0
796 
800 typedef enum {
818 
823 #define SPLT_DEFAULT_OUTPUT "@f_@mm_@ss_@h0h__@Mm_@Ss_@H0h"
824 
829 #define SPLT_DEFAULT_CDDB_CUE_OUTPUT "@A - @n - @t"
830 
834 #define SPLT_DEFAULT_SYNCERROR_OUTPUT "@f_error_@n"
835 
839 #define SPLT_DEFAULT_SILENCE_OUTPUT "@f_silence_@n"
840 
844 #define SPLT_DEFAULT_TRIM_SILENCE_OUTPUT "@f_trimmed"
845 
851 typedef enum {
873 
882 splt_code mp3splt_set_int_option(splt_state *state, splt_options option, int value);
883 
892 splt_code mp3splt_set_long_option(splt_state *state, splt_options option, long value);
893 
902 splt_code mp3splt_set_float_option(splt_state *state, splt_options option, float value);
903 
912 int mp3splt_get_int_option(splt_state *state, splt_options option, splt_code *error);
913 
922 long mp3splt_get_long_option(splt_state *state, splt_options option, splt_code *error);
923 
932 float mp3splt_get_float_option(splt_state *state, splt_options option, splt_code *error);
933 
941 splt_code mp3splt_set_oformat(splt_state *state, const char *format);
942 
944 
958 splt_code mp3splt_set_filename_to_split(splt_state *state, const char *filename);
959 
967 splt_code mp3splt_set_path_of_split(splt_state *state, const char *path_of_split);
968 
980 const char *mp3splt_get_filename_to_split(splt_state *state);
981 
994 splt_code mp3splt_set_m3u_filename(splt_state *state, const char *m3u_filename);
995 
1021 splt_code mp3splt_set_silence_log_filename(splt_state *state, const char *filename);
1022 
1055 splt_code mp3splt_set_silence_full_log_filename(splt_state *state, const char *filename);
1056 
1058 
1070 typedef enum {
1080 
1098  void (*message_cb)(const char *message, splt_message_type type, void *cb_data), void *cb_data);
1099 
1114  void (*file_cb)(const char *filename, void *cb_data),
1115  void *cb_data);
1116 
1138  void (*write_cb)(const void *ptr, size_t size, size_t nmemb, void *cb_data),
1139  void *cb_data);
1140 
1145 typedef enum {
1164 
1180 typedef struct splt_progres splt_progress;
1181 
1196  void (*progress_cb)(splt_progress *p_bar, void *cb_data), void *cb_data);
1197 
1201 int mp3splt_progress_get_type(const splt_progress *p_bar);
1202 
1207 
1212 
1217 
1222 
1227 
1232 
1249  void (*get_silence_cb)(long time, float level, void *user_data),
1250  void *user_data);
1251 
1253 
1264 typedef enum {
1275 
1284 typedef struct _splt_point splt_point;
1285 
1299 splt_point *mp3splt_point_new(long splitpoint_value, splt_code *error);
1300 
1308 splt_code mp3splt_point_set_name(splt_point *splitpoint, const char *name);
1309 
1318 
1329 
1337 typedef struct _splt_points splt_points;
1338 
1350 
1358 void mp3splt_points_init_iterator(splt_points *splitpoints);
1359 
1370 const splt_point *mp3splt_points_next(splt_points *splitpoints);
1371 
1380 long mp3splt_point_get_value(const splt_point *point);
1381 
1392 
1401 char *mp3splt_point_get_name(const splt_point *point);
1402 
1410 
1412 
1422 #define SPLT_UNDEFINED_GENRE "Other"
1423 
1428 #define SPLT_ID3V1_NUMBER_OF_GENRES 127
1429 
1433 extern const char splt_id3v1_genres[SPLT_ID3V1_NUMBER_OF_GENRES][25];
1434 
1438 typedef enum {
1439  SPLT_TAGS_TITLE = 1,
1440  SPLT_TAGS_ARTIST = 2,
1441  SPLT_TAGS_ALBUM = 3,
1442  SPLT_TAGS_YEAR = 4,
1443  SPLT_TAGS_COMMENT = 5,
1444  SPLT_TAGS_TRACK = 6,
1445  SPLT_TAGS_GENRE = 7,
1446  SPLT_TAGS_PERFORMER = 8,
1452 } splt_tag_key;
1453 
1463 typedef struct _splt_tags splt_tags;
1464 
1475 
1496 
1510 
1515 typedef struct _splt_tags_group splt_tags_group;
1516 
1528 
1536 
1545 
1555 
1559 char *mp3splt_tags_get(splt_tags *tags, splt_tag_key key);
1560 
1589 int mp3splt_put_tags_from_string(splt_state *state, const char *tags, splt_code *error);
1590 
1600 
1608 
1622 splt_code mp3splt_set_input_filename_regex(splt_state *state, const char *regex);
1623 
1633 splt_code mp3splt_set_default_comment_tag(splt_state *state, const char *default_comment_tag);
1634 
1644 splt_code mp3splt_set_default_genre_tag(splt_state *state, const char *default_genre_tag);
1645 
1659 
1667 void mp3splt_free_one_tag(splt_tags *tags);
1668 
1670 
1690 
1700 
1712 char **mp3splt_find_filenames(splt_state *state, const char *filename,
1713  int *num_of_files_found, splt_code *error);
1714 
1716 
1728 typedef enum {
1729  CUE_IMPORT,
1730  CDDB_IMPORT,
1731  AUDACITY_LABELS_IMPORT
1733 
1744 splt_code mp3splt_import(splt_state *state, splt_import_type type, const char *file);
1745 
1751 #define SPLT_FREEDB_SEARCH_TYPE_CDDB_CGI 1
1752 
1758 #define SPLT_FREEDB_GET_FILE_TYPE_CDDB_CGI 3
1759 
1765 #define SPLT_FREEDB_GET_FILE_TYPE_CDDB 4
1766 
1773 #define SPLT_FREEDB_CDDB_CGI_PORT 80
1774 
1782 #define SPLT_FREEDB2_CGI_SITE "tracktype.org/~cddb/cddb.cgi"
1783 
1792 typedef struct _splt_freedb_results splt_freedb_results;
1793 
1801 typedef struct _splt_freedb_one_result splt_freedb_one_result;
1802 
1811 splt_code mp3splt_use_proxy(splt_state *state, const char *proxy_address, int proxy_port);
1812 
1825  const char *base64_authentification);
1826 
1837 char *mp3splt_encode_in_base64(splt_state *state, const char *input, int *error);
1838 
1845 void mp3splt_clear_proxy(splt_state *state);
1846 
1864  const char *searched_string, splt_code *error,
1865  int search_type, const char *search_server, int port);
1866 
1875 
1887 
1893 
1897 const char *mp3splt_freedb_get_name(const splt_freedb_one_result *result);
1898 
1903 
1921  int disc_id, const char *output_file,
1922  int cddb_get_type, const char *cddb_get_server, int port);
1923 
1925 
1937 typedef enum {
1938  CUE_EXPORT
1940 
1952  const char *file, int stop_at_total_time);
1953 
1955 
1970 typedef struct _splt_wrap splt_wrap;
1971 
1978 typedef struct _splt_one_wrap splt_one_wrap;
1979 
1992 
2001 
2011 
2015 char *mp3splt_wrap_get_wrapped_file(const splt_one_wrap *one_wrap);
2016 
2018 
2032 int mp3splt_set_silence_points(splt_state *state, splt_code *error);
2033 
2041 
2045 char *mp3splt_get_version();
2046 
2047 #ifdef __WIN32__
2048 
2051 char *mp3splt_win32_utf16_to_utf8(const wchar_t *source);
2052 #endif
2053 
2057 int mp3splt_check_if_directory(const char *filename);
2058 
2059 #ifndef SPLT_DIRCHAR
2060 #ifdef __WIN32__
2061 #define SPLT_DIRCHAR '\\'
2062 #define SPLT_DIRSTR "\\"
2063 #else
2064 
2067 #define SPLT_DIRCHAR '/'
2068 
2071 #define SPLT_DIRSTR "/"
2072 #endif
2073 #endif
2074 
2076 
2085 typedef struct {
2089  float version;
2093  char *name;
2097  char *extension;
2103 
2107 typedef struct _splt_original_tags splt_original_tags;
2108 
2123 typedef struct {
2133  void (*splt_pl_init)(splt_state *state, splt_code *error);
2142  void (*splt_pl_end)(splt_state *state, splt_code *error);
2152  int (*splt_pl_check_plugin_is_for_file)(splt_state *state, splt_code *error);
2161  void (*splt_pl_set_plugin_info)(splt_plugin_info *information, splt_code *error);
2175  double (*splt_pl_split)(splt_state *state, const char *final_fname, double begin_point,
2176  double end_point, splt_code *error, int save_end_point);
2188  void (*splt_pl_set_original_tags)(splt_state *state, splt_code *error);
2197  void (*splt_pl_clear_original_tags)(splt_original_tags *original_tags);
2209  int (*splt_pl_scan_silence)(splt_state *state, splt_code *error);
2221  int (*splt_pl_scan_trim_silence)(splt_state *state, splt_code *error);
2230  void (*splt_pl_search_syncerrors)(splt_state *state, splt_code *error);
2242  int (*splt_pl_offset_split)(splt_state *state, const char *output_fname, off_t begin, off_t end);
2254  void (*splt_pl_dewrap)(splt_state *state, int listonly, const char *dir, splt_code *error);
2256 
2258 
2262 #define MP3SPLT_MP3SPLT_H
2263 #endif
2264