id3v2enc.c File Reference

#include <stdint.h>
#include <string.h>
#include "libavutil/avstring.h"
#include "libavutil/dict.h"
#include "libavutil/intreadwrite.h"
#include "libavutil/mem.h"
#include "avformat.h"
#include "avlanguage.h"
#include "avio.h"
#include "avio_internal.h"
#include "id3v2.h"
#include "mux.h"

Go to the source code of this file.

Data Structures
struct	LangDescrTagMap

Functions
static void	id3v2_put_size (AVIOContext *pb, int size)
static int	string_is_ascii (const uint8_t *str)
static void	id3v2_encode_string (AVIOContext *pb, const uint8_t *str, enum ID3v2Encoding enc)
static int	id3v2_put_frame (ID3v2EncContext *id3, AVIOContext *avioc, AVIOContext *dyn_buf, const uint32_t tag, const uint8_t flags)
static int	id3v2_put_lang_descr_tag (ID3v2EncContext *id3, AVIOContext *avioc, const uint32_t tag, const uint8_t flags, const char *lang, const char *descr, const char *comment, enum ID3v2Encoding enc)
	Write a frame containing lang, descr and text such as COMM and USLT according to encoding (only UTF-8 or UTF-16+BOM supported). More...
static int	id3v2_put_text_tag (ID3v2EncContext *id3, AVIOContext *avioc, const uint32_t tag, const uint8_t flags, const char **strings, int len, enum ID3v2Encoding enc)
	Write a text frame with multiple text string according to encoding (only UTF-8 or UTF-16+BOM supported). More...
static int	id3v2_put_priv (ID3v2EncContext *id3, AVIOContext *avioc, const uint8_t flags, const char *key, const char *data)
	Write a priv frame with owner and data. More...
static int	is_valid_lang (const char *s)
static int	id3v2_check_write_lang_descr_tag (ID3v2EncContext *id3, AVIOContext *pb, const AVDictionaryEntry *t, enum ID3v2Encoding enc)
static int	id3v2_check_write_tag (ID3v2EncContext *id3, AVIOContext *pb, const AVDictionaryEntry *t, const char table[][4], enum ID3v2Encoding enc)
static void	id3v2_3_metadata_split_date (AVDictionary **pm)
void	ff_id3v2_start (ID3v2EncContext *id3, AVIOContext *pb, int id3v2_version, const char *magic)
	Initialize an ID3v2 tag. More...
static int	write_metadata (AVIOContext *pb, AVDictionary **metadata, ID3v2EncContext *id3, int enc)
static int	write_ctoc (AVFormatContext *s, ID3v2EncContext *id3, int enc)
static int	write_chapter (AVFormatContext *s, ID3v2EncContext *id3, int id, int enc)
int	ff_id3v2_write_metadata (AVFormatContext *s, ID3v2EncContext *id3)
	Convert and write all global metadata from s into an ID3v2 tag. More...
int	ff_id3v2_write_apic (AVFormatContext *s, ID3v2EncContext *id3, AVPacket *pkt)
	Write an attached picture from pkt into an ID3v2 tag. More...
void	ff_id3v2_finish (ID3v2EncContext *id3, AVIOContext *pb, int padding_bytes)
	Finalize an opened ID3v2 tag. More...
int	ff_id3v2_write_simple (struct AVFormatContext *s, int id3v2_version, const char *magic)
	Write an ID3v2 tag containing all global metadata from s. More...

Variables
static const struct LangDescrTagMap	id3v2_lang_descr_tags []

Function Documentation

id3v2_put_size()

static void id3v2_put_size ( AVIOContext *  pb, int  size  )

static

Definition at line 35 of file id3v2enc.c.

Referenced by ff_id3v2_finish(), and id3v2_put_frame().

string_is_ascii()

static int string_is_ascii ( const uint8_t *  str )

static

Definition at line 43 of file id3v2enc.c.

Referenced by ff_id3v2_write_apic(), id3v2_put_lang_descr_tag(), and id3v2_put_text_tag().

id3v2_encode_string()

static void id3v2_encode_string ( AVIOContext *  pb, const uint8_t *  str, enum ID3v2Encoding  enc  )

static

Definition at line 49 of file id3v2enc.c.

Referenced by ff_id3v2_write_apic(), id3v2_put_lang_descr_tag(), and id3v2_put_text_tag().

id3v2_put_frame()

static int id3v2_put_frame ( ID3v2EncContext *  id3, AVIOContext *  avioc, AVIOContext *  dyn_buf, const uint32_t  tag, const uint8_t  flags  )

static

Definition at line 63 of file id3v2enc.c.

Referenced by ff_id3v2_write_apic(), id3v2_put_lang_descr_tag(), id3v2_put_priv(), id3v2_put_text_tag(), and write_ctoc().

id3v2_put_lang_descr_tag()

static int id3v2_put_lang_descr_tag ( ID3v2EncContext *  id3, AVIOContext *  avioc, const uint32_t  tag, const uint8_t  flags, const char *  lang, const char *  descr, const char *  comment, enum ID3v2Encoding  enc  )

static

Write a frame containing lang, descr and text such as COMM and USLT according to encoding (only UTF-8 or UTF-16+BOM supported).

Returns

number of bytes written or a negative error code.

Definition at line 90 of file id3v2enc.c.

Referenced by id3v2_check_write_lang_descr_tag().

id3v2_put_text_tag()

static int id3v2_put_text_tag ( ID3v2EncContext *  id3, AVIOContext *  avioc, const uint32_t  tag, const uint8_t  flags, const char **  strings, int  len, enum ID3v2Encoding  enc  )

static

Write a text frame with multiple text string according to encoding (only UTF-8 or UTF-16+BOM supported).

Returns

number of bytes written or a negative error code.

Definition at line 121 of file id3v2enc.c.

Referenced by id3v2_check_write_tag(), and write_metadata().

id3v2_put_priv()

static int id3v2_put_priv ( ID3v2EncContext *  id3, AVIOContext *  avioc, const uint8_t  flags, const char *  key, const char *  data  )

static

Write a priv frame with owner and data.

'key' is the owner prepended with ID3v2_PRIV_METADATA_PREFIX. 'data' is provided as a string. Any \xXX (where 'X' is a valid hex digit) will be unescaped to the byte value.

Definition at line 157 of file id3v2enc.c.

Referenced by write_metadata().

is_valid_lang()

static int is_valid_lang ( const char *  s )

static

Definition at line 207 of file id3v2enc.c.

Referenced by id3v2_check_write_lang_descr_tag().

id3v2_check_write_lang_descr_tag()

static int id3v2_check_write_lang_descr_tag ( ID3v2EncContext *  id3, AVIOContext *  pb, const AVDictionaryEntry *  t, enum ID3v2Encoding  enc  )

static

Definition at line 212 of file id3v2enc.c.

Referenced by write_metadata().

id3v2_check_write_tag()

static int id3v2_check_write_tag ( ID3v2EncContext *  id3, AVIOContext *  pb, const AVDictionaryEntry *  t, const char  table[][4], enum ID3v2Encoding  enc  )

static

Definition at line 292 of file id3v2enc.c.

Referenced by write_metadata().

id3v2_3_metadata_split_date()

static void id3v2_3_metadata_split_date ( AVDictionary **  pm )

static

Definition at line 311 of file id3v2enc.c.

Referenced by write_metadata().

ff_id3v2_start()

void ff_id3v2_start	(	ID3v2EncContext *	id3,
		AVIOContext *	pb,
		int	id3v2_version,
		const char *	magic
	)

Initialize an ID3v2 tag.

Definition at line 349 of file id3v2enc.c.

Referenced by ff_id3v2_write_simple(), mp3_write_header(), and put_id3v2_tags().

write_metadata()

static int write_metadata ( AVIOContext *  pb, AVDictionary **  metadata, ID3v2EncContext *  id3, int  enc  )

static

Definition at line 363 of file id3v2enc.c.

Referenced by ff_id3v2_write_metadata(), and write_chapter().

write_ctoc()

static int write_ctoc ( AVFormatContext *  s, ID3v2EncContext *  id3, int  enc  )

static

Definition at line 411 of file id3v2enc.c.

Referenced by ff_id3v2_write_metadata().

write_chapter()

static int write_chapter ( AVFormatContext *  s, ID3v2EncContext *  id3, int  id, int  enc  )

static

Definition at line 435 of file id3v2enc.c.

Referenced by ff_id3v2_write_metadata().

ff_id3v2_write_metadata()

int ff_id3v2_write_metadata	(	AVFormatContext *	s,
		ID3v2EncContext *	id3
	)

Convert and write all global metadata from s into an ID3v2 tag.

Definition at line 474 of file id3v2enc.c.

Referenced by ff_id3v2_write_simple(), mp3_write_header(), and put_id3v2_tags().

ff_id3v2_write_apic()

int ff_id3v2_write_apic	(	AVFormatContext *	s,
		ID3v2EncContext *	id3,
		AVPacket *	pkt
	)

Write an attached picture from pkt into an ID3v2 tag.

Definition at line 495 of file id3v2enc.c.

Referenced by mp3_write_packet(), and put_id3v2_tags().

ff_id3v2_finish()

void ff_id3v2_finish	(	ID3v2EncContext *	id3,
		AVIOContext *	pb,
		int	padding_bytes
	)

Finalize an opened ID3v2 tag.

Definition at line 552 of file id3v2enc.c.

Referenced by ff_id3v2_write_simple(), mp3_queue_flush(), mp3_write_header(), and put_id3v2_tags().

ff_id3v2_write_simple()

int ff_id3v2_write_simple	(	struct AVFormatContext *	s,
		int	id3v2_version,
		const char *	magic
	)

Write an ID3v2 tag containing all global metadata from s.

Parameters

id3v2_version	Subversion of ID3v2; supported values are 3 and 4
magic	magic bytes to identify the header If in doubt, use ID3v2_DEFAULT_MAGIC.

Definition at line 576 of file id3v2enc.c.

Referenced by adts_write_header(), and oma_write_header().

Variable Documentation

id3v2_lang_descr_tags

const struct LangDescrTagMap id3v2_lang_descr_tags[]

static

Initial value:

= {
    {.key = "comment", .tag = MKBETAG('C', 'O', 'M', 'M')},
    {.key = "lyrics", .tag = MKBETAG('U', 'S', 'L', 'T')},
    {.key = NULL, .tag = 0}
}

Definition at line 201 of file id3v2enc.c.

Referenced by id3v2_check_write_lang_descr_tag().