From patchwork Sat Sep 3 18:39:29 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Anton Khirnov X-Patchwork-Id: 37631 Delivered-To: ffmpegpatchwork2@gmail.com Received: by 2002:a05:6a20:139a:b0:8f:1db5:eae2 with SMTP id w26csp1708471pzh; Sat, 3 Sep 2022 11:40:54 -0700 (PDT) X-Google-Smtp-Source: AA6agR6FGCI/jLvA7/ERv/iqbEPx83YH6w94OLdNYZdGOEnGbKCfIgB2JIDfkUv+SGze74IWxXa7 X-Received: by 2002:a05:6402:350b:b0:43e:f4be:c447 with SMTP id b11-20020a056402350b00b0043ef4bec447mr38449626edd.427.1662230454568; Sat, 03 Sep 2022 11:40:54 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1662230454; cv=none; d=google.com; s=arc-20160816; b=VMS06pZ84DhRYdWCDqKSyA8aR0dfRYKpNZsOwSWwu701VrdHdWtLIQX8W0NLNkjd8S oljcIf9XEdhnKTGfvV5xLEYixvy0bA49QjmToJUa/OMNN/3/lMXM/alsNrdu2h3G3isZ JhNXdqjA7nNhFPhaTBdPiZTpnwpeDWum+qPQndfb8hAZvigNwVAZ3GzjfjguvIaIHH2X hSByqyge93HCgLmsVlRCCJ32JFfMD66PaOBbtcu5A63INJuX4P7kXnbiKwKxT+g1wMoo fk4HkHQXrKCrYelcpztnpcAhaSzzAZNoYEIicTyaxSi4RIu6CHmijCQY9dnF3jsXPBau 5npg== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=sender:errors-to:content-transfer-encoding:reply-to:list-subscribe :list-help:list-post:list-archive:list-unsubscribe:list-id :precedence:subject:mime-version:references:in-reply-to:message-id :date:to:from:delivered-to; bh=DhTWwmDMW7Ihjd6xPH11EjI4zcbJbNHya4Y6YejpPOc=; b=eBaxLVUj4mLZjdYQ/fq3V9EKdezXGKQ/6HwQBqZiqxeq050mbnVTfyjbRCcWk+w9JN xSodKEqPi5ASJcOktmEqcHluWTSHH17ZlQcW8WUEZQbGGql2VAg5x/URFEn24/Us1rM/ Q1lARybZLtdOcldOg4XCVMlLtwuH3QECg3+HTlRCQoHJ3RFwiKpYAicxAUsWp5jU1O9g 4hucFhW4K1VV1JCeolhRIh3ZX3KsNhjxM2OmcYG4m3W+JW4MMvnfhLChV0MQPMgB5KDE POLrjAzTwlKGYReFOXb767c03qSWLlmjej4S0NVQYwvqDED+zU+TNYAudF30DOOfH5uu i+QA== ARC-Authentication-Results: i=1; mx.google.com; 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 Return-Path: Received: from ffbox0-bg.mplayerhq.hu (ffbox0-bg.ffmpeg.org. [79.124.17.100]) by mx.google.com with ESMTP id i24-20020a0564020f1800b0044e68f06cadsi20014eda.290.2022.09.03.11.40.53; Sat, 03 Sep 2022 11:40:54 -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; 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 Received: from [127.0.1.1] (localhost [127.0.0.1]) by ffbox0-bg.mplayerhq.hu (Postfix) with ESMTP id E061868B9C3; Sat, 3 Sep 2022 21:40:50 +0300 (EEST) X-Original-To: ffmpeg-devel@ffmpeg.org Delivered-To: ffmpeg-devel@ffmpeg.org Received: from mail0.khirnov.net (red.khirnov.net [176.97.15.12]) by ffbox0-bg.mplayerhq.hu (Postfix) with ESMTPS id 0E59C68B455 for ; Sat, 3 Sep 2022 21:40:44 +0300 (EEST) Received: from localhost (localhost [IPv6:::1]) by mail0.khirnov.net (Postfix) with ESMTP id 8A5B4240D18 for ; Sat, 3 Sep 2022 20:40:43 +0200 (CEST) Received: from mail0.khirnov.net ([IPv6:::1]) by localhost (mail0.khirnov.net [IPv6:::1]) (amavisd-new, port 10024) with ESMTP id owz5nUQQ-LV2 for ; Sat, 3 Sep 2022 20:40:42 +0200 (CEST) Received: from libav.khirnov.net (libav.khirnov.net [IPv6:2a00:c500:561:201::7]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest SHA256 client-signature RSA-PSS (2048 bits) client-digest SHA256) (Client CN "libav.khirnov.net", Issuer "smtp.khirnov.net SMTP CA" (verified OK)) by mail0.khirnov.net (Postfix) with ESMTPS id 2CEAE240D03 for ; Sat, 3 Sep 2022 20:40:42 +0200 (CEST) Received: by libav.khirnov.net (Postfix, from userid 1000) id 3E5263A0520; Sat, 3 Sep 2022 20:40:42 +0200 (CEST) From: Anton Khirnov To: ffmpeg-devel@ffmpeg.org Date: Sat, 3 Sep 2022 20:39:29 +0200 Message-Id: <20220903183930.9223-1-anton@khirnov.net> X-Mailer: git-send-email 2.35.1 In-Reply-To: <166222954842.3205.17186561679857350925@lain.khirnov.net> References: <166222954842.3205.17186561679857350925@lain.khirnov.net> MIME-Version: 1.0 Subject: [FFmpeg-devel] [PATCH 1/2] lavc: fix and extend AVCodecContext.hwaccel_context doxy 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 Errors-To: ffmpeg-devel-bounces@ffmpeg.org Sender: "ffmpeg-devel" X-TUID: KiL8FspeabWz Mention: - that it is legacy and optional (every hwaccel that uses it can also work with hwcontext, though some optional information can only be signalled throught hwaccel_context) - that it can be used for encoders (only qsvenc currently) - ownership and lifetime --- libavcodec/avcodec.h | 27 ++++++++++++++++++++------- 1 file changed, 20 insertions(+), 7 deletions(-) diff --git a/libavcodec/avcodec.h b/libavcodec/avcodec.h index 65c8535359..7db5d1b1c5 100644 --- a/libavcodec/avcodec.h +++ b/libavcodec/avcodec.h @@ -1388,13 +1388,26 @@ typedef struct AVCodecContext { const struct AVHWAccel *hwaccel; /** - * Hardware accelerator context. - * For some hardware accelerators, a global context needs to be - * provided by the user. In that case, this holds display-dependent - * data FFmpeg cannot instantiate itself. Please refer to the - * FFmpeg HW accelerator documentation to know how to fill this. - * - encoding: unused - * - decoding: Set by user + * Legacy hardware accelerator context. + * + * For some hardware acceleration methods, the caller may use this field to + * signal hwaccel-specific data to the codec. The struct pointed to by this + * pointer is hwaccel-dependent and defined in the respective header. Please + * refer to the FFmpeg HW accelerator documentation to know how to fill + * this. + * + * In most cases this field is optional - the necessary information may also + * be provided to libavcodec through @ref hw_frames_ctx or @ref + * hw_device_ctx (see avcodec_get_hw_config()). However, in some cases it + * may be the only method of signalling some (optional) information. + * + * The struct and its contents are owned by the caller. + * + * - encoding: May be set by the caller before avcodec_open2(). Must remain + * valid until avcodec_free_context(). + * - decoding: May be set by the caller in the get_format() callback. + * Must remain valid until the next get_format() call, + * or avcodec_free_context() (whichever comes first). */ void *hwaccel_context;