Consider spaces special and escape them even in the middle of the string.

This is equivalent to adding the whitespace characters to the special characters lists, except it is guaranteed to use the exact same list of whitespace characters as the rest of libavutil.

Definition at line 293 of file avstring.h.

Referenced by av_bprint_escape(), main(), and segment_list_print_entry().

Escape only specified special characters.

Without this flag, escape also any characters that may be considered special by av_get_token(), such as the single quote.

Definition at line 300 of file avstring.h.

Referenced by av_bprint_escape(), and main().

accept codepoints over 0x10FFFF

Definition at line 321 of file avstring.h.

Referenced by av_utf8_decode().

accept non-characters - 0xFFFE and 0xFFFF

Definition at line 322 of file avstring.h.

Referenced by av_utf8_decode().

accept UTF-16 surrogates codes

Definition at line 323 of file avstring.h.

Referenced by av_utf8_decode().

exclude control codes not accepted by XML

Definition at line 324 of file avstring.h.

Referenced by av_utf8_decode(), and main().

Definition at line 326 of file avstring.h.

Enumerator:

AV_ESCAPE_MODE_AUTO

Use auto-selected escaping mode.

AV_ESCAPE_MODE_BACKSLASH

Use backslash escaping.

AV_ESCAPE_MODE_QUOTE

Use single-quote escaping.

Definition at line 279 of file avstring.h.

Return non-zero if pfx is a prefix of str.

If it is, *ptr is set to the address of the first character in str after the prefix.

Parameters

str input string

pfx prefix to test

ptr updated if the prefix is matched inside str

Returns

non-zero if the prefix matches, zero otherwise

Definition at line 34 of file avstring.c.

Referenced by amr_parse_sdp_line(), asfrtp_parse_sdp_line(), bluray_open(), cache_open(), concat_open(), crypto_open2(), dash_read_tmpl_id(), data_open(), dv_parse_sdp_line(), ff_make_absolute_url(), ff_real_parse_sdp_a_line(), ff_wms_parse_sdp_a_line(), ffurl_alloc(), file_check(), hevc_parse_sdp_line(), hls_open(), http_open_cnx_internal(), ilbc_parse_sdp_line(), latm_parse_sdp_line(), main(), md5_close(), open_output_file(), parse_command_line(), parse_h264_sdp_line(), parse_playlist(), parse_sdp_line(), rdt_parse_sdp_line(), rtsp_probe(), sap_probe(), subfile_open(), tls_open(), unix_open(), v4l2_read_probe(), and xiph_parse_sdp_line().

Return non-zero if pfx is a prefix of str independent of case.

If it is, *ptr is set to the address of the first character in str after the prefix.

Parameters

str input string

pfx prefix to test

ptr updated if the prefix is matched inside str

Returns

non-zero if the prefix matches, zero otherwise

Definition at line 45 of file avstring.c.

Referenced by av_stristr(), ff_http_auth_handle_header(), has_header(), and rtsp_parse_range_npt().

Locate the first case-independent occurrence in the string haystack of the string needle.

A zero-length string needle is considered to match at the start of haystack.

This function is a case-insensitive version of the standard strstr().

Parameters

haystack string to search in

needle string to search for

Returns

pointer to the located match within haystack or a null pointer if no match

Definition at line 56 of file avstring.c.

Referenced by av_opencl_compile(), ftp_connect_control_connection(), ftp_features(), has_header(), http_start_receive_data(), mov_read_uuid(), run_implementation(), and sami_paragraph_to_ass().

Locate the first occurrence of the string needle in the string haystack where not more than hay_length characters are searched.

A zero-length string needle is considered to match at the start of haystack.

This function is a length-limited version of the standard strstr().

Parameters

haystack string to search in

needle string to search for

hay_length length of string to search in

Returns

pointer to the located match within haystack or a null pointer if no match

Definition at line 69 of file avstring.c.

Copy the string src to dst, but no more than size - 1 bytes, and null-terminate dst.

This function is the same as BSD strlcpy().

Parameters

dst destination buffer

src source string

size size of destination buffer

Returns

the length of src

Warning

since the return value is the length of src, src absolutely must be a properly 0-terminated string, otherwise this will read beyond the end of the buffer and possibly crash.

Definition at line 83 of file avstring.c.

Referenced by add_fragment(), add_segment(), amf_parse_object(), asf_read_language_list(), ass_encode_frame(), av_parse_color(), av_pix_fmt_swap_endianness(), av_strerror(), av_strlcat(), av_url_split(), avformat_alloc_output_context2(), avformat_open_input(), choose_qop(), compute_real_filename(), compute_status(), concat_open(), ctime1(), dash_fill_tmpl_params(), dash_read_tmpl_id(), dash_write_header(), dprint_options(), dump_metadata(), ff_amf_get_field_value(), ff_img_read_header(), ff_make_absolute_url(), ff_rtsp_setup_output_streams(), find_compressor(), ftp_auth(), ftp_current_dir(), get_preset_file(), handle_connect_error(), hls_append_segment(), hls_delete_old_segments(), hls_open(), hls_start(), hls_write_header(), http_connect(), http_parse_request(), id3v1_set_string(), id3v2_3_metadata_split_date(), main(), matroska_convert_tag(), merge_date(), mmsh_open_internal(), mov_text_encode_frame(), mov_text_new_line_cb(), mov_text_text_cb(), open_input(), open_output_file(), opt_channel_layout(), opt_default(), opt_preset(), opt_streamid(), parse_command(), parse_command_line(), parse_playlist(), parse_sws_flags(), pp_get_mode_by_name_and_quality(), rtmp_open(), rtp_new_connection(), rtp_open(), rtsp_parse_request(), sap_read_header(), sap_write_header(), set_encoder_id(), show_help_options(), srt_to_ass(), start_children(), stream_open(), to_integer(), udp_open(), unix_open(), url_find_protocol(), write_header(), and write_packet().

Append the string src to the string dst, but to a total length of no more than size - 1 bytes, and null-terminate dst.

This function is similar to BSD strlcat(), but differs when size <= strlen(dst).

Parameters

dst destination buffer

src source string

size size of destination buffer

Returns

the total length of src and dst

Warning

since the return value use the length of src and dst, these absolutely must be a properly 0-terminated strings, otherwise this will read beyond the end of the buffer and possibly crash.

Definition at line 93 of file avstring.c.

Referenced by av_dict_set(), av_printf_format(), avcodec_string(), ff_http_auth_create_response(), ff_make_absolute_url(), ff_rtsp_setup_input_streams(), ff_url_join(), ffm_append_recommended_configuration(), ftp_open(), hls_delete_old_segments(), hls_write_header(), matroska_convert_tag(), mmsh_open_internal(), mov_open_dref(), mov_rewrite_dvd_sub_extradata(), opt_channel_layout(), rtmp_open(), rtp_new_connection(), rtsp_read_packet(), rtsp_send_reply(), set_encoder_id(), and show_help_options().

Append output to a string, according to a format.

Never write out of the destination buffer, and always put a terminating 0 within the buffer.

Parameters

dst destination buffer (string to which the output is appended)

size total size of the destination buffer

fmt printf-compatible format string, specifying how the following parameters are used

Returns

the length of the string that would have been generated if enough space had been available

Get the count of continuous non zero chars starting from the beginning.

Parameters

len maximum number of characters to check in the string, that is the maximum value which is returned by the function

Definition at line 140 of file avstring.h.

Referenced by wc3_read_packet().

Print arguments following specified format into a large enough auto allocated buffer.

It is similar to GNU asprintf().

Parameters

fmt printf-compatible format string, specifying how the following parameters are used.

Returns

the allocated string

Note

You have to free the string yourself with av_free().

Convert a number to a av_malloced string.

Definition at line 139 of file avstring.c.

Unescape the given string until a non escaped terminating char, and return the token corresponding to the unescaped string.

The normal \ and ' escaping is supported. Leading and trailing whitespaces are removed, unless they are escaped with '\' or are enclosed between ''.

Parameters

buf the buffer to parse, buf will be updated to point to the terminating char

term a 0-terminated list of terminating chars

Returns

the malloced unescaped string, which must be av_freed by the user, NULL in case of allocation failure

Definition at line 149 of file avstring.c.

Referenced by av_opt_get_key_value(), concat_read_header(), dilate_init(), expand_function(), opt_map(), opt_show_entries(), parse_command(), parse_filter(), parse_interval(), parse_key_value_pair(), parse_link_name(), set_params(), and tee_write_header().

Split the string into several tokens which can be accessed by successive calls to av_strtok().

A token is defined as a sequence of characters not belonging to the set specified in delim.

On the first call to av_strtok(), s should point to the string to parse, and the value of saveptr is ignored. In subsequent calls, s should be NULL, and saveptr should be unchanged since the previous call.

This function is similar to strtok_r() defined in POSIX.1.

Parameters

s the string to parse, may be NULL

delim 0-terminated list of token delimiters, must be non-NULL

saveptr user-provided pointer which points to stored information necessary for av_strtok() to continue scanning the same string. saveptr is updated to point to the next character after the first delimiter found, or to NULL if the string was terminated

Returns

the found token, or NULL when no token is found

Definition at line 184 of file avstring.c.

Referenced by config_input(), config_output(), fill_items(), frei0r_init(), ftp_auth(), ftp_passive_mode(), get_cookies(), init(), libssh_open(), main(), movie_common_init(), new_rendition(), opt_preset(), parse_bsfs(), parse_channel_expressions(), parse_device_name(), parse_frames(), parse_interval(), parse_times(), pp_get_mode_by_name_and_quality(), and sami_paragraph_to_ass().

Locale-independent conversion of ASCII isdigit.

Definition at line 289 of file avstring.c.

Referenced by av_get_frame_filename(), av_isxdigit(), av_parse_time(), channelmap_init(), dash_read_tmpl_id(), date_get_num(), init(), and parse_value().

Locale-independent conversion of ASCII isgraph.

Definition at line 294 of file avstring.c.

Referenced by init_pattern_from_file(), init_pattern_from_string(), and read_shape_from_file().

Locale-independent conversion of ASCII isspace.

Definition at line 299 of file avstring.c.

Referenced by av_expr_parse(), av_small_strptime(), avpriv_strtod(), choose_qop(), extract_rates(), ff_parse_key_value(), ff_smil_get_attr_ptr(), ffserver_get_arg(), ffserver_parse_ffconfig(), get_word(), http_parse_request(), parse_dynamic_acl(), parse_palette(), process_line(), read_chomp_line(), rt_event_to_ass(), rtmp_http_open(), sami_paragraph_to_ass(), and skip_line().

Locale-independent conversion of ASCII characters to uppercase.

Definition at line 221 of file avstring.h.

Referenced by av_dict_get(), av_stristart(), avpriv_toupper4(), ff_hex_to_data(), ff_vorbis_comment(), ffserver_parse_config_feed(), get_jss_cmd(), jacosub_to_ass(), read_yesno(), and upcase_string().

Locale-independent conversion of ASCII characters to lowercase.

Definition at line 231 of file avstring.h.

Referenced by av_isxdigit(), av_strcasecmp(), av_strncasecmp(), ff_urldecode(), ffserver_parse_config_stream(), microdvd_init(), and subviewer_read_header().

Locale-independent conversion of ASCII isxdigit.

Definition at line 305 of file avstring.c.

Referenced by ff_urldecode(), and xbm_decode_frame().

Locale-independent case-insensitive compare.

Note

This means only ASCII-range characters are case-insensitive

Definition at line 213 of file avstring.c.

Referenced by av_hash_alloc(), av_match_name(), av_parse_color(), av_parse_time(), av_probe_input_buffer2(), av_str2id(), avi_metadata_creation_time(), color_table_compare(), decode_info_header(), ff_http_auth_handle_header(), ff_id3v2_write_apic(), ff_img_read_header(), ff_metadata_conv(), ff_rtp_codec_id(), ff_rtp_handler_find_by_name(), ffserver_parse_acl_row(), ffserver_parse_config_feed(), ffserver_parse_config_global(), ffserver_parse_config_redirect(), ffserver_parse_config_stream(), ffserver_parse_ffconfig(), get_cookies(), id3v1_create_tag(), id3v2_3_metadata_split_date(), mkv_check_tag(), mkv_write_tag(), nist_read_header(), opt_vsync(), parse_dynamic_acl(), parse_fmtp(), process_line(), v4l2_set_parameters(), and write_header().

Locale-independent case-insensitive compare.

Note

This means only ASCII-range characters are case-insensitive

Definition at line 223 of file avstring.c.

Referenced by av_match_name(), avpriv_strtod(), data_open(), extract_rates(), ff_smil_get_attr_ptr(), get_cookies(), http_parse_request(), jacosub_read_header(), main(), parse_content_encoding(), process_line(), read_apic(), realtext_probe(), realtext_read_header(), rt_event_to_ass(), sami_paragraph_to_ass(), and sami_read_header().

Thread safe basename.

Parameters

path the path, on DOS both \ and / are considered separators.

Returns

pointer to the basename substring.

Definition at line 234 of file avstring.c.

Referenced by hls_append_segment(), hls_delete_old_segments(), set_segment_filename(), and write_manifest().

Thread safe dirname.

Parameters

path the path, on DOS both \ and / are considered separators.

Returns

the path with the separator replaced by the string terminator or ".".

Note

the function may change the input string.

Definition at line 251 of file avstring.c.

Match instances of a name in a comma-separated list of names.

Parameters

name Name to look for.

names List of names.

Returns

1 on match, 0 otherwise.

Definition at line 311 of file avstring.c.

Referenced by av_find_input_format(), av_guess_codec(), av_guess_format(), av_match_ext(), av_probe_input_format3(), and get_pix_fmt_internal().

Escape string in src, and put the escaped string in an allocated string in *dst, which must be freed with av_free().

Parameters

dst pointer where an allocated string is put

src string to escape, must be non-NULL

special_chars string containing the special characters which need to be escaped, can be NULL

mode escape mode to employ, see AV_ESCAPE_MODE_* macros. Any unknown value for mode will be considered equivalent to AV_ESCAPE_MODE_BACKSLASH, but this behaviour can change without notice.

flags flags which control how to escape, see AV_ESCAPE_FLAG_ macros

Returns

the length of the allocated string, or a negative error code in case of error

See Also

av_bprint_escape()

Definition at line 272 of file avstring.c.

Referenced by main(), and segment_list_print_entry().

Read and decode a single UTF-8 code point (character) from the buffer in *buf, and update *buf to point to the next byte to decode.

In case of an invalid byte sequence, the pointer will be updated to the next byte after the invalid sequence and the function will return an error code.

Depending on the specified flags, the function will also fail in case the decoded code point does not belong to a valid range.

Note

For speed-relevant code a carefully implemented use of GET_UTF8() may be preferred.

Parameters

codep pointer used to return the parsed code in case of success. The value in codep is set even in case the range check fails.

bufp pointer to the address the first byte of the sequence to decode, updated by the function to point to the byte next after the decoded sequence

buf_end pointer to the end of the buffer, points to the next byte past the last in the buffer. This is used to avoid buffer overreads (in case of an unfinished UTF-8 sequence towards the end of the buffer).

flags a collection of AV_UTF8_FLAG_ flags

Returns

>= 0 in case a sequence was successfully read, a negative value in case of invalid sequence

Definition at line 329 of file avstring.c.

Referenced by validate_string(), and writer_open().

Check if a name is in a list.

Returns

0 if not found, or the 1 based index where it has been found in the list.

Definition at line 405 of file avstring.c.

Referenced by av_demuxer_open(), avcodec_open2(), and avformat_open_input().