← Back to branch summary

~ubuntu-branches/ubuntu/trusty/gstreamer1.0/trusty

« back to all changes in this revision

Viewing changes to gst/gsttaglist.h

  • Committer: Package Import Robot
  • Author(s): Sebastian Dröge
  • Date: 2012-08-08 18:12:33 UTC
  • mfrom: (1.1.3)
  • Revision ID: package-import@ubuntu.com-20120808181233-riejwxprfsxh1njl
Tags: 0.11.93-1
* New upstream release:
  + debian/libgstreamer.symbols:
    - Update symbols file.

Show diffs side-by-side

added added

removed removed

Lines of Context:
gst/gsttaglist.h
211
211
gboolean               gst_tag_is_fixed        (const gchar * tag);
212
212
 
213
213
/* tag lists */
 
214
 
 
215
/**
 
216
 * GstTagEventScope:
 
217
 * @GST_TAG_SCOPE_STREAM: tags specific to this single stream
 
218
 * @GST_TAG_SCOPE_GLOBAL: global tags for the complete medium
 
219
 *
 
220
 * GstTagScope specifies if a taglist applies to the complete
 
221
 * medium or only to one single stream.
 
222
 */
 
223
typedef enum {
 
224
  GST_TAG_SCOPE_STREAM,
 
225
  GST_TAG_SCOPE_GLOBAL
 
226
} GstTagScope;
 
227
 
214
228
GstTagList * gst_tag_list_new_empty         (void) G_GNUC_MALLOC;
215
229
GstTagList * gst_tag_list_new               (const gchar * tag, ...) G_GNUC_MALLOC;
216
230
GstTagList * gst_tag_list_new_valist        (va_list var_args) G_GNUC_MALLOC;
217
231
 
 
232
void         gst_tag_list_set_scope         (GstTagList * list, GstTagScope scope);
 
233
GstTagScope  gst_tag_list_get_scope         (const GstTagList * list);
 
234
 
218
235
gchar      * gst_tag_list_to_string         (const GstTagList * list) G_GNUC_MALLOC;
219
236
GstTagList * gst_tag_list_new_from_string   (const gchar      * str) G_GNUC_MALLOC;
220
237
 
347
364
                                             const gchar      * tag,
348
365
                                             guint              index,
349
366
                                             GstDateTime     ** value);
350
 
gboolean     gst_tag_list_get_buffer        (const GstTagList * list,
 
367
gboolean     gst_tag_list_get_sample        (const GstTagList * list,
351
368
                                             const gchar      * tag,
352
 
                                             GstBuffer       ** value);
353
 
gboolean     gst_tag_list_get_buffer_index  (const GstTagList * list,
 
369
                                             GstSample       ** sample);
 
370
gboolean     gst_tag_list_get_sample_index  (const GstTagList * list,
354
371
                                             const gchar      * tag,
355
372
                                             guint              index,
356
 
                                             GstBuffer       ** value);
 
373
                                             GstSample       ** sample);
357
374
 
358
375
/* refcounting */
359
376
/**
468
485
 * commonly used title, as used for sorting (string)
469
486
 *
470
487
 * The title as it should be sorted, e.g. 'Doll House, The'
471
 
 *
472
 
 * Since: 0.10.15
473
488
 */
474
489
#define GST_TAG_TITLE_SORTNAME         "title-sortname"
475
490
/**
488
503
 *
489
504
 * The artist name as it should be sorted, e.g. 'Hendrix, Jimi' or
490
505
 * 'Guitar Heroes, The'
491
 
 *
492
 
 * Since: 0.10.15
493
506
 */
494
507
#define GST_TAG_ARTIST_SORTNAME        "artist-sortname"
495
508
/**
506
519
 * album containing this data, as used for sorting (string)
507
520
 *
508
521
 * The album name as it should be sorted, e.g. 'Jazz Guitar, The'
509
 
 *
510
 
 * Since: 0.10.15
511
522
 */
512
523
#define GST_TAG_ALBUM_SORTNAME         "album-sortname"
513
524
/**
514
525
 * GST_TAG_ALBUM_ARTIST:
515
526
 *
516
527
 * The artist of the entire album, as it should be displayed.
517
 
 *
518
 
 * Since: 0.10.25
519
528
 */
520
529
#define GST_TAG_ALBUM_ARTIST           "album-artist"
521
530
/**
522
531
 * GST_TAG_ALBUM_ARTIST_SORTNAME:
523
532
 *
524
533
 * The artist of the entire album, as it should be sorted.
525
 
 *
526
 
 * Since: 0.10.25
527
534
 */
528
535
#define GST_TAG_ALBUM_ARTIST_SORTNAME  "album-artist-sortname"
529
536
/**
530
537
 * GST_TAG_COMPOSER:
531
538
 *
532
539
 * person(s) who composed the recording (string)
533
 
 *
534
 
 * Since: 0.10.15
535
540
 */
536
541
#define GST_TAG_COMPOSER               "composer"
537
542
/**
544
549
 * GST_TAG_DATE_TIME:
545
550
 *
546
551
 * date and time the data was created (#GstDateTime structure)
547
 
 *
548
 
 * Since: 0.10.31
549
552
 */
550
553
#define GST_TAG_DATE_TIME              "datetime"
551
554
/**
571
574
 *
572
575
 * This tag is used for unknown Vorbis comment tags,
573
576
 * unknown APE tags and certain ID3v2 comment fields.
574
 
 *
575
 
 * Since: 0.10.10
576
577
 */
577
578
#define GST_TAG_EXTENDED_COMMENT       "extended-comment"
578
579
/**
610
611
 * GST_TAG_HOMEPAGE:
611
612
 *
612
613
 * Homepage for this media (i.e. artist or movie homepage) (string)
613
 
 *
614
 
 * Since: 0.10.23
615
614
 */
616
615
#define GST_TAG_HOMEPAGE               "homepage"
617
616
/**
648
647
 * GST_TAG_COPYRIGHT_URI:
649
648
 *
650
649
 * URI to location where copyright details can be found (string)
651
 
 *
652
 
 * Since: 0.10.14
653
650
 */
654
651
#define GST_TAG_COPYRIGHT_URI          "copyright-uri"
655
652
/**
661
658
 *
662
659
 * Note: do not use this field to describe the encoding application. Use
663
660
 * #GST_TAG_APPLICATION_NAME or #GST_TAG_COMMENT for that.
664
 
 *
665
 
 * Since: 0.10.33
666
661
 */
667
662
#define GST_TAG_ENCODED_BY             "encoded-by"
668
663
/**
681
676
 * GST_TAG_LICENSE_URI:
682
677
 *
683
678
 * URI to location where license details can be found (string)
684
 
 *
685
 
 * Since: 0.10.14
686
679
 */
687
680
#define GST_TAG_LICENSE_URI            "license-uri"
688
681
/**
719
712
 * GST_TAG_SUBTITLE_CODEC:
720
713
 *
721
714
 * codec/format the subtitle data is stored in (string)
722
 
 *
723
 
 * Since: 0.10.23
724
715
 */
725
716
#define GST_TAG_SUBTITLE_CODEC         "subtitle-codec"
726
717
/**
727
718
 * GST_TAG_CONTAINER_FORMAT:
728
719
 *
729
720
 * container format the data is stored in (string)
730
 
 *
731
 
 * Since: 0.10.24
732
721
 */
733
722
#define GST_TAG_CONTAINER_FORMAT       "container-format"
734
723
/**
802
791
 * GST_TAG_REFERENCE_LEVEL:
803
792
 *
804
793
 * reference level of track and album gain values (double)
805
 
 *
806
 
 * Since: 0.10.12
807
794
 */
808
795
#define GST_TAG_REFERENCE_LEVEL        "replaygain-reference-level"
809
796
/**
823
810
 * Free-form name of the language the content is in, if a language code
824
811
 * is not available. This tag should not be set in addition to a language
825
812
 * code. It is undefined what language or locale the language name is in.
826
 
 *
827
 
 * Since: 0.10.37
828
813
 */
829
814
#define GST_TAG_LANGUAGE_NAME          "language-name"
830
815
/**
832
817
 *
833
818
 * image (sample) (sample taglist should specify the content type and preferably
834
819
 * also set "image-type" field as #GstTagImageType)
835
 
 *
836
 
 * Since: 0.10.6
837
820
 */
838
821
#define GST_TAG_IMAGE                  "image"
839
822
/**
841
824
 *
842
825
 * image that is meant for preview purposes, e.g. small icon-sized version
843
826
 * (sample) (sample taglist should specify the content type)
844
 
 *
845
 
 * Since: 0.10.7
846
827
 */
847
828
#define GST_TAG_PREVIEW_IMAGE          "preview-image"
848
829
 
852
833
 * generic file attachment (sample) (sample taglist should specify the content
853
834
 * type and if possible set "filename" to the file name of the
854
835
 * attachment)
855
 
 *
856
 
 * Since: 0.10.21
857
836
 */
858
837
#define GST_TAG_ATTACHMENT             "attachment"
859
838
 
861
840
 * GST_TAG_BEATS_PER_MINUTE:
862
841
 *
863
842
 * number of beats per minute in audio (double)
864
 
 *
865
 
 * Since: 0.10.12
866
843
 */
867
844
#define GST_TAG_BEATS_PER_MINUTE       "beats-per-minute"
868
845
 
870
847
 * GST_TAG_KEYWORDS:
871
848
 *
872
849
 * comma separated keywords describing the content (string).
873
 
 *
874
 
 * Since: 0.10.21
875
850
 */
876
851
#define GST_TAG_KEYWORDS               "keywords"
877
852
 
880
855
 *
881
856
 * human readable descriptive location of where the media has been recorded or
882
857
 * produced. (string).
883
 
 *
884
 
 * Since: 0.10.21
885
858
 */
886
859
#define GST_TAG_GEO_LOCATION_NAME               "geo-location-name"
887
860
 
891
864
 * geo latitude location of where the media has been recorded or produced in
892
865
 * degrees according to WGS84 (zero at the equator, negative values for southern
893
866
 * latitudes) (double).
894
 
 *
895
 
 * Since: 0.10.21
896
867
 */
897
868
#define GST_TAG_GEO_LOCATION_LATITUDE               "geo-location-latitude"
898
869
 
902
873
 * geo longitude location of where the media has been recorded or produced in
903
874
 * degrees according to WGS84 (zero at the prime meridian in Greenwich/UK,
904
875
 * negative values for western longitudes). (double).
905
 
 *
906
 
 * Since: 0.10.21
907
876
 */
908
877
#define GST_TAG_GEO_LOCATION_LONGITUDE               "geo-location-longitude"
909
878
 
912
881
 *
913
882
 * geo elevation of where the media has been recorded or produced in meters
914
883
 * according to WGS84 (zero is average sea level) (double).
915
 
 *
916
 
 * Since: 0.10.21
917
884
 */
918
885
#define GST_TAG_GEO_LOCATION_ELEVATION               "geo-location-elevation"
919
886
/**
920
887
 * GST_TAG_GEO_LOCATION_COUNTRY:
921
888
 *
922
889
 * The country (english name) where the media has been produced (string).
923
 
 *
924
 
 * Since: 0.10.29
925
890
 */
926
891
#define GST_TAG_GEO_LOCATION_COUNTRY                 "geo-location-country"
927
892
/**
928
893
 * GST_TAG_GEO_LOCATION_CITY:
929
894
 *
930
895
 * The city (english name) where the media has been produced (string).
931
 
 *
932
 
 * Since: 0.10.29
933
896
 */
934
897
#define GST_TAG_GEO_LOCATION_CITY                    "geo-location-city"
935
898
/**
940
903
 *
941
904
 * This tag has been added as this is how it is handled/named in XMP's
942
905
 * Iptc4xmpcore schema.
943
 
 *
944
 
 * Since: 0.10.29
945
906
 */
946
907
#define GST_TAG_GEO_LOCATION_SUBLOCATION             "geo-location-sublocation"
947
908
/**
949
910
 *
950
911
 * Represents the expected error on the horizontal positioning in
951
912
 * meters (double).
952
 
 *
953
 
 * Since: 0.10.31
954
913
 */
955
914
#define GST_TAG_GEO_LOCATION_HORIZONTAL_ERROR   "geo-location-horizontal-error"
956
915
/**
960
919
 * Represented in m/s. (double)
961
920
 *
962
921
 * See also #GST_TAG_GEO_LOCATION_MOVEMENT_DIRECTION
963
 
 *
964
 
 * Since 0.10.30
965
922
 */
966
923
#define GST_TAG_GEO_LOCATION_MOVEMENT_SPEED       "geo-location-movement-speed"
967
924
/**
972
929
 * 0 means the geographic north, and increases clockwise (double from 0 to 360)
973
930
 *
974
931
 * See also #GST_TAG_GEO_LOCATION_CAPTURE_DIRECTION
975
 
 *
976
 
 * Since: 0.10.30
977
932
 */
978
933
#define GST_TAG_GEO_LOCATION_MOVEMENT_DIRECTION "geo-location-movement-direction"
979
934
/**
984
939
 * 0 means the geographic north, and increases clockwise (double from 0 to 360)
985
940
 *
986
941
 * See also #GST_TAG_GEO_LOCATION_MOVEMENT_DIRECTION
987
 
 *
988
 
 * Since: 0.10.30
989
942
 */
990
943
#define GST_TAG_GEO_LOCATION_CAPTURE_DIRECTION  "geo-location-capture-direction"
991
944
/**
992
945
 * GST_TAG_SHOW_NAME:
993
946
 *
994
947
 * Name of the show, used for displaying (string)
995
 
 *
996
 
 * Since: 0.10.26
997
948
 */
998
949
#define GST_TAG_SHOW_NAME                         "show-name"
999
950
/**
1000
951
 * GST_TAG_SHOW_SORTNAME:
1001
952
 *
1002
953
 * Name of the show, used for sorting (string)
1003
 
 *
1004
 
 * Since: 0.10.26
1005
954
 */
1006
955
#define GST_TAG_SHOW_SORTNAME                     "show-sortname"
1007
956
/**
1008
957
 * GST_TAG_SHOW_EPISODE_NUMBER:
1009
958
 *
1010
959
 * Number of the episode within a season/show (unsigned integer)
1011
 
 *
1012
 
 * Since: 0.10.26
1013
960
 */
1014
961
#define GST_TAG_SHOW_EPISODE_NUMBER               "show-episode-number"
1015
962
/**
1016
963
 * GST_TAG_SHOW_SEASON_NUMBER:
1017
964
 *
1018
965
 * Number of the season of a show/series (unsigned integer)
1019
 
 *
1020
 
 * Since: 0.10.26
1021
966
 */
1022
967
#define GST_TAG_SHOW_SEASON_NUMBER                "show-season-number"
1023
968
/**
1024
969
 * GST_TAG_LYRICS:
1025
970
 *
1026
971
 * The lyrics of the media (string)
1027
 
 *
1028
 
 * Since: 0.10.26
1029
972
 */
1030
973
#define GST_TAG_LYRICS                            "lyrics"
1031
974
/**
1032
975
 * GST_TAG_COMPOSER_SORTNAME:
1033
976
 *
1034
977
 * The composer's name, used for sorting (string)
1035
 
 *
1036
 
 * Since: 0.10.26
1037
978
 */
1038
979
#define GST_TAG_COMPOSER_SORTNAME                 "composer-sortname"
1039
980
/**
1041
982
 *
1042
983
 * Groups together media that are related and spans multiple tracks. An
1043
984
 * example are multiple pieces of a concerto. (string)
1044
 
 *
1045
 
 * Since: 0.10.26
1046
985
 */
1047
986
#define GST_TAG_GROUPING                          "grouping"
1048
987
/**
1051
990
 * Rating attributed by a person (likely the application user).
1052
991
 * The higher the value, the more the user likes this media
1053
992
 * (unsigned int from 0 to 100)
1054
 
 *
1055
 
 * Since: 0.10.29
1056
993
 */
1057
994
#define GST_TAG_USER_RATING                       "user-rating"
1058
995
/**
1059
996
 * GST_TAG_DEVICE_MANUFACTURER:
1060
997
 *
1061
998
 * Manufacturer of the device used to create the media (string)
1062
 
 *
1063
 
 * Since: 0.10.30
1064
999
 */
1065
1000
#define GST_TAG_DEVICE_MANUFACTURER               "device-manufacturer"
1066
1001
/**
1067
1002
 * GST_TAG_DEVICE_MODEL:
1068
1003
 *
1069
1004
 * Model of the device used to create the media (string)
1070
 
 *
1071
 
 * Since: 0.10.30
1072
1005
 */
1073
1006
#define GST_TAG_DEVICE_MODEL                      "device-model"
1074
1007
/**
1075
1008
 * GST_TAG_APPLICATION_NAME:
1076
1009
 *
1077
1010
 * Name of the application used to create the media (string)
1078
 
 *
1079
 
 * Since: 0.10.31
1080
1011
 */
1081
1012
#define GST_TAG_APPLICATION_NAME                  "application-name"
1082
1013
/**
1083
1014
 * GST_TAG_APPLICATION_DATA:
1084
1015
 *
1085
 
 * Arbitrary application data (buffer)
1086
 
 *
1087
 
 * Some formats allow application's to add their own arbitrary data
1088
 
 * into files. This data is application's dependent.
1089
 
 *
1090
 
 * Since: 0.10.31
 
1016
 * Arbitrary application data (sample)
 
1017
 *
 
1018
 * Some formats allow applications to add their own arbitrary data
 
1019
 * into files. This data is application dependent.
1091
1020
 */
1092
1021
#define GST_TAG_APPLICATION_DATA          "application-data"
1093
1022
/**
1112
1041
 *
1113
1042
 * Rotations indicated by the values are in clockwise direction and
1114
1043
 * 'flip' means an horizontal mirroring.
1115
 
 *
1116
 
 * Since: 0.10.30
1117
1044
 */
1118
1045
#define GST_TAG_IMAGE_ORIENTATION            "image-orientation"
1119
1046