From patchwork Sun Jun 12 16:23:55 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Stefano Sabatini X-Patchwork-Id: 36174 Delivered-To: ffmpegpatchwork2@gmail.com Received: by 2002:a05:6a20:1a22:b0:84:42e0:ad30 with SMTP id cj34csp76356pzb; Sun, 12 Jun 2022 09:24:08 -0700 (PDT) X-Google-Smtp-Source: ABdhPJx4yD6Abf/9ki8ATOyLqxD+CpC9zBU5n2OTK0+3wEPYfD4MzCWOX16b5qIWwOjI9aIrMZ5H X-Received: by 2002:a17:906:2083:b0:711:fea4:bf8d with SMTP id 3-20020a170906208300b00711fea4bf8dmr18211117ejq.310.1655051048547; Sun, 12 Jun 2022 09:24:08 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1655051048; cv=none; d=google.com; s=arc-20160816; b=oybscZSjmHmZU6M+noDla7OfsEV4zRAn/TZwqaAvQhWdBKiWWnhdB+SjeSjMIBF/OC 5IJjMQTKvJWipLXqa2HtkpZ3XjPljJPJ+DK2WSDyZOc3w4d8GnElzLeYFAbfJihR6nCW ZvHXgJggZy+xsH0RcbUXPcJcthd5zbpVpU8xptei1W2R29WNS6K+Qik+Sd9ABo2Le/Tg 9LmBosCAaU95j1F6SskM9wykSe5K6ZHFiot0g/xCjnEdroDgVjaWSXnU0KcgD5xK/om3 0AWzrkj455hthix1awuGYtB0GICY4ygMXGAUT1cnSnUzHwn1Kr5Bl2oKYT+1ZpwI6rt3 wZ4A== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=sender:errors-to:content-transfer-encoding:cc:reply-to :list-subscribe:list-help:list-post:list-archive:list-unsubscribe :list-id:precedence:subject:mime-version:message-id:date:to:from :dkim-signature:delivered-to; bh=vKK/jQNJCWJieNl9CfRjorCQ5+2Ru4+63yIg0ORIF7M=; b=AtnBL/XjyZkLhGLYPPlO4qr6drTfodOFHLhMcwNPSSPDPkwmpmjevtFdsOOLO02Ulq 5ozgxUWhJnIxfeS5YQ48aaIYfOvuYmv9u9mgYvjmNYP3r2bW0A8ApLA3zFyhpfI9jrHs yBmjS0TPm/ZJPGZRNhhdgRSU29xPbuLYp/3vo42H2sGZEcNLHc/R8TTCtxV8PzeHQEmP NkbDr2D64YE/dBiX9Vg8tT4afOV6zD43lmp8eSj0e4Py2JUcwAgQ3wtNhT102yuuSe0M qwOLE/DltD5qBMr8jH/T+mG/PEf7g4eihVf1PKuwD4+GT3yOmSmdQ32sKnuqPmytNg+v 0MAQ== ARC-Authentication-Results: i=1; mx.google.com; dkim=neutral (body hash did not verify) header.i=@gmail.com header.s=20210112 header.b=mQSLl6Ng; spf=pass (google.com: domain of ffmpeg-devel-bounces@ffmpeg.org designates 79.124.17.100 as permitted sender) smtp.mailfrom=ffmpeg-devel-bounces@ffmpeg.org; dmarc=fail (p=NONE sp=QUARANTINE dis=NONE) header.from=gmail.com Return-Path: Received: from ffbox0-bg.mplayerhq.hu (ffbox0-bg.ffmpeg.org. [79.124.17.100]) by mx.google.com with ESMTP id ho17-20020a1709070e9100b006e8358837d5si5848312ejc.732.2022.06.12.09.24.07; Sun, 12 Jun 2022 09:24:08 -0700 (PDT) Received-SPF: pass (google.com: domain of ffmpeg-devel-bounces@ffmpeg.org designates 79.124.17.100 as permitted sender) client-ip=79.124.17.100; Authentication-Results: mx.google.com; dkim=neutral (body hash did not verify) header.i=@gmail.com header.s=20210112 header.b=mQSLl6Ng; spf=pass (google.com: domain of ffmpeg-devel-bounces@ffmpeg.org designates 79.124.17.100 as permitted sender) smtp.mailfrom=ffmpeg-devel-bounces@ffmpeg.org; dmarc=fail (p=NONE sp=QUARANTINE dis=NONE) header.from=gmail.com Received: from [127.0.1.1] (localhost [127.0.0.1]) by ffbox0-bg.mplayerhq.hu (Postfix) with ESMTP id C001668B4B8; Sun, 12 Jun 2022 19:24:04 +0300 (EEST) X-Original-To: ffmpeg-devel@ffmpeg.org Delivered-To: ffmpeg-devel@ffmpeg.org Received: from mail-wm1-f44.google.com (mail-wm1-f44.google.com [209.85.128.44]) by ffbox0-bg.mplayerhq.hu (Postfix) with ESMTPS id E25FE68B073 for ; Sun, 12 Jun 2022 19:23:57 +0300 (EEST) Received: by mail-wm1-f44.google.com with SMTP id j5-20020a05600c1c0500b0039c5dbbfa48so3386391wms.5 for ; Sun, 12 Jun 2022 09:23:57 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=from:to:cc:subject:date:message-id:mime-version :content-transfer-encoding; bh=Dl7fFn9ms9B2x3eH7hLz8VU81+qLavqViXv5O/4cg5k=; b=mQSLl6Ng+mWTRgvFmPBQqPNdp8Z1BkEvAUmyKrm6MhexS0e07qrr/7aKHNB8dDGqcH xqzy2WXq5iTIslzxZBzNNQ0nbbu0hSuIz6YuJP0S04brfpQT0fcKoJvHd5hBt62tDilK 6DunvJabUuXfk543eK/COVrxJziUxnVB3CuvuO+mhzCIzUisiB0+iJ9lXyxlXPrWEcak 80ohaXIwfqxPOCMbM2g/dfKa3M0qhsqyojJXsvjNRc/KalSYmtVRxf0QU5M7kvcRx9zv HrLMHBH0vD2FDkOFhgwQSj28kIVcFvcoXyJxvsaQ1mOMxw2PDYcAC4WQyD8VcRpnp+Dp V2+Q== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:from:to:cc:subject:date:message-id:mime-version :content-transfer-encoding; bh=Dl7fFn9ms9B2x3eH7hLz8VU81+qLavqViXv5O/4cg5k=; b=wlF/q9VLMvPzXQVsJi57C/jVxr+4evERnOcqkkfyfMynfhUZZziBBxHYk7EsbzdrFF DjV2IytPiv7/BQDoRAQ2kH4ma0JCKsNLAN9b8w1sB6UupouQLnmLwJVDZYnVYbcPT2pH GFULSlH5JbbVpYePV14ScaIgYhbHVkJnJhF7zYbGBMzXTPsQ3pfd7icgFvHpHs/kDFKa nVyFm6rpFJLnPL4ab7eN/WEBgtGY9sb0+1qd/GhVuM7eenSnohCMFkz5s7hG2MlJ/SpI G46kohIbem6CvN0EBH+MAzDkTxyOxXtE89I66yGQsceY6/wWIBKXCq+0ipmGn479okcQ v/xA== X-Gm-Message-State: AOAM531TqZa+MlK3K27DIg+gODS35aKD76LQwAxD7FqQ74bw4B+oiyUs DxmGmELY6TDkGGNMRHhiIYqUyTt9JCQ= X-Received: by 2002:a05:600c:35c1:b0:39c:7930:7b5b with SMTP id r1-20020a05600c35c100b0039c79307b5bmr10062212wmq.162.1655051037028; Sun, 12 Jun 2022 09:23:57 -0700 (PDT) Received: from mariano (dynamic-adsl-78-14-101-54.clienti.tiscali.it. [78.14.101.54]) by smtp.gmail.com with ESMTPSA id b6-20020a056000054600b002102739add8sm7147317wrf.54.2022.06.12.09.23.56 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sun, 12 Jun 2022 09:23:56 -0700 (PDT) Received: by mariano (Postfix, from userid 1000) id 45988BFA36; Sun, 12 Jun 2022 18:23:55 +0200 (CEST) From: Stefano Sabatini To: FFmpeg development discussions and patches Date: Sun, 12 Jun 2022 18:23:55 +0200 Message-Id: <20220612162355.147219-1-stefasab@gmail.com> X-Mailer: git-send-email 2.25.1 MIME-Version: 1.0 Subject: [FFmpeg-devel] [PATCH] lavf/avformat.h: document av_guess_codec() parameters 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 Cc: Stefano Sabatini Errors-To: ffmpeg-devel-bounces@ffmpeg.org Sender: "ffmpeg-devel" X-TUID: K5+YSeoX8RKo Also annotate that some of the parameters were never used. Fix trac issue: http://trac.ffmpeg.org/ticket/4706 --- libavformat/avformat.h | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/libavformat/avformat.h b/libavformat/avformat.h index f12fa7d904..58030f1814 100644 --- a/libavformat/avformat.h +++ b/libavformat/avformat.h @@ -2493,6 +2493,15 @@ const AVOutputFormat *av_guess_format(const char *short_name, /** * Guess the codec ID based upon muxer and filename. + * + * @param fmt the output format, for example one computed by + * av_guess_format() + * @param short_name currently ignored + * @param filename the filename where the encoded stream is going to be stored + * @param mime_type currently ignored + * @param media_type the codec media type + * @return the guessed codec ID, or AV_CODEC_ID_NONE in case none could be guessed + * */ enum AVCodecID av_guess_codec(const AVOutputFormat *fmt, const char *short_name, const char *filename, const char *mime_type,