summaryrefslogtreecommitdiff
path: root/src/include/extractor.h
blob: 9f247359e23fb4eda112c2b0da120b08e9d9055a (plain)
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
/*
     This file is part of libextractor.
     Copyright (C) 2002-2017 Vidyut Samanta and Christian Grothoff

     libextractor 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, or (at your
     option) any later version.

     libextractor 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 libextractor; see the file COPYING.  If not, write to the
     Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
     Boston, MA 02110-1301, USA.
 */

#ifndef EXTRACTOR_H
#define EXTRACTOR_H

#ifdef __cplusplus
extern "C" {
#if 0 /* keep Emacsens' auto-indent happy */
}
#endif
#endif


#include <stdint.h>

/**
 * 0.2.6-1 => 0x00020601
 * 4.5.2-0 => 0x04050200
 */
#define EXTRACTOR_VERSION 0x010B0000

#include <stdio.h>

#ifndef _EXTRACTOR_EXTERN
#if defined(_WIN32) && defined(MHD_W32LIB)
#define _EXTRACTOR_EXTERN extern
#elif defined (_WIN32) && defined(MHD_W32DLL)
/* Define MHD_W32DLL when using MHD as W32 .DLL to speed up linker a little */
#define _EXTRACTOR_EXTERN __declspec(dllimport)
#else
#define _EXTRACTOR_EXTERN extern
#endif
#endif

/**
 * Options for how plugin execution should be done.
 */
enum EXTRACTOR_Options
{

  /**
   * Run plugin out-of-process, starting the process once the plugin
   * is to be run.  If a plugin crashes, automatically restart the
   * respective process for the same file and try once more
   * (since the crash may be caused by the previous file).  If
   * the process crashes immediately again, it is not restarted
   * until the next file.
   */
  EXTRACTOR_OPTION_DEFAULT_POLICY = 0,

  /**
   * Deprecated option.  Ignored.
   */
  EXTRACTOR_OPTION_OUT_OF_PROCESS_NO_RESTART = 1,

  /**
   * Run plugins in-process.  Unsafe, not recommended,
   * can be nice for debugging.
   */
  EXTRACTOR_OPTION_IN_PROCESS = 2,

  /**
   * Internal value for plugins that have been disabled.
   */
  EXTRACTOR_OPTION_DISABLED = 3

};


/**
 * Format in which the extracted meta data is presented.
 */
enum EXTRACTOR_MetaFormat
{
  /**
   * Format is unknown.
   */
  EXTRACTOR_METAFORMAT_UNKNOWN = 0,

  /**
   * 0-terminated, UTF-8 encoded string.  "data_len"
   * is strlen(data)+1.
   */
  EXTRACTOR_METAFORMAT_UTF8 = 1,

  /**
   * Some kind of binary format, see given Mime type.
   */
  EXTRACTOR_METAFORMAT_BINARY = 2,

  /**
   * 0-terminated string.  The specific encoding is unknown.
   * "data_len" is strlen (data)+1.
   */
  EXTRACTOR_METAFORMAT_C_STRING = 3

};


/**
 * Enumeration defining various sources of keywords.  See also
 * http://dublincore.org/documents/1998/09/dces/
 *
 * @defgroup types meta data types
 * @{
 */
enum EXTRACTOR_MetaType
{
  /* available to application for marking an `enum EXTRACTOR_MetaType` as not
     carrying any meaningful value - never used by libextractor */
  EXTRACTOR_METATYPE_NONE = -1,

  /* reserved should be used as a terminator (like the '\0'-terminator for strings)
     and is never used directly by libextractor */
  EXTRACTOR_METATYPE_RESERVED = 0,

  EXTRACTOR_METATYPE_MIMETYPE = 1,
  EXTRACTOR_METATYPE_FILENAME = 2,
  EXTRACTOR_METATYPE_COMMENT = 3,

  /* Standard types from bibtex */
  EXTRACTOR_METATYPE_TITLE = 4,
  EXTRACTOR_METATYPE_BOOK_TITLE = 5,
  EXTRACTOR_METATYPE_BOOK_EDITION = 6,
  EXTRACTOR_METATYPE_BOOK_CHAPTER_NUMBER = 7,
  EXTRACTOR_METATYPE_JOURNAL_NAME = 8,
  EXTRACTOR_METATYPE_JOURNAL_VOLUME = 9,
  EXTRACTOR_METATYPE_JOURNAL_NUMBER = 10,
  EXTRACTOR_METATYPE_PAGE_COUNT = 11,
  EXTRACTOR_METATYPE_PAGE_RANGE = 12,
  EXTRACTOR_METATYPE_AUTHOR_NAME = 13,
  EXTRACTOR_METATYPE_AUTHOR_EMAIL = 14,
  EXTRACTOR_METATYPE_AUTHOR_INSTITUTION = 15,
  EXTRACTOR_METATYPE_PUBLISHER = 16,
  EXTRACTOR_METATYPE_PUBLISHER_ADDRESS = 17,
  EXTRACTOR_METATYPE_PUBLISHER_INSTITUTION = 18,
  EXTRACTOR_METATYPE_PUBLISHER_SERIES = 19,
  EXTRACTOR_METATYPE_PUBLICATION_TYPE = 20,
  EXTRACTOR_METATYPE_PUBLICATION_YEAR = 21,
  EXTRACTOR_METATYPE_PUBLICATION_MONTH = 22,
  EXTRACTOR_METATYPE_PUBLICATION_DAY = 23,
  EXTRACTOR_METATYPE_PUBLICATION_DATE = 24,
  EXTRACTOR_METATYPE_BIBTEX_EPRINT = 25,
  EXTRACTOR_METATYPE_BIBTEX_ENTRY_TYPE = 26,
  EXTRACTOR_METATYPE_LANGUAGE = 27,
  EXTRACTOR_METATYPE_CREATION_TIME = 28,
  EXTRACTOR_METATYPE_URL = 29,

  /* "unique" document identifiers */
  EXTRACTOR_METATYPE_URI = 30,
  EXTRACTOR_METATYPE_ISRC = 31,
  EXTRACTOR_METATYPE_HASH_MD4 = 32,
  EXTRACTOR_METATYPE_HASH_MD5 = 33,
  EXTRACTOR_METATYPE_HASH_SHA0 = 34,
  EXTRACTOR_METATYPE_HASH_SHA1 = 35,
  EXTRACTOR_METATYPE_HASH_RMD160 = 36,

  /* identifiers of a location */
  EXTRACTOR_METATYPE_GPS_LATITUDE_REF = 37,
  EXTRACTOR_METATYPE_GPS_LATITUDE = 38,
  EXTRACTOR_METATYPE_GPS_LONGITUDE_REF = 39,
  EXTRACTOR_METATYPE_GPS_LONGITUDE = 40,
  EXTRACTOR_METATYPE_LOCATION_CITY = 41,
  EXTRACTOR_METATYPE_LOCATION_SUBLOCATION = 42,
  EXTRACTOR_METATYPE_LOCATION_COUNTRY = 43,
  EXTRACTOR_METATYPE_LOCATION_COUNTRY_CODE = 44,

  /* generic attributes */
  EXTRACTOR_METATYPE_UNKNOWN = 45,
  EXTRACTOR_METATYPE_DESCRIPTION = 46,
  EXTRACTOR_METATYPE_COPYRIGHT = 47,
  EXTRACTOR_METATYPE_RIGHTS = 48,
  EXTRACTOR_METATYPE_KEYWORDS = 49,
  EXTRACTOR_METATYPE_ABSTRACT = 50,
  EXTRACTOR_METATYPE_SUMMARY = 51,
  EXTRACTOR_METATYPE_SUBJECT = 52,
  EXTRACTOR_METATYPE_CREATOR = 53,
  EXTRACTOR_METATYPE_FORMAT = 54,
  EXTRACTOR_METATYPE_FORMAT_VERSION = 55,

  /* processing history */
  EXTRACTOR_METATYPE_CREATED_BY_SOFTWARE = 56,
  EXTRACTOR_METATYPE_UNKNOWN_DATE = 57,
  EXTRACTOR_METATYPE_CREATION_DATE = 58,
  EXTRACTOR_METATYPE_MODIFICATION_DATE = 59,
  EXTRACTOR_METATYPE_LAST_PRINTED = 60,
  EXTRACTOR_METATYPE_LAST_SAVED_BY = 61,
  EXTRACTOR_METATYPE_TOTAL_EDITING_TIME = 62,
  EXTRACTOR_METATYPE_EDITING_CYCLES = 63,
  EXTRACTOR_METATYPE_MODIFIED_BY_SOFTWARE = 64,
  EXTRACTOR_METATYPE_REVISION_HISTORY = 65,

  EXTRACTOR_METATYPE_EMBEDDED_FILE_SIZE = 66,
  EXTRACTOR_METATYPE_FINDER_FILE_TYPE = 67,
  EXTRACTOR_METATYPE_FINDER_FILE_CREATOR = 68,

  /* software package specifics (deb, rpm, tgz, elf) */
  EXTRACTOR_METATYPE_PACKAGE_NAME = 69,
  EXTRACTOR_METATYPE_PACKAGE_VERSION = 70,
  EXTRACTOR_METATYPE_SECTION = 71,
  EXTRACTOR_METATYPE_UPLOAD_PRIORITY = 72,
  EXTRACTOR_METATYPE_PACKAGE_DEPENDENCY = 73,
  EXTRACTOR_METATYPE_PACKAGE_CONFLICTS = 74,
  EXTRACTOR_METATYPE_PACKAGE_REPLACES = 75,
  EXTRACTOR_METATYPE_PACKAGE_PROVIDES = 76,
  EXTRACTOR_METATYPE_PACKAGE_RECOMMENDS = 77,
  EXTRACTOR_METATYPE_PACKAGE_SUGGESTS = 78,
  EXTRACTOR_METATYPE_PACKAGE_MAINTAINER = 79,
  EXTRACTOR_METATYPE_PACKAGE_INSTALLED_SIZE = 80,
  EXTRACTOR_METATYPE_PACKAGE_SOURCE = 81,
  EXTRACTOR_METATYPE_PACKAGE_ESSENTIAL = 82,
  EXTRACTOR_METATYPE_TARGET_ARCHITECTURE = 83,
  EXTRACTOR_METATYPE_PACKAGE_PRE_DEPENDENCY = 84,
  EXTRACTOR_METATYPE_LICENSE = 85,
  EXTRACTOR_METATYPE_PACKAGE_DISTRIBUTION = 86,
  EXTRACTOR_METATYPE_BUILDHOST = 87,
  EXTRACTOR_METATYPE_VENDOR = 88,
  EXTRACTOR_METATYPE_TARGET_OS = 89,
  EXTRACTOR_METATYPE_SOFTWARE_VERSION = 90,
  EXTRACTOR_METATYPE_TARGET_PLATFORM = 91,
  EXTRACTOR_METATYPE_RESOURCE_TYPE = 92,
  EXTRACTOR_METATYPE_LIBRARY_SEARCH_PATH = 93,
  EXTRACTOR_METATYPE_LIBRARY_DEPENDENCY = 94,

  /* photography specifics */
  EXTRACTOR_METATYPE_CAMERA_MAKE = 95,
  EXTRACTOR_METATYPE_CAMERA_MODEL = 96,
  EXTRACTOR_METATYPE_EXPOSURE = 97,
  EXTRACTOR_METATYPE_APERTURE = 98,
  EXTRACTOR_METATYPE_EXPOSURE_BIAS = 99,
  EXTRACTOR_METATYPE_FLASH = 100,
  EXTRACTOR_METATYPE_FLASH_BIAS = 101,
  EXTRACTOR_METATYPE_FOCAL_LENGTH = 102,
  EXTRACTOR_METATYPE_FOCAL_LENGTH_35MM = 103,
  EXTRACTOR_METATYPE_ISO_SPEED = 104,
  EXTRACTOR_METATYPE_EXPOSURE_MODE = 105,
  EXTRACTOR_METATYPE_METERING_MODE = 106,
  EXTRACTOR_METATYPE_MACRO_MODE = 107,
  EXTRACTOR_METATYPE_IMAGE_QUALITY = 108,
  EXTRACTOR_METATYPE_WHITE_BALANCE = 109,
  EXTRACTOR_METATYPE_ORIENTATION = 110,
  EXTRACTOR_METATYPE_MAGNIFICATION = 111,

  /* image specifics */
  EXTRACTOR_METATYPE_IMAGE_DIMENSIONS = 112,
  EXTRACTOR_METATYPE_PRODUCED_BY_SOFTWARE = 113,
  EXTRACTOR_METATYPE_THUMBNAIL = 114,
  EXTRACTOR_METATYPE_IMAGE_RESOLUTION = 115,
  EXTRACTOR_METATYPE_SOURCE = 116,

  /* (text) document processing specifics */
  EXTRACTOR_METATYPE_CHARACTER_SET = 117,
  EXTRACTOR_METATYPE_LINE_COUNT = 118,
  EXTRACTOR_METATYPE_PARAGRAPH_COUNT = 119,
  EXTRACTOR_METATYPE_WORD_COUNT = 120,
  EXTRACTOR_METATYPE_CHARACTER_COUNT = 121,
  EXTRACTOR_METATYPE_PAGE_ORIENTATION = 122,
  EXTRACTOR_METATYPE_PAPER_SIZE = 123,
  EXTRACTOR_METATYPE_TEMPLATE = 124,
  EXTRACTOR_METATYPE_COMPANY = 125,
  EXTRACTOR_METATYPE_MANAGER = 126,
  EXTRACTOR_METATYPE_REVISION_NUMBER = 127,

  /* music / video specifics */
  EXTRACTOR_METATYPE_DURATION = 128,
  EXTRACTOR_METATYPE_ALBUM = 129,
  EXTRACTOR_METATYPE_ARTIST = 130,
  EXTRACTOR_METATYPE_GENRE = 131,
  EXTRACTOR_METATYPE_TRACK_NUMBER = 132,
  EXTRACTOR_METATYPE_DISC_NUMBER = 133,
  EXTRACTOR_METATYPE_PERFORMER = 134,
  EXTRACTOR_METATYPE_CONTACT_INFORMATION = 135,
  EXTRACTOR_METATYPE_SONG_VERSION = 136,
  EXTRACTOR_METATYPE_PICTURE = 137,
  EXTRACTOR_METATYPE_COVER_PICTURE = 138,
  EXTRACTOR_METATYPE_CONTRIBUTOR_PICTURE = 139,
  EXTRACTOR_METATYPE_EVENT_PICTURE = 140,
  EXTRACTOR_METATYPE_LOGO = 141,
  EXTRACTOR_METATYPE_BROADCAST_TELEVISION_SYSTEM = 142,
  EXTRACTOR_METATYPE_SOURCE_DEVICE = 143,
  EXTRACTOR_METATYPE_DISCLAIMER = 144,
  EXTRACTOR_METATYPE_WARNING = 145,
  EXTRACTOR_METATYPE_PAGE_ORDER = 146,
  EXTRACTOR_METATYPE_WRITER = 147,
  EXTRACTOR_METATYPE_PRODUCT_VERSION = 148,
  EXTRACTOR_METATYPE_CONTRIBUTOR_NAME = 149,
  EXTRACTOR_METATYPE_MOVIE_DIRECTOR = 150,
  EXTRACTOR_METATYPE_NETWORK_NAME = 151,
  EXTRACTOR_METATYPE_SHOW_NAME = 152,
  EXTRACTOR_METATYPE_CHAPTER_NAME = 153,
  EXTRACTOR_METATYPE_SONG_COUNT = 154,
  EXTRACTOR_METATYPE_STARTING_SONG = 155,
  EXTRACTOR_METATYPE_PLAY_COUNTER = 156,
  EXTRACTOR_METATYPE_CONDUCTOR = 157,
  EXTRACTOR_METATYPE_INTERPRETATION = 158,
  EXTRACTOR_METATYPE_COMPOSER = 159,
  EXTRACTOR_METATYPE_BEATS_PER_MINUTE = 160,
  EXTRACTOR_METATYPE_ENCODED_BY = 161,
  EXTRACTOR_METATYPE_ORIGINAL_TITLE = 162,
  EXTRACTOR_METATYPE_ORIGINAL_ARTIST = 163,
  EXTRACTOR_METATYPE_ORIGINAL_WRITER = 164,
  EXTRACTOR_METATYPE_ORIGINAL_RELEASE_YEAR = 165,
  EXTRACTOR_METATYPE_ORIGINAL_PERFORMER = 166,
  EXTRACTOR_METATYPE_LYRICS = 167,
  EXTRACTOR_METATYPE_POPULARITY_METER = 168,
  EXTRACTOR_METATYPE_LICENSEE = 169,
  EXTRACTOR_METATYPE_MUSICIAN_CREDITS_LIST = 170,
  EXTRACTOR_METATYPE_MOOD = 171,
  EXTRACTOR_METATYPE_SUBTITLE = 172,

  /* GNUnet specific values (never extracted) */
  EXTRACTOR_METATYPE_GNUNET_DISPLAY_TYPE = 173,
  EXTRACTOR_METATYPE_GNUNET_FULL_DATA = 174,
  EXTRACTOR_METATYPE_RATING = 175,
  EXTRACTOR_METATYPE_ORGANIZATION = 176,
  EXTRACTOR_METATYPE_RIPPER = 177,
  EXTRACTOR_METATYPE_PRODUCER = 178,
  EXTRACTOR_METATYPE_GROUP = 179,
  EXTRACTOR_METATYPE_GNUNET_ORIGINAL_FILENAME = 180,

  EXTRACTOR_METATYPE_DISC_COUNT = 181,

  EXTRACTOR_METATYPE_CODEC = 182,
  EXTRACTOR_METATYPE_VIDEO_CODEC = 183,
  EXTRACTOR_METATYPE_AUDIO_CODEC = 184,
  EXTRACTOR_METATYPE_SUBTITLE_CODEC = 185,

  EXTRACTOR_METATYPE_CONTAINER_FORMAT = 186,

  EXTRACTOR_METATYPE_BITRATE = 187,
  EXTRACTOR_METATYPE_NOMINAL_BITRATE = 188,
  EXTRACTOR_METATYPE_MINIMUM_BITRATE = 189,
  EXTRACTOR_METATYPE_MAXIMUM_BITRATE = 190,

  EXTRACTOR_METATYPE_SERIAL = 191,

  EXTRACTOR_METATYPE_ENCODER = 192,
  EXTRACTOR_METATYPE_ENCODER_VERSION = 193,

  EXTRACTOR_METATYPE_TRACK_GAIN = 194,
  EXTRACTOR_METATYPE_TRACK_PEAK = 195,
  EXTRACTOR_METATYPE_ALBUM_GAIN = 196,
  EXTRACTOR_METATYPE_ALBUM_PEAK = 197,
  EXTRACTOR_METATYPE_REFERENCE_LEVEL = 198,

  EXTRACTOR_METATYPE_LOCATION_NAME = 199,
  EXTRACTOR_METATYPE_LOCATION_ELEVATION = 200,
  EXTRACTOR_METATYPE_LOCATION_HORIZONTAL_ERROR = 201,
  EXTRACTOR_METATYPE_LOCATION_MOVEMENT_SPEED = 202,
  EXTRACTOR_METATYPE_LOCATION_MOVEMENT_DIRECTION = 203,
  EXTRACTOR_METATYPE_LOCATION_CAPTURE_DIRECTION = 204,

  EXTRACTOR_METATYPE_SHOW_EPISODE_NUMBER = 205,
  EXTRACTOR_METATYPE_SHOW_SEASON_NUMBER = 206,

  EXTRACTOR_METATYPE_GROUPING = 207,

  EXTRACTOR_METATYPE_DEVICE_MANUFACTURER = 208,
  EXTRACTOR_METATYPE_DEVICE_MODEL = 209,

  EXTRACTOR_METATYPE_AUDIO_LANGUAGE = 210,
  EXTRACTOR_METATYPE_CHANNELS = 211,
  EXTRACTOR_METATYPE_SAMPLE_RATE = 212,
  EXTRACTOR_METATYPE_AUDIO_DEPTH = 213,
  EXTRACTOR_METATYPE_AUDIO_BITRATE = 214,
  EXTRACTOR_METATYPE_MAXIMUM_AUDIO_BITRATE = 215,

  EXTRACTOR_METATYPE_VIDEO_DIMENSIONS = 216,
  EXTRACTOR_METATYPE_VIDEO_DEPTH = 217,
  EXTRACTOR_METATYPE_FRAME_RATE = 218,
  EXTRACTOR_METATYPE_PIXEL_ASPECT_RATIO = 219,
  EXTRACTOR_METATYPE_VIDEO_BITRATE = 220,
  EXTRACTOR_METATYPE_MAXIMUM_VIDEO_BITRATE = 221,

  EXTRACTOR_METATYPE_SUBTITLE_LANGUAGE = 222,
  EXTRACTOR_METATYPE_VIDEO_LANGUAGE = 223,

  EXTRACTOR_METATYPE_TOC = 224,

  EXTRACTOR_METATYPE_VIDEO_DURATION = 225,
  EXTRACTOR_METATYPE_AUDIO_DURATION = 226,
  EXTRACTOR_METATYPE_SUBTITLE_DURATION = 227,

  EXTRACTOR_METATYPE_AUDIO_PREVIEW = 228,

  EXTRACTOR_METATYPE_NARINFO = 229,
  EXTRACTOR_METATYPE_NAR = 230,

  EXTRACTOR_METATYPE_LAST = 231
};

/** @} */ /* end of meta data types */

/**
 * Get the textual name of the keyword.
 *
 * @param type meta type to get a UTF-8 string for
 * @return NULL if the type is not known, otherwise
 *         an English (locale: C) string describing the type;
 *         translate using `dgettext ("libextractor", rval)`
 * @ingroup types
 */
_EXTRACTOR_EXTERN const char *
EXTRACTOR_metatype_to_string (enum EXTRACTOR_MetaType type);


/**
 * Get a long description for the meta type.
 *
 * @param type meta type to get a UTF-8 description for
 * @return NULL if the type is not known, otherwise
 *         an English (locale: C) string describing the type;
 *         translate using `dgettext ("libextractor", rval)`
 * @ingroup types
 */
_EXTRACTOR_EXTERN const char *
EXTRACTOR_metatype_to_description (enum EXTRACTOR_MetaType type);


/**
 * Return the highest type number, exclusive as in [0,max).
 *
 * @return highest legal metatype number for this version of libextractor
 * @ingroup types
 */
_EXTRACTOR_EXTERN enum EXTRACTOR_MetaType
EXTRACTOR_metatype_get_max (void);


/**
 * Type of a function that libextractor calls for each
 * meta data item found.
 *
 * @param cls closure (user-defined)
 * @param plugin_name name of the plugin that produced this value;
 *        special values can be used (i.e. '&lt;zlib&gt;' for zlib being
 *        used in the main libextractor library and yielding
 *        meta data).
 * @param type libextractor-type describing the meta data
 * @param format basic format information about @a data
 * @param data_mime_type mime-type of @a data (not of the original file);
 *        can be NULL (if mime-type is not known)
 * @param data actual meta-data found
 * @param data_len number of bytes in @a data
 * @return 0 to continue extracting, 1 to abort
 */
typedef int
(*EXTRACTOR_MetaDataProcessor) (void *cls,
                                const char *plugin_name,
                                enum EXTRACTOR_MetaType type,
                                enum EXTRACTOR_MetaFormat format,
                                const char *data_mime_type,
                                const char *data,
                                size_t data_len);


/**
 * Context provided for plugins that perform meta data extraction.
 */
struct EXTRACTOR_ExtractContext
{

  /**
   * Closure argument to pass to all callbacks.
   */
  void *cls;

  /**
   * Configuration string for the plugin.
   */
  const char *config;

  /**
   * Obtain a pointer to up to @a size bytes of data from the file to process.
   *
   * @param cls the @e cls member of this struct
   * @param data pointer to set to the file data, set to NULL on error
   * @param size maximum number of bytes requested
   * @return number of bytes now available in @a data (can be smaller than @a size),
   *         -1 on error
   */
  ssize_t (*read) (void *cls,
                   void **data,
                   size_t size);


  /**
   * Seek in the file.  Use `SEEK_CUR` for @a whence and @a pos of 0 to
   * obtain the current position in the file.
   *
   * @param cls the @e cls member of this struct
   * @param pos position to seek (see 'man lseek')
   * @param whence how to see (absolute to start, relative, absolute to end)
   * @return new absolute position, -1 on error (i.e. desired position
   *         does not exist)
   */
  int64_t (*seek) (void *cls,
                   int64_t pos,
                   int whence);


  /**
   * Determine the overall size of the file.
   *
   * @param cls the @a cls member of this struct
   * @return overall file size, `UINT64_MAX` on error (i.e. IPC failure)
   */
  uint64_t (*get_size) (void *cls);

  /**
   * Function to call on extracted data.
   */
  EXTRACTOR_MetaDataProcessor proc;

};


/**
 * Signature of the extract method that each plugin
 * must provide.
 *
 * @param ec extraction context provided to the plugin
 */
typedef void
(*EXTRACTOR_extract_method) (struct EXTRACTOR_ExtractContext *ec);


/**
 * Linked list of extractor plugins.  An application builds this list
 * by telling libextractor to load various keyword-extraction
 * plugins. Libraries can also be unloaded (removed from this list,
 * see #EXTRACTOR_plugin_remove).
 */
struct EXTRACTOR_PluginList;


/**
 * Load the default set of plugins.  The default can be changed
 * by setting the LIBEXTRACTOR_LIBRARIES environment variable;
 * If it is set to "env", then this function will return
 * #EXTRACTOR_plugin_add_config (NULL, env, flags).
 *
 * If LIBEXTRACTOR_LIBRARIES is not set, the function will attempt
 * to locate the installed plugins and load all of them.
 * The directory where the code will search for plugins is typically
 * automatically determined; it can be specified explicitly using the
 * "LIBEXTRACTOR_PREFIX" environment variable.
 *
 * This environment variable must be set to the precise directory with
 * the plugins (i.e. "/usr/lib/libextractor", not "/usr").  Note that
 * setting the environment variable will disable all of the methods
 * that are typically used to determine the location of plugins.
 * Multiple paths can be specified using ':' to separate them.
 *
 * @param flags options for all of the plugins loaded
 * @return the default set of plugins, NULL if no plugins were found
 */
_EXTRACTOR_EXTERN struct EXTRACTOR_PluginList *
EXTRACTOR_plugin_add_defaults (enum EXTRACTOR_Options flags);


/**
 * Add a library for keyword extraction.
 *
 * @param prev the previous list of libraries, may be NULL
 * @param library the name of the library (short handle, i.e. "mime")
 * @param options options to give to the library
 * @param flags options to use
 * @return the new list of libraries, equal to prev iff an error occured
 */
_EXTRACTOR_EXTERN struct EXTRACTOR_PluginList *
EXTRACTOR_plugin_add (struct EXTRACTOR_PluginList *prev,
                      const char *library,
                      const char *options,
                      enum EXTRACTOR_Options flags);


/**
 * Load multiple libraries as specified by the user.
 *
 * @param config a string given by the user that defines which
 *        libraries should be loaded. Has the format
 *        "[[-]LIBRARYNAME[(options)][:[-]LIBRARYNAME[(options)]]]*".
 *        For example, 'mp3:ogg' loads the
 *        mp3 and the ogg plugins. The '-' before the LIBRARYNAME
 *        indicates that the library should be removed from
 *        the library list.
 * @param prev the  previous list of libraries, may be NULL
 * @param flags options to use
 * @return the new list of libraries, equal to prev iff an error occured
 *         or if config was empty (or NULL).
 */
_EXTRACTOR_EXTERN struct EXTRACTOR_PluginList *
EXTRACTOR_plugin_add_config (struct EXTRACTOR_PluginList *prev,
                             const char *config,
                             enum EXTRACTOR_Options flags);


/**
 * Remove a plugin from a list.
 *
 * @param prev the current list of plugins
 * @param library the name of the plugin to remove (short handle)
 * @return the reduced list, unchanged if the plugin was not loaded
 */
_EXTRACTOR_EXTERN struct EXTRACTOR_PluginList *
EXTRACTOR_plugin_remove (struct EXTRACTOR_PluginList *prev,
                         const char *library);


/**
 * Remove all plugins from the given list (destroys the list).
 *
 * @param plugin the list of plugins
 */
_EXTRACTOR_EXTERN void
EXTRACTOR_plugin_remove_all (struct EXTRACTOR_PluginList *plugins);


/**
 * Extract keywords from a file using the given set of plugins.
 *
 * @param plugins the list of plugins to use
 * @param filename the name of the file, can be NULL if @a data is not NULL
 * @param data data of the file in memory, can be NULL (in which
 *        case libextractor will open file) if filename is not NULL
 * @param size number of bytes in @a data, ignored if @a data is NULL
 * @param proc function to call for each meta data item found
 * @param proc_cls cls argument to @a proc
 */
_EXTRACTOR_EXTERN void
EXTRACTOR_extract (struct EXTRACTOR_PluginList *plugins,
                   const char *filename,
                   const void *data,
                   size_t size,
                   EXTRACTOR_MetaDataProcessor proc,
                   void *proc_cls);


/**
 * Simple #EXTRACTOR_MetaDataProcessor implementation that simply
 * prints the extracted meta data to the given file.  Only prints
 * those keywords that are in UTF-8 format.
 *
 * @param handle the file to write to (`stdout`, `stderr`), must NOT be NULL,
 *               must be of type `FILE *`.
 * @param plugin_name name of the plugin that produced this value
 * @param type libextractor-type describing the meta data
 * @param format basic format information about data
 * @param data_mime_type mime-type of @a data (not of the original file);
 *        can be NULL (if mime-type is not known)
 * @param data actual meta-data found
 * @param data_len number of bytes in @a data
 * @return non-zero if printing failed, otherwise 0.
 */
_EXTRACTOR_EXTERN int
EXTRACTOR_meta_data_print (void *handle,
                           const char *plugin_name,
                           enum EXTRACTOR_MetaType type,
                           enum EXTRACTOR_MetaFormat format,
                           const char *data_mime_type,
                           const char *data,
                           size_t data_len);


#if 0 /* keep Emacsens' auto-indent happy */
{
#endif
#ifdef __cplusplus
}
#endif

#endif