mp3 tagging library

• Home
• Reference
• API
• Download
• mplib@sf.net

mplib.h

Go to the documentation of this file.

/*
 * mplib - a library that enables you to edit ID3 tags
 *
 * Copyright (c) 2001,2002,2003,2004,2005,2006 Stefan Podkowinski
 *               2006                          Michal Kowalczuk
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without 
 * modification, are permitted provided that the following conditions are met:
 *
 * * Redistributions of source code must retain the above copyright notice, this
 *   list of conditions and the following disclaimer.
 * * Redistributions in binary form must reproduce the above copyright notice,
 *   this list of conditions and the following disclaimer in the documentation
 *   and/or other materials provided with the distribution.
 * * Neither the name of the author nor the names of its contributors
 *   may be used to endorse or promote products derived from this software
 *   without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef __MPLIB_H
#define __MPLIB_H


/* __BEGIN_DECLS should be used at the beginning of your declarations,
   so that C++ compilers don't mangle their names.  Use __END_DECLS at
   the end of C declarations. */
#undef __BEGIN_DECLS
#undef __END_DECLS
#ifdef __cplusplus
# define __BEGIN_DECLS extern "C" {
# define __END_DECLS }
#else
# define __BEGIN_DECLS /* empty */
# define __END_DECLS /* empty */
#endif

/* __P is a macro used to wrap function prototypes, so that compilers
   that don't understand ANSI C prototypes still work, and ANSI C
   compilers can issue warnings about type mismatches. */
#undef __P
#if defined (__STDC__) || defined (_AIX) \
        || (defined (__mips) && defined (_SYSTYPE_SVR4)) \
        || defined(WIN32) || defined(__cplusplus)
# define __P(protos) protos
#else
# define __P(protos) ()
#endif


__BEGIN_DECLS


/*************************************/
/*             Defines               */
/*************************************/

#define MP_ARTIST 1
#define MP_TITLE 2
#define MP_ALBUM 3
#define MP_GENRE 4
#define MP_COMMENT 5
#define MP_YEAR 6
#define MP_TRACK 7

#define ISO_8859_1 0
#define UTF16 1
#define UTF16BE 2
#define UTF8 3


/*************************************/
/*              errno values         */
/*************************************/
#define MP_EERROR 1
#define MP_EFNF 2
#define MP_EFCOMPR 3
#define MP_EFENCR 4
/*define MP_EUNICODE 5*/
#define MP_EVERSION 6


/*************************************/
/*        Structs and company        */
/*************************************/

typedef struct _mpeg_header 
{
  unsigned int syncword; 
  unsigned int version; 
  unsigned int layer; 
  unsigned int protbit; 
  unsigned int bitrate; 
  unsigned int samplingfreq; 
  unsigned int padbit; 
  unsigned int privbit; 
  unsigned int mode; 
  unsigned int mode_ext; 
  unsigned int copyright; 
  unsigned int originalhome; 
  unsigned int emphasis; 
} mpeg_header;


typedef struct _id3_tag
{
  int version; 
  void *tag; 
} id3_tag;


typedef struct _id3_tag_list
{
  id3_tag *tag;
  struct _id3_tag_list *next;
  struct _id3_tag_list *first;
} id3_tag_list;


/*
 * The following structures are ment as low-level data holders. I strongly
 * suggest you to use the appropriate generic functions below to access them.
 */

/* V 1 */

typedef struct _id3v1_tag
{
  char *title;
  char *artist;
  char *album;
  char *year;
  char *comment;
  unsigned char track; 
  unsigned char genre; 
} id3v1_tag;


/* V 2 */

typedef struct _id3v2_frame
{
  char* frame_id; 
  unsigned char status_flag;
  unsigned char format_flag;
  char *data;
  unsigned int data_size; 
} id3v2_frame;

typedef struct _id3v2_frame_list
{
  struct _id3v2_frame *data;
  struct _id3v2_frame_list *next;
  struct _id3v2_frame_list *start;
} id3v2_frame_list;

typedef struct _id3v2_extended_header
{
  unsigned long size;
  char *flag_bytes;
  unsigned int no_flag_bytes;
  unsigned int is_update;
  unsigned int crc_data_present;
  unsigned char crc_data_length;
  unsigned char* crc_data;
  unsigned int restrictions;
  unsigned char restrictions_data_length;
  unsigned char* restrictions_data;
} id3v2_extended_header;

typedef struct _id3v2_header
{
  unsigned int version_minor;
  unsigned int version_revision;
  char flags; 
  unsigned int unsyncronization;
  unsigned int has_extended_header;
  unsigned int is_experimental;
  unsigned int has_footer;
  unsigned long total_tag_size; 
  id3v2_extended_header *extended_header;   
} id3v2_header;


typedef struct _id3v2_tag
{
  id3v2_header *header;
  id3v2_frame_list *frame_list;
} id3v2_tag;

typedef struct _id3_content
{
  unsigned int compressed;
  unsigned int encrypted;
  char *data;
  unsigned int length;
} id3_content;

typedef enum _id3_encoding
{
  iso_8859_1 = ISO_8859_1,
  utf16 = UTF16,
  utf16be = UTF16BE,
  utf8 = UTF8
} id3_encoding;

typedef struct _id3_text_content
{
  id3_encoding encoding;
  char *text; 
} id3_text_content;

typedef struct _id3_comment_content
{
  id3_encoding encoding;
  char *language; 
  char *short_descr; 
  char *text; 
} id3_comment_content;

/***************************************/
/*               Functions             */
/***************************************/

extern mpeg_header *mp_get_mpeg_header_from_file __P((const char* path));


extern mpeg_header *mp_get_mpeg_header_from_fd __P((int fd));


#define mp_free_mpeg_header(str) xfree(str)


extern char *mp_get_str_version __P((const mpeg_header*));
extern char *mp_get_str_layer __P((const mpeg_header*));
extern char *mp_get_str_bitrate __P((const mpeg_header*));
extern char *mp_get_str_samplingfreq __P((const mpeg_header*));
extern char *mp_get_str_mode __P((const mpeg_header*));


extern id3_tag_list* mp_get_tag_list_from_file __P((const char* path));

extern id3_tag_list* mp_get_tag_list_from_fd __P((int fd));


extern id3_tag_list* mp_get_tag_list_from_mem __P((void * buf, size_t s));

extern id3_tag_list* mp_get_tag_list __P((size_t (*read_func)(void *, size_t, void *),
                                                off_t (*lseek_func)(off_t, int, void *),
                                                void *arg));


extern void mp_free_list __P((id3_tag_list*));


extern id3_content* mp_get_content __P((const id3_tag* t, int f));

extern id3_content* mp_get_content_at_pos __P((const id3_tag* t, int f, int pos));

extern id3_content* mp_get_content_custom __P((const id3_tag* t, const char* f));

extern id3_content* mp_get_content_custom_at_pos __P((const id3_tag* t, const char* f, int pos));

extern void mp_free_content __P((id3_content*));
extern void mp_free_text_content __P((id3_text_content*));
extern void mp_free_comment_content __P((id3_comment_content*));


extern int mp_set_content __P((id3_tag* t, int field, id3_content* content));

extern int mp_set_content_at_pos __P((id3_tag* t, int field, id3_content* content, int pos));

extern int mp_set_custom_content __P((id3_tag* t, char* field, id3_content* content));

extern int mp_set_custom_content_at_pos __P((id3_tag* t, char* field, id3_content* content, int pos));

extern int mp_write_to_file __P((const id3_tag_list* ls, const char* path));

extern int mp_write_to_fd __P((const id3_tag_list* ls, int fd));

extern int mp_del_tags_from_file __P((const char* path));

extern int mp_del_tags_from_fd __P((int fd));

extern int mp_del_tags_by_ver_from_file __P((const char* path, int version));

extern int mp_del_tags_by_ver_from_fd __P((int fd, int version));

extern int mp_convert_to_v1 __P((id3_tag* t));

extern int mp_convert_to_v2 __P((id3_tag* t));

extern int mp_is_valid_v1_value __P((int field, char* value));

extern id3_text_content *mp_parse_artist __P((const id3_content* content));

extern id3_text_content *mp_parse_title __P((const id3_content* content));

extern id3_text_content *mp_parse_album __P((const id3_content* content));

extern id3_text_content *mp_parse_year __P((const id3_content* content));

extern id3_text_content *mp_parse_genre __P((const id3_content* content));

extern id3_text_content *mp_parse_track __P((const id3_content* content));

extern id3_text_content *mp_parse_text __P((const id3_content* content));

extern id3_comment_content *mp_parse_comment __P((const id3_content* content));

extern id3_content *mp_assemble_text_content __P((const char* text, id3_encoding enc));

extern id3_content *mp_assemble_comment_content __P((const char* text, const char* descr, 
    id3_encoding enc, const char* lang));

extern id3_tag* mp_alloc_tag __P((void));

extern id3_tag* mp_alloc_tag_with_version __P((int));

extern void mp_free_tag __P((id3_tag* t));


typedef struct _mem_arg
{
        void *buf;
        size_t size;
        void *act;
} mem_arg;

typedef struct _file_arg
{
        int fd;
} file_arg;


__END_DECLS

#endif /* __MPLIB_H */

Design by growldesign