From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from ffbox0-bg.mplayerhq.hu (ffbox0-bg.ffmpeg.org [79.124.17.100]) by master.gitmailbox.com (Postfix) with ESMTP id 32FFC421E9 for ; Mon, 28 Feb 2022 03:22:25 +0000 (UTC) Received: from [127.0.1.1] (localhost [127.0.0.1]) by ffbox0-bg.mplayerhq.hu (Postfix) with ESMTP id 028FB68B056; Mon, 28 Feb 2022 05:22:23 +0200 (EET) Received: from mail-il1-f174.google.com (mail-il1-f174.google.com [209.85.166.174]) by ffbox0-bg.mplayerhq.hu (Postfix) with ESMTPS id A936568AF34 for ; Mon, 28 Feb 2022 05:22:21 +0200 (EET) Received: by mail-il1-f174.google.com with SMTP id x14so3905493ill.12 for ; Sun, 27 Feb 2022 19:22:21 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=sandflow-com.20210112.gappssmtp.com; s=20210112; h=mime-version:references:in-reply-to:from:date:message-id:subject:to; bh=zvesH5DVyaMMQyDHCQjqPNU28Iau6WrFLqYghyaCgDM=; b=72V9FV1n6Tt6XPDlxroyccRA7128wkOb5wvQGz6HyksPRl5QMBsJ5MAoJliZ49dQd4 ocfKXv2z6sMHwpCzGmSHsy/S+cubRRpHYNxtsyw2xPGBm2UyPS8JIikhQue0VVgS53+E B07aF7SK++3+euRz9rKoe82cde8sYNJRU6vkAHs7ZC9k8K54WAquwGdEkCQYKe0bqzGz y89hQJXchRkf0J95CKXJwj6vI4wtV8Qi4kXxfAmPXBWy8WbnqKy3CFY3bWME+Whdesoq 9jJ9TpHYgT9d24pnoUjHPJ8q3sQwQSiKQfuPToD78ERP47p/t+js2VEG673xKgfaPpeJ phSw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:mime-version:references:in-reply-to:from:date :message-id:subject:to; bh=zvesH5DVyaMMQyDHCQjqPNU28Iau6WrFLqYghyaCgDM=; b=l3GE+I0Zd/m6H0ZY30AqKPAzgh8X0flHUMv2Q/8JAdx0nYX4Gu4ZAA4QnwCjZJ/OcQ ZfyxEL9jMulaDbPw1cuNaDNc9ARoS8Q8k6tpQP+zqJnshD8VRKVaJQeT8yEKWEGqFF5x aC/OBOi9Ul2KnrMky5GpvMfuX9KJczJWYvdAovSEqJ/dZiQ+ifVx80X3Yj95ptdE/Yuf GDcoQY/hgpfpiWQZNOmervsYaswoWYgZyGIA85uJyIHgpZJPIKO/HV4e4TLZNMsQXQWh etSJg0+yn1eB8aNi195MrIvggyEyGAtq1RzYkoM3FM5/0uPfq/bR5Ff1TtYJrXkW/7xd JpJA== X-Gm-Message-State: AOAM533Frw2TVuW1Lg6swsx7YQVRrxsfraDe4eQm17mMCaj8JedcAN9T 6yDgXcspCLNmLcI91XkJjSh+EKET8SD7AA== X-Google-Smtp-Source: ABdhPJxGiQfxndSeEsQrlx1JL1vUp94LFdxBaP/vl3NVUbHc0wVN64o61APcFdXwFnuLHOpb2JP6jw== X-Received: by 2002:a05:6e02:178b:b0:2c2:81f5:3cbb with SMTP id y11-20020a056e02178b00b002c281f53cbbmr17167096ilu.296.1646018539003; Sun, 27 Feb 2022 19:22:19 -0800 (PST) Received: from mail-io1-f44.google.com (mail-io1-f44.google.com. [209.85.166.44]) by smtp.gmail.com with ESMTPSA id c7-20020a92dc87000000b002c2ed8cc0d1sm961651iln.10.2022.02.27.19.22.18 for (version=TLS1_3 cipher=TLS_AES_128_GCM_SHA256 bits=128/128); Sun, 27 Feb 2022 19:22:18 -0800 (PST) Received: by mail-io1-f44.google.com with SMTP id t11so13336275ioi.7 for ; Sun, 27 Feb 2022 19:22:18 -0800 (PST) X-Received: by 2002:a02:3f48:0:b0:314:2352:1dcb with SMTP id c8-20020a023f48000000b0031423521dcbmr16031104jaf.246.1646018537569; Sun, 27 Feb 2022 19:22:17 -0800 (PST) MIME-Version: 1.0 References: <20220222130153.289215-1-zane@zanevaniperen.com> <20220222130153.289215-2-zane@zanevaniperen.com> In-Reply-To: From: Pierre-Anthony Lemieux Date: Sun, 27 Feb 2022 19:22:06 -0800 X-Gmail-Original-Message-ID: Message-ID: To: FFmpeg development discussions and patches Subject: Re: [FFmpeg-devel] [PATCH 1/7] avutil/uuid: add utility library for manipulating UUIDs as specified in RFC 4122 X-BeenThere: ffmpeg-devel@ffmpeg.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: FFmpeg development discussions and patches List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Reply-To: FFmpeg development discussions and patches Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit Errors-To: ffmpeg-devel-bounces@ffmpeg.org Sender: "ffmpeg-devel" Archived-At: List-Archive: List-Post: On Tue, Feb 22, 2022 at 6:21 AM James Almer wrote: > > > > On 2/22/2022 10:01 AM, Zane van Iperen wrote: > > Loosely based on libuuid > > > > Co-authored-by: Pierre-Anthony Lemieux > > Signed-off-by: Pierre-Anthony Lemieux > > Signed-off-by: Zane van Iperen > > --- > > libavutil/Makefile | 2 + > > libavutil/uuid.c | 156 ++++++++++++++++++++++++++++++++++++++++++ > > libavutil/uuid.h | 167 +++++++++++++++++++++++++++++++++++++++++++++ > > 3 files changed, 325 insertions(+) > > create mode 100644 libavutil/uuid.c > > create mode 100644 libavutil/uuid.h > > > > diff --git a/libavutil/Makefile b/libavutil/Makefile > > index d17876df1a..e0f40412d0 100644 > > --- a/libavutil/Makefile > > +++ b/libavutil/Makefile > > @@ -80,6 +80,7 @@ HEADERS = adler32.h \ > > timestamp.h \ > > tree.h \ > > twofish.h \ > > + uuid.h \ > > version.h \ > > video_enc_params.h \ > > xtea.h \ > > @@ -172,6 +173,7 @@ OBJS = adler32.o \ > > tx_float.o \ > > tx_double.o \ > > tx_int32.o \ > > + uuid.o \ > > video_enc_params.o \ > > film_grain_params.o \ > > > > diff --git a/libavutil/uuid.c b/libavutil/uuid.c > > new file mode 100644 > > index 0000000000..7bcbbe487f > > --- /dev/null > > +++ b/libavutil/uuid.c > > @@ -0,0 +1,156 @@ > > +/* > > + * Copyright (c) 2022 Pierre-Anthony Lemieux > > + * Zane van Iperen > > + * > > + * This file is part of FFmpeg. > > + * > > + * FFmpeg is free software; you can redistribute it and/or > > + * modify it under the terms of the GNU Lesser General Public > > + * License as published by the Free Software Foundation; either > > + * version 2.1 of the License, or (at your option) any later version. > > + * > > + * FFmpeg is distributed in the hope that it will be useful, > > + * but WITHOUT ANY WARRANTY; without even the implied warranty of > > + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU > > + * Lesser General Public License for more details. > > + * > > + * You should have received a copy of the GNU Lesser General Public > > + * License along with FFmpeg; if not, write to the Free Software > > + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA > > + */ > > + > > +/* > > + * Copyright (C) 1996, 1997 Theodore Ts'o. > > + * > > + * Redistribution and use in source and binary forms, with or without > > + * modification, are permitted provided that the following conditions > > + * are met: > > + * 1. Redistributions of source code must retain the above copyright > > + * notice, and the entire permission notice in its entirety, > > + * including the disclaimer of warranties. > > + * 2. 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. > > + * 3. The name of the author may not be used to endorse or promote > > + * products derived from this software without specific prior > > + * written permission. > > + * > > + * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED > > + * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES > > + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE, ALL OF > > + * WHICH ARE HEREBY DISCLAIMED. IN NO EVENT SHALL THE AUTHOR 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 NOT ADVISED OF THE POSSIBILITY OF SUCH > > + * DAMAGE. > > + */ > > + > > +/** > > + * @file > > + * UUID parsing and serialization utilities. > > + * The library treat the UUID as an opaque sequence of 16 unsigned bytes, > > + * i.e. ignoring the internal layout of the UUID, which depends on the type > > + * of the UUID. > > + * > > + * @author Pierre-Anthony Lemieux > > + * @author Zane van Iperen > > + */ > > + > > +#include "uuid.h" > > +#include "error.h" > > +#include "avstring.h" > > +#include > > +#include > > + > > +int av_uuid_parse(const char *in, AVUUID uu) > > +{ > > + size_t len = strlen(in); > > + if (len != 36) > > + return -1; > > + > > + return av_uuid_parse_range(in, in + len, uu); > > +} > > + > > +int av_uuid_parse_range(const char *in_start, const char *in_end, AVUUID uu) > > +{ > > + int i; > > + const char *cp; > > + char buf[3]; > > + > > + if ((in_end - in_start) != 36) > > + return -1; > > + > > + for (i = 0, cp = in_start; i < 36; i++, cp++) { > > + > > + if (i == 8 || i == 13 || i == 18 || i == 23) { > > + if (*cp == '-') > > + continue; > > + return AVERROR(EINVAL); > > + } > > + > > + if (!av_isxdigit(*cp)) > > + return AVERROR(EINVAL); > > + } > > + > > + buf[2] = '\0'; > > + for (i = 0, cp = in_start; i < 16; i++) { > > + > > + if (i == 4 || i == 6 || i == 8 || i == 10) > > + cp++; > > + > > + buf[0] = *cp++; > > + buf[1] = *cp++; > > + > > + errno = 0; > > + uu[i] = strtoul(buf, NULL, 16); > > + if (errno) > > + return AVERROR(errno); > > + } > > + > > + return 0; > > +} > > + > > +void av_uuid_unparse(const AVUUID uuid, char *out) > > +{ > > + static char const hexdigits_lower[16] = "0123456789abcdef"; > > + > > + char *p = out; > > + > > + for (int i = 0; i < 16; i++) { > > + size_t tmp; > > + > > + if (i == 4 || i == 6 || i == 8 || i == 10) { > > + *p++ = '-'; > > + } > > + > > + tmp = uuid[i]; > > + *p++ = hexdigits_lower[tmp >> 4]; > > + *p++ = hexdigits_lower[tmp & 15]; > > + } > > + > > + *p = '\0'; > > +} > > + > > +int av_uuid_urn_parse(const char *in, AVUUID uu) > > +{ > > + return av_uuid_parse(in + 9, uu); > > +} > > + > > +int av_uuid_equal(const AVUUID uu1, const AVUUID uu2) > > +{ > > + return memcmp(uu1, uu2, AV_UUID_LEN) == 0; > > +} > > + > > +void av_uuid_copy(AVUUID dest, const AVUUID src) > > +{ > > + memcpy(dest, src, AV_UUID_LEN); > > +} > > + > > +void av_uuid_nil_set(AVUUID uu) > > +{ > > + memset(uu, 0, AV_UUID_LEN); > > These three seem unnecessary. We don't need new public symbols for this > when we can just state in the doxy that you can copy, compare or zero by > assignment or zeroing or any such standard method. I think explicit calls like `av_uuid_nil_set(uu)` are preferable over `memset(uu, 0, 16)`: - it makes it easier for folks that are not familiar with UUIDs to correctly use the library in particular and UUIDs in general - it makes it easier to find/refactor UUID-related processing across the codebase - it is testable (in contrast to documentation) - it makes the code easier to read IMHO > > > +} > > diff --git a/libavutil/uuid.h b/libavutil/uuid.h > > new file mode 100644 > > index 0000000000..b5d8166898 > > --- /dev/null > > +++ b/libavutil/uuid.h > > @@ -0,0 +1,167 @@ > > +/* > > + * Copyright (c) 2022 Pierre-Anthony Lemieux > > + * Zane van Iperen > > + * > > + * This file is part of FFmpeg. > > + * > > + * FFmpeg is free software; you can redistribute it and/or > > + * modify it under the terms of the GNU Lesser General Public > > + * License as published by the Free Software Foundation; either > > + * version 2.1 of the License, or (at your option) any later version. > > + * > > + * FFmpeg is distributed in the hope that it will be useful, > > + * but WITHOUT ANY WARRANTY; without even the implied warranty of > > + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU > > + * Lesser General Public License for more details. > > + * > > + * You should have received a copy of the GNU Lesser General Public > > + * License along with FFmpeg; if not, write to the Free Software > > + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA > > + */ > > + > > +/* > > + * Copyright (C) 1996, 1997 Theodore Ts'o. > > + * > > + * Redistribution and use in source and binary forms, with or without > > + * modification, are permitted provided that the following conditions > > + * are met: > > + * 1. Redistributions of source code must retain the above copyright > > + * notice, and the entire permission notice in its entirety, > > + * including the disclaimer of warranties. > > + * 2. 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. > > + * 3. The name of the author may not be used to endorse or promote > > + * products derived from this software without specific prior > > + * written permission. > > + * > > + * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED > > + * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES > > + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE, ALL OF > > + * WHICH ARE HEREBY DISCLAIMED. IN NO EVENT SHALL THE AUTHOR 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 NOT ADVISED OF THE POSSIBILITY OF SUCH > > + * DAMAGE. > > + */ > > + > > +/** > > + * @file > > + * UUID parsing and serialization utilities. > > + * The library treat the UUID as an opaque sequence of 16 unsigned bytes, > > + * i.e. ignoring the internal layout of the UUID, which depends on the type > > + * of the UUID. > > + * > > + * @author Pierre-Anthony Lemieux > > + * @author Zane van Iperen > > + */ > > + > > +#ifndef AVUTIL_UUID_H > > +#define AVUTIL_UUID_H > > + > > +#include > > + > > +#define AV_PRI_UUID \ > > + "%02hhx%02hhx%02hhx%02hhx-%02hhx%02hhx-" \ > > + "%02hhx%02hhx-%02hhx%02hhx-%02hhx%02hhx%02hhx%02hhx%02hhx%02hhx" > > + > > +#define AV_PRI_URN_UUID \ > > + "urn:uuid:%02hhx%02hhx%02hhx%02hhx-%02hhx%02hhx-" \ > > + "%02hhx%02hhx-%02hhx%02hhx-%02hhx%02hhx%02hhx%02hhx%02hhx%02hhx" > > + > > +/* AV_UUID_ARG() is used together with AV_PRI_UUID() or AV_PRI_URN_UUID > > + * to print UUIDs, e.g. > > + * av_log(NULL, AV_LOG_DEBUG, "UUID: " AV_PRI_UUID, AV_UUID_ARG(uuid)); > > + */ > > +#define AV_UUID_ARG(x) \ > > + (x)[0], (x)[1], (x)[2], (x)[3], \ > > + (x)[4], (x)[5], (x)[6], (x)[7], \ > > + (x)[8], (x)[9], (x)[10], (x)[11], \ > > + (x)[12], (x)[13], (x)[14], (x)[15] > > + > > +#define AV_UUID_LEN 16 > > + > > +/* Binary representation of a UUID */ > > +typedef uint8_t AVUUID[AV_UUID_LEN]; > > + > > +/** > > + * Parses a string representation of a UUID formatted according to IETF RFC 4122 > > + * into an AVUUID. The parsing is case-insensitive. The string must be 37 > > + * characters long, including the terminating NULL character. > > + * > > + * Example string representation: "2fceebd0-7017-433d-bafb-d073a7116696" > > + * > > + * @param[in] in String representation of a UUID, > > + * e.g. 2fceebd0-7017-433d-bafb-d073a7116696 > > + * @param[out] uu AVUUID > > + * @return A non-zero value in case of an error. > > + */ > > +int av_uuid_parse(const char *in, AVUUID uu); > > + > > +/** > > + * Parses a URN representation of a UUID, as specified at IETF RFC 4122, > > + * into an AVUUID. The parsing is case-insensitive. The string must be 46 > > + * characters long, including the terminating NULL character. > > + * > > + * Example string representation: "urn:uuid:2fceebd0-7017-433d-bafb-d073a7116696" > > + * > > + * @param[in] in URN UUID > > + * @param[out] uu AVUUID > > + * @return A non-zero value in case of an error. > > + */ > > +int av_uuid_urn_parse(const char *in, AVUUID uu); > > + > > +/** > > + * Parses a string representation of a UUID formatted according to IETF RFC 4122 > > + * into an AVUUID. The parsing is case-insensitive. The string must consist of > > + * 36 characters, i.e. `in_end - in_start == 36` > > + * > > + * @param[in] in_start Pointer to the first character of the string representation > > + * @param[in] in_end Pointer to the character after the last character of the > > + * string representation. That memory location is never > > + * accessed > > + * @param[out] uu AVUUID > > + * @return A non-zero value in case of an error. > > + */ > > +int av_uuid_parse_range(const char *in_start, const char *in_end, AVUUID uu); > > + > > +/** > > + * Serializes a AVUUID into a string representation according to IETF RFC 4122. > > + * The string is lowercase and always 37 characters long, including the > > + * terminating NULL character. > > + * > > + * @param[in] uu AVUUID > > + * @param[out] out Pointer to a array of no less than 37 characters. > > + * @return A non-zero value in case of an error. > > + */ > > +void av_uuid_unparse(const AVUUID uu, char *out); > > + > > +/** > > + * Compares two UUIDs for equality. > > + * > > + * @param[in] uu1 AVUUID > > + * @param[in] uu2 AVUUID > > + * @return Nonzero if uu1 and uu2 are identical, 0 otherwise > > + */ > > +int av_uuid_equal(const AVUUID uu1, const AVUUID uu2); > > + > > +/** > > + * Copies the bytes of src into dest. > > + * > > + * @param[out] dest AVUUID > > + * @param[in] src AVUUID > > + */ > > +void av_uuid_copy(AVUUID dest, const AVUUID src); > > + > > +/** > > + * Sets a UUID to nil > > + * > > + * @param[in,out] uu UUID to be set to nil > > + */ > > +void av_uuid_nil_set(AVUUID uu); > > + > > +#endif /* AVUTIL_UUID_H */ > _______________________________________________ > ffmpeg-devel mailing list > ffmpeg-devel@ffmpeg.org > https://ffmpeg.org/mailman/listinfo/ffmpeg-devel > > To unsubscribe, visit link above, or email > ffmpeg-devel-request@ffmpeg.org with subject "unsubscribe". _______________________________________________ ffmpeg-devel mailing list ffmpeg-devel@ffmpeg.org https://ffmpeg.org/mailman/listinfo/ffmpeg-devel To unsubscribe, visit link above, or email ffmpeg-devel-request@ffmpeg.org with subject "unsubscribe".