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
|
\input texinfo @c -*- Texinfo -*-
@c % The structure of this document is based on the
@c % Texinfo manual from libgcrypt by Werner Koch and
@c % and Moritz Schulte.
@c %**start of header
@setfilename extractor.info
@include version.texi
@settitle The GNU libextractor Reference Manual
@c Unify some of the indices.
@c %**end of header
@copying
This manual is for GNU libextractor
(version @value{VERSION}, @value{UPDATED}).
GNU libextractor is a GNU package.
Copyright @copyright{} 2007, 2010, 2012 Christian Grothoff
@quotation
Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.3
or any later version published by the Free Software Foundation;
with no Invariant Sections, no Front-Cover Texts, and no Back-Cover
Texts. A copy of the license is included in the section entitled "GNU
Free Documentation License".
@end quotation
@end copying
@dircategory GNU Libraries
@direntry
* libextractor: (extractor). Meta data extraction library.
@end direntry
@c
@c Titlepage
@c
@setchapternewpage odd
@titlepage
@title The GNU libextractor Reference Manual
@subtitle Version @value{VERSION}
@subtitle @value{UPDATED}
@author Christian Grothoff (@email{christian@@grothoff.org})
@page
@vskip 0pt plus 1filll
@insertcopying
@end titlepage
@summarycontents
@contents
@page
@macro gnu{}
@acronym{GNU}
@end macro
@macro gpl{}
@acronym{GPL}
@end macro
@macro api{}
@acronym{API}
@end macro
@macro cfunction{arg}
@code{\arg\()}
@end macro
@macro mynull{}
@code{NULL}
@end macro
@macro gnule{}
@acronym{GNU libextractor}
@end macro
@ifnottex
@node Top
@top The GNU libextractor Reference Manual
@insertcopying
@end ifnottex
@menu
* Introduction:: What is @gnule{}.
* Preparation:: What you should do before using the library.
* Generalities:: General library functions and data types.
* Extracting meta data:: How to use @gnule{} to obtain meta data.
* Language bindings:: How to use @gnule{} from languages other than C.
* Utility functions:: Utility functions of @gnule{}.
* Existing Plugins:: What plugins are available.
* Writing new Plugins:: How to write new plugins for @gnule{}.
* Internal utility functions:: Utility functions of @gnule{} for writing plugins.
* Reporting bugs:: How to report bugs or request new features.
Appendices
* Copying:: The GNU General Public License says how you
can copy and share some parts of @gnule{}.
Indices
* Concept Index:: Index of concepts and programs.
* Function and Data Index:: Index of functions, variables and data types.
* Type Index:: Index of data types.
@end menu
@c **********************************************************
@c ******************* Introduction ***********************
@c **********************************************************
@node Introduction
@chapter Introduction
@cindex error handling
@gnule{} is GNU's library for extracting meta data from
files. Meta data includes format information (such as mime type,
image dimensions, color depth, recording frequency), content
descriptions (such as document title or document description) and
copyright information (such as license, author and contributors).
Meta data extraction is an inherently uncertain business --- a parse
error can be a corrupt file, an incompatibility in the file format
version, an entirely different file format or a bug in the parser. As
a result of this uncertainty, @gnule{} deliberately
avoids to ever report any errors. Unexpected file contents simply
result in less or possibly no meta data being extracted.
@cindex plugin
@gnule{} uses plugins to handle various file formats.
Technically a plugin can support multiple file formats; however, most
plugins only support one particular format. By default,
@gnule{} will use all plugins that are available and found
in the plugin installation directory. Applications can
request the use of only specific plugins or the exclusion of
certain plugins.
@gnule{} is distributed with the @command{extract}
command@footnote{Some distributions ship @command{extract} in a
seperate package.} which is a command-line tool for extracting
meta data. @command{extract} is given a list of filenames and
prints the resulting meta data to the console. The @command{extract}
source code also serves as an advanced example for how to use
@gnule{}.
This manual focuses on providing documentation for writing software
with @gnule{}. The only relevant parts for end-users
are the chapter on compiling and installing @gnule{}
(@xref{Preparation}.). Also, the chapter on existing plugins maybe of
interest (@xref{Existing Plugins}.). Additional documentation for
end-users can be find in the man page on @command{extract} (using
@verb{|man extract|}).
@cindex license
@gnule{} is licensed under the GNU General Public License,
specifically, since version 0.7, @gnule{} is licensed under GPLv3
@emph{or any later version}.
@node Preparation
@chapter Preparation
This chapter first describes the general build instructions that
should apply to all systems. Specific instructions for known problems
for particular platforms are then described in individual sections
afterwards.
Compiling @gnule{} follows the standard GNU autotools build process
using @command{configure} and @command{make}. For details on the GNU
autotools build process, read the @file{INSTALL} file and query
@verb{|./configure --help|} for additional options.
@gnule{} has various dependencies, most of which are optional.
Instead of specifying the names of the software packages, we
will give the list in terms of the names of the respective
Debian (unstable) packages that should be installed.
You absolutely need:
@itemize @bullet
@item
libtool
@item
gcc
@item
make
@item
g++
@item
libltdl7-dev
@end itemize
Recommended dependencies are:
@itemize @bullet
@item
zlib1g-dev
@item
libbz2-dev
@item
libgif-dev
@item
libvorbis-dev
@item
libflac-dev
@item
libmpeg2-4-dev
@item
librpm-dev
@item
libgtk2.0-dev
@item
libgsf-1-dev
@item
libqt4-dev
@item
libpoppler-dev
@item
libexiv2-dev
@item
libavformat-dev
@item
libswscale-dev
@end itemize
For Subversion access and compilation one also needs:
@itemize @bullet
@item
subversion
@item
autoconf
@item
automake
@end itemize
Please notify us if we missed some dependencies (note that the list is
supposed to only list direct dependencies, not transitive
dependencies).
Once you have compiled and installed @gnule{}, you should have a file
@file{extractor.h} installed in your @file{include/} directory. This
file should be the starting point for your C and C++ development with
@gnule{}. The build process also installs the @file{extract} binary and
man pages for @file{extract} and @gnule{}. The @file{extract} man page
documents the @file{extract} tool. The @gnule{} man page gives a brief
summary of the C API for @gnule{}.
@cindex packageing
@cindex directory structure
@cindex plugin
@cindex environment variables
@vindex LIBEXTRACTOR_PREFIX
When you install @gnule{}, various plugins will be
installed in the @file{lib/libextractor/} directory. The main library
will be installed as @file{lib/libextractor.so}. Note that
@gnule{} will attempt to find the plugins relative to the
path of the main library. Consequently, a package manager can move
the library and its plugins to a different location later --- as long
as the relative path between the main library and the plugins is
preserved. As a method of last resort, the user can specify an
environment variable @verb{|LIBEXTRACTOR_PREFIX|}. If
@gnule{} cannot locate a plugin, it will look in
@verb{|LIBEXTRACTOR_PREFIX/lib/libextractor/|}.
@section Installation on GNU/Linux
Should work using the standard instructions without problems.
@section Installation on FreeBSD
Should work using the standard instructions without problems.
@section Installation on OpenBSD
OpenBSD 3.8 also doesn't have CODESET in @file{langinfo.h}. CODESET
is used in @gnule{} in about three places. This causes problems
during compilation.
@section Installation on NetBSD
No reports so far.
@section Installation using MinGW
Linking -lstdc++ with the provided libtool fails on Cygwin, this
is a problem with libtool, there is unfortunately no flag to tell
libtool how to do its job on Cygwin and it seems that it cannot be the
default to set the library check to 'pass_all'. Patching libtool may
help.
Note: this is a rather dated report and may no longer apply.
@section Installation on OS X
libextractor has two installation methods on Mac OS X: it can be
installed as a Mac OS X framework or with the standard
@command{./configure; make; make install} shell commands. The
framework package is self-contained, but currently omits some of the
extractor plugins that can be compiled in if libextractor is installed
with @command{./configure; make; make install} (provided that the
required dependencies exist.)
@subsection Installing and uninstalling the framework
The binary framework is distributed as a disk image (@file{Extractor-x.x.xx.dmg}).
Installation is done by opening the disk image and clicking @file{Extractor.pkg}
inside it. The Mac OS X installer application will then run. The framework
is installed to the root volume's @file{/Library/Frameworks} folder and installing
will require admin privileges.
The framework can be uninstalled by dragging
@file{/Library/Frameworks/Extractor.framework} cto the @file{Trash}.
@subsection Using the framework
In the framework, the @command{extract} command line tool can be found at
@file{/Library/Frameworks/Extractor.framework/Versions/Current/bin/extract}
The framework can be used in software projects as a framework or as a dynamic
library.
When using the framework as a dynamic library in projects using autotools,
one would most likely want to add
"-I/Library/Frameworks/Extractor.framework/Versions/Current/include"
to CPPFLAGS and
"-L/Library/Frameworks/Extractor.framework/Versions/Current/lib"
to LDFLAGS.
@subsection Example for using the framework
@example
@verbatim
// hello.c
#include <Extractor/extractor.h>
int
main (int argc, char **argv)
{
struct EXTRACTOR_PluginList *el;
el = EXTRACTOR_plugin_load_defaults (EXTRACTOR_OPTION_DEFAULT_POLICY);
// ...
EXTRACTOR_plugin_remove_all (el);
return 0;
}
@end verbatim
@end example
You can then compile the example using
@verbatim
$ gcc -o hello hello.c -framework Extractor
@end verbatim
@subsection Example for using the dynamic library
@example
@verbatim
// hello.c
#include <extractor.h>
int main()
{
struct EXTRACTOR_PluginList *el;
el = EXTRACTOR_plugin_load_defaults (EXTRACTOR_OPTION_DEFAULT_POLICY);
// ...
EXTRACTOR_plugin_remove_all (el);
return 0;
}
@end verbatim
@end example
You can then compile the example using
@verbatim
$ gcc -I/Library/Frameworks/Extractor.framework/Versions/Current/include \
-o hello hello.c \
-L/Library/Frameworks/Extractor.framework/Versions/Current/lib \
-lextractor
@end verbatim
Notice the difference in the @code{#include} line.
@section Note to package maintainers
The suggested way to package GNU libextractor is to split it into
roughly the following binary packages:
@itemize @bullet
@item
libextractor (main library only, only hard dependency for other packages depending on GNU libextractor)
@item
extract (command-line tool and man page)
@item
libextractor-dev (extractor.h header and man page)
@item
libextractor-doc (this manual)
@item
libextractor-plugins (plugins without external dependencies; recommended but not required by extract and libextractor package)
@item
libextractor-plugin-XXX (plugin with dependency on libXXX, for example for XXX=mpeg this would be @file{libextractor_mpeg.so})
@item
libextractor-plugins-all (meta package that requires all plugins)
@end itemize
This would enable minimal installations (i.e. for embedded systems) to
not include any plugins, as well as moderate-size installations (that
do not trigger GTK, QT and X11) for systems that have limited
resources.
@node Generalities
@chapter Generalities
@section Introduction to the ``extract'' command
The @command{extract} command takes a list of file names as arguments,
extracts meta data from each of those files and prints the result to
the console. By default, @command{extract} will use all available
plugins and print all (non-binary) meta data that is found.
The set of plugins used by @command{extract} can be controlled using
the ``-l'' and ``-n'' options. Use ``-n'' to not load all of the
default plugins. Use ``-l NAME'' to specifically load a certain
plugin. For example, specify ``-n -l mime'' to only use the MIME
plugin.
Using the ``-p'' option the output of @command{extract} can be limited
to only certain keyword types. Similarly, using the ``-x'' option,
certain keyword types can be excluded. A list of all known keyword
types can be obtained using the ``-L'' option.
The output format of @command{extract} can be influenced with the
``-V'' (more verbose, lists filenames), ``-g'' (grep-friendly, all
meta data on a single line per file) and ``-b'' (bibTeX style)
options.
@section Common usage examples for ``extract''
@example
$ extract test/test.jpg
comment - (C) 2001 by Christian Grothoff, using gimp 1.2 1
mimetype - image/jpeg
$ extract -V -x comment test/test.jpg
Keywords for file test/test.jpg:
mimetype - image/jpeg
$ extract -p comment test/test.jpg
comment - (C) 2001 by Christian Grothoff, using gimp 1.2 1
$ extract -nV -l png.so -p comment test/test.jpg test/test.png
Keywords for file test/test.jpg:
Keywords for file test/test.png:
comment - Testing keyword extraction
@end example
@section Introduction to the libextractor library
Each public symbol exported by @gnule{} has the prefix
@verb{|EXTRACTOR_|}. All-caps names are used for constants. For the
impatient, the minimal C code for using @gnule{} (on the
executing binary itself) looks like this:
@verbatim
#include <extractor.h>
int
main (int argc, char ** argv)
{
struct EXTRACTOR_PluginList *plugins
= EXTRACTOR_plugin_add_defaults (EXTRACTOR_OPTION_DEFAULT_POLICY);
EXTRACTOR_extract (plugins, argv[1],
NULL, 0,
&EXTRACTOR_meta_data_print, stdout);
EXTRACTOR_plugin_remove_all (plugins);
return 0;
}
@end verbatim
The minimal API illustrated by this example is actually sufficient for
many applications. The full external C API of @gnule{} is described
in chapter @xref{Extracting meta data}. Bindings for other languages
are described in chapter @xref{Language bindings}. The API for
writing new plugins is described in chapter @xref{Writing new Plugins}.
@node Extracting meta data
@chapter Extracting meta data
In order to extract meta data with @gnule{} you first need to
load the respective plugins and then call the extraction API
with the plugins and the data to process. This section
documents how to load and unload plugins, the various types
and formats in which meta data is returned to the application
and finally the extraction API itself.
@menu
* Plugin management:: How to load and unload plugins
* Meta types:: About meta types
* Meta formats:: About meta formats
* Extracting:: How to use the extraction API
@end menu
@node Plugin management
@section Plugin management
@cindex reentrant
@cindex concurrency
@cindex threads
@cindex thread-safety
@tindex enum EXTRACTOR_Options
Using @gnule{} from a multi-threaded parent process requires some
care. The problem is that on most platforms @gnule{} starts
sub-processes for the actual extraction work. This is useful to
isolate the parent process from potential bugs; however, it can cause
problems if the parent process is multi-threaded. The issue is that
at the time of the fork, another thread of the application may hold a
lock (i.e. in gettext or libc). That lock would then never be
released in the child process (as the other thread is not present in
the child process). As a result, the child process would then
deadlock on trying to acquire the lock and never terminate. This has
actually been observed with a lock in GNU gettext that is triggered by
the plugin startup code when it interacts with libltdl.
The problem can be solved by loading the plugins using the
@code{EXTRACTOR_OPTION_IN_PROCESS} option, which will run @gnule{}
in-process and thus avoid the locking issue. In this case, all of the
functions for loading and unloading plugins, including
@verb{|EXTRACTOR_plugin_add_defaults|} and
@verb{|EXTRACTOR_plugin_remove_all|}, are thread-safe and reentrant.
However, using the same plugin list from multiple threads at the same
time is not safe.
All plugin code is expected required to be reentrant and state-less,
but due to the extensive use of 3rd party libraries this cannot
be guaranteed.
@deftp {C Struct} EXTRACTOR_PluginList
@tindex struct EXTRACTOR_PluginList
A plugin list represents a set of GNU libextractor plugins. Most of
the GNU libextractor API is concerned with either constructing a
plugin list or using it to extract meta data. The internal representation
of the plugin list is of no concern to users or plugin developers.
@end deftp
@deftypefun void EXTRACTOR_plugin_remove_all (struct EXTRACTOR_PluginList *plugins)
@findex EXTRACTOR_plugin_remove_all
Unload all of the plugins in the given list.
@end deftypefun
@deftypefun {struct EXTRACTOR_PluginList *} EXTRACTOR_plugin_remove (struct EXTRACTOR_PluginList *plugins, const char*name)
@findex EXTRACTOR_plugin_remove
Unloads a particular plugin. The given name should be the short name of the plugin, for example ``mime'' for the mime-type extractor or ``mpeg'' for the MPEG extractor.
@end deftypefun
@deftypefun {struct EXTRACTOR_PluginList *} EXTRACTOR_plugin_add (struct EXTRACTOR_PluginList *plugins, const char* name,const char* options, enum EXTRACTOR_Options flags)
@findex EXTRACTOR_plugin_add
Loads a particular plugin. The plugin is added to the existing list, which can be NULL. The second argument specifies the name of the plugin (i.e. ``ogg''). The third argument can be NULL and specifies plugin-specific options. Finally, the last argument specifies if the plugin should be executed out-of-process (@code{EXTRACTOR_OPTION_DEFAULT_POLICY}) or not.
@end deftypefun
@deftypefun {struct EXTRACTOR_PluginList *} EXTRACTOR_plugin_add_config (struct EXTRACTOR_PluginList *plugins, const char* config, enum EXTRACTOR_Options flags)
@findex EXTRACTOR_plugin_add_config
Loads and unloads plugins based on a configuration string, modifying the existing list, which can be NULL. The string has the format ``[-]NAME(OPTIONS)@{:[-]NAME(OPTIONS)@}*''. Prefixing the plugin name with a ``-'' means that the plugin should be unloaded.
@end deftypefun
@deftypefun {struct EXTRACTOR_PluginList *} EXTRACTOR_plugin_add_defaults (enum EXTRACTOR_Options flags)
@findex EXTRACTOR_plugin_add_defaults
Loads all of the plugins in the plugin directory. This function is what most @gnule{} applications should use to setup the plugins.
@end deftypefun
@node Meta types
@section Meta types
@tindex enum EXTRACTOR_MetaType
@findex EXTRACTOR_metatype_get_max
@verb{|enum EXTRACTOR_MetaType|} is a C enum which defines a list of over 100 different types of meta data. The total number can differ between different @gnule{} releases; the maximum value for the current release can be obtained using the @verb{|EXTRACTOR_metatype_get_max|} function. All values in this enumeration are of the form @verb{|EXTRACTOR_METATYPE_XXX|}.
@deftypefun {const char *} EXTRACTOR_metatype_to_string (enum EXTRACTOR_MetaType type)
@findex EXTRACTOR_metatype_to_string
@cindex gettext
@cindex internationalization
The function @verb{|EXTRACTOR_metatype_to_string|} can be used to obtain a short English string @samp{s} describing the meta data type. The string can be translated into other languages using GNU gettext with the domain set to @gnule{} (@verb{|dgettext("libextractor", s)|}).
@end deftypefun
@deftypefun {const char *} EXTRACTOR_metatype_to_description (enum EXTRACTOR_MetaType type)
@findex EXTRACTOR_metatype_to_description
@cindex gettext
@cindex internationalization
The function @verb{|EXTRACTOR_metatype_to_description|} can be used to obtain a longer English string @samp{s} describing the meta data type. The description may be empty if the short description returned by @code{EXTRACTOR_metatype_to_string} is already comprehensive. The string can be translated into other languages using GNU gettext with the domain set to @gnule{} (@verb{|dgettext("libextractor", s)|}).
@end deftypefun
@node Meta formats
@section Meta formats
@tindex enum EXTRACTOR_MetaFormat
@verb{|enum EXTRACTOR_MetaFormat|} is a C enum which defines on a high level how the extracted meta data is represented. Currently, the library uses three formats: UTF-8 strings, C strings and binary data. A fourth value, @code{EXTRACTOR_METAFORMAT_UNKNOWN} is defined but not used. UTF-8 strings are 0-terminated strings that have been converted to UTF-8. The format code is @code{EXTRACTOR_METAFORMAT_UTF8}. Ideally, most text meta data will be of this format. Some file formats fail to specify the encoding used for the text. In this case, the text cannot be converted to UTF-8. However, the meta data is still known to be 0-terminated and presumably human-readable. In this case, the format code used is @code{EXTRACTOR_METAFORMAT_C_STRING}; however, this should not be understood to mean that the encoding is the same as that used by the C compiler. Finally, for binary data (mostly images), the format @code{EXTRACTOR_METAFORMAT_BINARY} is used.
Naturally this is not a precise description of the meta format. Plugins can provide a more precise description (if known) by providing the respective mime type of the meta data. For example, binary image meta data could be also tagged as ``image/png'' and normal text would typically be tagged as ``text/plain''.
@node Extracting
@section Extracting
@deftypefn {Function Pointer} 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)
@tindex EXTRACTOR_MetaDataProcessor
Type of a function that libextractor calls for each meta data item found.
@table @var
@item cls
closure (user-defined)
@item plugin_name
name of the plugin that produced this value; special values can be used (i.e. '<zlib>' for zlib being used in the main libextractor library and yielding meta data);
@item type
libextractor-type describing the meta data;
@item format basic
format information about data
@item data_mime_type
mime-type of data (not of the original file); can be NULL (if mime-type is not known);
@item data
actual meta-data found
@item data_len
number of bytes in data
@end table
Return 0 to continue extracting, 1 to abort.
@end deftypefn
@deftypefun void EXTRACTOR_extract (struct EXTRACTOR_PluginList *plugins, const char *filename, const void *data, size_t size, EXTRACTOR_MetaDataProcessor proc, void *proc_cls)
@findex EXTRACTOR_extract
@cindex reentrant
@cindex concurrency
@cindex threads
@cindex thread-safety
This is the main function for extracting keywords with @gnule{}. The first argument is a plugin list which specifies the set of plugins that should be used for extracting meta data. The @samp{filename} argument is optional and can be used to specify the name of a file to process. If @samp{filename} is NULL, then the @samp{data} argument must point to the in-memory data to extract meta data from. If @samp{filename} is non-NULL, @samp{data} can be NULL. If @samp{data} is non-null, then @samp{size} is the size of @samp{data} in bytes. Otherwise @samp{size} should be zero. For each meta data item found, GNU libextractor will call the @samp{proc} function, passing @samp{proc_cls} as the first argument to @samp{proc}. The other arguments to @samp{proc} depend on the specific meta data found.
@cindex SIGBUS
@cindex bus error
Meta data extraction should never really fail --- at worst, @gnule{} should not call @samp{proc} with any meta data. By design, @gnule{} should never crash or leak memory, even given corrupt files as input. Note however, that running @gnule{} on a corrupt file system (or incorrectly @verb{|mmap|}ed files) can result in the operating system sending a SIGBUS (bus error) to the process. While @gnule{} runs plugins out-of-process, it first maps the file into memory and then attempts to decompress it. During decompression it is possible to encounter a SIGBUS. @gnule{} will @emph{not} attempt to catch this signal and your application is likely to crash. Note again that this should only happen if the file @emph{system} is corrupt (not if individual files are corrupt). If this is not acceptable, you might want to consider running @gnule{} itself also out-of-process (as done, for example, by @url{http://grothoff.org/christian/doodle/,doodle}).
@end deftypefun
@node Language bindings
@chapter Language bindings
@cindex Java
@cindex Mono
@cindex Perl
@cindex Python
@cindex PHP
@cindex Ruby
@gnule{} works immediately with C and C++ code. Bindings for Java, Mono, Ruby, Perl, PHP and Python are available for download from the main @gnule{} website. Documentation for these bindings (if available) is part of the downloads for the respective binding. In all cases, a full installation of the C library is required before the binding can be installed.
@section Java
Compiling the GNU libextractor Java binding follows the usual process of
running @command{configure} and @command{make}. The result will be a
shared C library @file{libextractor_java.so} with the native code and
a JAR file (installed to @file{$PREFIX/share/java/libextractor.java}).
A minimal example for using GNU libextractor's Java binding would look
like this:
@verbatim
import org.gnu.libextractor.*;
import java.util.ArrayList;
public static void main(String[] args) {
Extractor ex = Extractor.getDefault();
for (int i=0;i<args.length;i++) {
ArrayList keywords = ex.extract(args[i]);
System.out.println("Keywords for " + args[i] + ":");
for (int j=0;j<keywords.size();j++)
System.out.println(keywords.get(j));
}
}
@end verbatim
The GNU libextractor library and the @file{libextractor_java.so} JNI binding
have to be in the library search path for this to work. Furthermore, the
@file{libextractor.jar} file should be on the classpath.
Note that the API does not use Java 5 style generics in order to work
with older versions of Java.
@section Mono
his binding is undocumented at this point.
@section Perl
This binding is undocumented at this point.
@section Python
This binding is undocumented at this point.
@section PHP
This binding is undocumented at this point.
@section Ruby
This binding is undocumented at this point.
@node Utility functions
@chapter Utility functions
@cindex reentrant
@cindex concurrency
@cindex threads
@cindex thread-safety
This chapter describes various utility functions for @gnule{} usage. All of the functions are reentrant.
@menu
* Utility Constants::
* Meta data printing::
@end menu
@node Utility Constants
@section Utility Constants
@findex EXTRACTOR_VERSION
The constant @verb{|EXTRACTOR_VERSION|} is a hexadecimal
representation of the version number of the installed libextractor
header. The hexadecimal format is 0xAABBCCDD where AA is the major
version (so far always 0), BB is the minor version, CC is the revision
and DD the patch number. For example, for version 0.5.18, we would
have AA=0, BB=5, CC=18 and DD=0. Minor releases such as 0.5.18a or
significant changes in unreleased versions would be marked with DD=1
or higher.
@node Meta data printing
@section Meta data printing
@findex EXTRACTOR_meta_data_print
The @verb{|EXTRACTOR_meta_data_print|} is a simple function which prints the meta data found with libextractor to a file. The function is mostly useful for debugging and as an example for how to manipulate the keyword list and can be passed as the @samp{proc} argument to @code{EXTRACTOR_extract}. The file to print to should be passed as @samp{proc_cls} (which must be of type @code{FILE *}), for example @code{stdout}.
@node Existing Plugins
@chapter Existing Plugins
@itemize @bullet
@item
ARCHIVE (using libarchive)
@item
DVI
@item
EXIV2 (using libexiv2)
@item
FLAC (using libFLAC)
@item
GIF (using libgif)
@item
GSTREAMER (using libgstreamer)
@item
HTML (using libtidy)
@item
IT
@item
JPEG (using libjpeg)
@item
MAN
@item
MIDI (using libsmf)
@item
MIME (using libmagic)
@item
MPEG (using libmpeg2)
@item
NSF
@item
NSFE
@item
ODF
@item
OLE2 (with libgsf)
@item
OGG (with libogg)
@item
PNG
@item
PS
@item
RIFF
@item
RPM (using librpm)
@item
S3M
@item
SID
@item
ThumbnailFFMPEG (using libavformat)
@item
ThumbnailGtk (using libgtk)
@item
TIFF (with libtiff)
@item
WAV
@item
XM
@item
ZIP
@end itemize
@file{gzip} and @file{bzip2} compressed versions of these formats are
also supported (as well as meta data embedded by @file{gzip} itself)
if zlib or libbz2 are available.
@node Writing new Plugins
@chapter Writing new Plugins
Writing a new plugin for libextractor usually requires writing of or
interfacing with an actual parser for a specific format. How this is
can be accomplished depends on the format and cannot be specified in
general. However, care should be taken for the code to be reentrant
and highly fault-tolerant, especially with respect to malformed
inputs.
Plugins should start by verifying that the header of the data matches
the specific format and immediately return if that is not the case.
Even if the header matches the expected file format, plugins must not
assume that the remainder of the file is well formed.
The plugin library must be called libextractor_XXX.so, where XXX
denotes the file format of the plugin. The library must export a
method @verb{|libextractor_XXX_extract_method|}, with the following
signature:
@verbatim
void
EXTRACTOR_XXX_extract_method (struct EXTRACTOR_ExtractContext *ec);
@end verbatim
@samp{ec} contains various information the plugin may need for its
execution. Most importantly, it contains functions for reading
(``read'') and seeking (``seek'') the input data and for returning
extracted data (``proc''). The ``config'' member can contain
additional configuration options. ``proc'' should be called on
each meta data item found. If ``proc'' returns non-zero,
processing should be aborted (if possible).
In order to test new plugins, the @file{extract} command can be run
with the options ``-ni'' and ``-l XXX'' . This will run the plugin
in-process (making it easier to debug) and without any of the other
plugins.
@section Example for a minimal extract method
The following example shows how a plugin can return the mime type of
a file.
@example
@verbatim
void
EXTRACTOR_mymime_extract (struct EXTRACTOR_ExtractContext *ec)
{
void *data;
ssize_t data_size,
if (-1 == (data_size = ec->read (ec->cls, &data, 4)))
return; /* read error */
if (data_size < 4)
return; /* file too small */
if (0 != memcmp (data, "\177ELF", 4))
return; /* not ELF */
if (0 != ec->proc (ec->cls,
"mymime",
EXTRACTOR_METATYPE_MIMETYPE,
EXTRACTOR_METAFORMAT_UTF8,
"text/plain",
"application/x-executable",
1 + strlen("application/x-executable")))
return;
/* more calls to 'proc' here as needed */
}
@end verbatim
@end example
@node Internal utility functions
@chapter Internal utility functions
Some plugins link against the @code{libextractor_common} library which
provides common abstractions needed by many plugins. This section
documents this internal API for plugin developers. Note that the headers
for this library are (intentionally) not installed: we do not consider
this API stable and it should hence only be used by plugins that are
build and shipped with GNU libextractor. Third-party plugins should
not use it.
@file{convert_numeric.h} defines various conversion functions for
numbers (in particular, byte-order conversion for floating point
numbers).
@file{unzip.h} defines an API for accessing compressed files.
@file{pack.h} provides an interpreter for unpacking structs of integer
numbers from streams and converting from big or little endian to host
byte order at the same time.
@file{convert.h} provides a function for character set conversion described
below.
@deftypefun {char *} EXTRACTOR_common_convert_to_utf8 (const char *input, size_t len, const char *charset)
@cindex UTF-8
@cindex character set
@findex EXTRACTOR_common_convert_to_utf8
Various @gnule{} plugins make use of the internal
@file{convert.h} header which defines a function
@verb{|EXTRACTOR_common_convert_to_utf8|} which can be used to easily convert text from
any character set to UTF-8. This conversion is important since the
linked list of keywords that is returned by @gnule{} is
expected to contain only UTF-8 strings. Naturally, proper conversion
may not always be possible since some file formats fail to specify the
character set. In that case, it is often better to not convert at
all.
The arguments to @verb{|EXTRACTOR_common_convert_to_utf8|} are the input string (which
does @emph{not} have to be zero-terminated), the length of the input
string, and the character set (which @emph{must} be zero-terminated).
Which character sets are supported depends on the platform, a list can
generally be obtained using the @command{iconv -l} command. The
return value from @verb{|EXTRACTOR_common_convert_to_utf8|} is a zero-terminated string
in UTF-8 format. The responsibility to free the string is with the
caller, so storing the string in the keyword list is acceptable.
@end deftypefun
@node Reporting bugs
@chapter Reporting bugs
@cindex bug
@gnule{} uses the @url{http://gnunet.org/bugs/,Mantis bugtracking
system}. If possible, please report bugs there. You can also e-mail
the @gnule{} mailinglist at @url{libextractor@@gnu.org}.
@c **********************************************************
@c ******************* Appendices *************************
@c **********************************************************
@include gpl.texi
@node Concept Index
@unnumbered Concept Index
@printindex cp
@node Function and Data Index
@unnumbered Function and Data Index
@printindex fn
@node Type Index
@unnumbered Type Index
@printindex tp
@bye
|