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 9FA6447349 for ; Tue, 5 Sep 2023 13:31:45 +0000 (UTC) Received: from [127.0.1.1] (localhost [127.0.0.1]) by ffbox0-bg.mplayerhq.hu (Postfix) with ESMTP id 564DA68C3F4; Tue, 5 Sep 2023 16:31:42 +0300 (EEST) Received: from mail-ot1-f42.google.com (mail-ot1-f42.google.com [209.85.210.42]) by ffbox0-bg.mplayerhq.hu (Postfix) with ESMTPS id A5234680072 for ; Tue, 5 Sep 2023 16:31:36 +0300 (EEST) Received: by mail-ot1-f42.google.com with SMTP id 46e09a7af769-6bc9c01e154so1704985a34.0 for ; Tue, 05 Sep 2023 06:31:36 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20221208; t=1693920694; x=1694525494; darn=ffmpeg.org; h=content-transfer-encoding:in-reply-to:from:references:to :content-language:subject:user-agent:mime-version:date:message-id :from:to:cc:subject:date:message-id:reply-to; bh=djiykj3q4rwDX4yzbVvnYzQE8W5DggeIQuLtaDBTC5Q=; b=mUItlKLzC1vz1D7z5w9F3TSbJ0EExeJqu7NnwKOgURBqJ/fHKz/C21GrsYZkEqpLtl TaKA3eTBaXzb45fcEtOTwKyoFu/LEfzSAkM66xZoP4yDEcahzeme4EUpGv600MPuoJim qKhdRu5lPMvEWwKxPaasTmHSHm/LWZiJ2LPHDNEsPxajFot1Pqmij1NugOVDezRhPbmS spdprjWnlAGcx7KL0xLH55IJfyHZ0EOfkMJUBJCsFFYjM7g80dcFN5KA24xybIRUcq9Y z+m0FllHQd5pBhGu9YKQSy1tVyAsnvOmi+7o4eMmrc6w6Fi8y6JOzTzHKN37y+RdbSsa U+Xg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20221208; t=1693920694; x=1694525494; h=content-transfer-encoding:in-reply-to:from:references:to :content-language:subject:user-agent:mime-version:date:message-id :x-gm-message-state:from:to:cc:subject:date:message-id:reply-to; bh=djiykj3q4rwDX4yzbVvnYzQE8W5DggeIQuLtaDBTC5Q=; b=KJmDNDPjftIrdtFbuAd/jGtN+DL8aCFcqGBPba5MVuu5iluc3csjJz07J03phBUHkN h6YQ2UL5gUhe2r3pUfYCIEybmEoA/p66pMaz3qY3vteoxA17hcc5anRnE5zcrtuwUl9V Yy9EPPUiIqpw+sad4Em9dy440RjBZEIYuC+8sSOQcwee4H9e4y1HW/kS/HkYH1Y3KVao 8jmQE6OH2m21dH4geEewmTVYlKP1Bqnq1Z3lUlXqN5ZW1UQRzrjDg4r0/1bf/2fw79Q1 vjopwSKyyJ7pW1G2Ah0tRFQiGfqmwFLBdHiHDj6nTSHqiVA11zIM9NUNMYFfwERUnbnM seXg== X-Gm-Message-State: AOJu0YzNz/Y0TV/6OUxBbNGTYikP41a5R+TqiGLGvhFgABWy09tL4VYR /4KrUw5NUdA1EYfzfL898NLOseIv7KA= X-Google-Smtp-Source: AGHT+IEF2d1BsL4HdbUSNBZ+QSHb4ClZWH5DfeN7R9GoPsPup+0K9D9dG2JNrhZILj5IMsBFke0flQ== X-Received: by 2002:a9d:74d1:0:b0:6ba:864e:c5de with SMTP id a17-20020a9d74d1000000b006ba864ec5demr7707508otl.8.1693920694237; Tue, 05 Sep 2023 06:31:34 -0700 (PDT) Received: from [192.168.0.10] (host197.190-225-105.telecom.net.ar. [190.225.105.197]) by smtp.gmail.com with ESMTPSA id z14-20020a9d65ce000000b006b871010cb1sm5622662oth.46.2023.09.05.06.31.33 for (version=TLS1_3 cipher=TLS_AES_128_GCM_SHA256 bits=128/128); Tue, 05 Sep 2023 06:31:33 -0700 (PDT) Message-ID: <1c67edf5-0933-eaed-dd3c-ef77412cf373@gmail.com> Date: Tue, 5 Sep 2023 10:31:32 -0300 MIME-Version: 1.0 User-Agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:102.0) Gecko/20100101 Thunderbird/102.15.0 Content-Language: en-US To: ffmpeg-devel@ffmpeg.org References: <20230904150411.56777-1-jamrial@gmail.com> <7d9e4055-c77c-38e5-6e92-58a0eaff5e46@gmail.com> <6eee5a65-516e-f165-43ee-4c513c4a1376@gmail.com> From: James Almer In-Reply-To: <6eee5a65-516e-f165-43ee-4c513c4a1376@gmail.com> Subject: Re: [FFmpeg-devel] [PATCH 00/17 v3] AVCodecContext and AVCodecParameters side data 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-Transfer-Encoding: 7bit Content-Type: text/plain; charset="us-ascii"; Format="flowed" Errors-To: ffmpeg-devel-bounces@ffmpeg.org Sender: "ffmpeg-devel" Archived-At: List-Archive: List-Post: On 9/5/2023 10:19 AM, Derek Buitenhuis wrote: > On 9/4/2023 5:10 PM, James Almer wrote: >>> * Warn users they need to update their code to not use stream side data (?). >>> Will my code just silently change behavior if it was using stream >>> side data? I legitimately do not know due to the above. >> >> How so? This, like any other deprecated field, remains working as it >> always did until it's removed. The downstream users will see the >> deprecation warning during compilation, and the doxy for the field >> mentions the direct replacement. It's standard procedure. > > I mean dowstream users who are relying on the current behavior of checking the > first packet or stream side data - will it just cease to behave that > way silently? That is, users relying on the *output/result* of the current > behavior. Users relying on global side data being in the first packet need to call the inject() lavf function to enable said functionality. As that function is now deprecated, they will get the relevant warning and be directed to the global side data API. Nothing is being dropped silently. Their code will behave as usual during the deprecation period. > >> I'll add a @deprecated comment to the doxy of >> av_format_inject_global_side_data() to mention the aforementioned objective. >> >>> * Any useful doxy for API users or any example aside from function args and >>> very basic struct info. >> >> The helper functions are basically the same as the packet ones, and the >> stream ones I'm deprecating. add(), new(), get(), etc. Example usage as >> usual is in ffmpeg.c, but i think the doxy does a good job explaining >> what they do. > > I think neither ffmpeg.c nor doxy are very good ways to explain to API users > both what they should use and why. The doxy relies on the fact you alreay know > they exist and you need to use them and for what purpose. ffmpeg.c is the > worst example for API users in the known universe. What makes this different to every other API that was introduced with relevant documentation and references to it in the deprecacted/replaced API? It's IMO very clear in the doxy: Instead of calling inject() and looking at packet side data, just look at the always available avctx side data. Similarly, instead of looking or filling AVStream.side_data, you look or fill the field in AVStream.codecpar. _______________________________________________ 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".